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