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