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