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