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