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