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