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