xref: /openbmc/u-boot/README (revision 1b3e3c4f263ff20b95c3514eefbde47e950c39e0)
1 c609719bSwdenk#
2 6abe6fb6SDetlev Zundel# (C) Copyright 2000 - 2011
3 c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 c609719bSwdenk#
5 c609719bSwdenk# See file CREDITS for list of people who contributed to this
6 c609719bSwdenk# project.
7 c609719bSwdenk#
8 c609719bSwdenk# This program is free software; you can redistribute it and/or
9 c609719bSwdenk# modify it under the terms of the GNU General Public License as
10 c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11 c609719bSwdenk# the License, or (at your option) any later version.
12 c609719bSwdenk#
13 c609719bSwdenk# This program is distributed in the hope that it will be useful,
14 c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15 c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16 c609719bSwdenk# GNU General Public License for more details.
17 c609719bSwdenk#
18 c609719bSwdenk# You should have received a copy of the GNU General Public License
19 c609719bSwdenk# along with this program; if not, write to the Free Software
20 c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 c609719bSwdenk# MA 02111-1307 USA
22 c609719bSwdenk#
23 c609719bSwdenk
24 c609719bSwdenkSummary:
25 c609719bSwdenk========
26 c609719bSwdenk
27 24ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28 e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29 e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30 e86e5a07Swdenkinitialize and test the hardware or to download and run application
31 e86e5a07Swdenkcode.
32 c609719bSwdenk
33 c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
34 24ee89b9Swdenkthe source code originate in the Linux source tree, we have some
35 24ee89b9Swdenkheader files in common, and special provision has been made to
36 c609719bSwdenksupport booting of Linux images.
37 c609719bSwdenk
38 c609719bSwdenkSome attention has been paid to make this software easily
39 c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40 c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41 c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42 c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43 c609719bSwdenkload and run it dynamically.
44 c609719bSwdenk
45 c609719bSwdenk
46 c609719bSwdenkStatus:
47 c609719bSwdenk=======
48 c609719bSwdenk
49 c609719bSwdenkIn general, all boards for which a configuration option exists in the
50 c609719bSwdenkMakefile have been tested to some extent and can be considered
51 c609719bSwdenk"working". In fact, many of them are used in production systems.
52 c609719bSwdenk
53 c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54 218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55 218ca724SWolfgang Denkmaintainers.
56 c609719bSwdenk
57 c609719bSwdenk
58 c609719bSwdenkWhere to get help:
59 c609719bSwdenk==================
60 c609719bSwdenk
61 c609719bSwdenkIn case you have questions about, problems with or contributions for
62 c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
63 0c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
64 0c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
65 0c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
66 0c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67 c609719bSwdenk
68 c609719bSwdenk
69 218ca724SWolfgang DenkWhere to get source code:
70 218ca724SWolfgang Denk=========================
71 218ca724SWolfgang Denk
72 218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73 218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74 218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75 218ca724SWolfgang Denk
76 218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
77 11ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
78 218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79 218ca724SWolfgang Denkdirectory.
80 218ca724SWolfgang Denk
81 d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
82 218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83 218ca724SWolfgang Denk
84 218ca724SWolfgang Denk
85 c609719bSwdenkWhere we come from:
86 c609719bSwdenk===================
87 c609719bSwdenk
88 c609719bSwdenk- start from 8xxrom sources
89 24ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90 c609719bSwdenk- clean up code
91 c609719bSwdenk- make it easier to add custom boards
92 c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93 c609719bSwdenk- extend functions, especially:
94 c609719bSwdenk  * Provide extended interface to Linux boot loader
95 c609719bSwdenk  * S-Record download
96 c609719bSwdenk  * network boot
97 11ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
98 24ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99 c609719bSwdenk- add other CPU families (starting with ARM)
100 24ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
101 0d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
102 24ee89b9Swdenk
103 24ee89b9Swdenk
104 24ee89b9SwdenkNames and Spelling:
105 24ee89b9Swdenk===================
106 24ee89b9Swdenk
107 24ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
108 24ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
109 24ee89b9Swdenkin source files etc.). Example:
110 24ee89b9Swdenk
111 24ee89b9Swdenk	This is the README file for the U-Boot project.
112 24ee89b9Swdenk
113 24ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
114 24ee89b9Swdenk
115 24ee89b9Swdenk	include/asm-ppc/u-boot.h
116 24ee89b9Swdenk
117 24ee89b9Swdenk	#include <asm/u-boot.h>
118 24ee89b9Swdenk
119 24ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
120 24ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
121 24ee89b9Swdenk
122 24ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
123 24ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124 c609719bSwdenk
125 c609719bSwdenk
126 93f19cc0SwdenkVersioning:
127 93f19cc0Swdenk===========
128 93f19cc0Swdenk
129 360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
130 360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
131 360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
132 360d883aSThomas Webernames consisting of the calendar year and month of the release date.
133 360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
134 360d883aSThomas Weberreleases in "stable" maintenance trees.
135 93f19cc0Swdenk
136 360d883aSThomas WeberExamples:
137 360d883aSThomas Weber	U-Boot v2009.11     - Release November 2009
138 360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
139 360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
140 93f19cc0Swdenk
141 93f19cc0Swdenk
142 c609719bSwdenkDirectory Hierarchy:
143 c609719bSwdenk====================
144 c609719bSwdenk
145 8d321b81SPeter Tyser/arch			Architecture specific files
146 8d321b81SPeter Tyser  /arm			Files generic to ARM architecture
147 8d321b81SPeter Tyser    /cpu		CPU specific files
148 8d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
149 8d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
150 8d321b81SPeter Tyser	/at91rm9200	Files specific to Atmel AT91RM9200 CPU
151 8d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
152 8d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
153 8d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
154 8d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
155 8d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
156 8d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
157 8d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
158 8d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
159 8d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
160 8d321b81SPeter Tyser    /lib		Architecture specific library files
161 8d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
162 8d321b81SPeter Tyser    /cpu		CPU specific files
163 8d321b81SPeter Tyser    /lib		Architecture specific library files
164 8d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
165 8d321b81SPeter Tyser    /cpu		CPU specific files
166 8d321b81SPeter Tyser    /lib		Architecture specific library files
167 fea25720SGraeme Russ  /x86			Files generic to x86 architecture
168 8d321b81SPeter Tyser    /cpu		CPU specific files
169 8d321b81SPeter Tyser    /lib		Architecture specific library files
170 8d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
171 8d321b81SPeter Tyser    /cpu		CPU specific files
172 8d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
173 8d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
174 8d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
175 8d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
176 8d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
177 8d321b81SPeter Tyser    /lib		Architecture specific library files
178 8d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
179 8d321b81SPeter Tyser    /cpu		CPU specific files
180 8d321b81SPeter Tyser    /lib		Architecture specific library files
181 8d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
182 8d321b81SPeter Tyser    /cpu		CPU specific files
183 8d321b81SPeter Tyser    /lib		Architecture specific library files
184 8d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
185 8d321b81SPeter Tyser    /cpu		CPU specific files
186 8d321b81SPeter Tyser    /lib		Architecture specific library files
187 a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
188 8d321b81SPeter Tyser    /cpu		CPU specific files
189 8d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
190 8d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
191 8d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
192 8d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
193 8d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
194 8d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
195 8d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
196 8d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
197 8d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
198 8d321b81SPeter Tyser    /lib		Architecture specific library files
199 8d321b81SPeter Tyser  /sh			Files generic to SH architecture
200 8d321b81SPeter Tyser    /cpu		CPU specific files
201 8d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
202 8d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
203 8d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
204 8d321b81SPeter Tyser    /lib		Architecture specific library files
205 8d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
206 8d321b81SPeter Tyser    /cpu		CPU specific files
207 8d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
208 8d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
209 8d321b81SPeter Tyser    /lib		Architecture specific library files
210 8d321b81SPeter Tyser/api			Machine/arch independent API for external apps
211 8d321b81SPeter Tyser/board			Board dependent files
212 8d321b81SPeter Tyser/common			Misc architecture independent functions
213 8d321b81SPeter Tyser/disk			Code for disk drive partition handling
214 8d321b81SPeter Tyser/doc			Documentation (don't expect too much)
215 8d321b81SPeter Tyser/drivers		Commonly used device drivers
216 8d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
217 8d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
218 8d321b81SPeter Tyser/include		Header Files
219 8d321b81SPeter Tyser/lib			Files generic to all architectures
220 8d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
221 8d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
222 8d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
223 8d321b81SPeter Tyser/net			Networking code
224 8d321b81SPeter Tyser/post			Power On Self Test
225 8d321b81SPeter Tyser/rtc			Real Time Clock drivers
226 8d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
227 c609719bSwdenk
228 c609719bSwdenkSoftware Configuration:
229 c609719bSwdenk=======================
230 c609719bSwdenk
231 c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
232 c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
233 c609719bSwdenk
234 c609719bSwdenkThere are two classes of configuration variables:
235 c609719bSwdenk
236 c609719bSwdenk* Configuration _OPTIONS_:
237 c609719bSwdenk  These are selectable by the user and have names beginning with
238 c609719bSwdenk  "CONFIG_".
239 c609719bSwdenk
240 c609719bSwdenk* Configuration _SETTINGS_:
241 c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
242 c609719bSwdenk  you don't know what you're doing; they have names beginning with
243 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
244 c609719bSwdenk
245 c609719bSwdenkLater we will add a configuration tool - probably similar to or even
246 c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
247 c609719bSwdenkdo the configuration by hand, which means creating some symbolic
248 c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
249 c609719bSwdenkas an example here.
250 c609719bSwdenk
251 c609719bSwdenk
252 c609719bSwdenkSelection of Processor Architecture and Board Type:
253 c609719bSwdenk---------------------------------------------------
254 c609719bSwdenk
255 c609719bSwdenkFor all supported boards there are ready-to-use default
256 c609719bSwdenkconfigurations available; just type "make <board_name>_config".
257 c609719bSwdenk
258 c609719bSwdenkExample: For a TQM823L module type:
259 c609719bSwdenk
260 c609719bSwdenk	cd u-boot
261 c609719bSwdenk	make TQM823L_config
262 c609719bSwdenk
263 11ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
264 c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
265 c609719bSwdenkdirectory according to the instructions in cogent/README.
266 c609719bSwdenk
267 c609719bSwdenk
268 c609719bSwdenkConfiguration Options:
269 c609719bSwdenk----------------------
270 c609719bSwdenk
271 c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
272 c609719bSwdenksuch information is kept in a configuration file
273 c609719bSwdenk"include/configs/<board_name>.h".
274 c609719bSwdenk
275 c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
276 c609719bSwdenk"include/configs/TQM823L.h".
277 c609719bSwdenk
278 c609719bSwdenk
279 7f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
280 7f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
281 7f6c2cbcSwdenkbuild a config tool - later.
282 7f6c2cbcSwdenk
283 7f6c2cbcSwdenk
284 c609719bSwdenkThe following options need to be configured:
285 c609719bSwdenk
286 2628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
287 c609719bSwdenk
288 2628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
289 6ccec449SWolfgang Denk
290 6ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
291 09ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
292 c609719bSwdenk
293 c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
294 c609719bSwdenk		Define exactly one of
295 c609719bSwdenk		CONFIG_CMA286_60_OLD
296 c609719bSwdenk--- FIXME --- not tested yet:
297 c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298 c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
299 c609719bSwdenk
300 c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
301 c609719bSwdenk		Define exactly one of
302 c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
303 c609719bSwdenk
304 c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305 c609719bSwdenk		Define one or more of
306 c609719bSwdenk		CONFIG_CMA302
307 c609719bSwdenk
308 c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309 c609719bSwdenk		Define one or more of
310 c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
311 11ccc33fSMarcel Ziswiler					  the LCD display every second with
312 c609719bSwdenk					  a "rotator" |\-/|\-/
313 c609719bSwdenk
314 2535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
315 2535d602Swdenk		CONFIG_ADSTYPE
316 2535d602Swdenk		Possible values are:
317 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
318 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
319 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
320 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
321 2535d602Swdenk
322 cf946c6dSLei Wen- Marvell Family Member
323 cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
324 cf946c6dSLei Wen					  multiple fs option at one time
325 cf946c6dSLei Wen					  for marvell soc family
326 cf946c6dSLei Wen
327 c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
328 c609719bSwdenk		Define exactly one of
329 c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
330 c609719bSwdenk
331 11ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
332 66ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
333 66ca92a5Swdenk					  get_gclk_freq() cannot work
334 5da627a4Swdenk					  e.g. if there is no 32KHz
335 5da627a4Swdenk					  reference PIT/RTC clock
336 66ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
337 66ca92a5Swdenk					  or XTAL/EXTAL)
338 c609719bSwdenk
339 66ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
340 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
341 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
342 66ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
343 75d1ea7fSwdenk			See doc/README.MPC866
344 75d1ea7fSwdenk
345 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
346 75d1ea7fSwdenk
347 75d1ea7fSwdenk		Define this to measure the actual CPU clock instead
348 75d1ea7fSwdenk		of relying on the correctness of the configured
349 75d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
350 75d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
351 75d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
352 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
353 75d1ea7fSwdenk
354 506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
355 506f3918SHeiko Schocher
356 506f3918SHeiko Schocher		Define this option if you want to enable the
357 506f3918SHeiko Schocher		ICache only when Code runs from RAM.
358 506f3918SHeiko Schocher
359 66412c63SKumar Gala- 85xx CPU Options:
360 66412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
361 66412c63SKumar Gala
362 66412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
363 66412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
364 66412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
365 66412c63SKumar Gala
366 8f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
367 8f29084aSKumar Gala
368 8f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
369 8f29084aSKumar Gala		tree nodes for the given platform.
370 8f29084aSKumar Gala
371 0b953ffcSMarkus Klotzbuecher- Intel Monahans options:
372 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
373 0b953ffcSMarkus Klotzbuecher
374 0b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
375 0b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
376 0b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
377 0b953ffcSMarkus Klotzbuecher
378 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
379 0b953ffcSMarkus Klotzbuecher
380 0b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
381 0b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
382 0b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
383 0b953ffcSMarkus Klotzbuecher		by this value.
384 0b953ffcSMarkus Klotzbuecher
385 5da627a4Swdenk- Linux Kernel Interface:
386 c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
387 c609719bSwdenk
388 c609719bSwdenk		U-Boot stores all clock information in Hz
389 c609719bSwdenk		internally. For binary compatibility with older Linux
390 c609719bSwdenk		kernels (which expect the clocks passed in the
391 c609719bSwdenk		bd_info data to be in MHz) the environment variable
392 c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
393 c609719bSwdenk		converts clock data to MHZ before passing it to the
394 c609719bSwdenk		Linux kernel.
395 c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
396 c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
397 c609719bSwdenk		default environment.
398 c609719bSwdenk
399 5da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
400 5da627a4Swdenk
401 11ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
402 5da627a4Swdenk		expect it to be in bytes, others in MB.
403 5da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
404 5da627a4Swdenk
405 fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
406 f57f70aaSWolfgang Denk
407 f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
408 213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
409 213bf8c8SGerald Van Baren		concepts).
410 213bf8c8SGerald Van Baren
411 213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
412 213bf8c8SGerald Van Baren		 * New libfdt-based support
413 213bf8c8SGerald Van Baren		 * Adds the "fdt" command
414 3bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
415 213bf8c8SGerald Van Baren
416 b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
417 b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
418 b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
419 b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
420 f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
421 c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
422 f57f70aaSWolfgang Denk
423 11ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
424 11ccc33fSMarcel Ziswiler		addresses
425 3bb342fcSKim Phillips
426 4e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
427 4e253137SKumar Gala
428 4e253137SKumar Gala		Board code has addition modification that it wants to make
429 4e253137SKumar Gala		to the flat device tree before handing it off to the kernel
430 6705d81eSwdenk
431 0267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
432 0267768eSMatthew McClintock
433 11ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
434 0267768eSMatthew McClintock		param header, the default value is zero if undefined.
435 0267768eSMatthew McClintock
436 3887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
437 3887c3fbSHeiko Schocher
438 3887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
439 3887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
440 3887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
441 3887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
442 3887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
443 3887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
444 3887c3fbSHeiko Schocher
445 0b2f4ecaSNiklaus Giger- vxWorks boot parameters:
446 0b2f4ecaSNiklaus Giger
447 0b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
448 0b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
449 0b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
450 0b2f4ecaSNiklaus Giger
451 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
452 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
453 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
454 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
455 0b2f4ecaSNiklaus Giger
456 0b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
457 0b2f4ecaSNiklaus Giger
458 0b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
459 0b2f4ecaSNiklaus Giger
460 0b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
461 0b2f4ecaSNiklaus Giger		the defaults discussed just above.
462 0b2f4ecaSNiklaus Giger
463 2c451f78SAneesh V- Cache Configuration:
464 2c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
465 2c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
466 2c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
467 2c451f78SAneesh V
468 93bc2193SAneesh V- Cache Configuration for ARM:
469 93bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
470 93bc2193SAneesh V				      controller
471 93bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
472 93bc2193SAneesh V					controller register space
473 93bc2193SAneesh V
474 6705d81eSwdenk- Serial Ports:
475 48d0192fSAndreas Engel		CONFIG_PL010_SERIAL
476 6705d81eSwdenk
477 6705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
478 6705d81eSwdenk
479 48d0192fSAndreas Engel		CONFIG_PL011_SERIAL
480 6705d81eSwdenk
481 6705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
482 6705d81eSwdenk
483 6705d81eSwdenk		CONFIG_PL011_CLOCK
484 6705d81eSwdenk
485 6705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
486 6705d81eSwdenk		the clock speed of the UARTs.
487 6705d81eSwdenk
488 6705d81eSwdenk		CONFIG_PL01x_PORTS
489 6705d81eSwdenk
490 6705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
491 6705d81eSwdenk		define this to a list of base addresses for each (supported)
492 6705d81eSwdenk		port. See e.g. include/configs/versatile.h
493 6705d81eSwdenk
494 910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
495 910f1ae3SJohn Rigby
496 910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
497 910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
498 910f1ae3SJohn Rigby		this variable to initialize the extra register.
499 910f1ae3SJohn Rigby
500 910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
501 910f1ae3SJohn Rigby
502 910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
503 910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
504 910f1ae3SJohn Rigby		variable to flush the UART at init time.
505 910f1ae3SJohn Rigby
506 6705d81eSwdenk
507 c609719bSwdenk- Console Interface:
508 c609719bSwdenk		Depending on board, define exactly one serial port
509 c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
510 c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
511 c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
512 c609719bSwdenk
513 c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
514 c609719bSwdenk		port routines must be defined elsewhere
515 c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
516 c609719bSwdenk
517 c609719bSwdenk		CONFIG_CFB_CONSOLE
518 c609719bSwdenk		Enables console device for a color framebuffer. Needs following
519 c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
520 c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
521 c609719bSwdenk						(default big endian)
522 c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
523 c609719bSwdenk						rectangle fill
524 c609719bSwdenk						(cf. smiLynxEM)
525 c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
526 c609719bSwdenk						bit-blit (cf. smiLynxEM)
527 c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
528 c609719bSwdenk						(cols=pitch)
529 c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
530 c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
531 c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
532 c609719bSwdenk						(0-5, cf. cfb_console.c)
533 c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
534 c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
535 c609719bSwdenk						(i.e. i8042_kbd_init())
536 c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
537 c609719bSwdenk						(i.e. i8042_tstc)
538 c609719bSwdenk			VIDEO_GETC_FCT		get char fct
539 c609719bSwdenk						(i.e. i8042_getc)
540 c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
541 c609719bSwdenk						(requires blink timer
542 c609719bSwdenk						cf. i8042.c)
543 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
544 c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
545 c609719bSwdenk						upper right corner
546 602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
547 c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
548 c609719bSwdenk						upper left corner
549 a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
550 a6c7ad2fSwdenk						linux_logo.h for logo.
551 a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
552 c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
553 11ccc33fSMarcel Ziswiler						additional board info beside
554 c609719bSwdenk						the logo
555 c609719bSwdenk
556 c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
557 c609719bSwdenk		default i/o. Serial console can be forced with
558 c609719bSwdenk		environment 'console=serial'.
559 c609719bSwdenk
560 a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
561 a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
562 a3ad8e26Swdenk		the "silent" environment variable. See
563 a3ad8e26Swdenk		doc/README.silent for more information.
564 a3ad8e26Swdenk
565 c609719bSwdenk- Console Baudrate:
566 c609719bSwdenk		CONFIG_BAUDRATE - in bps
567 c609719bSwdenk		Select one of the baudrates listed in
568 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
569 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
570 c609719bSwdenk
571 c92fac91SHeiko Schocher- Console Rx buffer length
572 c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
573 c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
574 2b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
575 c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
576 c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
577 c92fac91SHeiko Schocher		the SMC.
578 c92fac91SHeiko Schocher
579 c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
580 c609719bSwdenk		Delay before automatically booting the default image;
581 c609719bSwdenk		set to -1 to disable autoboot.
582 c609719bSwdenk
583 c609719bSwdenk		See doc/README.autoboot for these options that
584 c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
585 c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
586 c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
587 c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
588 c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
589 c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
590 c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
591 c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
592 c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
593 c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
594 c609719bSwdenk		CONFIG_RESET_TO_RETRY
595 c609719bSwdenk
596 c609719bSwdenk- Autoboot Command:
597 c609719bSwdenk		CONFIG_BOOTCOMMAND
598 c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
599 c609719bSwdenk		define a command string that is automatically executed
600 c609719bSwdenk		when no character is read on the console interface
601 c609719bSwdenk		within "Boot Delay" after reset.
602 c609719bSwdenk
603 c609719bSwdenk		CONFIG_BOOTARGS
604 c609719bSwdenk		This can be used to pass arguments to the bootm
605 c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
606 c609719bSwdenk		environment value "bootargs".
607 c609719bSwdenk
608 c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
609 c609719bSwdenk		The value of these goes into the environment as
610 c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
611 c609719bSwdenk		as a convenience, when switching between booting from
612 11ccc33fSMarcel Ziswiler		RAM and NFS.
613 c609719bSwdenk
614 c609719bSwdenk- Pre-Boot Commands:
615 c609719bSwdenk		CONFIG_PREBOOT
616 c609719bSwdenk
617 c609719bSwdenk		When this option is #defined, the existence of the
618 c609719bSwdenk		environment variable "preboot" will be checked
619 c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
620 c609719bSwdenk		countdown and/or running the auto-boot command resp.
621 c609719bSwdenk		entering interactive mode.
622 c609719bSwdenk
623 c609719bSwdenk		This feature is especially useful when "preboot" is
624 c609719bSwdenk		automatically generated or modified. For an example
625 c609719bSwdenk		see the LWMON board specific code: here "preboot" is
626 c609719bSwdenk		modified when the user holds down a certain
627 c609719bSwdenk		combination of keys on the (special) keyboard when
628 c609719bSwdenk		booting the systems
629 c609719bSwdenk
630 c609719bSwdenk- Serial Download Echo Mode:
631 c609719bSwdenk		CONFIG_LOADS_ECHO
632 c609719bSwdenk		If defined to 1, all characters received during a
633 c609719bSwdenk		serial download (using the "loads" command) are
634 c609719bSwdenk		echoed back. This might be needed by some terminal
635 c609719bSwdenk		emulations (like "cu"), but may as well just take
636 c609719bSwdenk		time on others. This setting #define's the initial
637 c609719bSwdenk		value of the "loads_echo" environment variable.
638 c609719bSwdenk
639 602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
640 c609719bSwdenk		CONFIG_KGDB_BAUDRATE
641 c609719bSwdenk		Select one of the baudrates listed in
642 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
643 c609719bSwdenk
644 c609719bSwdenk- Monitor Functions:
645 602ad3b3SJon Loeliger		Monitor commands can be included or excluded
646 602ad3b3SJon Loeliger		from the build by using the #include files
647 602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
648 602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
649 602ad3b3SJon Loeliger		and augmenting with additional #define's
650 602ad3b3SJon Loeliger		for wanted commands.
651 c609719bSwdenk
652 602ad3b3SJon Loeliger		The default command configuration includes all commands
653 602ad3b3SJon Loeliger		except those marked below with a "*".
654 602ad3b3SJon Loeliger
655 602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
656 602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
657 602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
658 602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
659 602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
660 602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
661 602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
662 602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
663 710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
664 602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
665 602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
666 602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
667 a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
668 a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
669 a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
670 a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
671 602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
672 602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
673 246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
674 602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
675 602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
676 0c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
677 bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
678 602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
679 602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
680 602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
681 602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
682 602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
683 a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
684 a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
685 602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
686 602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
687 602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
688 602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
689 602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
690 602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
691 0c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
692 602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
693 602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
694 602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
695 602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
696 1ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
697 602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
698 602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
699 02c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
700 02c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
701 602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
702 56523f12Swdenk					  loop, loopw, mtest
703 602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
704 602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
705 602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
706 68d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
707 602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
708 602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
709 e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
710 e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
711 602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
712 602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
713 602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
714 602ad3b3SJon Loeliger					  host
715 602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
716 602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
717 602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
718 602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
719 602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
720 602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
721 602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
722 602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
723 602ad3b3SJon Loeliger					  (4xx only)
724 c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
725 02c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
726 74de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
727 602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
728 7a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
729 602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
730 602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
731 602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
732 c609719bSwdenk
733 c609719bSwdenk
734 c609719bSwdenk		EXAMPLE: If you want all functions except of network
735 c609719bSwdenk		support you can write:
736 c609719bSwdenk
737 602ad3b3SJon Loeliger		#include "config_cmd_all.h"
738 602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
739 c609719bSwdenk
740 213bf8c8SGerald Van Baren	Other Commands:
741 213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
742 c609719bSwdenk
743 c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
744 602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
745 c609719bSwdenk		what you (and your U-Boot users) are doing. Data
746 c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
747 c609719bSwdenk		8260 (where accesses to the IMMR region must be
748 c609719bSwdenk		uncached), and it cannot be disabled on all other
749 c609719bSwdenk		systems where we (mis-) use the data cache to hold an
750 c609719bSwdenk		initial stack and some data.
751 c609719bSwdenk
752 c609719bSwdenk
753 c609719bSwdenk		XXX - this list needs to get updated!
754 c609719bSwdenk
755 c609719bSwdenk- Watchdog:
756 c609719bSwdenk		CONFIG_WATCHDOG
757 c609719bSwdenk		If this variable is defined, it enables watchdog
758 6abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
759 6abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
760 6abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
761 6abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
762 6abe6fb6SDetlev Zundel		available, then no further board specific code should
763 6abe6fb6SDetlev Zundel		be needed to use it.
764 6abe6fb6SDetlev Zundel
765 6abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
766 6abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
767 6abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
768 6abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
769 c609719bSwdenk
770 c1551ea8Sstroese- U-Boot Version:
771 c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
772 c1551ea8Sstroese		If this variable is defined, an environment variable
773 c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
774 c1551ea8Sstroese		version as printed by the "version" command.
775 c1551ea8Sstroese		This variable is readonly.
776 c1551ea8Sstroese
777 c609719bSwdenk- Real-Time Clock:
778 c609719bSwdenk
779 602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
780 c609719bSwdenk		has to be selected, too. Define exactly one of the
781 c609719bSwdenk		following options:
782 c609719bSwdenk
783 c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
784 c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
785 7ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
786 c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
787 1cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
788 c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
789 7f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
790 3bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
791 9536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
792 4c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
793 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
794 71d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
795 71d19f30SHeiko Schocher					  RV3029 RTC.
796 c609719bSwdenk
797 b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
798 b37c7e5eSwdenk		must also be configured. See I2C Support, below.
799 b37c7e5eSwdenk
800 e92739d3SPeter Tyser- GPIO Support:
801 e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
802 e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
803 e92739d3SPeter Tyser
804 5dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
805 5dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
806 5dec49caSChris Packham		pins supported by a particular chip.
807 5dec49caSChris Packham
808 e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
809 e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
810 e92739d3SPeter Tyser
811 c609719bSwdenk- Timestamp Support:
812 c609719bSwdenk
813 c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
814 c609719bSwdenk		(date and time) of an image is printed by image
815 c609719bSwdenk		commands like bootm or iminfo. This option is
816 602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
817 c609719bSwdenk
818 c609719bSwdenk- Partition Support:
819 c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
820 07f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
821 c609719bSwdenk
822 602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
823 218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
824 218ca724SWolfgang Denk		least one partition type as well.
825 c609719bSwdenk
826 c609719bSwdenk- IDE Reset method:
827 4d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
828 4d13cbadSwdenk		board configurations files but used nowhere!
829 c609719bSwdenk
830 4d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
831 4d13cbadSwdenk		be performed by calling the function
832 4d13cbadSwdenk			ide_set_reset(int reset)
833 4d13cbadSwdenk		which has to be defined in a board specific file
834 c609719bSwdenk
835 c609719bSwdenk- ATAPI Support:
836 c609719bSwdenk		CONFIG_ATAPI
837 c609719bSwdenk
838 c609719bSwdenk		Set this to enable ATAPI support.
839 c609719bSwdenk
840 c40b2956Swdenk- LBA48 Support
841 c40b2956Swdenk		CONFIG_LBA48
842 c40b2956Swdenk
843 c40b2956Swdenk		Set this to enable support for disks larger than 137GB
844 4b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
845 c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
846 c40b2956Swdenk		support disks up to 2.1TB.
847 c40b2956Swdenk
848 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
849 c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
850 c40b2956Swdenk			Default is 32bit.
851 c40b2956Swdenk
852 c609719bSwdenk- SCSI Support:
853 c609719bSwdenk		At the moment only there is only support for the
854 c609719bSwdenk		SYM53C8XX SCSI controller; define
855 c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
856 c609719bSwdenk
857 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
858 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
859 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
860 c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
861 c609719bSwdenk		devices.
862 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
863 c609719bSwdenk
864 c609719bSwdenk- NETWORK Support (PCI):
865 682011ffSwdenk		CONFIG_E1000
866 682011ffSwdenk		Support for Intel 8254x gigabit chips.
867 682011ffSwdenk
868 ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
869 11ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
870 ac3315c2SAndre Schwarz
871 c609719bSwdenk		CONFIG_EEPRO100
872 c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
873 11ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
874 c609719bSwdenk		write routine for first time initialisation.
875 c609719bSwdenk
876 c609719bSwdenk		CONFIG_TULIP
877 c609719bSwdenk		Support for Digital 2114x chips.
878 c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
879 c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
880 c609719bSwdenk
881 c609719bSwdenk		CONFIG_NATSEMI
882 c609719bSwdenk		Support for National dp83815 chips.
883 c609719bSwdenk
884 c609719bSwdenk		CONFIG_NS8382X
885 c609719bSwdenk		Support for National dp8382[01] gigabit chips.
886 c609719bSwdenk
887 45219c46Swdenk- NETWORK Support (other):
888 45219c46Swdenk
889 c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
890 c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
891 c041e9d2SJens Scharsig
892 c041e9d2SJens Scharsig			CONFIG_RMII
893 c041e9d2SJens Scharsig			Define this to use reduced MII inteface
894 c041e9d2SJens Scharsig
895 c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
896 c041e9d2SJens Scharsig			If this defined, the driver is quiet.
897 c041e9d2SJens Scharsig			The driver doen't show link status messages.
898 c041e9d2SJens Scharsig
899 45219c46Swdenk		CONFIG_DRIVER_LAN91C96
900 45219c46Swdenk		Support for SMSC's LAN91C96 chips.
901 45219c46Swdenk
902 45219c46Swdenk			CONFIG_LAN91C96_BASE
903 45219c46Swdenk			Define this to hold the physical address
904 45219c46Swdenk			of the LAN91C96's I/O space
905 45219c46Swdenk
906 45219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
907 45219c46Swdenk			Define this to enable 32 bit addressing
908 45219c46Swdenk
909 f39748aeSwdenk		CONFIG_DRIVER_SMC91111
910 f39748aeSwdenk		Support for SMSC's LAN91C111 chip
911 f39748aeSwdenk
912 f39748aeSwdenk			CONFIG_SMC91111_BASE
913 f39748aeSwdenk			Define this to hold the physical address
914 f39748aeSwdenk			of the device (I/O space)
915 f39748aeSwdenk
916 f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
917 f39748aeSwdenk			Define this if data bus is 32 bits
918 f39748aeSwdenk
919 f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
920 f39748aeSwdenk			Define this to use i/o functions instead of macros
921 f39748aeSwdenk			(some hardware wont work with macros)
922 f39748aeSwdenk
923 b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
924 b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
925 b3dbf4a5SMacpaul Lin
926 b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
927 b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
928 b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
929 b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
930 b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
931 b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
932 b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
933 b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
934 b3dbf4a5SMacpaul Lin
935 c2fff331SMike Rapoport		CONFIG_SMC911X
936 557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
937 557b377dSJens Gehrlein
938 c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
939 557b377dSJens Gehrlein			Define this to hold the physical address
940 557b377dSJens Gehrlein			of the device (I/O space)
941 557b377dSJens Gehrlein
942 c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
943 557b377dSJens Gehrlein			Define this if data bus is 32 bits
944 557b377dSJens Gehrlein
945 c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
946 557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
947 557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
948 c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
949 557b377dSJens Gehrlein
950 3d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
951 3d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
952 3d0075faSYoshihiro Shimoda
953 3d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
954 3d0075faSYoshihiro Shimoda			Define the number of ports to be used
955 3d0075faSYoshihiro Shimoda
956 3d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
957 3d0075faSYoshihiro Shimoda			Define the ETH PHY's address
958 3d0075faSYoshihiro Shimoda
959 68260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
960 68260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
961 68260aabSYoshihiro Shimoda
962 c609719bSwdenk- USB Support:
963 c609719bSwdenk		At the moment only the UHCI host controller is
964 4d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
965 c609719bSwdenk		CONFIG_USB_UHCI to enable it.
966 c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
967 30d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
968 c609719bSwdenk		storage devices.
969 c609719bSwdenk		Note:
970 c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
971 c609719bSwdenk		(TEAC FD-05PUB).
972 4d13cbadSwdenk		MPC5200 USB requires additional defines:
973 4d13cbadSwdenk			CONFIG_USB_CLOCK
974 4d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
975 307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
976 307ecb6dSEric Millbrandt				for USB on PSC3
977 4d13cbadSwdenk			CONFIG_USB_CONFIG
978 4d13cbadSwdenk				for differential drivers: 0x00001000
979 4d13cbadSwdenk				for single ended drivers: 0x00005000
980 307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
981 307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
982 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
983 fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
984 fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
985 4d13cbadSwdenk
986 16c8d5e7SWolfgang Denk- USB Device:
987 16c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
988 16c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
989 16c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
990 11ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
991 16c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
992 16c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
993 16c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
994 16c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
995 16c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
996 16c8d5e7SWolfgang Denk		a Linux host by
997 16c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
998 16c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
999 16c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
1000 16c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
1001 16c8d5e7SWolfgang Denk
1002 16c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
1003 16c8d5e7SWolfgang Denk			Define this to build a UDC device
1004 16c8d5e7SWolfgang Denk
1005 16c8d5e7SWolfgang Denk			CONFIG_USB_TTY
1006 16c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
1007 16c8d5e7SWolfgang Denk			talk to the UDC device
1008 16c8d5e7SWolfgang Denk
1009 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
1010 16c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
1011 16c8d5e7SWolfgang Denk			be set to usbtty.
1012 16c8d5e7SWolfgang Denk
1013 16c8d5e7SWolfgang Denk			mpc8xx:
1014 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1015 16c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
1016 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
1017 16c8d5e7SWolfgang Denk
1018 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
1019 16c8d5e7SWolfgang Denk				Derive USB clock from brgclk
1020 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
1021 16c8d5e7SWolfgang Denk
1022 16c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
1023 16c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
1024 16c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
1025 16c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1026 16c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1027 16c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
1028 16c8d5e7SWolfgang Denk
1029 16c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
1030 16c8d5e7SWolfgang Denk			Define this string as the name of your company for
1031 16c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
1032 16c8d5e7SWolfgang Denk
1033 16c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
1034 16c8d5e7SWolfgang Denk			Define this string as the name of your product
1035 16c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
1036 16c8d5e7SWolfgang Denk
1037 16c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
1038 16c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
1039 16c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
1040 16c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
1041 16c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
1042 16c8d5e7SWolfgang Denk
1043 16c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
1044 16c8d5e7SWolfgang Denk			Define this as the unique Product ID
1045 16c8d5e7SWolfgang Denk			for your device
1046 16c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1047 c609719bSwdenk
1048 c609719bSwdenk
1049 c609719bSwdenk- MMC Support:
1050 c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1051 c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1052 c609719bSwdenk		accessed from the boot prompt by mapping the device
1053 c609719bSwdenk		to physical memory similar to flash. Command line is
1054 602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1055 602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1056 c609719bSwdenk
1057 6705d81eSwdenk- Journaling Flash filesystem support:
1058 6705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1059 6705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
1060 6705d81eSwdenk		Define these for a default partition on a NAND device
1061 6705d81eSwdenk
1062 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
1063 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1064 6705d81eSwdenk		Define these for a default partition on a NOR device
1065 6705d81eSwdenk
1066 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
1067 6705d81eSwdenk		Define this to create an own partition. You have to provide a
1068 6705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
1069 6705d81eSwdenk
1070 6705d81eSwdenk		If you define only one JFFS2 partition you may also want to
1071 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
1072 6705d81eSwdenk		to disable the command chpart. This is the default when you
1073 6705d81eSwdenk		have not defined a custom partition
1074 6705d81eSwdenk
1075 c609719bSwdenk- Keyboard Support:
1076 c609719bSwdenk		CONFIG_ISA_KEYBOARD
1077 c609719bSwdenk
1078 c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1079 c609719bSwdenk		support
1080 c609719bSwdenk
1081 c609719bSwdenk		CONFIG_I8042_KBD
1082 c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1083 c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1084 c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1085 c609719bSwdenk		for cfb_console. Supports cursor blinking.
1086 c609719bSwdenk
1087 c609719bSwdenk- Video support:
1088 c609719bSwdenk		CONFIG_VIDEO
1089 c609719bSwdenk
1090 c609719bSwdenk		Define this to enable video support (for output to
1091 c609719bSwdenk		video).
1092 c609719bSwdenk
1093 c609719bSwdenk		CONFIG_VIDEO_CT69000
1094 c609719bSwdenk
1095 c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1096 c609719bSwdenk
1097 c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1098 eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1099 eeb1b77bSwdenk		video output is selected via environment 'videoout'
1100 eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1101 eeb1b77bSwdenk		assumed.
1102 c609719bSwdenk
1103 eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
1104 11ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1105 eeb1b77bSwdenk		are possible:
1106 eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1107 eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1108 eeb1b77bSwdenk
1109 eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1110 eeb1b77bSwdenk		-------------+---------------------------------------------
1111 eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1112 eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1113 eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1114 eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1115 eeb1b77bSwdenk		-------------+---------------------------------------------
1116 c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1117 c609719bSwdenk
1118 eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
1119 7817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1120 eeb1b77bSwdenk
1121 eeb1b77bSwdenk
1122 a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1123 a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1124 a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1125 a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1126 a6c7ad2fSwdenk
1127 7d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
1128 7d3053fbSTimur Tabi		Enable the Freescale DIU video driver.  Reference boards for
1129 7d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
1130 7d3053fbSTimur Tabi		support, and should also define these other macros:
1131 7d3053fbSTimur Tabi
1132 7d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
1133 7d3053fbSTimur Tabi			CONFIG_VIDEO
1134 7d3053fbSTimur Tabi			CONFIG_CMD_BMP
1135 7d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
1136 7d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
1137 7d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
1138 7d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
1139 7d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
1140 7d3053fbSTimur Tabi
1141 ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1142 ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1143 ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1144 ba8e76bdSTimur Tabi		description of this variable.
1145 7d3053fbSTimur Tabi
1146 682011ffSwdenk- Keyboard Support:
1147 682011ffSwdenk		CONFIG_KEYBOARD
1148 682011ffSwdenk
1149 682011ffSwdenk		Define this to enable a custom keyboard support.
1150 682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1151 682011ffSwdenk		defined in your board-specific files.
1152 682011ffSwdenk		The only board using this so far is RBC823.
1153 a6c7ad2fSwdenk
1154 c609719bSwdenk- LCD Support:	CONFIG_LCD
1155 c609719bSwdenk
1156 c609719bSwdenk		Define this to enable LCD support (for output to LCD
1157 c609719bSwdenk		display); also select one of the supported displays
1158 c609719bSwdenk		by defining one of these:
1159 c609719bSwdenk
1160 39cf4804SStelian Pop		CONFIG_ATMEL_LCD:
1161 39cf4804SStelian Pop
1162 39cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
1163 39cf4804SStelian Pop
1164 fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1165 c609719bSwdenk
1166 fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1167 c609719bSwdenk
1168 fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1169 c609719bSwdenk
1170 fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1171 fd3103bbSwdenk			Active, color, single scan.
1172 fd3103bbSwdenk
1173 fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1174 fd3103bbSwdenk
1175 fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1176 c609719bSwdenk			Active, color, single scan.
1177 c609719bSwdenk
1178 c609719bSwdenk		CONFIG_SHARP_16x9
1179 c609719bSwdenk
1180 c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1181 c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1182 c609719bSwdenk
1183 c609719bSwdenk		CONFIG_SHARP_LQ64D341
1184 c609719bSwdenk
1185 c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1186 c609719bSwdenk			Active, color, single scan.
1187 c609719bSwdenk
1188 c609719bSwdenk		CONFIG_HLD1045
1189 c609719bSwdenk
1190 c609719bSwdenk			HLD1045 display, 640x480.
1191 c609719bSwdenk			Active, color, single scan.
1192 c609719bSwdenk
1193 c609719bSwdenk		CONFIG_OPTREX_BW
1194 c609719bSwdenk
1195 c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1196 c609719bSwdenk			or
1197 c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1198 c609719bSwdenk			or
1199 c609719bSwdenk			Hitachi	 SP14Q002
1200 c609719bSwdenk
1201 c609719bSwdenk			320x240. Black & white.
1202 c609719bSwdenk
1203 c609719bSwdenk		Normally display is black on white background; define
1204 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1205 c609719bSwdenk
1206 7152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1207 d791b1dcSwdenk
1208 d791b1dcSwdenk		If this option is set, the environment is checked for
1209 d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1210 d791b1dcSwdenk		of logo, copyright and system information on the LCD
1211 e94d2cd9Swdenk		is suppressed and the BMP image at the address
1212 d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1213 d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1214 d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1215 d791b1dcSwdenk		loaded very quickly after power-on.
1216 d791b1dcSwdenk
1217 1ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
1218 1ca298ceSMatthias Weisser
1219 1ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
1220 1ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
1221 1ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
1222 1ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
1223 1ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
1224 1ca298ceSMatthias Weisser		specify 'm' for centering the image.
1225 1ca298ceSMatthias Weisser
1226 1ca298ceSMatthias Weisser		Example:
1227 1ca298ceSMatthias Weisser		setenv splashpos m,m
1228 1ca298ceSMatthias Weisser			=> image at center of screen
1229 1ca298ceSMatthias Weisser
1230 1ca298ceSMatthias Weisser		setenv splashpos 30,20
1231 1ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
1232 1ca298ceSMatthias Weisser
1233 1ca298ceSMatthias Weisser		setenv splashpos -10,m
1234 1ca298ceSMatthias Weisser			=> vertically centered image
1235 1ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
1236 1ca298ceSMatthias Weisser
1237 98f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1238 98f4a3dfSStefan Roese
1239 98f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
1240 98f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
1241 98f4a3dfSStefan Roese		splashscreen support or the bmp command.
1242 98f4a3dfSStefan Roese
1243 d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1244 d5011762SAnatolij Gustschin
1245 d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1246 d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1247 d5011762SAnatolij Gustschin		bmp command.
1248 d5011762SAnatolij Gustschin
1249 c29fdfc1Swdenk- Compression support:
1250 c29fdfc1Swdenk		CONFIG_BZIP2
1251 c29fdfc1Swdenk
1252 c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1253 c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1254 c29fdfc1Swdenk		compressed images are supported.
1255 c29fdfc1Swdenk
1256 c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1257 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1258 c29fdfc1Swdenk		be at least 4MB.
1259 d791b1dcSwdenk
1260 fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1261 fc9c1727SLuigi 'Comio' Mantellini
1262 fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1263 fc9c1727SLuigi 'Comio' Mantellini		images is included.
1264 fc9c1727SLuigi 'Comio' Mantellini
1265 fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1266 fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1267 fc9c1727SLuigi 'Comio' Mantellini		formula:
1268 fc9c1727SLuigi 'Comio' Mantellini
1269 fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1270 fc9c1727SLuigi 'Comio' Mantellini
1271 fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1272 fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1273 fc9c1727SLuigi 'Comio' Mantellini
1274 fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1275 fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1276 fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1277 fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1278 fc9c1727SLuigi 'Comio' Mantellini
1279 fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1280 fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
1281 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1282 fc9c1727SLuigi 'Comio' Mantellini
1283 17ea1177Swdenk- MII/PHY support:
1284 17ea1177Swdenk		CONFIG_PHY_ADDR
1285 17ea1177Swdenk
1286 17ea1177Swdenk		The address of PHY on MII bus.
1287 17ea1177Swdenk
1288 17ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1289 17ea1177Swdenk
1290 17ea1177Swdenk		The clock frequency of the MII bus
1291 17ea1177Swdenk
1292 17ea1177Swdenk		CONFIG_PHY_GIGE
1293 17ea1177Swdenk
1294 17ea1177Swdenk		If this option is set, support for speed/duplex
1295 11ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
1296 17ea1177Swdenk
1297 17ea1177Swdenk		CONFIG_PHY_RESET_DELAY
1298 17ea1177Swdenk
1299 17ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
1300 17ea1177Swdenk		reset before any MII register access is possible.
1301 17ea1177Swdenk		For such PHY, set this option to the usec delay
1302 17ea1177Swdenk		required. (minimum 300usec for LXT971A)
1303 17ea1177Swdenk
1304 17ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
1305 17ea1177Swdenk
1306 17ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
1307 17ea1177Swdenk		command issued before MII status register can be read
1308 17ea1177Swdenk
1309 c609719bSwdenk- Ethernet address:
1310 c609719bSwdenk		CONFIG_ETHADDR
1311 c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1312 c609719bSwdenk		CONFIG_ETH2ADDR
1313 c609719bSwdenk		CONFIG_ETH3ADDR
1314 c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1315 c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1316 c609719bSwdenk
1317 11ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
1318 11ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1319 c609719bSwdenk		is not determined automatically.
1320 c609719bSwdenk
1321 c609719bSwdenk- IP address:
1322 c609719bSwdenk		CONFIG_IPADDR
1323 c609719bSwdenk
1324 c609719bSwdenk		Define a default value for the IP address to use for
1325 11ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1326 c609719bSwdenk		determined through e.g. bootp.
1327 c609719bSwdenk
1328 c609719bSwdenk- Server IP address:
1329 c609719bSwdenk		CONFIG_SERVERIP
1330 c609719bSwdenk
1331 c609719bSwdenk		Defines a default value for the IP address of a TFTP
1332 c609719bSwdenk		server to contact when using the "tftboot" command.
1333 c609719bSwdenk
1334 97cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
1335 97cfe861SRobin Getz
1336 97cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
1337 97cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
1338 97cfe861SRobin Getz
1339 53a5c424SDavid Updegraff- Multicast TFTP Mode:
1340 53a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
1341 53a5c424SDavid Updegraff
1342 53a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
1343 53a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
1344 11ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
1345 53a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
1346 53a5c424SDavid Updegraff		multicast group.
1347 53a5c424SDavid Updegraff
1348 c609719bSwdenk- BOOTP Recovery Mode:
1349 c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1350 c609719bSwdenk
1351 c609719bSwdenk		If you have many targets in a network that try to
1352 c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1353 c609719bSwdenk		systems send out BOOTP requests at precisely the same
1354 c609719bSwdenk		moment (which would happen for instance at recovery
1355 c609719bSwdenk		from a power failure, when all systems will try to
1356 c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1357 c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1358 c609719bSwdenk		inserted before sending out BOOTP requests. The
1359 6c33c785SWolfgang Denk		following delays are inserted then:
1360 c609719bSwdenk
1361 c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1362 c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1363 c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1364 c609719bSwdenk		4th and following
1365 c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1366 c609719bSwdenk
1367 fe389a82Sstroese- DHCP Advanced Options:
1368 1fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
1369 1fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1370 fe389a82Sstroese
1371 1fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
1372 1fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
1373 1fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
1374 1fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
1375 1fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
1376 1fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
1377 1fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
1378 1fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
1379 1fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
1380 1fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
1381 1fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
1382 1fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1383 fe389a82Sstroese
1384 5d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1385 5d110f0aSWilson Callan		environment variable, not the BOOTP server.
1386 fe389a82Sstroese
1387 fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1388 fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1389 fe389a82Sstroese		than one DNS serverip is offered to the client.
1390 fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1391 fe389a82Sstroese		serverip will be stored in the additional environment
1392 fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1393 fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1394 1fe80d79SJon Loeliger		is defined.
1395 fe389a82Sstroese
1396 fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1397 fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1398 fe389a82Sstroese		need the hostname of the DHCP requester.
1399 5d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1400 1fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
1401 1fe80d79SJon Loeliger		option 12 to the DHCP server.
1402 fe389a82Sstroese
1403 d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1404 d9a2f416SAras Vaichas
1405 d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1406 d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1407 d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1408 d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1409 d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1410 d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1411 d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1412 d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1413 d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1414 d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1415 d9a2f416SAras Vaichas		this delay.
1416 d9a2f416SAras Vaichas
1417 a3d991bdSwdenk - CDP Options:
1418 a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1419 a3d991bdSwdenk
1420 a3d991bdSwdenk		The device id used in CDP trigger frames.
1421 a3d991bdSwdenk
1422 a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1423 a3d991bdSwdenk
1424 a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1425 a3d991bdSwdenk		of the device.
1426 a3d991bdSwdenk
1427 a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1428 a3d991bdSwdenk
1429 a3d991bdSwdenk		A printf format string which contains the ascii name of
1430 a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1431 11ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1432 a3d991bdSwdenk
1433 a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1434 a3d991bdSwdenk
1435 a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1436 a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1437 a3d991bdSwdenk
1438 a3d991bdSwdenk		CONFIG_CDP_VERSION
1439 a3d991bdSwdenk
1440 a3d991bdSwdenk		An ascii string containing the version of the software.
1441 a3d991bdSwdenk
1442 a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1443 a3d991bdSwdenk
1444 a3d991bdSwdenk		An ascii string containing the name of the platform.
1445 a3d991bdSwdenk
1446 a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1447 a3d991bdSwdenk
1448 a3d991bdSwdenk		A 32bit integer sent on the trigger.
1449 a3d991bdSwdenk
1450 a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1451 a3d991bdSwdenk
1452 a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1453 a3d991bdSwdenk		device in .1 of milliwatts.
1454 a3d991bdSwdenk
1455 a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1456 a3d991bdSwdenk
1457 a3d991bdSwdenk		A byte containing the id of the VLAN.
1458 a3d991bdSwdenk
1459 c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1460 c609719bSwdenk
1461 c609719bSwdenk		Several configurations allow to display the current
1462 c609719bSwdenk		status using a LED. For instance, the LED will blink
1463 c609719bSwdenk		fast while running U-Boot code, stop blinking as
1464 c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1465 c609719bSwdenk		start blinking slow once the Linux kernel is running
1466 c609719bSwdenk		(supported by a status LED driver in the Linux
1467 c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1468 c609719bSwdenk		feature in U-Boot.
1469 c609719bSwdenk
1470 c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1471 c609719bSwdenk
1472 c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1473 c609719bSwdenk		on those systems that support this (optional)
1474 c609719bSwdenk		feature, like the TQM8xxL modules.
1475 c609719bSwdenk
1476 c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1477 c609719bSwdenk
1478 b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1479 b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1480 11ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1481 c609719bSwdenk
1482 b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1483 602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1484 b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1485 b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1486 c609719bSwdenk		command line interface.
1487 c609719bSwdenk
1488 bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1489 c609719bSwdenk
1490 b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1491 b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1492 b37c7e5eSwdenk		support for I2C.
1493 c609719bSwdenk
1494 b37c7e5eSwdenk		There are several other quantities that must also be
1495 b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1496 c609719bSwdenk
1497 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1498 b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1499 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
1500 11ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1501 c609719bSwdenk
1502 8d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1503 a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
1504 8d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
1505 8d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
1506 8d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1507 b37c7e5eSwdenk
1508 5da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
1509 5da71efaSEric Millbrandt
1510 5da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
1511 5da71efaSEric Millbrandt		chips might think that the current transfer is still
1512 5da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
1513 5da71efaSEric Millbrandt		commands until the slave device responds.
1514 5da71efaSEric Millbrandt
1515 b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1516 b37c7e5eSwdenk
1517 b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1518 b37c7e5eSwdenk		then the following macros need to be defined (examples are
1519 b37c7e5eSwdenk		from include/configs/lwmon.h):
1520 c609719bSwdenk
1521 c609719bSwdenk		I2C_INIT
1522 c609719bSwdenk
1523 b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1524 c609719bSwdenk		controller or configure ports.
1525 c609719bSwdenk
1526 b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1527 b37c7e5eSwdenk
1528 c609719bSwdenk		I2C_PORT
1529 c609719bSwdenk
1530 c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1531 c609719bSwdenk		assumes both bits are on the same port). Valid values
1532 c609719bSwdenk		are 0..3 for ports A..D.
1533 c609719bSwdenk
1534 c609719bSwdenk		I2C_ACTIVE
1535 c609719bSwdenk
1536 c609719bSwdenk		The code necessary to make the I2C data line active
1537 c609719bSwdenk		(driven).  If the data line is open collector, this
1538 c609719bSwdenk		define can be null.
1539 c609719bSwdenk
1540 b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1541 b37c7e5eSwdenk
1542 c609719bSwdenk		I2C_TRISTATE
1543 c609719bSwdenk
1544 c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1545 c609719bSwdenk		(inactive).  If the data line is open collector, this
1546 c609719bSwdenk		define can be null.
1547 c609719bSwdenk
1548 b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1549 b37c7e5eSwdenk
1550 c609719bSwdenk		I2C_READ
1551 c609719bSwdenk
1552 c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1553 c609719bSwdenk		FALSE if it is low.
1554 c609719bSwdenk
1555 b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1556 b37c7e5eSwdenk
1557 c609719bSwdenk		I2C_SDA(bit)
1558 c609719bSwdenk
1559 c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1560 c609719bSwdenk		is FALSE, it clears it (low).
1561 c609719bSwdenk
1562 b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1563 b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1564 b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1565 b37c7e5eSwdenk
1566 c609719bSwdenk		I2C_SCL(bit)
1567 c609719bSwdenk
1568 c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1569 c609719bSwdenk		is FALSE, it clears it (low).
1570 c609719bSwdenk
1571 b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1572 b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1573 b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1574 b37c7e5eSwdenk
1575 c609719bSwdenk		I2C_DELAY
1576 c609719bSwdenk
1577 c609719bSwdenk		This delay is invoked four times per clock cycle so this
1578 c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1579 b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1580 b37c7e5eSwdenk		like:
1581 b37c7e5eSwdenk
1582 b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1583 c609719bSwdenk
1584 793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1585 793b5726SMike Frysinger
1586 793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1587 793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1588 793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1589 793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1590 793b5726SMike Frysinger
1591 793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1592 793b5726SMike Frysinger		the generic GPIO functions.
1593 793b5726SMike Frysinger
1594 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
1595 47cd00faSwdenk
1596 47cd00faSwdenk		When a board is reset during an i2c bus transfer
1597 47cd00faSwdenk		chips might think that the current transfer is still
1598 47cd00faSwdenk		in progress. On some boards it is possible to access
1599 47cd00faSwdenk		the i2c SCLK line directly, either by using the
1600 47cd00faSwdenk		processor pin as a GPIO or by having a second pin
1601 47cd00faSwdenk		connected to the bus. If this option is defined a
1602 47cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
1603 47cd00faSwdenk		is run early in the boot sequence.
1604 47cd00faSwdenk
1605 26a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
1606 26a33504SRichard Retanubun
1607 26a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1608 26a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
1609 26a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
1610 26a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
1611 26a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
1612 26a33504SRichard Retanubun		controller provide such a method. It is called at the end of
1613 26a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
1614 26a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
1615 26a33504SRichard Retanubun
1616 17ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1617 17ea1177Swdenk
1618 17ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
1619 17ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
1620 17ea1177Swdenk		variable "i2cfast". (see also i2cfast)
1621 17ea1177Swdenk
1622 bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1623 bb99ad6dSBen Warren
1624 bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1625 bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1626 bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1627 bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1628 bb99ad6dSBen Warren
1629 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1630 bb99ad6dSBen Warren
1631 bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
1632 0f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
1633 0f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
1634 0f89c54bSPeter Tyser		a 1D array of device addresses
1635 bb99ad6dSBen Warren
1636 bb99ad6dSBen Warren		e.g.
1637 bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
1638 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1639 bb99ad6dSBen Warren
1640 bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1641 bb99ad6dSBen Warren
1642 bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
1643 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1644 bb99ad6dSBen Warren
1645 bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1646 bb99ad6dSBen Warren
1647 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1648 be5e6181STimur Tabi
1649 be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1650 be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1651 be5e6181STimur Tabi
1652 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
1653 0dc018ecSStefan Roese
1654 0dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
1655 0dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1656 0dc018ecSStefan Roese
1657 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
1658 0dc018ecSStefan Roese
1659 0dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
1660 0dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1661 0dc018ecSStefan Roese
1662 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
1663 9ebbb54fSVictor Gallardo
1664 9ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
1665 9ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
1666 9ebbb54fSVictor Gallardo		specified DTT device.
1667 9ebbb54fSVictor Gallardo
1668 be5e6181STimur Tabi		CONFIG_FSL_I2C
1669 be5e6181STimur Tabi
1670 be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
1671 7817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1672 be5e6181STimur Tabi
1673 67b23a32SHeiko Schocher		CONFIG_I2C_MUX
1674 67b23a32SHeiko Schocher
1675 67b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
1676 67b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
1677 67b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1678 67b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
1679 67b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
1680 67b23a32SHeiko Schocher		the muxes to activate this new "bus".
1681 67b23a32SHeiko Schocher
1682 67b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
1683 67b23a32SHeiko Schocher		feature!
1684 67b23a32SHeiko Schocher
1685 67b23a32SHeiko Schocher		Example:
1686 67b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
1687 67b23a32SHeiko Schocher			The First mux with address 70 and channel 6
1688 67b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
1689 67b23a32SHeiko Schocher
1690 67b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
1691 67b23a32SHeiko Schocher
1692 67b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
1693 67b23a32SHeiko Schocher		of I2C Busses with muxes:
1694 67b23a32SHeiko Schocher
1695 67b23a32SHeiko Schocher		=> i2c bus
1696 67b23a32SHeiko Schocher		Busses reached over muxes:
1697 67b23a32SHeiko Schocher		Bus ID: 2
1698 67b23a32SHeiko Schocher		  reached over Mux(es):
1699 67b23a32SHeiko Schocher		    pca9544a@70 ch: 4
1700 67b23a32SHeiko Schocher		Bus ID: 3
1701 67b23a32SHeiko Schocher		  reached over Mux(es):
1702 67b23a32SHeiko Schocher		    pca9544a@70 ch: 6
1703 67b23a32SHeiko Schocher		    pca9544a@71 ch: 4
1704 67b23a32SHeiko Schocher		=>
1705 67b23a32SHeiko Schocher
1706 67b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1707 67b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
1708 67b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
1709 67b23a32SHeiko Schocher		the channel 4.
1710 67b23a32SHeiko Schocher
1711 67b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
1712 67b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
1713 67b23a32SHeiko Schocher		the 2 muxes.
1714 67b23a32SHeiko Schocher
1715 67b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
1716 67b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
1717 67b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
1718 67b23a32SHeiko Schocher		to add this option to other architectures.
1719 67b23a32SHeiko Schocher
1720 2ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
1721 2ac6985aSAndrew Dyer
1722 2ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
1723 2ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
1724 2ac6985aSAndrew Dyer		between writing the address pointer and reading the
1725 2ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
1726 2ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
1727 2ac6985aSAndrew Dyer		devices can use either method, but some require one or
1728 2ac6985aSAndrew Dyer		the other.
1729 be5e6181STimur Tabi
1730 c609719bSwdenk- SPI Support:	CONFIG_SPI
1731 c609719bSwdenk
1732 c609719bSwdenk		Enables SPI driver (so far only tested with
1733 c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1734 c609719bSwdenk		D/As on the SACSng board)
1735 c609719bSwdenk
1736 6639562eSYoshihiro Shimoda		CONFIG_SH_SPI
1737 6639562eSYoshihiro Shimoda
1738 6639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
1739 6639562eSYoshihiro Shimoda		only SH7757 is supported.
1740 6639562eSYoshihiro Shimoda
1741 c609719bSwdenk		CONFIG_SPI_X
1742 c609719bSwdenk
1743 c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1744 c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1745 c609719bSwdenk
1746 c609719bSwdenk		CONFIG_SOFT_SPI
1747 c609719bSwdenk
1748 c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1749 c609719bSwdenk		using hardware support. This is a general purpose
1750 c609719bSwdenk		driver that only requires three general I/O port pins
1751 c609719bSwdenk		(two outputs, one input) to function. If this is
1752 c609719bSwdenk		defined, the board configuration must define several
1753 c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1754 c609719bSwdenk		an example, see include/configs/sacsng.h.
1755 c609719bSwdenk
1756 04a9e118SBen Warren		CONFIG_HARD_SPI
1757 04a9e118SBen Warren
1758 04a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
1759 04a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
1760 04a9e118SBen Warren		must define a list of chip-select function pointers.
1761 04a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
1762 04a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
1763 04a9e118SBen Warren
1764 38254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
1765 38254f45SGuennadi Liakhovetski
1766 38254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
1767 38254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
1768 38254f45SGuennadi Liakhovetski
1769 0133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
1770 0133502eSMatthias Fuchs
1771 0133502eSMatthias Fuchs		Enables FPGA subsystem.
1772 0133502eSMatthias Fuchs
1773 0133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
1774 0133502eSMatthias Fuchs
1775 0133502eSMatthias Fuchs		Enables support for specific chip vendors.
1776 0133502eSMatthias Fuchs		(ALTERA, XILINX)
1777 0133502eSMatthias Fuchs
1778 0133502eSMatthias Fuchs		CONFIG_FPGA_<family>
1779 0133502eSMatthias Fuchs
1780 0133502eSMatthias Fuchs		Enables support for FPGA family.
1781 0133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1782 0133502eSMatthias Fuchs
1783 0133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1784 c609719bSwdenk
1785 c609719bSwdenk		Specify the number of FPGA devices to support.
1786 c609719bSwdenk
1787 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1788 c609719bSwdenk
1789 c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1790 c609719bSwdenk
1791 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1792 c609719bSwdenk
1793 c609719bSwdenk		Enable checks on FPGA configuration interface busy
1794 c609719bSwdenk		status by the configuration function. This option
1795 c609719bSwdenk		will require a board or device specific function to
1796 c609719bSwdenk		be written.
1797 c609719bSwdenk
1798 c609719bSwdenk		CONFIG_FPGA_DELAY
1799 c609719bSwdenk
1800 c609719bSwdenk		If defined, a function that provides delays in the FPGA
1801 c609719bSwdenk		configuration driver.
1802 c609719bSwdenk
1803 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1804 c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1805 c609719bSwdenk
1806 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1807 c609719bSwdenk
1808 c609719bSwdenk		Check for configuration errors during FPGA bitfile
1809 c609719bSwdenk		loading. For example, abort during Virtex II
1810 c609719bSwdenk		configuration if the INIT_B line goes low (which
1811 c609719bSwdenk		indicated a CRC error).
1812 c609719bSwdenk
1813 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1814 c609719bSwdenk
1815 c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1816 c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1817 c609719bSwdenk		FPGA configuration sequence. The default time is 500
1818 11ccc33fSMarcel Ziswiler		ms.
1819 c609719bSwdenk
1820 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1821 c609719bSwdenk
1822 c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1823 11ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1824 c609719bSwdenk
1825 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1826 c609719bSwdenk
1827 c609719bSwdenk		Time to wait after FPGA configuration. The default is
1828 11ccc33fSMarcel Ziswiler		200 ms.
1829 c609719bSwdenk
1830 c609719bSwdenk- Configuration Management:
1831 c609719bSwdenk		CONFIG_IDENT_STRING
1832 c609719bSwdenk
1833 c609719bSwdenk		If defined, this string will be added to the U-Boot
1834 c609719bSwdenk		version information (U_BOOT_VERSION)
1835 c609719bSwdenk
1836 c609719bSwdenk- Vendor Parameter Protection:
1837 c609719bSwdenk
1838 c609719bSwdenk		U-Boot considers the values of the environment
1839 c609719bSwdenk		variables "serial#" (Board Serial Number) and
1840 7152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1841 c609719bSwdenk		are set once by the board vendor / manufacturer, and
1842 c609719bSwdenk		protects these variables from casual modification by
1843 c609719bSwdenk		the user. Once set, these variables are read-only,
1844 c609719bSwdenk		and write or delete attempts are rejected. You can
1845 11ccc33fSMarcel Ziswiler		change this behaviour:
1846 c609719bSwdenk
1847 c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1848 c609719bSwdenk		file, the write protection for vendor parameters is
1849 47cd00faSwdenk		completely disabled. Anybody can change or delete
1850 c609719bSwdenk		these parameters.
1851 c609719bSwdenk
1852 c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1853 c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1854 11ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1855 c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1856 c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1857 c609719bSwdenk		read-only.]
1858 c609719bSwdenk
1859 c609719bSwdenk- Protected RAM:
1860 c609719bSwdenk		CONFIG_PRAM
1861 c609719bSwdenk
1862 c609719bSwdenk		Define this variable to enable the reservation of
1863 c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1864 c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1865 c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1866 c609719bSwdenk		this default value by defining an environment
1867 c609719bSwdenk		variable "pram" to the number of kB you want to
1868 c609719bSwdenk		reserve. Note that the board info structure will
1869 c609719bSwdenk		still show the full amount of RAM. If pRAM is
1870 c609719bSwdenk		reserved, a new environment variable "mem" will
1871 c609719bSwdenk		automatically be defined to hold the amount of
1872 c609719bSwdenk		remaining RAM in a form that can be passed as boot
1873 c609719bSwdenk		argument to Linux, for instance like that:
1874 c609719bSwdenk
1875 fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1876 c609719bSwdenk			saveenv
1877 c609719bSwdenk
1878 c609719bSwdenk		This way you can tell Linux not to use this memory,
1879 c609719bSwdenk		either, which results in a memory region that will
1880 c609719bSwdenk		not be affected by reboots.
1881 c609719bSwdenk
1882 c609719bSwdenk		*WARNING* If your board configuration uses automatic
1883 c609719bSwdenk		detection of the RAM size, you must make sure that
1884 c609719bSwdenk		this memory test is non-destructive. So far, the
1885 c609719bSwdenk		following board configurations are known to be
1886 c609719bSwdenk		"pRAM-clean":
1887 c609719bSwdenk
1888 c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1889 c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1890 544d97e9SWolfgang Denk			FLAGADM, TQM8260
1891 c609719bSwdenk
1892 c609719bSwdenk- Error Recovery:
1893 c609719bSwdenk		CONFIG_PANIC_HANG
1894 c609719bSwdenk
1895 c609719bSwdenk		Define this variable to stop the system in case of a
1896 c609719bSwdenk		fatal error, so that you have to reset it manually.
1897 c609719bSwdenk		This is probably NOT a good idea for an embedded
1898 11ccc33fSMarcel Ziswiler		system where you want the system to reboot
1899 c609719bSwdenk		automatically as fast as possible, but it may be
1900 c609719bSwdenk		useful during development since you can try to debug
1901 c609719bSwdenk		the conditions that lead to the situation.
1902 c609719bSwdenk
1903 c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1904 c609719bSwdenk
1905 c609719bSwdenk		This variable defines the number of retries for
1906 c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1907 c609719bSwdenk		before giving up the operation. If not defined, a
1908 c609719bSwdenk		default value of 5 is used.
1909 c609719bSwdenk
1910 40cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
1911 40cb90eeSGuennadi Liakhovetski
1912 40cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
1913 40cb90eeSGuennadi Liakhovetski
1914 c609719bSwdenk- Command Interpreter:
1915 8078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
1916 04a85b3bSwdenk
1917 04a85b3bSwdenk		Enable auto completion of commands using TAB.
1918 04a85b3bSwdenk
1919 8078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
1920 8078f1a5SWolfgang Denk		for the "hush" shell.
1921 8078f1a5SWolfgang Denk
1922 8078f1a5SWolfgang Denk
1923 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1924 c609719bSwdenk
1925 c609719bSwdenk		Define this variable to enable the "hush" shell (from
1926 c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1927 c609719bSwdenk		powerful command line syntax like
1928 c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1929 c609719bSwdenk		constructs ("shell scripts").
1930 c609719bSwdenk
1931 c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1932 c609719bSwdenk		with a somewhat smaller memory footprint.
1933 c609719bSwdenk
1934 c609719bSwdenk
1935 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1936 c609719bSwdenk
1937 c609719bSwdenk		This defines the secondary prompt string, which is
1938 c609719bSwdenk		printed when the command interpreter needs more input
1939 c609719bSwdenk		to complete a command. Usually "> ".
1940 c609719bSwdenk
1941 c609719bSwdenk	Note:
1942 c609719bSwdenk
1943 c609719bSwdenk		In the current implementation, the local variables
1944 c609719bSwdenk		space and global environment variables space are
1945 c609719bSwdenk		separated. Local variables are those you define by
1946 3b57fe0aSwdenk		simply typing `name=value'. To access a local
1947 c609719bSwdenk		variable later on, you have write `$name' or
1948 3b57fe0aSwdenk		`${name}'; to execute the contents of a variable
1949 3b57fe0aSwdenk		directly type `$name' at the command prompt.
1950 c609719bSwdenk
1951 c609719bSwdenk		Global environment variables are those you use
1952 c609719bSwdenk		setenv/printenv to work with. To run a command stored
1953 c609719bSwdenk		in such a variable, you need to use the run command,
1954 c609719bSwdenk		and you must not use the '$' sign to access them.
1955 c609719bSwdenk
1956 c609719bSwdenk		To store commands and special characters in a
1957 c609719bSwdenk		variable, please use double quotation marks
1958 c609719bSwdenk		surrounding the whole text of the variable, instead
1959 c609719bSwdenk		of the backslashes before semicolons and special
1960 c609719bSwdenk		symbols.
1961 c609719bSwdenk
1962 aa0c71acSWolfgang Denk- Commandline Editing and History:
1963 aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1964 aa0c71acSWolfgang Denk
1965 11ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1966 aa0c71acSWolfgang Denk		commandline input operations
1967 aa0c71acSWolfgang Denk
1968 a8c7c708Swdenk- Default Environment:
1969 c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1970 c609719bSwdenk
1971 c609719bSwdenk		Define this to contain any number of null terminated
1972 c609719bSwdenk		strings (variable = value pairs) that will be part of
1973 7152b1d0Swdenk		the default environment compiled into the boot image.
1974 2262cfeeSwdenk
1975 c609719bSwdenk		For example, place something like this in your
1976 c609719bSwdenk		board's config file:
1977 c609719bSwdenk
1978 c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1979 c609719bSwdenk			"myvar1=value1\0" \
1980 c609719bSwdenk			"myvar2=value2\0"
1981 c609719bSwdenk
1982 c609719bSwdenk		Warning: This method is based on knowledge about the
1983 c609719bSwdenk		internal format how the environment is stored by the
1984 2262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1985 c609719bSwdenk		interface! Although it is unlikely that this format
1986 7152b1d0Swdenk		will change soon, there is no guarantee either.
1987 c609719bSwdenk		You better know what you are doing here.
1988 c609719bSwdenk
1989 c609719bSwdenk		Note: overly (ab)use of the default environment is
1990 c609719bSwdenk		discouraged. Make sure to check other ways to preset
1991 74de7aefSWolfgang Denk		the environment like the "source" command or the
1992 c609719bSwdenk		boot command first.
1993 c609719bSwdenk
1994 a8c7c708Swdenk- DataFlash Support:
1995 2abbe075Swdenk		CONFIG_HAS_DATAFLASH
1996 2abbe075Swdenk
1997 2abbe075Swdenk		Defining this option enables DataFlash features and
1998 2abbe075Swdenk		allows to read/write in Dataflash via the standard
1999 2abbe075Swdenk		commands cp, md...
2000 2abbe075Swdenk
2001 3f85ce27Swdenk- SystemACE Support:
2002 3f85ce27Swdenk		CONFIG_SYSTEMACE
2003 3f85ce27Swdenk
2004 3f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
2005 3f85ce27Swdenk		chips attached via some sort of local bus. The address
2006 11ccc33fSMarcel Ziswiler		of the chip must also be defined in the
2007 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
2008 3f85ce27Swdenk
2009 3f85ce27Swdenk		#define CONFIG_SYSTEMACE
2010 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
2011 3f85ce27Swdenk
2012 3f85ce27Swdenk		When SystemACE support is added, the "ace" device type
2013 3f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
2014 3f85ce27Swdenk
2015 ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2016 ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2017 ecb0ccd9SWolfgang Denk
2018 28cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2019 ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
2020 28cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2021 ecb0ccd9SWolfgang Denk		number generator is used.
2022 ecb0ccd9SWolfgang Denk
2023 28cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
2024 28cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
2025 28cb9375SWolfgang Denk		defined, the normal port 69 is used.
2026 28cb9375SWolfgang Denk
2027 28cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2028 ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2029 ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2030 ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2031 ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2032 ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2033 ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2034 ecb0ccd9SWolfgang Denk
2035 a8c7c708Swdenk- Show boot progress:
2036 c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2037 c609719bSwdenk
2038 c609719bSwdenk		Defining this option allows to add some board-
2039 c609719bSwdenk		specific code (calling a user-provided function
2040 c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2041 c609719bSwdenk		the system's boot progress on some display (for
2042 c609719bSwdenk		example, some LED's) on your board. At the moment,
2043 c609719bSwdenk		the following checkpoints are implemented:
2044 c609719bSwdenk
2045 8ae86b76SWolfgang Denk- Standalone program support:
2046 8ae86b76SWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
2047 8ae86b76SWolfgang Denk
2048 8ae86b76SWolfgang Denk		This option allows to define board specific values
2049 8ae86b76SWolfgang Denk		for the address where standalone program gets loaded,
2050 8ae86b76SWolfgang Denk		thus overwriting the architecutre dependent default
2051 8ae86b76SWolfgang Denk		settings.
2052 8ae86b76SWolfgang Denk
2053 d32a1a4cSMinkyu Kang- Frame Buffer Address:
2054 d32a1a4cSMinkyu Kang	CONFIG_FB_ADDR
2055 d32a1a4cSMinkyu Kang
2056 d32a1a4cSMinkyu Kang	Define CONFIG_FB_ADDR if you want to use specific address for
2057 d32a1a4cSMinkyu Kang	frame buffer.
2058 d32a1a4cSMinkyu Kang	Then system will reserve the frame buffer address to defined address
2059 d32a1a4cSMinkyu Kang	instead of lcd_setmem (this function grab the memory for frame buffer
2060 d32a1a4cSMinkyu Kang	by panel's size).
2061 d32a1a4cSMinkyu Kang
2062 d32a1a4cSMinkyu Kang	Please see board_init_f function.
2063 d32a1a4cSMinkyu Kang
2064 d32a1a4cSMinkyu Kang	If you want this config option then,
2065 d32a1a4cSMinkyu Kang	please define it at your board config file
2066 d32a1a4cSMinkyu Kang
2067 1372cce2SMarian BalakowiczLegacy uImage format:
2068 1372cce2SMarian Balakowicz
2069 c609719bSwdenk  Arg	Where			When
2070 c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2071 c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2072 c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2073 c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2074 c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2075 c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2076 c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2077 c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2078 c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
2079 1372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2080 c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2081 c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2082 c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2083 c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
2084 1372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2085 c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
2086 1372cce2SMarian Balakowicz
2087 1372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
2088 1372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
2089 1372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
2090 1372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
2091 1372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
2092 1372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
2093 1372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
2094 11ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
2095 1372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
2096 1372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
2097 1372cce2SMarian Balakowicz
2098 ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
2099 c609719bSwdenk
2100 a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
2101 63e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
2102 63e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
2103 63e73c9aSwdenk
2104 566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2105 566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2106 566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2107 566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2108 566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2109 566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2110 566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2111 566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2112 566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2113 566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2114 566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2115 566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2116 566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2117 566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2118 566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2119 566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2120 566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2121 566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2122 566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2123 566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2124 566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2125 566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2126 566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2127 566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2128 566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2129 566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2130 566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2131 566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2132 566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2133 566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2134 566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2135 566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2136 566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2137 566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2138 566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2139 566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2140 566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2141 566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2142 566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2143 566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2144 566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2145 566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2146 566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2147 566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2148 566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2149 566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2150 566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2151 c609719bSwdenk
2152 566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2153 c609719bSwdenk
2154 566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2155 566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2156 566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2157 206c60cbSwdenk
2158 566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2159 566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
2160 11ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2161 566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2162 566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2163 566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
2164 74de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
2165 74de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2166 566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2167 c609719bSwdenk
2168 1372cce2SMarian BalakowiczFIT uImage format:
2169 1372cce2SMarian Balakowicz
2170 1372cce2SMarian Balakowicz  Arg	Where			When
2171 1372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
2172 1372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
2173 1372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
2174 1372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
2175 1372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
2176 1372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2177 f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
2178 1372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
2179 1372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
2180 1372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
2181 1372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
2182 1372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
2183 11ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
2184 11ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
2185 1372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
2186 1372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
2187 1372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
2188 1372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
2189 1372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
2190 1372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
2191 1372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
2192 1372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
2193 1372cce2SMarian Balakowicz
2194 1372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
2195 1372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
2196 1372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
2197 11ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
2198 1372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
2199 1372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
2200 1372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
2201 1372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
2202 1372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
2203 1372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
2204 1372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
2205 1372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
2206 1372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
2207 1372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
2208 1372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
2209 1372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
2210 1372cce2SMarian Balakowicz
2211 11ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
2212 1372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
2213 1372cce2SMarian Balakowicz
2214 11ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
2215 1372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
2216 1372cce2SMarian Balakowicz
2217 11ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
2218 1372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
2219 1372cce2SMarian Balakowicz
2220 cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2221 cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2222 cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2223 cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2224 cccfc2abSDetlev Zundel
2225 cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2226 cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2227 cccfc2abSDetlev Zundel
2228 cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2229 cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2230 cccfc2abSDetlev Zundel
2231 cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2232 cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2233 cccfc2abSDetlev Zundel
2234 cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2235 cccfc2abSDetlev Zundel
2236 cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2237 cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2238 cccfc2abSDetlev Zundel
2239 1372cce2SMarian Balakowicz
2240 c609719bSwdenkModem Support:
2241 c609719bSwdenk--------------
2242 c609719bSwdenk
2243 566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2244 c609719bSwdenk
2245 11ccc33fSMarcel Ziswiler- Modem support enable:
2246 c609719bSwdenk		CONFIG_MODEM_SUPPORT
2247 c609719bSwdenk
2248 c609719bSwdenk- RTS/CTS Flow control enable:
2249 c609719bSwdenk		CONFIG_HWFLOW
2250 c609719bSwdenk
2251 c609719bSwdenk- Modem debug support:
2252 c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2253 c609719bSwdenk
2254 c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2255 c609719bSwdenk		for modem support. Useful only with BDI2000.
2256 c609719bSwdenk
2257 a8c7c708Swdenk- Interrupt support (PPC):
2258 a8c7c708Swdenk
2259 a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2260 a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
2261 11ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2262 a8c7c708Swdenk		should set decrementer_count to appropriate value. If
2263 11ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2264 a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
2265 11ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2266 a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2267 a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2268 a8c7c708Swdenk		general timer_interrupt().
2269 a8c7c708Swdenk
2270 c609719bSwdenk- General:
2271 c609719bSwdenk
2272 c609719bSwdenk		In the target system modem support is enabled when a
2273 c609719bSwdenk		specific key (key combination) is pressed during
2274 c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
2275 11ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2276 c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2277 c609719bSwdenk		function, returning 1 and thus enabling modem
2278 c609719bSwdenk		initialization.
2279 c609719bSwdenk
2280 c609719bSwdenk		If there are no modem init strings in the
2281 c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2282 c609719bSwdenk		previous output (banner, info printfs) will be
2283 11ccc33fSMarcel Ziswiler		suppressed, though.
2284 c609719bSwdenk
2285 c609719bSwdenk		See also: doc/README.Modem
2286 c609719bSwdenk
2287 c609719bSwdenk
2288 c609719bSwdenkConfiguration Settings:
2289 c609719bSwdenk-----------------------
2290 c609719bSwdenk
2291 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2292 c609719bSwdenk		undefine this when you're short of memory.
2293 c609719bSwdenk
2294 2fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2295 2fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
2296 2fb2604dSPeter Tyser
2297 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2298 c609719bSwdenk		prompt for user input.
2299 c609719bSwdenk
2300 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2301 c609719bSwdenk
2302 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2303 c609719bSwdenk
2304 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2305 c609719bSwdenk
2306 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2307 c609719bSwdenk		the application (usually a Linux kernel) when it is
2308 c609719bSwdenk		booted
2309 c609719bSwdenk
2310 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2311 c609719bSwdenk		List of legal baudrate settings for this board.
2312 c609719bSwdenk
2313 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2314 c609719bSwdenk		Suppress display of console information at boot.
2315 c609719bSwdenk
2316 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2317 c609719bSwdenk		If the board specific function
2318 c609719bSwdenk			extern int overwrite_console (void);
2319 c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2320 c609719bSwdenk		serial port, else the settings in the environment are used.
2321 c609719bSwdenk
2322 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2323 c609719bSwdenk		Enable the call to overwrite_console().
2324 c609719bSwdenk
2325 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2326 c609719bSwdenk		Enable overwrite of previous console environment settings.
2327 c609719bSwdenk
2328 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2329 c609719bSwdenk		Begin and End addresses of the area used by the
2330 c609719bSwdenk		simple memory test.
2331 c609719bSwdenk
2332 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2333 c609719bSwdenk		Enable an alternate, more extensive memory test.
2334 c609719bSwdenk
2335 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
2336 5f535fe1Swdenk		Scratch address used by the alternate memory test
2337 5f535fe1Swdenk		You only need to set this if address zero isn't writeable
2338 5f535fe1Swdenk
2339 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2340 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2341 14f73ca6SStefan Roese		this specified memory area will get subtracted from the top
2342 11ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
2343 14f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
2344 14f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
2345 14f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
2346 5e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
2347 14f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
2348 5e12e75dSStefan Roese		will have to get fixed in Linux additionally.
2349 14f73ca6SStefan Roese
2350 14f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
2351 14f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2352 14f73ca6SStefan Roese		be touched.
2353 14f73ca6SStefan Roese
2354 14f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
2355 14f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
2356 14f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
2357 14f73ca6SStefan Roese		non page size aligned address and this could cause major
2358 14f73ca6SStefan Roese		problems.
2359 14f73ca6SStefan Roese
2360 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2361 c609719bSwdenk		Default load address for network file downloads
2362 c609719bSwdenk
2363 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2364 c609719bSwdenk		Enable temporary baudrate change while serial download
2365 c609719bSwdenk
2366 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2367 c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2368 c609719bSwdenk
2369 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2370 c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2371 c609719bSwdenk		Cogent motherboard)
2372 c609719bSwdenk
2373 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2374 c609719bSwdenk		Physical start address of Flash memory.
2375 c609719bSwdenk
2376 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2377 c609719bSwdenk		Physical start address of boot monitor code (set by
2378 c609719bSwdenk		make config files to be same as the text base address
2379 14d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
2380 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2381 c609719bSwdenk
2382 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
2383 3b57fe0aSwdenk		Size of memory reserved for monitor code, used to
2384 3b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
2385 3b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
2386 3b57fe0aSwdenk		flash sector.
2387 c609719bSwdenk
2388 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2389 c609719bSwdenk		Size of DRAM reserved for malloc() use.
2390 c609719bSwdenk
2391 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
2392 15940c9aSStefan Roese		Normally compressed uImages are limited to an
2393 15940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
2394 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
2395 15940c9aSStefan Roese		to adjust this setting to your needs.
2396 c609719bSwdenk
2397 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2398 c609719bSwdenk		Maximum size of memory mapped by the startup code of
2399 c609719bSwdenk		the Linux kernel; all data that must be processed by
2400 7d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
2401 7d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
2402 7d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
2403 7d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2404 c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
2405 c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2406 c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2407 c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2408 c609719bSwdenk
2409 fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2410 fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2411 fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2412 fca43cc8SJohn Rigby		is enabled.
2413 fca43cc8SJohn Rigby
2414 fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2415 fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2416 fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2417 fca43cc8SJohn Rigby
2418 fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2419 fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2420 fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2421 fca43cc8SJohn Rigby
2422 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2423 c609719bSwdenk		Max number of Flash memory banks
2424 c609719bSwdenk
2425 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2426 c609719bSwdenk		Max number of sectors on a Flash chip
2427 c609719bSwdenk
2428 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2429 c609719bSwdenk		Timeout for Flash erase operations (in ms)
2430 c609719bSwdenk
2431 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2432 c609719bSwdenk		Timeout for Flash write operations (in ms)
2433 c609719bSwdenk
2434 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
2435 8564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
2436 8564acf9Swdenk
2437 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
2438 8564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
2439 8564acf9Swdenk
2440 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
2441 8564acf9Swdenk		If defined, hardware flash sectors protection is used
2442 8564acf9Swdenk		instead of U-Boot software protection.
2443 8564acf9Swdenk
2444 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2445 c609719bSwdenk
2446 c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2447 c609719bSwdenk		without this option such a download has to be
2448 c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2449 c609719bSwdenk		copy from RAM to flash.
2450 c609719bSwdenk
2451 c609719bSwdenk		The two-step approach is usually more reliable, since
2452 c609719bSwdenk		you can check if the download worked before you erase
2453 11ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
2454 11ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2455 c609719bSwdenk		downloaded image) this option may be very useful.
2456 c609719bSwdenk
2457 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2458 c609719bSwdenk		Define if the flash driver uses extra elements in the
2459 5653fc33Swdenk		common flash structure for storing flash geometry.
2460 5653fc33Swdenk
2461 00b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
2462 5653fc33Swdenk		This option also enables the building of the cfi_flash driver
2463 5653fc33Swdenk		in the drivers directory
2464 53cf9435Sstroese
2465 91809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
2466 91809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
2467 91809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
2468 91809ed5SPiotr Ziecik		to the MTD layer.
2469 91809ed5SPiotr Ziecik
2470 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
2471 96ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
2472 96ef831fSGuennadi Liakhovetski
2473 96ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
2474 96ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
2475 96ef831fSGuennadi Liakhovetski		write commands.
2476 96ef831fSGuennadi Liakhovetski
2477 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
2478 5568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
2479 5568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
2480 5568e613SStefan Roese		is useful, if some of the configured banks are only
2481 5568e613SStefan Roese		optionally available.
2482 5568e613SStefan Roese
2483 9a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
2484 9a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
2485 9a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
2486 9a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
2487 9a042e9cSJerry Van Baren
2488 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
2489 11ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
2490 11ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
2491 53cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
2492 53cf9435Sstroese		buffers can be full shortly after enabling the interface
2493 11ccc33fSMarcel Ziswiler		on high Ethernet traffic.
2494 53cf9435Sstroese		Defaults to 4 if not defined.
2495 c609719bSwdenk
2496 ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2497 ea882bafSWolfgang Denk
2498 ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2499 ea882bafSWolfgang Denk	internally to store the environment settings. The default
2500 ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2501 ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2502 ea882bafSWolfgang Denk	lib/hashtable.c for details.
2503 ea882bafSWolfgang Denk
2504 c609719bSwdenkThe following definitions that deal with the placement and management
2505 c609719bSwdenkof environment data (variable area); in general, we support the
2506 c609719bSwdenkfollowing configurations:
2507 c609719bSwdenk
2508 5a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2509 c609719bSwdenk
2510 c609719bSwdenk	Define this if the environment is in flash memory.
2511 c609719bSwdenk
2512 c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2513 c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2514 c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2515 c609719bSwdenk	   sector" type flash chips, which have several smaller
2516 c609719bSwdenk	   sectors at the start or the end. For instance, such a
2517 c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2518 c609719bSwdenk	   such a case you would place the environment in one of the
2519 c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2520 c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2521 c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2522 c609719bSwdenk	   between U-Boot and the environment.
2523 c609719bSwdenk
2524 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2525 c609719bSwdenk
2526 c609719bSwdenk	   Offset of environment data (variable area) to the
2527 c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2528 c609719bSwdenk	   type flash chips the second sector can be used: the offset
2529 c609719bSwdenk	   for this sector is given here.
2530 c609719bSwdenk
2531 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2532 c609719bSwdenk
2533 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2534 c609719bSwdenk
2535 c609719bSwdenk	   This is just another way to specify the start address of
2536 c609719bSwdenk	   the flash sector containing the environment (instead of
2537 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2538 c609719bSwdenk
2539 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2540 c609719bSwdenk
2541 c609719bSwdenk	   Size of the sector containing the environment.
2542 c609719bSwdenk
2543 c609719bSwdenk
2544 c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2545 c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2546 c609719bSwdenk	   the environment.
2547 c609719bSwdenk
2548 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2549 c609719bSwdenk
2550 5a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
2551 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2552 c609719bSwdenk	   of this flash sector for the environment. This saves
2553 c609719bSwdenk	   memory for the RAM copy of the environment.
2554 c609719bSwdenk
2555 c609719bSwdenk	   It may also save flash memory if you decide to use this
2556 c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2557 c609719bSwdenk	   since then the remainder of the flash sector could be used
2558 c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2559 c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2560 c609719bSwdenk	   updating the environment in flash makes it always
2561 c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2562 c609719bSwdenk	   wrong before the contents has been restored from a copy in
2563 c609719bSwdenk	   RAM, your target system will be dead.
2564 c609719bSwdenk
2565 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
2566 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2567 c609719bSwdenk
2568 c609719bSwdenk	   These settings describe a second storage area used to hold
2569 11ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
2570 3e38691eSwdenk	   a valid backup copy in case there is a power failure during
2571 c609719bSwdenk	   a "saveenv" operation.
2572 c609719bSwdenk
2573 c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2574 c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2575 c609719bSwdenkaccordingly!
2576 c609719bSwdenk
2577 c609719bSwdenk
2578 9314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2579 c609719bSwdenk
2580 c609719bSwdenk	Define this if you have some non-volatile memory device
2581 c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2582 c609719bSwdenk	environment.
2583 c609719bSwdenk
2584 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2585 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2586 c609719bSwdenk
2587 11ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2588 c609719bSwdenk	  want to use for environment. It is assumed that this memory
2589 c609719bSwdenk	  can just be read and written to, without any special
2590 c609719bSwdenk	  provision.
2591 c609719bSwdenk
2592 c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2593 c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
2594 11ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2595 c609719bSwdenkU-Boot will hang.
2596 c609719bSwdenk
2597 c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2598 c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2599 c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2600 c609719bSwdenkto save the current settings.
2601 c609719bSwdenk
2602 c609719bSwdenk
2603 bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2604 c609719bSwdenk
2605 c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2606 c609719bSwdenk	device and a driver for it.
2607 c609719bSwdenk
2608 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2609 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2610 c609719bSwdenk
2611 c609719bSwdenk	  These two #defines specify the offset and size of the
2612 c609719bSwdenk	  environment area within the total memory of your EEPROM.
2613 c609719bSwdenk
2614 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2615 c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2616 c609719bSwdenk	  The default address is zero.
2617 c609719bSwdenk
2618 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2619 c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2620 c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2621 c609719bSwdenk	  would require six bits.
2622 c609719bSwdenk
2623 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2624 c609719bSwdenk	  If defined, the number of milliseconds to delay between
2625 c609719bSwdenk	  page writes.	The default is zero milliseconds.
2626 c609719bSwdenk
2627 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2628 c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2629 c609719bSwdenk	  that this is NOT the chip address length!
2630 c609719bSwdenk
2631 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
2632 5cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
2633 5cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2634 5cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
2635 5cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2636 5cf91d6bSwdenk	  byte chips.
2637 5cf91d6bSwdenk
2638 5cf91d6bSwdenk	  Note that we consider the length of the address field to
2639 5cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
2640 5cf91d6bSwdenk	  in the chip address.
2641 5cf91d6bSwdenk
2642 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2643 c609719bSwdenk	  The size in bytes of the EEPROM device.
2644 c609719bSwdenk
2645 548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2646 548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2647 548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2648 548738b4SHeiko Schocher
2649 548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2650 548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2651 548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2652 548738b4SHeiko Schocher	  EEPROM. For example:
2653 548738b4SHeiko Schocher
2654 548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
2655 548738b4SHeiko Schocher
2656 548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2657 548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2658 c609719bSwdenk
2659 057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
2660 5779d8d9Swdenk
2661 5779d8d9Swdenk	Define this if you have a DataFlash memory device which you
2662 5779d8d9Swdenk	want to use for the environment.
2663 5779d8d9Swdenk
2664 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2665 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2666 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2667 5779d8d9Swdenk
2668 5779d8d9Swdenk	  These three #defines specify the offset and size of the
2669 5779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
2670 5779d8d9Swdenk	  at the specified address.
2671 5779d8d9Swdenk
2672 51bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
2673 13a5695bSwdenk
2674 13a5695bSwdenk	Define this if you have a NAND device which you want to use
2675 13a5695bSwdenk	for the environment.
2676 13a5695bSwdenk
2677 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2678 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2679 13a5695bSwdenk
2680 13a5695bSwdenk	  These two #defines specify the offset and size of the environment
2681 fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
2682 fdd813deSScott Wood	  aligned to an erase block boundary.
2683 5779d8d9Swdenk
2684 fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
2685 e443c944SMarkus Klotzbuecher
2686 0e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2687 fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
2688 fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
2689 fdd813deSScott Wood	  during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
2690 fdd813deSScott Wood	  aligned to an erase block boundary.
2691 e443c944SMarkus Klotzbuecher
2692 fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
2693 fdd813deSScott Wood
2694 fdd813deSScott Wood	  Specifies the length of the region in which the environment
2695 fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
2696 fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
2697 fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2698 fdd813deSScott Wood	  the range to be avoided.
2699 fdd813deSScott Wood
2700 fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
2701 fdd813deSScott Wood
2702 fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
2703 fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
2704 fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
2705 fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2706 fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
2707 e443c944SMarkus Klotzbuecher
2708 b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2709 b74ab737SGuennadi Liakhovetski
2710 b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2711 b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2712 b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2713 b74ab737SGuennadi Liakhovetski
2714 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2715 c609719bSwdenk
2716 c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2717 c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2718 c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2719 c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2720 c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2721 c609719bSwdenk	to be a good choice since it makes it far enough from the
2722 c609719bSwdenk	start of the data area as well as from the stack pointer.
2723 c609719bSwdenk
2724 e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2725 c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2726 cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
2727 c609719bSwdenkuntil then to read environment variables.
2728 c609719bSwdenk
2729 85ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
2730 85ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
2731 85ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
2732 85ec0bccSwdenknecessary, because the first environment variable we need is the
2733 85ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
2734 85ec0bccSwdenkhave any device yet where we could complain.]
2735 c609719bSwdenk
2736 c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2737 c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
2738 85ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2739 c609719bSwdenk
2740 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2741 fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2742 fc3e2165Swdenk
2743 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2744 fc3e2165Swdenk		      also needs to be defined.
2745 fc3e2165Swdenk
2746 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2747 fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2748 c609719bSwdenk
2749 f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2750 f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2751 f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2752 f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2753 f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2754 f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2755 f5675aa5SRon Madrid
2756 c609719bSwdenkLow Level (hardware related) configuration options:
2757 dc7c9a1aSwdenk---------------------------------------------------
2758 c609719bSwdenk
2759 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2760 c609719bSwdenk		Cache Line Size of the CPU.
2761 c609719bSwdenk
2762 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2763 c609719bSwdenk		Default address of the IMMR after system reset.
2764 2535d602Swdenk
2765 2535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2766 2535d602Swdenk		and RPXsuper) to be able to adjust the position of
2767 2535d602Swdenk		the IMMR register after a reset.
2768 c609719bSwdenk
2769 7f6c2cbcSwdenk- Floppy Disk Support:
2770 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
2771 7f6c2cbcSwdenk
2772 7f6c2cbcSwdenk		the default drive number (default value 0)
2773 7f6c2cbcSwdenk
2774 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
2775 7f6c2cbcSwdenk
2776 11ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
2777 7f6c2cbcSwdenk		(default value 1)
2778 7f6c2cbcSwdenk
2779 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
2780 7f6c2cbcSwdenk
2781 7f6c2cbcSwdenk		defines the offset of register from address. It
2782 7f6c2cbcSwdenk		depends on which part of the data bus is connected to
2783 11ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
2784 7f6c2cbcSwdenk
2785 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2786 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
2787 7f6c2cbcSwdenk		default value.
2788 7f6c2cbcSwdenk
2789 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
2790 7f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
2791 7f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
2792 7f6c2cbcSwdenk		source code. It is used to make hardware dependant
2793 7f6c2cbcSwdenk		initializations.
2794 7f6c2cbcSwdenk
2795 0abddf82SMacpaul Lin- CONFIG_IDE_AHB:
2796 0abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
2797 0abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
2798 0abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
2799 0abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
2800 0abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
2801 0abddf82SMacpaul Lin		is requierd.
2802 0abddf82SMacpaul Lin
2803 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
2804 25d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
2805 25d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2806 c609719bSwdenk
2807 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2808 c609719bSwdenk
2809 7152b1d0Swdenk		Start address of memory area that can be used for
2810 c609719bSwdenk		initial data and stack; please note that this must be
2811 c609719bSwdenk		writable memory that is working WITHOUT special
2812 c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2813 c609719bSwdenk		will become available only after programming the
2814 c609719bSwdenk		memory controller and running certain initialization
2815 c609719bSwdenk		sequences.
2816 c609719bSwdenk
2817 c609719bSwdenk		U-Boot uses the following memory types:
2818 c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2819 c609719bSwdenk		- MPC824X: data cache
2820 c609719bSwdenk		- PPC4xx:  data cache
2821 c609719bSwdenk
2822 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2823 c609719bSwdenk
2824 c609719bSwdenk		Offset of the initial data structure in the memory
2825 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2826 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2827 c609719bSwdenk		data is located at the end of the available space
2828 553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
2829 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2830 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2831 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2832 c609719bSwdenk
2833 c609719bSwdenk	Note:
2834 c609719bSwdenk		On the MPC824X (or other systems that use the data
2835 c609719bSwdenk		cache for initial memory) the address chosen for
2836 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2837 c609719bSwdenk		point to an otherwise UNUSED address space between
2838 c609719bSwdenk		the top of RAM and the start of the PCI space.
2839 c609719bSwdenk
2840 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2841 c609719bSwdenk
2842 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2843 c609719bSwdenk
2844 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2845 c609719bSwdenk
2846 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2847 c609719bSwdenk
2848 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2849 c609719bSwdenk
2850 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2851 c609719bSwdenk
2852 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2853 c609719bSwdenk		SDRAM timing
2854 c609719bSwdenk
2855 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2856 c609719bSwdenk		periodic timer for refresh
2857 c609719bSwdenk
2858 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2859 c609719bSwdenk
2860 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2861 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2862 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2863 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2864 c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2865 c609719bSwdenk
2866 c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2867 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2868 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2869 c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2870 c609719bSwdenk
2871 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2872 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2873 c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2874 c609719bSwdenk		Prescaler definitions (SDRAM timing)
2875 c609719bSwdenk
2876 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2877 c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2878 c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2879 c609719bSwdenk
2880 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2881 b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2882 b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2883 b423d055SHeiko Schocher
2884 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2885 c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2886 c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2887 c609719bSwdenk
2888 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2889 c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2890 c609719bSwdenk		wrong setting might damage your board. Read
2891 c609719bSwdenk		doc/README.MBX before setting this variable!
2892 c609719bSwdenk
2893 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2894 ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2895 ea909b76Swdenk		(Power On Self Tests). This definition overrides
2896 ea909b76Swdenk		#define'd default value in commproc.h resp.
2897 ea909b76Swdenk		cpm_8260.h.
2898 ea909b76Swdenk
2899 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2900 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2901 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2902 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2903 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2904 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2905 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2906 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
2907 a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
2908 5d232d0eSwdenk
2909 9cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
2910 9cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
2911 9cacf4fcSDirk Eibach		required.
2912 9cacf4fcSDirk Eibach
2913 a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
2914 a09b9b68SKumar Gala		Chip has SRIO or not
2915 a09b9b68SKumar Gala
2916 a09b9b68SKumar Gala- CONFIG_SRIO1:
2917 a09b9b68SKumar Gala		Board has SRIO 1 port available
2918 a09b9b68SKumar Gala
2919 a09b9b68SKumar Gala- CONFIG_SRIO2:
2920 a09b9b68SKumar Gala		Board has SRIO 2 port available
2921 a09b9b68SKumar Gala
2922 a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
2923 a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
2924 a09b9b68SKumar Gala
2925 a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
2926 a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
2927 a09b9b68SKumar Gala
2928 a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
2929 a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
2930 a09b9b68SKumar Gala
2931 eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
2932 eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
2933 eced4626SAlex Waterman		16 bit bus.
2934 eced4626SAlex Waterman
2935 eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
2936 eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
2937 eced4626SAlex Waterman		a default value will be used.
2938 eced4626SAlex Waterman
2939 bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2940 218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2941 218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2942 218ca724SWolfgang Denk
2943 bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2944 bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2945 bb99ad6dSBen Warren
2946 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2947 218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2948 218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2949 218ca724SWolfgang Denk		to something your driver can deal with.
2950 bb99ad6dSBen Warren
2951 *1b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
2952 *1b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
2953 *1b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
2954 *1b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
2955 *1b3e3c4fSYork Sun		header files or board specific files.
2956 *1b3e3c4fSYork Sun
2957 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2958 218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2959 218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
2960 2ad6b513STimur Tabi
2961 c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2962 c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2963 c26e454dSwdenk
2964 c26e454dSwdenk- CONFIG_FEC[12]_PHY
2965 c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
2966 6e592385Swdenk		to the given FEC; i. e.
2967 c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2968 c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2969 c26e454dSwdenk
2970 c26e454dSwdenk		When set to -1, means to probe for first available.
2971 c26e454dSwdenk
2972 c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2973 c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2974 c26e454dSwdenk		(so program the FEC to ignore it).
2975 c26e454dSwdenk
2976 c26e454dSwdenk- CONFIG_RMII
2977 c26e454dSwdenk		Enable RMII mode for all FECs.
2978 c26e454dSwdenk		Note that this is a global option, we can't
2979 c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2980 c26e454dSwdenk
2981 5cf91d6bSwdenk- CONFIG_CRC32_VERIFY
2982 5cf91d6bSwdenk		Add a verify option to the crc32 command.
2983 5cf91d6bSwdenk		The syntax is:
2984 5cf91d6bSwdenk
2985 5cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
2986 5cf91d6bSwdenk
2987 5cf91d6bSwdenk		Where address/count indicate a memory area
2988 5cf91d6bSwdenk		and crc32 is the correct crc32 which the
2989 5cf91d6bSwdenk		area should have.
2990 5cf91d6bSwdenk
2991 56523f12Swdenk- CONFIG_LOOPW
2992 56523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2993 602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
2994 56523f12Swdenk
2995 7b466641Sstroese- CONFIG_MX_CYCLIC
2996 7b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
2997 7b466641Sstroese		"md/mw" commands.
2998 7b466641Sstroese		Examples:
2999 7b466641Sstroese
3000 7b466641Sstroese		=> mdc.b 10 4 500
3001 7b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
3002 7b466641Sstroese
3003 7b466641Sstroese		=> mwc.l 100 12345678 10
3004 7b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
3005 7b466641Sstroese
3006 7b466641Sstroese		This only takes effect if the memory commands are activated
3007 602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
3008 7b466641Sstroese
3009 8aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3010 e03f3169SWolfgang Denk		[ARM only] If this variable is defined, then certain
3011 e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3012 e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3013 e03f3169SWolfgang Denk		relocate itself into RAM.
3014 8aa1a2d1Swdenk
3015 e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3016 e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3017 e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3018 e03f3169SWolfgang Denk		these initializations itself.
3019 8aa1a2d1Swdenk
3020 df81238bSMagnus Lilja- CONFIG_PRELOADER
3021 df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3022 df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3023 df81238bSMagnus Lilja		compiling a NAND SPL.
3024 400558b5Swdenk
3025 d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3026 d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3027 d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3028 d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3029 d8834a13SMatthias Weisser		conditions but may increase the binary size.
3030 d8834a13SMatthias Weisser
3031 c609719bSwdenkBuilding the Software:
3032 c609719bSwdenk======================
3033 c609719bSwdenk
3034 218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3035 218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3036 218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3037 218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3038 218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3039 218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3040 c609719bSwdenk
3041 218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3042 218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3043 218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3044 218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3045 218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3046 c609719bSwdenk
3047 218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3048 218ca724SWolfgang Denk	$ export CROSS_COMPILE
3049 c609719bSwdenk
3050 2f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
3051 2f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
3052 2f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
3053 2f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
3054 2f8d396bSPeter Tyser
3055 2f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3056 2f8d396bSPeter Tyser
3057 2f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
3058 2f8d396bSPeter Tyser      be executed on computers running Windows.
3059 2f8d396bSPeter Tyser
3060 c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3061 c609719bSwdenksources you must configure U-Boot for one specific board type. This
3062 c609719bSwdenkis done by typing:
3063 c609719bSwdenk
3064 c609719bSwdenk	make NAME_config
3065 c609719bSwdenk
3066 218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
3067 218ca724SWolfgang Denkrations; see the main Makefile for supported names.
3068 54387ac9Swdenk
3069 c609719bSwdenkNote: for some board special configuration names may exist; check if
3070 c609719bSwdenk      additional information is available from the board vendor; for
3071 2729af9dSwdenk      instance, the TQM823L systems are available without (standard)
3072 2729af9dSwdenk      or with LCD support. You can select such additional "features"
3073 11ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3074 c609719bSwdenk
3075 2729af9dSwdenk      make TQM823L_config
3076 2729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3077 c609719bSwdenk
3078 c609719bSwdenk      make TQM823L_LCD_config
3079 c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3080 c609719bSwdenk
3081 c609719bSwdenk      etc.
3082 c609719bSwdenk
3083 c609719bSwdenk
3084 c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
3085 7152b1d0Swdenkimages ready for download to / installation on your system:
3086 c609719bSwdenk
3087 c609719bSwdenk- "u-boot.bin" is a raw binary image
3088 c609719bSwdenk- "u-boot" is an image in ELF binary format
3089 c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3090 c609719bSwdenk
3091 baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3092 baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3093 baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3094 baf31249SMarian Balakowicz
3095 baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3096 baf31249SMarian Balakowicz
3097 baf31249SMarian Balakowicz	make O=/tmp/build distclean
3098 baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3099 baf31249SMarian Balakowicz	make O=/tmp/build all
3100 baf31249SMarian Balakowicz
3101 baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3102 baf31249SMarian Balakowicz
3103 baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3104 baf31249SMarian Balakowicz	make distclean
3105 baf31249SMarian Balakowicz	make NAME_config
3106 baf31249SMarian Balakowicz	make all
3107 baf31249SMarian Balakowicz
3108 baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3109 baf31249SMarian Balakowiczvariable.
3110 baf31249SMarian Balakowicz
3111 c609719bSwdenk
3112 c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3113 c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3114 c609719bSwdenknative "make".
3115 c609719bSwdenk
3116 c609719bSwdenk
3117 c609719bSwdenkIf the system board that you have is not listed, then you will need
3118 c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3119 c609719bSwdenksteps:
3120 c609719bSwdenk
3121 c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
3122 85ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
3123 85ec0bccSwdenk    entries as examples. Note that here and at many other places
3124 7152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
3125 85ec0bccSwdenk    keep this order.
3126 c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
3127 85ec0bccSwdenk    files you need. In your board directory, you will need at least
3128 85ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
3129 85ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
3130 85ec0bccSwdenk    your board
3131 c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3132 c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
3133 85ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3134 c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3135 c609719bSwdenk    to be installed on your target system.
3136 85ec0bccSwdenk6.  Debug and solve any problems that might arise.
3137 c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3138 c609719bSwdenk
3139 c609719bSwdenk
3140 c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3141 c609719bSwdenk==============================================================
3142 c609719bSwdenk
3143 c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3144 c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3145 c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3146 c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3147 218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3148 c609719bSwdenk
3149 c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3150 c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3151 c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3152 c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3153 c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
3154 7152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3155 218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3156 218ca724SWolfgang Denkyou can type
3157 c609719bSwdenk
3158 c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3159 c609719bSwdenk
3160 c609719bSwdenkor to build on a native PowerPC system you can type
3161 c609719bSwdenk
3162 c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3163 c609719bSwdenk
3164 218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3165 218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3166 218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3167 218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3168 218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3169 218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3170 218ca724SWolfgang Denkvariable. For example:
3171 baf31249SMarian Balakowicz
3172 baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3173 baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3174 baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3175 baf31249SMarian Balakowicz
3176 218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3177 218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3178 218ca724SWolfgang Denkduring the whole build process.
3179 baf31249SMarian Balakowicz
3180 baf31249SMarian Balakowicz
3181 c609719bSwdenkSee also "U-Boot Porting Guide" below.
3182 c609719bSwdenk
3183 c609719bSwdenk
3184 c609719bSwdenkMonitor Commands - Overview:
3185 c609719bSwdenk============================
3186 c609719bSwdenk
3187 c609719bSwdenkgo	- start application at address 'addr'
3188 c609719bSwdenkrun	- run commands in an environment variable
3189 c609719bSwdenkbootm	- boot application image from memory
3190 c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
3191 c609719bSwdenktftpboot- boot image via network using TFTP protocol
3192 c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3193 c609719bSwdenk	       (and eventually "gatewayip")
3194 c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3195 c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3196 c609719bSwdenkloads	- load S-Record file over serial line
3197 c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3198 c609719bSwdenkmd	- memory display
3199 c609719bSwdenkmm	- memory modify (auto-incrementing)
3200 c609719bSwdenknm	- memory modify (constant address)
3201 c609719bSwdenkmw	- memory write (fill)
3202 c609719bSwdenkcp	- memory copy
3203 c609719bSwdenkcmp	- memory compare
3204 c609719bSwdenkcrc32	- checksum calculation
3205 0f89c54bSPeter Tyseri2c	- I2C sub-system
3206 c609719bSwdenksspi	- SPI utility commands
3207 c609719bSwdenkbase	- print or set address offset
3208 c609719bSwdenkprintenv- print environment variables
3209 c609719bSwdenksetenv	- set environment variables
3210 c609719bSwdenksaveenv - save environment variables to persistent storage
3211 c609719bSwdenkprotect - enable or disable FLASH write protection
3212 c609719bSwdenkerase	- erase FLASH memory
3213 c609719bSwdenkflinfo	- print FLASH memory information
3214 c609719bSwdenkbdinfo	- print Board Info structure
3215 c609719bSwdenkiminfo	- print header information for application image
3216 c609719bSwdenkconinfo - print console devices and informations
3217 c609719bSwdenkide	- IDE sub-system
3218 c609719bSwdenkloop	- infinite loop on address range
3219 56523f12Swdenkloopw	- infinite write loop on address range
3220 c609719bSwdenkmtest	- simple RAM test
3221 c609719bSwdenkicache	- enable or disable instruction cache
3222 c609719bSwdenkdcache	- enable or disable data cache
3223 c609719bSwdenkreset	- Perform RESET of the CPU
3224 c609719bSwdenkecho	- echo args to console
3225 c609719bSwdenkversion - print monitor version
3226 c609719bSwdenkhelp	- print online help
3227 c609719bSwdenk?	- alias for 'help'
3228 c609719bSwdenk
3229 c609719bSwdenk
3230 c609719bSwdenkMonitor Commands - Detailed Description:
3231 c609719bSwdenk========================================
3232 c609719bSwdenk
3233 c609719bSwdenkTODO.
3234 c609719bSwdenk
3235 c609719bSwdenkFor now: just type "help <command>".
3236 c609719bSwdenk
3237 c609719bSwdenk
3238 c609719bSwdenkEnvironment Variables:
3239 c609719bSwdenk======================
3240 c609719bSwdenk
3241 c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3242 c609719bSwdenkcan be made persistent by saving to Flash memory.
3243 c609719bSwdenk
3244 c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3245 c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3246 c609719bSwdenkwithout a value can be used to delete a variable from the
3247 c609719bSwdenkenvironment. As long as you don't save the environment you are
3248 c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3249 c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3250 c609719bSwdenk
3251 c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3252 c96f86eeSWolfgang Denk
3253 c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3254 c609719bSwdenk
3255 c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3256 c609719bSwdenk
3257 c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3258 c609719bSwdenk
3259 c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3260 c609719bSwdenk
3261 c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3262 c609719bSwdenk
3263 c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3264 c609719bSwdenk
3265 7d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
3266 7d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
3267 7d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
3268 7d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
3269 7d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
3270 7d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3271 c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3272 c3624e6eSGrant Likely		  bootm_mapsize.
3273 c3624e6eSGrant Likely
3274 c3624e6eSGrant Likely  bootm_mapsize	- Size of the initial memory mapping for the Linux kernel.
3275 c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3276 c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3277 c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3278 c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3279 c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3280 c3624e6eSGrant Likely		  used otherwise.
3281 7d721e34SBartlomiej Sieka
3282 7d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
3283 7d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
3284 7d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
3285 7d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
3286 7d721e34SBartlomiej Sieka		  environment variable.
3287 7d721e34SBartlomiej Sieka
3288 4bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
3289 4bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
3290 4bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
3291 4bae9090SBartlomiej Sieka
3292 c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3293 c609719bSwdenk		  "bootp" will just load perform a lookup of the
3294 c609719bSwdenk		  configuration from the BOOTP server, but not try to
3295 c609719bSwdenk		  load any image using TFTP
3296 c609719bSwdenk
3297 c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3298 c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3299 c609719bSwdenk		  be automatically started (by internally calling
3300 c609719bSwdenk		  "bootm")
3301 c609719bSwdenk
3302 4a6fd34bSwdenk		  If set to "no", a standalone image passed to the
3303 4a6fd34bSwdenk		  "bootm" command will be copied to the load address
3304 4a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
3305 4a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
3306 4a6fd34bSwdenk		  data.
3307 4a6fd34bSwdenk
3308 17ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
3309 17ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
3310 17ea1177Swdenk		  mode (400kHZ). This environment variable is used in
3311 17ea1177Swdenk		  initialization code. So, for changes to be effective
3312 17ea1177Swdenk		  it must be saved and board must be reset.
3313 17ea1177Swdenk
3314 c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3315 c609719bSwdenk		  If this variable is not set, initrd images will be
3316 c609719bSwdenk		  copied to the highest possible address in RAM; this
3317 c609719bSwdenk		  is usually what you want since it allows for
3318 c609719bSwdenk		  maximum initrd size. If for some reason you want to
3319 c609719bSwdenk		  make sure that the initrd image is loaded below the
3320 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3321 c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3322 c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3323 c609719bSwdenk		  address to use (U-Boot will still check that it
3324 c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3325 c609719bSwdenk
3326 c609719bSwdenk		  For instance, when you have a system with 16 MB
3327 7152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3328 c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3329 c609719bSwdenk		  the "bootargs" variable. However, now you must make
3330 7152b1d0Swdenk		  sure that the initrd image is placed in the first
3331 c609719bSwdenk		  12 MB as well - this can be done with
3332 c609719bSwdenk
3333 c609719bSwdenk		  setenv initrd_high 00c00000
3334 c609719bSwdenk
3335 38b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
3336 38b99261Swdenk		  indication to U-Boot that all addresses are legal
3337 38b99261Swdenk		  for the Linux kernel, including addresses in flash
3338 38b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
3339 38b99261Swdenk		  ramdisk at all. This may be useful to reduce the
3340 38b99261Swdenk		  boot time on your system, but requires that this
3341 38b99261Swdenk		  feature is supported by your Linux kernel.
3342 38b99261Swdenk
3343 c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3344 c609719bSwdenk
3345 c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3346 dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3347 c609719bSwdenk
3348 c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3349 c609719bSwdenk
3350 c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3351 c609719bSwdenk
3352 c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3353 c609719bSwdenk
3354 c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3355 c609719bSwdenk
3356 c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3357 c609719bSwdenk
3358 a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3359 a3d991bdSwdenk		  interface is used first.
3360 a3d991bdSwdenk
3361 a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3362 a3d991bdSwdenk		  interface is currently active. For example you
3363 a3d991bdSwdenk		  can do the following
3364 a3d991bdSwdenk
3365 48690d80SHeiko Schocher		  => setenv ethact FEC
3366 48690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
3367 48690d80SHeiko Schocher		  => setenv ethact SCC
3368 48690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3369 a3d991bdSwdenk
3370 e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3371 e1692577SMatthias Fuchs		  available network interfaces.
3372 e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3373 e1692577SMatthias Fuchs
3374 a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3375 a3d991bdSwdenk		  either succeed or fail without retrying.
3376 6e592385Swdenk		  When set to "once" the network operation will
3377 6e592385Swdenk		  fail when all the available network interfaces
3378 6e592385Swdenk		  are tried once without success.
3379 a3d991bdSwdenk		  Useful on scripts which control the retry operation
3380 a3d991bdSwdenk		  themselves.
3381 a3d991bdSwdenk
3382 b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3383 a1cf027aSJean-Christophe PLAGNIOL-VILLARD
3384 28cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3385 ecb0ccd9SWolfgang Denk		  UDP source port.
3386 ecb0ccd9SWolfgang Denk
3387 28cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
3388 28cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
3389 28cb9375SWolfgang Denk
3390 c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3391 c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3392 c96f86eeSWolfgang Denk
3393 c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3394 c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3395 c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3396 c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3397 c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3398 c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3399 c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3400 c96f86eeSWolfgang Denk
3401 a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
3402 11ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3403 a3d991bdSwdenk		  VLAN tagged frames.
3404 c609719bSwdenk
3405 c609719bSwdenkThe following environment variables may be used and automatically
3406 c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3407 c609719bSwdenkdepending the information provided by your boot server:
3408 c609719bSwdenk
3409 c609719bSwdenk  bootfile	- see above
3410 c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3411 fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3412 c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3413 c609719bSwdenk  hostname	- Target hostname
3414 c609719bSwdenk  ipaddr	- see above
3415 c609719bSwdenk  netmask	- Subnet Mask
3416 c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3417 c609719bSwdenk  serverip	- see above
3418 c609719bSwdenk
3419 c609719bSwdenk
3420 c609719bSwdenkThere are two special Environment Variables:
3421 c609719bSwdenk
3422 c609719bSwdenk  serial#	- contains hardware identification information such
3423 c609719bSwdenk		  as type string and/or serial number
3424 c609719bSwdenk  ethaddr	- Ethernet address
3425 c609719bSwdenk
3426 c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3427 c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3428 c609719bSwdenkonce they have been set once.
3429 c609719bSwdenk
3430 c609719bSwdenk
3431 c1551ea8SstroeseFurther special Environment Variables:
3432 c1551ea8Sstroese
3433 c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3434 c1551ea8Sstroese		  with the "version" command. This variable is
3435 c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3436 c1551ea8Sstroese
3437 c1551ea8Sstroese
3438 c609719bSwdenkPlease note that changes to some configuration parameters may take
3439 c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3440 c609719bSwdenk
3441 c609719bSwdenk
3442 f07771ccSwdenkCommand Line Parsing:
3443 f07771ccSwdenk=====================
3444 f07771ccSwdenk
3445 f07771ccSwdenkThere are two different command line parsers available with U-Boot:
3446 7152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3447 f07771ccSwdenk
3448 f07771ccSwdenkOld, simple command line parser:
3449 f07771ccSwdenk--------------------------------
3450 f07771ccSwdenk
3451 f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3452 f07771ccSwdenk- several commands on one line, separated by ';'
3453 fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3454 f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3455 f07771ccSwdenk  for example:
3456 fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3457 f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3458 f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3459 f07771ccSwdenk
3460 f07771ccSwdenkHush shell:
3461 f07771ccSwdenk-----------
3462 f07771ccSwdenk
3463 f07771ccSwdenk- similar to Bourne shell, with control structures like
3464 f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3465 f07771ccSwdenk  until...do...done, ...
3466 f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3467 f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3468 f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3469 f07771ccSwdenk  command
3470 f07771ccSwdenk
3471 f07771ccSwdenkGeneral rules:
3472 f07771ccSwdenk--------------
3473 f07771ccSwdenk
3474 f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3475 f07771ccSwdenk    command) contains several commands separated by semicolon, and
3476 f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3477 f07771ccSwdenk    executed anyway.
3478 f07771ccSwdenk
3479 f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
3480 11ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3481 f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3482 f07771ccSwdenk    variables are not executed.
3483 f07771ccSwdenk
3484 c609719bSwdenkNote for Redundant Ethernet Interfaces:
3485 c609719bSwdenk=======================================
3486 c609719bSwdenk
3487 11ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3488 c609719bSwdenksuch configurations and is capable of automatic selection of a
3489 7152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3490 c609719bSwdenk
3491 c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3492 c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3493 c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3494 c609719bSwdenk
3495 c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3496 c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3497 c609719bSwdenkding setting in the environment; if the corresponding environment
3498 c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3499 c609719bSwdenk
3500 c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3501 c609719bSwdenk  environment, the SROM's address is used.
3502 c609719bSwdenk
3503 c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3504 c609719bSwdenk  environment exists, then the value from the environment variable is
3505 c609719bSwdenk  used.
3506 c609719bSwdenk
3507 c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3508 c609719bSwdenk  both addresses are the same, this MAC address is used.
3509 c609719bSwdenk
3510 c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3511 c609719bSwdenk  addresses differ, the value from the environment is used and a
3512 c609719bSwdenk  warning is printed.
3513 c609719bSwdenk
3514 c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3515 c609719bSwdenk  is raised.
3516 c609719bSwdenk
3517 ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3518 ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.  This
3519 ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3520 ecee9324SBen WarrenThe naming convention is as follows:
3521 ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3522 c609719bSwdenk
3523 c609719bSwdenkImage Formats:
3524 c609719bSwdenk==============
3525 c609719bSwdenk
3526 3310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
3527 3310c549SMarian Balakowiczimages in two formats:
3528 3310c549SMarian Balakowicz
3529 3310c549SMarian BalakowiczNew uImage format (FIT)
3530 3310c549SMarian Balakowicz-----------------------
3531 3310c549SMarian Balakowicz
3532 3310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
3533 3310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
3534 3310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
3535 3310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3536 3310c549SMarian Balakowicz
3537 3310c549SMarian Balakowicz
3538 3310c549SMarian BalakowiczOld uImage format
3539 3310c549SMarian Balakowicz-----------------
3540 3310c549SMarian Balakowicz
3541 3310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
3542 3310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
3543 3310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3544 c609719bSwdenk
3545 c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3546 c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3547 f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3548 f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3549 f5ed9e39SPeter Tyser  INTEGRITY).
3550 7b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
3551 1117cbf2SThomas Chou  IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3552 1117cbf2SThomas Chou  Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
3553 c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3554 c609719bSwdenk* Load Address
3555 c609719bSwdenk* Entry Point
3556 c609719bSwdenk* Image Name
3557 c609719bSwdenk* Image Timestamp
3558 c609719bSwdenk
3559 c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3560 c609719bSwdenkand the data portions of the image are secured against corruption by
3561 c609719bSwdenkCRC32 checksums.
3562 c609719bSwdenk
3563 c609719bSwdenk
3564 c609719bSwdenkLinux Support:
3565 c609719bSwdenk==============
3566 c609719bSwdenk
3567 c609719bSwdenkAlthough U-Boot should support any OS or standalone application
3568 7152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3569 c609719bSwdenkU-Boot.
3570 c609719bSwdenk
3571 c609719bSwdenkU-Boot includes many features that so far have been part of some
3572 c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3573 c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3574 c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
3575 7152b1d0Swdenkserves several purposes:
3576 c609719bSwdenk
3577 c609719bSwdenk- the same features can be used for other OS or standalone
3578 c609719bSwdenk  applications (for instance: using compressed images to reduce the
3579 c609719bSwdenk  Flash memory footprint)
3580 c609719bSwdenk
3581 c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
3582 7152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3583 c609719bSwdenk
3584 c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3585 c609719bSwdenk  images; of course this also means that different kernel images can
3586 c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3587 c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3588 c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3589 c609719bSwdenk  software is easier now.
3590 c609719bSwdenk
3591 c609719bSwdenk
3592 c609719bSwdenkLinux HOWTO:
3593 c609719bSwdenk============
3594 c609719bSwdenk
3595 c609719bSwdenkPorting Linux to U-Boot based systems:
3596 c609719bSwdenk---------------------------------------
3597 c609719bSwdenk
3598 c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3599 c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3600 c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3601 c609719bSwdenkLinux :-).
3602 c609719bSwdenk
3603 a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3604 c609719bSwdenk
3605 c609719bSwdenkJust make sure your machine specific header file (for instance
3606 c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
3607 1dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
3608 1dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
3609 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3610 c609719bSwdenk
3611 c609719bSwdenk
3612 c609719bSwdenkConfiguring the Linux kernel:
3613 c609719bSwdenk-----------------------------
3614 c609719bSwdenk
3615 c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3616 c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3617 c609719bSwdenk
3618 c609719bSwdenk
3619 c609719bSwdenkBuilding a Linux Image:
3620 c609719bSwdenk-----------------------
3621 c609719bSwdenk
3622 24ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
3623 24ee89b9Swdenknot used. If you use recent kernel source, a new build target
3624 24ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
3625 24ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
3626 24ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
3627 24ee89b9Swdenk100% compatible format.
3628 c609719bSwdenk
3629 c609719bSwdenkExample:
3630 c609719bSwdenk
3631 c609719bSwdenk	make TQM850L_config
3632 c609719bSwdenk	make oldconfig
3633 c609719bSwdenk	make dep
3634 24ee89b9Swdenk	make uImage
3635 c609719bSwdenk
3636 24ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
3637 24ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
3638 24ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3639 c609719bSwdenk
3640 24ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
3641 24ee89b9Swdenk
3642 24ee89b9Swdenk* convert the kernel into a raw binary image:
3643 24ee89b9Swdenk
3644 24ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
3645 24ee89b9Swdenk				 -R .note -R .comment \
3646 24ee89b9Swdenk				 -S vmlinux linux.bin
3647 24ee89b9Swdenk
3648 24ee89b9Swdenk* compress the binary image:
3649 24ee89b9Swdenk
3650 24ee89b9Swdenk	gzip -9 linux.bin
3651 24ee89b9Swdenk
3652 24ee89b9Swdenk* package compressed binary image for U-Boot:
3653 24ee89b9Swdenk
3654 24ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
3655 24ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
3656 24ee89b9Swdenk		-d linux.bin.gz uImage
3657 24ee89b9Swdenk
3658 24ee89b9Swdenk
3659 24ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
3660 24ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
3661 24ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
3662 24ee89b9Swdenkbyte header containing information about target architecture,
3663 24ee89b9Swdenkoperating system, image type, compression method, entry points, time
3664 24ee89b9Swdenkstamp, CRC32 checksums, etc.
3665 24ee89b9Swdenk
3666 24ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
3667 24ee89b9Swdenkprint the header information, or to build new images.
3668 c609719bSwdenk
3669 c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3670 c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3671 c609719bSwdenkchecksum verification:
3672 c609719bSwdenk
3673 c609719bSwdenk	tools/mkimage -l image
3674 c609719bSwdenk	  -l ==> list image header information
3675 c609719bSwdenk
3676 c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3677 c609719bSwdenkfrom a "data file" which is used as image payload:
3678 c609719bSwdenk
3679 c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3680 c609719bSwdenk		      -n name -d data_file image
3681 c609719bSwdenk	  -A ==> set architecture to 'arch'
3682 c609719bSwdenk	  -O ==> set operating system to 'os'
3683 c609719bSwdenk	  -T ==> set image type to 'type'
3684 c609719bSwdenk	  -C ==> set compression type 'comp'
3685 c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3686 c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3687 c609719bSwdenk	  -n ==> set image name to 'name'
3688 c609719bSwdenk	  -d ==> use image data from 'datafile'
3689 c609719bSwdenk
3690 69459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
3691 69459791Swdenkaddress (0x00000000), but the entry point address depends on the
3692 69459791Swdenkkernel version:
3693 c609719bSwdenk
3694 c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
3695 24ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3696 c609719bSwdenk
3697 c609719bSwdenkSo a typical call to build a U-Boot image would read:
3698 c609719bSwdenk
3699 24ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3700 24ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3701 a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
3702 24ee89b9Swdenk	> examples/uImage.TQM850L
3703 24ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3704 c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3705 c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3706 c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3707 c609719bSwdenk	Load Address: 0x00000000
3708 24ee89b9Swdenk	Entry Point:  0x00000000
3709 c609719bSwdenk
3710 c609719bSwdenkTo verify the contents of the image (or check for corruption):
3711 c609719bSwdenk
3712 24ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
3713 24ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3714 c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3715 c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3716 c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3717 c609719bSwdenk	Load Address: 0x00000000
3718 24ee89b9Swdenk	Entry Point:  0x00000000
3719 c609719bSwdenk
3720 c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3721 c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3722 c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3723 c609719bSwdenkneed to be uncompressed:
3724 c609719bSwdenk
3725 a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
3726 24ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3727 24ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3728 a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
3729 24ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
3730 24ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3731 c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3732 c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3733 c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3734 c609719bSwdenk	Load Address: 0x00000000
3735 24ee89b9Swdenk	Entry Point:  0x00000000
3736 c609719bSwdenk
3737 c609719bSwdenk
3738 c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3739 c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3740 c609719bSwdenk
3741 c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3742 c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3743 c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3744 c609719bSwdenk	Image Name:   Simple Ramdisk Image
3745 c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3746 c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3747 c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3748 c609719bSwdenk	Load Address: 0x00000000
3749 c609719bSwdenk	Entry Point:  0x00000000
3750 c609719bSwdenk
3751 c609719bSwdenk
3752 c609719bSwdenkInstalling a Linux Image:
3753 c609719bSwdenk-------------------------
3754 c609719bSwdenk
3755 c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3756 c609719bSwdenkyou must convert the image to S-Record format:
3757 c609719bSwdenk
3758 c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3759 c609719bSwdenk
3760 c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3761 c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3762 c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3763 c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3764 c609719bSwdenkcommand.
3765 c609719bSwdenk
3766 c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3767 c609719bSwdenkTQM8xxL is in the first Flash bank):
3768 c609719bSwdenk
3769 c609719bSwdenk	=> erase 40100000 401FFFFF
3770 c609719bSwdenk
3771 c609719bSwdenk	.......... done
3772 c609719bSwdenk	Erased 8 sectors
3773 c609719bSwdenk
3774 c609719bSwdenk	=> loads 40100000
3775 c609719bSwdenk	## Ready for S-Record download ...
3776 c609719bSwdenk	~>examples/image.srec
3777 c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3778 c609719bSwdenk	...
3779 c609719bSwdenk	15989 15990 15991 15992
3780 c609719bSwdenk	[file transfer complete]
3781 c609719bSwdenk	[connected]
3782 c609719bSwdenk	## Start Addr = 0x00000000
3783 c609719bSwdenk
3784 c609719bSwdenk
3785 c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3786 c609719bSwdenkthis includes a checksum verification so you can be sure no data
3787 c609719bSwdenkcorruption happened:
3788 c609719bSwdenk
3789 c609719bSwdenk	=> imi 40100000
3790 c609719bSwdenk
3791 c609719bSwdenk	## Checking Image at 40100000 ...
3792 c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3793 c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3794 c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3795 c609719bSwdenk	   Load Address: 00000000
3796 c609719bSwdenk	   Entry Point:	 0000000c
3797 c609719bSwdenk	   Verifying Checksum ... OK
3798 c609719bSwdenk
3799 c609719bSwdenk
3800 c609719bSwdenkBoot Linux:
3801 c609719bSwdenk-----------
3802 c609719bSwdenk
3803 c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3804 c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3805 c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3806 c609719bSwdenkparameters. You can check and modify this variable using the
3807 c609719bSwdenk"printenv" and "setenv" commands:
3808 c609719bSwdenk
3809 c609719bSwdenk
3810 c609719bSwdenk	=> printenv bootargs
3811 c609719bSwdenk	bootargs=root=/dev/ram
3812 c609719bSwdenk
3813 c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3814 c609719bSwdenk
3815 c609719bSwdenk	=> printenv bootargs
3816 c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3817 c609719bSwdenk
3818 c609719bSwdenk	=> bootm 40020000
3819 c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3820 c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3821 c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3822 c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3823 c609719bSwdenk	   Load Address: 00000000
3824 c609719bSwdenk	   Entry Point:	 0000000c
3825 c609719bSwdenk	   Verifying Checksum ... OK
3826 c609719bSwdenk	   Uncompressing Kernel Image ... OK
3827 c609719bSwdenk	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
3828 c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3829 c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3830 c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3831 c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3832 c609719bSwdenk	...
3833 c609719bSwdenk
3834 11ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
3835 7152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3836 c609719bSwdenkformat!) to the "bootm" command:
3837 c609719bSwdenk
3838 c609719bSwdenk	=> imi 40100000 40200000
3839 c609719bSwdenk
3840 c609719bSwdenk	## Checking Image at 40100000 ...
3841 c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3842 c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3843 c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3844 c609719bSwdenk	   Load Address: 00000000
3845 c609719bSwdenk	   Entry Point:	 0000000c
3846 c609719bSwdenk	   Verifying Checksum ... OK
3847 c609719bSwdenk
3848 c609719bSwdenk	## Checking Image at 40200000 ...
3849 c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3850 c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3851 c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3852 c609719bSwdenk	   Load Address: 00000000
3853 c609719bSwdenk	   Entry Point:	 00000000
3854 c609719bSwdenk	   Verifying Checksum ... OK
3855 c609719bSwdenk
3856 c609719bSwdenk	=> bootm 40100000 40200000
3857 c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3858 c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3859 c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3860 c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3861 c609719bSwdenk	   Load Address: 00000000
3862 c609719bSwdenk	   Entry Point:	 0000000c
3863 c609719bSwdenk	   Verifying Checksum ... OK
3864 c609719bSwdenk	   Uncompressing Kernel Image ... OK
3865 c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3866 c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3867 c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3868 c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3869 c609719bSwdenk	   Load Address: 00000000
3870 c609719bSwdenk	   Entry Point:	 00000000
3871 c609719bSwdenk	   Verifying Checksum ... OK
3872 c609719bSwdenk	   Loading Ramdisk ... OK
3873 c609719bSwdenk	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
3874 c609719bSwdenk	Boot arguments: root=/dev/ram
3875 c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3876 c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3877 c609719bSwdenk	...
3878 c609719bSwdenk	RAMDISK: Compressed image found at block 0
3879 c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3880 c609719bSwdenk
3881 c609719bSwdenk	bash#
3882 c609719bSwdenk
3883 0267768eSMatthew McClintockBoot Linux and pass a flat device tree:
3884 0267768eSMatthew McClintock-----------
3885 0267768eSMatthew McClintock
3886 0267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
3887 0267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
3888 0267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
3889 0267768eSMatthew McClintockflat device tree:
3890 0267768eSMatthew McClintock
3891 0267768eSMatthew McClintock=> print oftaddr
3892 0267768eSMatthew McClintockoftaddr=0x300000
3893 0267768eSMatthew McClintock=> print oft
3894 0267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
3895 0267768eSMatthew McClintock=> tftp $oftaddr $oft
3896 0267768eSMatthew McClintockSpeed: 1000, full duplex
3897 0267768eSMatthew McClintockUsing TSEC0 device
3898 0267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
3899 0267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
3900 0267768eSMatthew McClintockLoad address: 0x300000
3901 0267768eSMatthew McClintockLoading: #
3902 0267768eSMatthew McClintockdone
3903 0267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
3904 0267768eSMatthew McClintock=> tftp $loadaddr $bootfile
3905 0267768eSMatthew McClintockSpeed: 1000, full duplex
3906 0267768eSMatthew McClintockUsing TSEC0 device
3907 0267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
3908 0267768eSMatthew McClintockFilename 'uImage'.
3909 0267768eSMatthew McClintockLoad address: 0x200000
3910 0267768eSMatthew McClintockLoading:############
3911 0267768eSMatthew McClintockdone
3912 0267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
3913 0267768eSMatthew McClintock=> print loadaddr
3914 0267768eSMatthew McClintockloadaddr=200000
3915 0267768eSMatthew McClintock=> print oftaddr
3916 0267768eSMatthew McClintockoftaddr=0x300000
3917 0267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
3918 0267768eSMatthew McClintock## Booting image at 00200000 ...
3919 0267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
3920 0267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3921 0267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
3922 0267768eSMatthew McClintock   Load Address: 00000000
3923 0267768eSMatthew McClintock   Entry Point:	 00000000
3924 0267768eSMatthew McClintock   Verifying Checksum ... OK
3925 0267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
3926 0267768eSMatthew McClintockBooting using flat device tree at 0x300000
3927 0267768eSMatthew McClintockUsing MPC85xx ADS machine description
3928 0267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3929 0267768eSMatthew McClintock[snip]
3930 0267768eSMatthew McClintock
3931 0267768eSMatthew McClintock
3932 6069ff26SwdenkMore About U-Boot Image Types:
3933 6069ff26Swdenk------------------------------
3934 6069ff26Swdenk
3935 6069ff26SwdenkU-Boot supports the following image types:
3936 6069ff26Swdenk
3937 6069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
3938 6069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
3939 6069ff26Swdenk	well) you can continue to work in U-Boot after return from
3940 6069ff26Swdenk	the Standalone Program.
3941 6069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
3942 6069ff26Swdenk	will take over control completely. Usually these programs
3943 6069ff26Swdenk	will install their own set of exception handlers, device
3944 6069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
3945 6069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
3946 6069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
3947 6069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
3948 6069ff26Swdenk	being started.
3949 6069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
3950 6069ff26Swdenk	(Linux) kernel image and one or more data images like
3951 6069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
3952 6069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
3953 6069ff26Swdenk	server provides just a single image file, but you want to get
3954 6069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
3955 6069ff26Swdenk
3956 6069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
3957 6069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
3958 6069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
3959 6069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
3960 6069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
3961 6069ff26Swdenk	a multiple of 4 bytes).
3962 6069ff26Swdenk
3963 6069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
3964 6069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
3965 6069ff26Swdenk	flash memory.
3966 6069ff26Swdenk
3967 6069ff26Swdenk   "Script files" are command sequences that will be executed by
3968 6069ff26Swdenk	U-Boot's command interpreter; this feature is especially
3969 6069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
3970 6069ff26Swdenk	as command interpreter.
3971 6069ff26Swdenk
3972 c609719bSwdenk
3973 c609719bSwdenkStandalone HOWTO:
3974 c609719bSwdenk=================
3975 c609719bSwdenk
3976 c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3977 c609719bSwdenkrun "standalone" applications, which can use some resources of
3978 c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3979 c609719bSwdenk
3980 c609719bSwdenkTwo simple examples are included with the sources:
3981 c609719bSwdenk
3982 c609719bSwdenk"Hello World" Demo:
3983 c609719bSwdenk-------------------
3984 c609719bSwdenk
3985 c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3986 c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3987 c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3988 c609719bSwdenklike that:
3989 c609719bSwdenk
3990 c609719bSwdenk	=> loads
3991 c609719bSwdenk	## Ready for S-Record download ...
3992 c609719bSwdenk	~>examples/hello_world.srec
3993 c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3994 c609719bSwdenk	[file transfer complete]
3995 c609719bSwdenk	[connected]
3996 c609719bSwdenk	## Start Addr = 0x00040004
3997 c609719bSwdenk
3998 c609719bSwdenk	=> go 40004 Hello World! This is a test.
3999 c609719bSwdenk	## Starting application at 0x00040004 ...
4000 c609719bSwdenk	Hello World
4001 c609719bSwdenk	argc = 7
4002 c609719bSwdenk	argv[0] = "40004"
4003 c609719bSwdenk	argv[1] = "Hello"
4004 c609719bSwdenk	argv[2] = "World!"
4005 c609719bSwdenk	argv[3] = "This"
4006 c609719bSwdenk	argv[4] = "is"
4007 c609719bSwdenk	argv[5] = "a"
4008 c609719bSwdenk	argv[6] = "test."
4009 c609719bSwdenk	argv[7] = "<NULL>"
4010 c609719bSwdenk	Hit any key to exit ...
4011 c609719bSwdenk
4012 c609719bSwdenk	## Application terminated, rc = 0x0
4013 c609719bSwdenk
4014 c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4015 c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4016 c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4017 c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4018 c609719bSwdenkcharacter, but this is just a demo program. The application can be
4019 c609719bSwdenkcontrolled by the following keys:
4020 c609719bSwdenk
4021 c609719bSwdenk	? - print current values og the CPM Timer registers
4022 c609719bSwdenk	b - enable interrupts and start timer
4023 c609719bSwdenk	e - stop timer and disable interrupts
4024 c609719bSwdenk	q - quit application
4025 c609719bSwdenk
4026 c609719bSwdenk	=> loads
4027 c609719bSwdenk	## Ready for S-Record download ...
4028 c609719bSwdenk	~>examples/timer.srec
4029 c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4030 c609719bSwdenk	[file transfer complete]
4031 c609719bSwdenk	[connected]
4032 c609719bSwdenk	## Start Addr = 0x00040004
4033 c609719bSwdenk
4034 c609719bSwdenk	=> go 40004
4035 c609719bSwdenk	## Starting application at 0x00040004 ...
4036 c609719bSwdenk	TIMERS=0xfff00980
4037 c609719bSwdenk	Using timer 1
4038 c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4039 c609719bSwdenk
4040 c609719bSwdenkHit 'b':
4041 c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4042 c609719bSwdenk	Enabling timer
4043 c609719bSwdenkHit '?':
4044 c609719bSwdenk	[q, b, e, ?] ........
4045 c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4046 c609719bSwdenkHit '?':
4047 c609719bSwdenk	[q, b, e, ?] .
4048 c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4049 c609719bSwdenkHit '?':
4050 c609719bSwdenk	[q, b, e, ?] .
4051 c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4052 c609719bSwdenkHit '?':
4053 c609719bSwdenk	[q, b, e, ?] .
4054 c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4055 c609719bSwdenkHit 'e':
4056 c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4057 c609719bSwdenkHit 'q':
4058 c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4059 c609719bSwdenk
4060 c609719bSwdenk
4061 85ec0bccSwdenkMinicom warning:
4062 85ec0bccSwdenk================
4063 85ec0bccSwdenk
4064 7152b1d0SwdenkOver time, many people have reported problems when trying to use the
4065 85ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
4066 85ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4067 f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
4068 85ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
4069 85ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
4070 85ec0bccSwdenk
4071 52f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
4072 52f52c14Swdenkconfiguration to your "File transfer protocols" section:
4073 52f52c14Swdenk
4074 52f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
4075 52f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
4076 52f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
4077 52f52c14Swdenk
4078 52f52c14Swdenk
4079 c609719bSwdenkNetBSD Notes:
4080 c609719bSwdenk=============
4081 c609719bSwdenk
4082 c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4083 c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4084 c609719bSwdenk
4085 c609719bSwdenkBuilding requires a cross environment; it is known to work on
4086 c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4087 c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4088 c609719bSwdenkNote that the cross-powerpc package does not install include files;
4089 c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4090 c609719bSwdenkmissing.  This file has to be installed and patched manually:
4091 c609719bSwdenk
4092 c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4093 c609719bSwdenk	# mkdir powerpc
4094 c609719bSwdenk	# ln -s powerpc machine
4095 c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4096 c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4097 c609719bSwdenk
4098 c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4099 c609719bSwdenkand U-Boot include files.
4100 c609719bSwdenk
4101 c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4102 c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4103 c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4104 c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
4105 2a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4106 c609719bSwdenk
4107 c609719bSwdenk
4108 c609719bSwdenkImplementation Internals:
4109 c609719bSwdenk=========================
4110 c609719bSwdenk
4111 c609719bSwdenkThe following is not intended to be a complete description of every
4112 c609719bSwdenkimplementation detail. However, it should help to understand the
4113 c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4114 c609719bSwdenkhardware.
4115 c609719bSwdenk
4116 c609719bSwdenk
4117 c609719bSwdenkInitial Stack, Global Data:
4118 c609719bSwdenk---------------------------
4119 c609719bSwdenk
4120 c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4121 c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4122 c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4123 c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4124 c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4125 c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4126 c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4127 c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4128 c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4129 c609719bSwdenklocked as (mis-) used as memory, etc.
4130 c609719bSwdenk
4131 7152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
4132 0668236bSWolfgang Denk	U-Boot mailing list:
4133 43d9616cSwdenk
4134 43d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4135 43d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
4136 43d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4137 43d9616cSwdenk	...
4138 43d9616cSwdenk
4139 43d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
4140 43d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
4141 43d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
4142 43d9616cSwdenk	is that the cache is being used as a temporary supply of
4143 43d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
4144 11ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
4145 43d9616cSwdenk	can see how this works by studying the cache architecture and
4146 43d9616cSwdenk	operation in the architecture and processor-specific manuals.
4147 43d9616cSwdenk
4148 43d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
4149 43d9616cSwdenk	is another option for the system designer to use as an
4150 11ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
4151 43d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
4152 43d9616cSwdenk	board designers haven't used it for something that would
4153 43d9616cSwdenk	cause you grief during the initial boot! It is frequently not
4154 43d9616cSwdenk	used.
4155 43d9616cSwdenk
4156 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
4157 43d9616cSwdenk	with your processor/board/system design. The default value
4158 43d9616cSwdenk	you will find in any recent u-boot distribution in
4159 8a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
4160 43d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
4161 43d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
4162 43d9616cSwdenk	that are supposed to respond to that address! That code in
4163 43d9616cSwdenk	start.S has been around a while and should work as is when
4164 43d9616cSwdenk	you get the config right.
4165 43d9616cSwdenk
4166 43d9616cSwdenk	-Chris Hallinan
4167 43d9616cSwdenk	DS4.COM, Inc.
4168 43d9616cSwdenk
4169 c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4170 c609719bSwdenkcode for the initialization procedures:
4171 c609719bSwdenk
4172 c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4173 c609719bSwdenk  to write it.
4174 c609719bSwdenk
4175 11ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4176 c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
4177 7152b1d0Swdenk  zation is performed later (when relocating to RAM).
4178 c609719bSwdenk
4179 c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4180 c609719bSwdenk  that.
4181 c609719bSwdenk
4182 c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4183 c609719bSwdenknormal global data to share information beween the code. But it
4184 c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4185 c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4186 c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4187 c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4188 c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4189 c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4190 c609719bSwdenkreserve for this purpose.
4191 c609719bSwdenk
4192 7152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4193 c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4194 c609719bSwdenkGCC's implementation.
4195 c609719bSwdenk
4196 c609719bSwdenkFor PowerPC, the following registers have specific use:
4197 c609719bSwdenk	R1:	stack pointer
4198 e7670f6cSWolfgang Denk	R2:	reserved for system use
4199 c609719bSwdenk	R3-R4:	parameter passing and return values
4200 c609719bSwdenk	R5-R10: parameter passing
4201 c609719bSwdenk	R13:	small data area pointer
4202 c609719bSwdenk	R30:	GOT pointer
4203 c609719bSwdenk	R31:	frame pointer
4204 c609719bSwdenk
4205 e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4206 e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4207 e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4208 c609719bSwdenk
4209 e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4210 c609719bSwdenk
4211 c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4212 c609719bSwdenk    address of the global data structure is known at compile time),
4213 c609719bSwdenk    but it turned out that reserving a register results in somewhat
4214 c609719bSwdenk    smaller code - although the code savings are not that big (on
4215 c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4216 c609719bSwdenk    624 text + 127 data).
4217 c609719bSwdenk
4218 c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
4219 4c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4220 4c58eb55SMike Frysinger
4221 c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
4222 4c58eb55SMike Frysinger
4223 c609719bSwdenkOn ARM, the following registers are used:
4224 c609719bSwdenk
4225 c609719bSwdenk	R0:	function argument word/integer result
4226 c609719bSwdenk	R1-R3:	function argument word
4227 c609719bSwdenk	R9:	GOT pointer
4228 c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4229 c609719bSwdenk	R11:	argument (frame) pointer
4230 c609719bSwdenk	R12:	temporary workspace
4231 c609719bSwdenk	R13:	stack pointer
4232 c609719bSwdenk	R14:	link register
4233 c609719bSwdenk	R15:	program counter
4234 c609719bSwdenk
4235 c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4236 c609719bSwdenk
4237 0df01fd3SThomas ChouOn Nios II, the ABI is documented here:
4238 0df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4239 0df01fd3SThomas Chou
4240 0df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
4241 0df01fd3SThomas Chou
4242 0df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
4243 0df01fd3SThomas Chou    to access small data sections, so gp is free.
4244 0df01fd3SThomas Chou
4245 d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4246 d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4247 c609719bSwdenk
4248 c609719bSwdenkMemory Management:
4249 c609719bSwdenk------------------
4250 c609719bSwdenk
4251 c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4252 c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4253 c609719bSwdenk
4254 c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4255 c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4256 c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4257 c609719bSwdenkphysical memory banks.
4258 c609719bSwdenk
4259 c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4260 c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4261 c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4262 c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
4263 6d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4264 c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4265 c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4266 c609719bSwdenk
4267 c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4268 c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4269 c609719bSwdenk
4270 c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4271 c609719bSwdenkthis:
4272 c609719bSwdenk
4273 c609719bSwdenk	0x0000 0000	Exception Vector code
4274 c609719bSwdenk	      :
4275 c609719bSwdenk	0x0000 1FFF
4276 c609719bSwdenk	0x0000 2000	Free for Application Use
4277 c609719bSwdenk	      :
4278 c609719bSwdenk	      :
4279 c609719bSwdenk
4280 c609719bSwdenk	      :
4281 c609719bSwdenk	      :
4282 c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4283 c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4284 c609719bSwdenk	0x00FC 0000	Malloc Arena
4285 c609719bSwdenk	      :
4286 c609719bSwdenk	0x00FD FFFF
4287 c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4288 c609719bSwdenk	...		eventually: LCD or video framebuffer
4289 c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4290 c609719bSwdenk	0x00FF FFFF	[End of RAM]
4291 c609719bSwdenk
4292 c609719bSwdenk
4293 c609719bSwdenkSystem Initialization:
4294 c609719bSwdenk----------------------
4295 c609719bSwdenk
4296 c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
4297 11ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4298 c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
4299 7152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4300 c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4301 c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4302 c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4303 c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4304 c609719bSwdenkthe caches and the SIU.
4305 c609719bSwdenk
4306 c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4307 c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4308 c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4309 c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4310 c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4311 c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4312 c609719bSwdenkbanks.
4313 c609719bSwdenk
4314 c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
4315 7152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4316 c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4317 c609719bSwdenk0x00000000, with any additional banks following immediately to create
4318 c609719bSwdenkcontiguous memory starting from 0.
4319 c609719bSwdenk
4320 c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4321 c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4322 c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4323 c609719bSwdenkpages, and the final stack is set up.
4324 c609719bSwdenk
4325 c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4326 c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4327 c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4328 c609719bSwdenknew address in RAM.
4329 c609719bSwdenk
4330 c609719bSwdenk
4331 c609719bSwdenkU-Boot Porting Guide:
4332 c609719bSwdenk----------------------
4333 c609719bSwdenk
4334 c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4335 6aff3115Swdenklist, October 2002]
4336 c609719bSwdenk
4337 c609719bSwdenk
4338 c609719bSwdenkint main(int argc, char *argv[])
4339 c609719bSwdenk{
4340 c609719bSwdenk	sighandler_t no_more_time;
4341 c609719bSwdenk
4342 c609719bSwdenk	signal(SIGALRM, no_more_time);
4343 c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4344 c609719bSwdenk
4345 c609719bSwdenk	if (available_money > available_manpower) {
4346 6c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4347 c609719bSwdenk		return 0;
4348 c609719bSwdenk	}
4349 c609719bSwdenk
4350 c609719bSwdenk	Download latest U-Boot source;
4351 c609719bSwdenk
4352 0668236bSWolfgang Denk	Subscribe to u-boot mailing list;
4353 6aff3115Swdenk
4354 6c3fef28SJerry Van Baren	if (clueless)
4355 c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4356 c609719bSwdenk
4357 c609719bSwdenk	while (learning) {
4358 c609719bSwdenk		Read the README file in the top level directory;
4359 7cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4360 6c3fef28SJerry Van Baren		Read applicable doc/*.README;
4361 c609719bSwdenk		Read the source, Luke;
4362 6c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4363 c609719bSwdenk	}
4364 c609719bSwdenk
4365 6c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
4366 6c3fef28SJerry Van Baren		Buy a BDI3000;
4367 6c3fef28SJerry Van Baren	else
4368 c609719bSwdenk		Add a lot of aggravation and time;
4369 c609719bSwdenk
4370 6c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
4371 6c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
4372 6c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
4373 6c3fef28SJerry Van Baren	} else {
4374 c609719bSwdenk		Create your own board support subdirectory;
4375 6c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
4376 6c3fef28SJerry Van Baren	}
4377 6c3fef28SJerry Van Baren	Edit new board/<myboard> files
4378 6c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4379 c609719bSwdenk
4380 6c3fef28SJerry Van Baren	while (!accepted) {
4381 c609719bSwdenk		while (!running) {
4382 c609719bSwdenk			do {
4383 c609719bSwdenk				Add / modify source code;
4384 c609719bSwdenk			} until (compiles);
4385 c609719bSwdenk			Debug;
4386 c609719bSwdenk			if (clueless)
4387 c609719bSwdenk				email("Hi, I am having problems...");
4388 c609719bSwdenk		}
4389 6c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
4390 6c3fef28SJerry Van Baren		if (reasonable critiques)
4391 6c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
4392 6c3fef28SJerry Van Baren		else
4393 6c3fef28SJerry Van Baren			Defend code as written;
4394 6c3fef28SJerry Van Baren	}
4395 c609719bSwdenk
4396 c609719bSwdenk	return 0;
4397 c609719bSwdenk}
4398 c609719bSwdenk
4399 c609719bSwdenkvoid no_more_time (int sig)
4400 c609719bSwdenk{
4401 c609719bSwdenk      hire_a_guru();
4402 c609719bSwdenk}
4403 c609719bSwdenk
4404 c609719bSwdenk
4405 c609719bSwdenkCoding Standards:
4406 c609719bSwdenk-----------------
4407 c609719bSwdenk
4408 c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
4409 2c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
4410 2c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
4411 2c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
4412 2c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4413 c609719bSwdenk
4414 2c051651SDetlev ZundelSource files originating from a different project (for example the
4415 2c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
4416 2c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
4417 2c051651SDetlev Zundelsources.
4418 2c051651SDetlev Zundel
4419 2c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
4420 2c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
4421 2c051651SDetlev Zundelin your code.
4422 c609719bSwdenk
4423 c178d3daSwdenkPlease also stick to the following formatting rules:
4424 180d3f74Swdenk- remove any trailing white space
4425 180d3f74Swdenk- use TAB characters for indentation, not spaces
4426 180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4427 180d3f74Swdenk- do not add more than 2 empty lines to source files
4428 180d3f74Swdenk- do not add trailing empty lines to source files
4429 180d3f74Swdenk
4430 c609719bSwdenkSubmissions which do not conform to the standards may be returned
4431 c609719bSwdenkwith a request to reformat the changes.
4432 c609719bSwdenk
4433 c609719bSwdenk
4434 c609719bSwdenkSubmitting Patches:
4435 c609719bSwdenk-------------------
4436 c609719bSwdenk
4437 c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4438 c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4439 c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4440 c609719bSwdenk
4441 0d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4442 218ca724SWolfgang Denk
4443 0668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4444 0668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
4445 0668236bSWolfgang Denk
4446 c609719bSwdenkWhen you send a patch, please include the following information with
4447 c609719bSwdenkit:
4448 c609719bSwdenk
4449 c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4450 c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4451 c609719bSwdenk  patch actually fixes something.
4452 c609719bSwdenk
4453 c609719bSwdenk* For new features: a description of the feature and your
4454 c609719bSwdenk  implementation.
4455 c609719bSwdenk
4456 c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4457 c609719bSwdenk
4458 c609719bSwdenk* For major contributions, your entry to the CREDITS file
4459 c609719bSwdenk
4460 c609719bSwdenk* When you add support for a new board, don't forget to add this
4461 c609719bSwdenk  board to the MAKEALL script, too.
4462 c609719bSwdenk
4463 c609719bSwdenk* If your patch adds new configuration options, don't forget to
4464 c609719bSwdenk  document these in the README file.
4465 c609719bSwdenk
4466 218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4467 218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4468 218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4469 218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4470 218ca724SWolfgang Denk  with some other mail clients.
4471 c609719bSwdenk
4472 218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4473 218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4474 218ca724SWolfgang Denk  GNU diff.
4475 6dff5529Swdenk
4476 218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4477 218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4478 218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4479 218ca724SWolfgang Denk  affected files).
4480 218ca724SWolfgang Denk
4481 218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4482 218ca724SWolfgang Denk  and compressed attachments must not be used.
4483 c609719bSwdenk
4484 52f52c14Swdenk* If one logical set of modifications affects or creates several
4485 52f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
4486 52f52c14Swdenk
4487 52f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
4488 52f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
4489 52f52c14Swdenk
4490 52f52c14Swdenk
4491 c609719bSwdenkNotes:
4492 c609719bSwdenk
4493 c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4494 c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4495 c609719bSwdenk  for any of the boards.
4496 c609719bSwdenk
4497 c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4498 c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4499 c609719bSwdenk  returned with a request to re-formatting / split it.
4500 c609719bSwdenk
4501 c609719bSwdenk* If you modify existing code, make sure that your new code does not
4502 c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4503 c609719bSwdenk  When adding new features, these should compile conditionally only
4504 c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4505 c609719bSwdenk  disabled must not need more memory than the old code without your
4506 c609719bSwdenk  modification.
4507 90dc6704Swdenk
4508 0668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
4509 0668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
4510 0668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
4511 0668236bSWolfgang Denk  bigger than the size limit should be avoided.
4512