blob: f9c1978c3bfb8a7af03d0463e9c2acb4a7d4c98d [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
wdenk99408ba2005-02-24 22:44:16 +00002# (C) Copyright 2000 - 2005
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
wdenkc6097192002-11-03 00:24:07 +000054who contributed the specific port.
55
wdenkc6097192002-11-03 00:24:07 +000056
57Where to get help:
58==================
59
wdenk24ee89b2002-11-03 17:56:27 +000060In case you have questions about, problems with or contributions for
61U-Boot you should send a message to the U-Boot mailing list at
62<u-boot-users@lists.sourceforge.net>. There is also an archive of
63previous traffic on the mailing list - please search the archive
wdenkc6097192002-11-03 00:24:07 +000064before asking FAQ's. Please see
65http://lists.sourceforge.net/lists/listinfo/u-boot-users/
66
67
68Where we come from:
69===================
70
71- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000072- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000073- clean up code
74- make it easier to add custom boards
75- make it possible to add other [PowerPC] CPUs
76- extend functions, especially:
77 * Provide extended interface to Linux boot loader
78 * S-Record download
79 * network boot
80 * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000081- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000082- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000083- create U-Boot project (http://sourceforge.net/projects/u-boot)
84
85
86Names and Spelling:
87===================
88
89The "official" name of this project is "Das U-Boot". The spelling
90"U-Boot" shall be used in all written text (documentation, comments
91in source files etc.). Example:
92
93 This is the README file for the U-Boot project.
94
95File names etc. shall be based on the string "u-boot". Examples:
96
97 include/asm-ppc/u-boot.h
98
99 #include <asm/u-boot.h>
100
101Variable names, preprocessor constants etc. shall be either based on
102the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000103
wdenk24ee89b2002-11-03 17:56:27 +0000104 U_BOOT_VERSION u_boot_logo
105 IH_OS_U_BOOT u_boot_hush_start
106
wdenkc6097192002-11-03 00:24:07 +0000107
wdenk7474aca2002-12-17 17:55:09 +0000108Versioning:
109===========
110
111U-Boot uses a 3 level version number containing a version, a
112sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
113sub-version "34", and patchlevel "4".
114
115The patchlevel is used to indicate certain stages of development
116between released versions, i. e. officially released versions of
117U-Boot will always have a patchlevel of "0".
118
119
wdenkc6097192002-11-03 00:24:07 +0000120Directory Hierarchy:
121====================
122
wdenkeb20ad32003-09-05 23:19:14 +0000123- board Board dependent files
124- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000125- cpu CPU specific files
wdenk337f5652004-10-28 00:09:35 +0000126 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenkd729d302004-02-27 00:07:27 +0000127 - arm720t Files specific to ARM 720 CPUs
128 - arm920t Files specific to ARM 920 CPUs
wdenk91fcc952005-04-06 13:52:31 +0000129 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk337f5652004-10-28 00:09:35 +0000130 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenkf8e9a232004-10-09 22:21:29 +0000131 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenkd729d302004-02-27 00:07:27 +0000132 - arm925t Files specific to ARM 925 CPUs
133 - arm926ejs Files specific to ARM 926 CPUs
wdenkf8062712005-01-09 23:16:25 +0000134 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk64702552006-10-24 14:27:35 +0200135 - at32ap Files specific to Atmel AVR32 AP CPUs
wdenkd729d302004-02-27 00:07:27 +0000136 - i386 Files specific to i386 CPUs
137 - ixp Files specific to Intel XScale IXP CPUs
wdenk337f5652004-10-28 00:09:35 +0000138 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
wdenkd729d302004-02-27 00:07:27 +0000139 - mips Files specific to MIPS CPUs
wdenk337f5652004-10-28 00:09:35 +0000140 - mpc5xx Files specific to Freescale MPC5xx CPUs
141 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
142 - mpc8xx Files specific to Freescale MPC8xx CPUs
143 - mpc8220 Files specific to Freescale MPC8220 CPUs
144 - mpc824x Files specific to Freescale MPC824x CPUs
145 - mpc8260 Files specific to Freescale MPC8260 CPUs
146 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenkd729d302004-02-27 00:07:27 +0000147 - nios Files specific to Altera NIOS CPUs
wdenkef3386f2004-10-10 21:27:30 +0000148 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0ee70772005-09-23 11:05:55 +0200149 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenkd729d302004-02-27 00:07:27 +0000150 - pxa Files specific to Intel XScale PXA CPUs
151 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
152 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000153- disk Code for disk drive partition handling
154- doc Documentation (don't expect too much)
wdenkeb20ad32003-09-05 23:19:14 +0000155- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000156- dtt Digital Thermometer and Thermostat drivers
157- examples Example code for standalone applications, etc.
158- include Header Files
wdenkd729d302004-02-27 00:07:27 +0000159- lib_arm Files generic to ARM architecture
Wolfgang Denk83c15852006-10-24 14:21:16 +0200160- lib_avr32 Files generic to AVR32 architecture
wdenkd729d302004-02-27 00:07:27 +0000161- lib_generic Files generic to all architectures
162- lib_i386 Files generic to i386 architecture
163- lib_m68k Files generic to m68k architecture
164- lib_mips Files generic to MIPS architecture
165- lib_nios Files generic to NIOS architecture
166- lib_ppc Files generic to PowerPC architecture
Gerald Van Barend6abef42007-03-31 12:23:51 -0400167- libfdt Library files to support flattened device trees
wdenkc6097192002-11-03 00:24:07 +0000168- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000169- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000170- rtc Real Time Clock drivers
171- tools Tools to build S-Record or U-Boot images, etc.
172
wdenkc6097192002-11-03 00:24:07 +0000173Software Configuration:
174=======================
175
176Configuration is usually done using C preprocessor defines; the
177rationale behind that is to avoid dead code whenever possible.
178
179There are two classes of configuration variables:
180
181* Configuration _OPTIONS_:
182 These are selectable by the user and have names beginning with
183 "CONFIG_".
184
185* Configuration _SETTINGS_:
186 These depend on the hardware etc. and should not be meddled with if
187 you don't know what you're doing; they have names beginning with
188 "CFG_".
189
190Later we will add a configuration tool - probably similar to or even
191identical to what's used for the Linux kernel. Right now, we have to
192do the configuration by hand, which means creating some symbolic
193links and editing some configuration files. We use the TQM8xxL boards
194as an example here.
195
196
197Selection of Processor Architecture and Board Type:
198---------------------------------------------------
199
200For all supported boards there are ready-to-use default
201configurations available; just type "make <board_name>_config".
202
203Example: For a TQM823L module type:
204
205 cd u-boot
206 make TQM823L_config
207
208For the Cogent platform, you need to specify the cpu type as well;
209e.g. "make cogent_mpc8xx_config". And also configure the cogent
210directory according to the instructions in cogent/README.
211
212
213Configuration Options:
214----------------------
215
216Configuration depends on the combination of board and CPU type; all
217such information is kept in a configuration file
218"include/configs/<board_name>.h".
219
220Example: For a TQM823L module, all configuration settings are in
221"include/configs/TQM823L.h".
222
223
wdenk1272e232002-11-10 22:06:23 +0000224Many of the options are named exactly as the corresponding Linux
225kernel configuration options. The intention is to make it easier to
226build a config tool - later.
227
228
wdenkc6097192002-11-03 00:24:07 +0000229The following options need to be configured:
230
231- CPU Type: Define exactly one of
232
233 PowerPC based CPUs:
234 -------------------
235 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
wdenk359733b2003-03-31 17:27:09 +0000236 or CONFIG_MPC5xx
wdenk337f5652004-10-28 00:09:35 +0000237 or CONFIG_MPC8220
wdenkc6097192002-11-03 00:24:07 +0000238 or CONFIG_MPC824X, CONFIG_MPC8260
wdenk9c53f402003-10-15 23:53:47 +0000239 or CONFIG_MPC85xx
wdenkc6097192002-11-03 00:24:07 +0000240 or CONFIG_IOP480
241 or CONFIG_405GP
wdenk232fe0b2003-09-02 22:48:03 +0000242 or CONFIG_405EP
wdenkc6097192002-11-03 00:24:07 +0000243 or CONFIG_440
244 or CONFIG_MPC74xx
wdenkaaf48a92003-06-20 23:10:58 +0000245 or CONFIG_750FX
wdenkc6097192002-11-03 00:24:07 +0000246
247 ARM based CPUs:
248 ---------------
249 CONFIG_SA1110
250 CONFIG_ARM7
251 CONFIG_PXA250
Rodolfo Giometti6659da82007-03-26 12:03:36 +0200252 CONFIG_PXA27X
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100253 CONFIG_CPU_MONAHANS
wdenkc6097192002-11-03 00:24:07 +0000254
wdenk12490652004-04-18 21:13:41 +0000255 MicroBlaze based CPUs:
256 ----------------------
wdenk20a61222004-07-10 23:48:41 +0000257 CONFIG_MICROBLAZE
wdenk12490652004-04-18 21:13:41 +0000258
wdenkef3386f2004-10-10 21:27:30 +0000259 Nios-2 based CPUs:
260 ----------------------
261 CONFIG_NIOS2
262
Wolfgang Denk64702552006-10-24 14:27:35 +0200263 AVR32 based CPUs:
264 ----------------------
265 CONFIG_AT32AP
wdenkc6097192002-11-03 00:24:07 +0000266
267- Board Type: Define exactly one of
268
269 PowerPC based boards:
270 ---------------------
271
Detlev Zundel07c4f5f2006-04-24 17:52:01 +0200272 CONFIG_ADCIOP CONFIG_FPS860L CONFIG_OXC
273 CONFIG_ADS860 CONFIG_GEN860T CONFIG_PCI405
274 CONFIG_AMX860 CONFIG_GENIETV CONFIG_PCIPPC2
275 CONFIG_AP1000 CONFIG_GTH CONFIG_PCIPPC6
276 CONFIG_AR405 CONFIG_gw8260 CONFIG_pcu_e
277 CONFIG_BAB7xx CONFIG_hermes CONFIG_PIP405
278 CONFIG_BC3450 CONFIG_hymod CONFIG_PM826
Wolfgang Denk315b46a2006-03-17 11:42:53 +0100279 CONFIG_c2mon CONFIG_IAD210 CONFIG_ppmc8260
280 CONFIG_CANBT CONFIG_ICU862 CONFIG_QS823
281 CONFIG_CCM CONFIG_IP860 CONFIG_QS850
282 CONFIG_CMI CONFIG_IPHASE4539 CONFIG_QS860T
283 CONFIG_cogent_mpc8260 CONFIG_IVML24 CONFIG_RBC823
284 CONFIG_cogent_mpc8xx CONFIG_IVML24_128 CONFIG_RPXClassic
285 CONFIG_CPCI405 CONFIG_IVML24_256 CONFIG_RPXlite
286 CONFIG_CPCI4052 CONFIG_IVMS8 CONFIG_RPXsuper
287 CONFIG_CPCIISER4 CONFIG_IVMS8_128 CONFIG_rsdproto
288 CONFIG_CPU86 CONFIG_IVMS8_256 CONFIG_sacsng
289 CONFIG_CRAYL1 CONFIG_JSE CONFIG_Sandpoint8240
290 CONFIG_CSB272 CONFIG_LANTEC CONFIG_Sandpoint8245
291 CONFIG_CU824 CONFIG_LITE5200B CONFIG_sbc8260
292 CONFIG_DASA_SIM CONFIG_lwmon CONFIG_sbc8560
293 CONFIG_DB64360 CONFIG_MBX CONFIG_SM850
294 CONFIG_DB64460 CONFIG_MBX860T CONFIG_SPD823TS
295 CONFIG_DU405 CONFIG_MHPC CONFIG_STXGP3
296 CONFIG_DUET_ADS CONFIG_MIP405 CONFIG_SXNI855T
297 CONFIG_EBONY CONFIG_MOUSSE CONFIG_TQM823L
298 CONFIG_ELPPC CONFIG_MPC8260ADS CONFIG_TQM8260
299 CONFIG_ELPT860 CONFIG_MPC8540ADS CONFIG_TQM850L
300 CONFIG_ep8260 CONFIG_MPC8540EVAL CONFIG_TQM855L
301 CONFIG_ERIC CONFIG_MPC8560ADS CONFIG_TQM860L
302 CONFIG_ESTEEM192E CONFIG_MUSENKI CONFIG_TTTech
303 CONFIG_ETX094 CONFIG_MVS1 CONFIG_UTX8245
304 CONFIG_EVB64260 CONFIG_NETPHONE CONFIG_V37
305 CONFIG_FADS823 CONFIG_NETTA CONFIG_W7OLMC
306 CONFIG_FADS850SAR CONFIG_NETVIA CONFIG_W7OLMG
307 CONFIG_FADS860T CONFIG_NX823 CONFIG_WALNUT
308 CONFIG_FLAGADM CONFIG_OCRTC CONFIG_ZPC1900
309 CONFIG_FPS850L CONFIG_ORSG CONFIG_ZUMA
Wolfgang Denk3193a652005-10-09 01:41:48 +0200310
wdenkc6097192002-11-03 00:24:07 +0000311 ARM based boards:
312 -----------------
313
Wolfgang Denk4dc11462005-09-26 01:06:33 +0200314 CONFIG_ARMADILLO, CONFIG_AT91RM9200DK, CONFIG_CERF250,
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100315 CONFIG_CSB637, CONFIG_DELTA, CONFIG_DNP1110,
Wolfgang Denkc80857e2006-07-21 11:56:05 +0200316 CONFIG_EP7312, CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE,
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200317 CONFIG_IMPA7, CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610,
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100318 CONFIG_KB9202, CONFIG_LART, CONFIG_LPD7A400,
319 CONFIG_LUBBOCK, CONFIG_OSK_OMAP5912, CONFIG_OMAP2420H4,
Heiko Schocher221a5062006-05-02 07:51:46 +0200320 CONFIG_PLEB2, CONFIG_SHANNON, CONFIG_P2_OMAP730,
321 CONFIG_SMDK2400, CONFIG_SMDK2410, CONFIG_TRAB,
322 CONFIG_VCMA9
wdenkc6097192002-11-03 00:24:07 +0000323
wdenk12490652004-04-18 21:13:41 +0000324 MicroBlaze based boards:
325 ------------------------
326
327 CONFIG_SUZAKU
328
wdenkef3386f2004-10-10 21:27:30 +0000329 Nios-2 based boards:
330 ------------------------
331
332 CONFIG_PCI5441 CONFIG_PK1C20
Scott McNutt2ca00852006-06-08 13:37:39 -0400333 CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40
wdenkef3386f2004-10-10 21:27:30 +0000334
Wolfgang Denk994ad962006-10-24 14:42:37 +0200335 AVR32 based boards:
336 -------------------
337
338 CONFIG_ATSTK1000
339
340- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
341 Define exactly one of
342 CONFIG_ATSTK1002
343
wdenkc6097192002-11-03 00:24:07 +0000344
345- CPU Module Type: (if CONFIG_COGENT is defined)
346 Define exactly one of
347 CONFIG_CMA286_60_OLD
348--- FIXME --- not tested yet:
349 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
350 CONFIG_CMA287_23, CONFIG_CMA287_50
351
352- Motherboard Type: (if CONFIG_COGENT is defined)
353 Define exactly one of
354 CONFIG_CMA101, CONFIG_CMA102
355
356- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
357 Define one or more of
358 CONFIG_CMA302
359
360- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
361 Define one or more of
362 CONFIG_LCD_HEARTBEAT - update a character position on
363 the lcd display every second with
364 a "rotator" |\-/|\-/
365
wdenk2bb11052003-07-17 23:16:40 +0000366- Board flavour: (if CONFIG_MPC8260ADS is defined)
367 CONFIG_ADSTYPE
368 Possible values are:
369 CFG_8260ADS - original MPC8260ADS
wdenkad276f22004-01-04 16:28:35 +0000370 CFG_8266ADS - MPC8266ADS
wdenk2f0812d2003-10-08 22:45:44 +0000371 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
wdenk3902d702004-04-15 18:22:41 +0000372 CFG_8272ADS - MPC8272ADS
wdenk2bb11052003-07-17 23:16:40 +0000373
wdenkc6097192002-11-03 00:24:07 +0000374- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000375 Define exactly one of
376 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000377
wdenkfde37042004-01-31 20:06:54 +0000378- 8xx CPU Options: (if using an MPC8xx cpu)
wdenk20bddb32004-09-28 17:59:53 +0000379 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
380 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000381 e.g. if there is no 32KHz
382 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000383 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
384 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000385
wdenk20bddb32004-09-28 17:59:53 +0000386- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
387 CFG_8xx_CPUCLK_MIN
388 CFG_8xx_CPUCLK_MAX
389 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000390 See doc/README.MPC866
391
392 CFG_MEASURE_CPUCLK
393
wdenk544e9732004-02-06 23:19:44 +0000394 Define this to measure the actual CPU clock instead
395 of relying on the correctness of the configured
396 values. Mostly useful for board bringup to make sure
397 the PLL is locked at the intended frequency. Note
398 that this requires a (stable) reference clock (32 kHz
wdenk20bddb32004-09-28 17:59:53 +0000399 RTC clock or CFG_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000400
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100401- Intel Monahans options:
402 CFG_MONAHANS_RUN_MODE_OSC_RATIO
403
404 Defines the Monahans run mode to oscillator
405 ratio. Valid values are 8, 16, 24, 31. The core
406 frequency is this value multiplied by 13 MHz.
407
408 CFG_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200409
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100410 Defines the Monahans turbo mode to oscillator
411 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200412 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100413 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200414
wdenk9b7f3842003-10-09 20:09:04 +0000415- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000416 CONFIG_CLOCKS_IN_MHZ
417
418 U-Boot stores all clock information in Hz
419 internally. For binary compatibility with older Linux
420 kernels (which expect the clocks passed in the
421 bd_info data to be in MHz) the environment variable
422 "clocks_in_mhz" can be defined so that U-Boot
423 converts clock data to MHZ before passing it to the
424 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000425 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
426 "clocks_in_mhz=1" is automatically included in the
427 default environment.
428
wdenk9b7f3842003-10-09 20:09:04 +0000429 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
430
431 When transfering memsize parameter to linux, some versions
432 expect it to be in bytes, others in MB.
433 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
434
Gerald Van Barend6abef42007-03-31 12:23:51 -0400435 CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200436
437 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400438 passed using flattened device trees (based on open firmware
439 concepts).
440
441 CONFIG_OF_LIBFDT
442 * New libfdt-based support
443 * Adds the "fdt" command
444 * The bootm command does _not_ modify the fdt
445
446 CONFIG_OF_FLAT_TREE
447 * Deprecated, see CONFIG_OF_LIBFDT
448 * Original ft_build.c-based support
449 * Automatically modifies the dft as part of the bootm command
450 * The environment variable "disable_of", when set,
451 disables this functionality.
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200452
453 CONFIG_OF_FLAT_TREE_MAX_SIZE
454
455 The maximum size of the constructed OF tree.
456
457 OF_CPU - The proper name of the cpus node.
Kumar Galae40c2b52006-01-11 13:59:02 -0600458 OF_SOC - The proper name of the soc node.
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200459 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600460 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200461
Kumar Gala4ce14312006-01-11 13:49:31 -0600462 CONFIG_OF_HAS_BD_T
463
Gerald Van Barend6abef42007-03-31 12:23:51 -0400464 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
465 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
466 will have a copy of the bd_t. Space should be
467 pre-allocated in the dts for the bd_t.
Kumar Gala4ce14312006-01-11 13:49:31 -0600468
469 CONFIG_OF_HAS_UBOOT_ENV
Stefan Roese5d5ce292006-03-13 11:16:36 +0100470
Gerald Van Barend6abef42007-03-31 12:23:51 -0400471 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
472 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
473 will have a copy of u-boot's environment variables
Kumar Gala4ce14312006-01-11 13:49:31 -0600474
Kumar Gala1e26aa52006-01-11 13:54:17 -0600475 CONFIG_OF_BOARD_SETUP
476
477 Board code has addition modification that it wants to make
478 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000479
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500480 CONFIG_OF_BOOT_CPU
481
482 This define fills in the correct boot cpu in the boot
483 param header, the default value is zero if undefined.
484
wdenkda04a8b2004-08-02 23:22:59 +0000485- Serial Ports:
486 CFG_PL010_SERIAL
487
488 Define this if you want support for Amba PrimeCell PL010 UARTs.
489
490 CFG_PL011_SERIAL
491
492 Define this if you want support for Amba PrimeCell PL011 UARTs.
493
494 CONFIG_PL011_CLOCK
495
496 If you have Amba PrimeCell PL011 UARTs, set this variable to
497 the clock speed of the UARTs.
498
499 CONFIG_PL01x_PORTS
500
501 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
502 define this to a list of base addresses for each (supported)
503 port. See e.g. include/configs/versatile.h
504
505
wdenkc6097192002-11-03 00:24:07 +0000506- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000507 Depending on board, define exactly one serial port
508 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
509 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
510 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000511
512 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
513 port routines must be defined elsewhere
514 (i.e. serial_init(), serial_getc(), ...)
515
516 CONFIG_CFB_CONSOLE
517 Enables console device for a color framebuffer. Needs following
518 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
519 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
520 (default big endian)
521 VIDEO_HW_RECTFILL graphic chip supports
522 rectangle fill
523 (cf. smiLynxEM)
524 VIDEO_HW_BITBLT graphic chip supports
525 bit-blit (cf. smiLynxEM)
526 VIDEO_VISIBLE_COLS visible pixel columns
527 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000528 VIDEO_VISIBLE_ROWS visible pixel rows
529 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000530 VIDEO_DATA_FORMAT graphic data format
531 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000532 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000533 VIDEO_KBD_INIT_FCT keyboard int fct
534 (i.e. i8042_kbd_init())
535 VIDEO_TSTC_FCT test char fct
536 (i.e. i8042_tstc)
537 VIDEO_GETC_FCT get char fct
538 (i.e. i8042_getc)
539 CONFIG_CONSOLE_CURSOR cursor drawing on/off
540 (requires blink timer
541 cf. i8042.c)
542 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
543 CONFIG_CONSOLE_TIME display time/date info in
544 upper right corner
545 (requires CFG_CMD_DATE)
546 CONFIG_VIDEO_LOGO display Linux logo in
547 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000548 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
549 linux_logo.h for logo.
550 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000551 CONFIG_CONSOLE_EXTRA_INFO
552 addional board info beside
553 the logo
554
wdenk4a5c8a72003-03-06 00:02:04 +0000555 When CONFIG_CFB_CONSOLE is defined, video console is
556 default i/o. Serial console can be forced with
557 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000558
wdenk1ebf41e2004-01-02 14:00:00 +0000559 When CONFIG_SILENT_CONSOLE is defined, all console
560 messages (by U-Boot and Linux!) can be silenced with
561 the "silent" environment variable. See
562 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000563
wdenkc6097192002-11-03 00:24:07 +0000564- Console Baudrate:
565 CONFIG_BAUDRATE - in bps
566 Select one of the baudrates listed in
567 CFG_BAUDRATE_TABLE, see below.
wdenk174e0e52003-12-07 22:27:15 +0000568 CFG_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000569
570- Interrupt driven serial port input:
571 CONFIG_SERIAL_SOFTWARE_FIFO
572
573 PPC405GP only.
574 Use an interrupt handler for receiving data on the
575 serial port. It also enables using hardware handshake
576 (RTS/CTS) and UART's built-in FIFO. Set the number of
577 bytes the interrupt driven input buffer should have.
578
wdenkf16b5162004-03-23 21:43:07 +0000579 Leave undefined to disable this feature, including
580 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000581
stroese3d24d6e2003-05-23 11:39:05 +0000582- Console UART Number:
583 CONFIG_UART1_CONSOLE
584
Wolfgang Denk0ee70772005-09-23 11:05:55 +0200585 AMCC PPC4xx only.
stroese3d24d6e2003-05-23 11:39:05 +0000586 If defined internal UART1 (and not UART0) is used
587 as default U-Boot console.
588
wdenkc6097192002-11-03 00:24:07 +0000589- Boot Delay: CONFIG_BOOTDELAY - in seconds
590 Delay before automatically booting the default image;
591 set to -1 to disable autoboot.
592
593 See doc/README.autoboot for these options that
594 work with CONFIG_BOOTDELAY. None are required.
595 CONFIG_BOOT_RETRY_TIME
596 CONFIG_BOOT_RETRY_MIN
597 CONFIG_AUTOBOOT_KEYED
598 CONFIG_AUTOBOOT_PROMPT
599 CONFIG_AUTOBOOT_DELAY_STR
600 CONFIG_AUTOBOOT_STOP_STR
601 CONFIG_AUTOBOOT_DELAY_STR2
602 CONFIG_AUTOBOOT_STOP_STR2
603 CONFIG_ZERO_BOOTDELAY_CHECK
604 CONFIG_RESET_TO_RETRY
605
606- Autoboot Command:
607 CONFIG_BOOTCOMMAND
608 Only needed when CONFIG_BOOTDELAY is enabled;
609 define a command string that is automatically executed
610 when no character is read on the console interface
611 within "Boot Delay" after reset.
612
613 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000614 This can be used to pass arguments to the bootm
615 command. The value of CONFIG_BOOTARGS goes into the
616 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000617
618 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000619 The value of these goes into the environment as
620 "ramboot" and "nfsboot" respectively, and can be used
621 as a convenience, when switching between booting from
622 ram and nfs.
wdenkc6097192002-11-03 00:24:07 +0000623
624- Pre-Boot Commands:
625 CONFIG_PREBOOT
626
627 When this option is #defined, the existence of the
628 environment variable "preboot" will be checked
629 immediately before starting the CONFIG_BOOTDELAY
630 countdown and/or running the auto-boot command resp.
631 entering interactive mode.
632
633 This feature is especially useful when "preboot" is
634 automatically generated or modified. For an example
635 see the LWMON board specific code: here "preboot" is
636 modified when the user holds down a certain
637 combination of keys on the (special) keyboard when
638 booting the systems
639
640- Serial Download Echo Mode:
641 CONFIG_LOADS_ECHO
642 If defined to 1, all characters received during a
643 serial download (using the "loads" command) are
644 echoed back. This might be needed by some terminal
645 emulations (like "cu"), but may as well just take
646 time on others. This setting #define's the initial
647 value of the "loads_echo" environment variable.
648
649- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
650 CONFIG_KGDB_BAUDRATE
651 Select one of the baudrates listed in
652 CFG_BAUDRATE_TABLE, see below.
653
654- Monitor Functions:
655 CONFIG_COMMANDS
656 Most monitor functions can be selected (or
657 de-selected) by adjusting the definition of
658 CONFIG_COMMANDS; to select individual functions,
659 #define CONFIG_COMMANDS by "OR"ing any of the
660 following values:
661
662 #define enables commands:
663 -------------------------
664 CFG_CMD_ASKENV * ask for env variable
wdenk1f197c62003-09-15 18:00:00 +0000665 CFG_CMD_AUTOSCRIPT Autoscript Support
wdenkc6097192002-11-03 00:24:07 +0000666 CFG_CMD_BDI bdinfo
wdenkda04a8b2004-08-02 23:22:59 +0000667 CFG_CMD_BEDBUG * Include BedBug Debugger
wdenk544e9732004-02-06 23:19:44 +0000668 CFG_CMD_BMP * BMP support
wdenkda04a8b2004-08-02 23:22:59 +0000669 CFG_CMD_BSP * Board specific commands
wdenkc6097192002-11-03 00:24:07 +0000670 CFG_CMD_BOOTD bootd
wdenkda04a8b2004-08-02 23:22:59 +0000671 CFG_CMD_CACHE * icache, dcache
wdenkc6097192002-11-03 00:24:07 +0000672 CFG_CMD_CONSOLE coninfo
673 CFG_CMD_DATE * support for RTC, date/time...
wdenkda04a8b2004-08-02 23:22:59 +0000674 CFG_CMD_DHCP * DHCP support
wdenk544e9732004-02-06 23:19:44 +0000675 CFG_CMD_DIAG * Diagnostics
676 CFG_CMD_DOC * Disk-On-Chip Support
wdenkda04a8b2004-08-02 23:22:59 +0000677 CFG_CMD_DTT * Digital Therm and Thermostat
Wolfgang Denk582f3dd2006-03-12 16:51:59 +0100678 CFG_CMD_ECHO echo arguments
wdenkc6097192002-11-03 00:24:07 +0000679 CFG_CMD_EEPROM * EEPROM read/write support
wdenkda04a8b2004-08-02 23:22:59 +0000680 CFG_CMD_ELF * bootelf, bootvx
wdenkc6097192002-11-03 00:24:07 +0000681 CFG_CMD_ENV saveenv
682 CFG_CMD_FDC * Floppy Disk Support
wdenkda04a8b2004-08-02 23:22:59 +0000683 CFG_CMD_FAT * FAT partition support
wdenk591dda52002-11-18 00:14:45 +0000684 CFG_CMD_FDOS * Dos diskette Support
wdenkc6097192002-11-03 00:24:07 +0000685 CFG_CMD_FLASH flinfo, erase, protect
686 CFG_CMD_FPGA FPGA device initialization support
wdenk544e9732004-02-06 23:19:44 +0000687 CFG_CMD_HWFLOW * RTS/CTS hw flow control
wdenkc6097192002-11-03 00:24:07 +0000688 CFG_CMD_I2C * I2C serial bus support
689 CFG_CMD_IDE * IDE harddisk support
690 CFG_CMD_IMI iminfo
wdenk544e9732004-02-06 23:19:44 +0000691 CFG_CMD_IMLS List all found images
wdenkc6097192002-11-03 00:24:07 +0000692 CFG_CMD_IMMAP * IMMR dump support
693 CFG_CMD_IRQ * irqinfo
wdenkda04a8b2004-08-02 23:22:59 +0000694 CFG_CMD_ITEST Integer/string test of 2 values
wdenk544e9732004-02-06 23:19:44 +0000695 CFG_CMD_JFFS2 * JFFS2 Support
wdenkc6097192002-11-03 00:24:07 +0000696 CFG_CMD_KGDB * kgdb
697 CFG_CMD_LOADB loadb
698 CFG_CMD_LOADS loads
699 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
wdenk64519362004-07-11 17:40:54 +0000700 loop, loopw, mtest
wdenk544e9732004-02-06 23:19:44 +0000701 CFG_CMD_MISC Misc functions like sleep etc
wdenkda04a8b2004-08-02 23:22:59 +0000702 CFG_CMD_MMC * MMC memory mapped support
703 CFG_CMD_MII * MII utility commands
wdenk544e9732004-02-06 23:19:44 +0000704 CFG_CMD_NAND * NAND support
wdenkc6097192002-11-03 00:24:07 +0000705 CFG_CMD_NET bootp, tftpboot, rarpboot
706 CFG_CMD_PCI * pciinfo
707 CFG_CMD_PCMCIA * PCMCIA support
wdenk544e9732004-02-06 23:19:44 +0000708 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
709 CFG_CMD_PORTIO * Port I/O
wdenkc6097192002-11-03 00:24:07 +0000710 CFG_CMD_REGINFO * Register dump
711 CFG_CMD_RUN run command in env variable
wdenkda04a8b2004-08-02 23:22:59 +0000712 CFG_CMD_SAVES * save S record dump
wdenkc6097192002-11-03 00:24:07 +0000713 CFG_CMD_SCSI * SCSI Support
wdenk544e9732004-02-06 23:19:44 +0000714 CFG_CMD_SDRAM * print SDRAM configuration information
wdenkfa66e932005-04-03 14:52:59 +0000715 (requires CFG_CMD_I2C)
wdenkc6097192002-11-03 00:24:07 +0000716 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
717 CFG_CMD_SPI * SPI serial bus support
718 CFG_CMD_USB * USB support
wdenk544e9732004-02-06 23:19:44 +0000719 CFG_CMD_VFD * VFD support (TRAB)
wdenkc6097192002-11-03 00:24:07 +0000720 CFG_CMD_BSP * Board SPecific functions
wdenk145d2c12004-04-15 21:48:45 +0000721 CFG_CMD_CDP * Cisco Discover Protocol support
Michal Simek95945832007-05-05 18:54:42 +0200722 CFG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000723 -----------------------------------------------
724 CFG_CMD_ALL all
725
wdenk7dd13292004-07-11 20:04:51 +0000726 CONFIG_CMD_DFL Default configuration; at the moment
wdenkc6097192002-11-03 00:24:07 +0000727 this is includes all commands, except
728 the ones marked with "*" in the list
729 above.
730
731 If you don't define CONFIG_COMMANDS it defaults to
wdenk7dd13292004-07-11 20:04:51 +0000732 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
wdenkc6097192002-11-03 00:24:07 +0000733 override the default settings in the respective
734 include file.
735
736 EXAMPLE: If you want all functions except of network
737 support you can write:
738
739 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
740
Gerald Van Barend6abef42007-03-31 12:23:51 -0400741 Other Commands:
742 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000743
744 Note: Don't enable the "icache" and "dcache" commands
wdenk4a5c8a72003-03-06 00:02:04 +0000745 (configuration option CFG_CMD_CACHE) unless you know
746 what you (and your U-Boot users) are doing. Data
747 cache cannot be enabled on systems like the 8xx or
748 8260 (where accesses to the IMMR region must be
749 uncached), and it cannot be disabled on all other
750 systems where we (mis-) use the data cache to hold an
751 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000752
753
754 XXX - this list needs to get updated!
755
756- Watchdog:
757 CONFIG_WATCHDOG
758 If this variable is defined, it enables watchdog
wdenkeb20ad32003-09-05 23:19:14 +0000759 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000760 code for a watchdog. For the 8xx and 8260 CPUs, the
761 SIU Watchdog feature is enabled in the SYPCR
762 register.
763
stroeseb9c17c52003-04-04 15:53:41 +0000764- U-Boot Version:
765 CONFIG_VERSION_VARIABLE
766 If this variable is defined, an environment variable
767 named "ver" is created by U-Boot showing the U-Boot
768 version as printed by the "version" command.
769 This variable is readonly.
770
wdenkc6097192002-11-03 00:24:07 +0000771- Real-Time Clock:
772
773 When CFG_CMD_DATE is selected, the type of the RTC
774 has to be selected, too. Define exactly one of the
775 following options:
776
777 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
778 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
779 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +0000780 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000781 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +0000782 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +0000783 CONFIG_RTC_DS164x - use Dallas DS164x RTC
wdenkaeba06f2004-06-09 17:34:58 +0000784 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
wdenkc6097192002-11-03 00:24:07 +0000785
wdenkb9bbd242003-06-30 16:24:52 +0000786 Note that if the RTC uses I2C, then the I2C interface
787 must also be configured. See I2C Support, below.
788
wdenkc6097192002-11-03 00:24:07 +0000789- Timestamp Support:
790
wdenk4a5c8a72003-03-06 00:02:04 +0000791 When CONFIG_TIMESTAMP is selected, the timestamp
792 (date and time) of an image is printed by image
793 commands like bootm or iminfo. This option is
794 automatically enabled when you select CFG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000795
796- Partition Support:
797 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
798 and/or CONFIG_ISO_PARTITION
799
800 If IDE or SCSI support is enabled (CFG_CMD_IDE or
801 CFG_CMD_SCSI) you must configure support for at least
802 one partition type as well.
803
804- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +0000805 CONFIG_IDE_RESET_ROUTINE - this is defined in several
806 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000807
wdenk369d43d2004-03-14 14:09:05 +0000808 CONFIG_IDE_RESET - is this is defined, IDE Reset will
809 be performed by calling the function
810 ide_set_reset(int reset)
811 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000812
813- ATAPI Support:
814 CONFIG_ATAPI
815
816 Set this to enable ATAPI support.
817
wdenkf602aa02004-03-13 23:29:43 +0000818- LBA48 Support
819 CONFIG_LBA48
820
821 Set this to enable support for disks larger than 137GB
822 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
823 Whithout these , LBA48 support uses 32bit variables and will 'only'
824 support disks up to 2.1TB.
825
826 CFG_64BIT_LBA:
827 When enabled, makes the IDE subsystem use 64bit sector addresses.
828 Default is 32bit.
829
wdenkc6097192002-11-03 00:24:07 +0000830- SCSI Support:
831 At the moment only there is only support for the
832 SYM53C8XX SCSI controller; define
833 CONFIG_SCSI_SYM53C8XX to enable it.
834
835 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
836 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
837 CFG_SCSI_MAX_LUN] can be adjusted to define the
838 maximum numbers of LUNs, SCSI ID's and target
839 devices.
840 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
841
842- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +0000843 CONFIG_E1000
844 Support for Intel 8254x gigabit chips.
stroese94ef1cf2003-06-05 15:39:44 +0000845
wdenkc6097192002-11-03 00:24:07 +0000846 CONFIG_EEPRO100
847 Support for Intel 82557/82559/82559ER chips.
848 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
849 write routine for first time initialisation.
850
851 CONFIG_TULIP
852 Support for Digital 2114x chips.
853 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
854 modem chip initialisation (KS8761/QS6611).
855
856 CONFIG_NATSEMI
857 Support for National dp83815 chips.
858
859 CONFIG_NS8382X
860 Support for National dp8382[01] gigabit chips.
861
wdenkaa603362003-05-12 21:50:16 +0000862- NETWORK Support (other):
863
864 CONFIG_DRIVER_LAN91C96
865 Support for SMSC's LAN91C96 chips.
866
867 CONFIG_LAN91C96_BASE
868 Define this to hold the physical address
869 of the LAN91C96's I/O space
870
871 CONFIG_LAN91C96_USE_32_BIT
872 Define this to enable 32 bit addressing
873
wdenk3c711762004-06-09 13:37:52 +0000874 CONFIG_DRIVER_SMC91111
875 Support for SMSC's LAN91C111 chip
876
877 CONFIG_SMC91111_BASE
878 Define this to hold the physical address
879 of the device (I/O space)
880
881 CONFIG_SMC_USE_32_BIT
882 Define this if data bus is 32 bits
883
884 CONFIG_SMC_USE_IOFUNCS
885 Define this to use i/o functions instead of macros
886 (some hardware wont work with macros)
887
wdenkc6097192002-11-03 00:24:07 +0000888- USB Support:
889 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +0000890 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000891 CONFIG_USB_UHCI to enable it.
892 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +0000893 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000894 storage devices.
895 Note:
896 Supported are USB Keyboards and USB Floppy drives
897 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +0000898 MPC5200 USB requires additional defines:
899 CONFIG_USB_CLOCK
900 for 528 MHz Clock: 0x0001bbbb
901 CONFIG_USB_CONFIG
902 for differential drivers: 0x00001000
903 for single ended drivers: 0x00005000
904
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200905- USB Device:
906 Define the below if you wish to use the USB console.
907 Once firmware is rebuilt from a serial console issue the
908 command "setenv stdin usbtty; setenv stdout usbtty" and
909 attach your usb cable. The Unix command "dmesg" should print
910 it has found a new device. The environment variable usbtty
911 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +0200912 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200913 Common Device Class Abstract Control Model serial device.
914 If you select usbtty = gserial you should be able to enumerate
915 a Linux host by
916 # modprobe usbserial vendor=0xVendorID product=0xProductID
917 else if using cdc_acm, simply setting the environment
918 variable usbtty to be cdc_acm should suffice. The following
919 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200920
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200921 CONFIG_USB_DEVICE
922 Define this to build a UDC device
923
924 CONFIG_USB_TTY
925 Define this to have a tty type of device available to
926 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +0200927
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200928 CFG_CONSOLE_IS_IN_ENV
929 Define this if you want stdin, stdout &/or stderr to
930 be set to usbtty.
931
932 mpc8xx:
933 CFG_USB_EXTC_CLK 0xBLAH
934 Derive USB clock from external clock "blah"
Wolfgang Denke2601822006-06-14 18:14:56 +0200935 - CFG_USB_EXTC_CLK 0x02
936
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200937 CFG_USB_BRG_CLK 0xBLAH
938 Derive USB clock from brgclk
939 - CFG_USB_BRG_CLK 0x04
940
Wolfgang Denke2601822006-06-14 18:14:56 +0200941 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200942 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +0200943 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200944 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
945 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
946 should pretend to be a Linux device to it's target host.
947
948 CONFIG_USBD_MANUFACTURER
949 Define this string as the name of your company for
950 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +0200951
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200952 CONFIG_USBD_PRODUCT_NAME
953 Define this string as the name of your product
954 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +0000955
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200956 CONFIG_USBD_VENDORID
957 Define this as your assigned Vendor ID from the USB
958 Implementors Forum. This *must* be a genuine Vendor ID
959 to avoid polluting the USB namespace.
960 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200961
Wolfgang Denk3f0137b2006-06-14 17:45:53 +0200962 CONFIG_USBD_PRODUCTID
963 Define this as the unique Product ID
964 for your device
965 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +0200966
wdenkc6097192002-11-03 00:24:07 +0000967
wdenk7a428cc2003-06-15 22:40:42 +0000968- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +0000969 The MMC controller on the Intel PXA is supported. To
970 enable this define CONFIG_MMC. The MMC can be
971 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +0000972 to physical memory similar to flash. Command line is
973 enabled with CFG_CMD_MMC. The MMC driver also works with
wdenk57b2d802003-06-27 21:31:46 +0000974 the FAT fs. This is enabled with CFG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +0000975
wdenkda04a8b2004-08-02 23:22:59 +0000976- Journaling Flash filesystem support:
977 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
978 CONFIG_JFFS2_NAND_DEV
979 Define these for a default partition on a NAND device
980
981 CFG_JFFS2_FIRST_SECTOR,
982 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
983 Define these for a default partition on a NOR device
984
985 CFG_JFFS_CUSTOM_PART
986 Define this to create an own partition. You have to provide a
987 function struct part_info* jffs2_part_info(int part_num)
988
989 If you define only one JFFS2 partition you may also want to
wdenk07d7e6b2004-12-16 21:44:03 +0000990 #define CFG_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +0000991 to disable the command chpart. This is the default when you
992 have not defined a custom partition
993
wdenkc6097192002-11-03 00:24:07 +0000994- Keyboard Support:
995 CONFIG_ISA_KEYBOARD
996
997 Define this to enable standard (PC-Style) keyboard
998 support
999
1000 CONFIG_I8042_KBD
1001 Standard PC keyboard driver with US (is default) and
1002 GERMAN key layout (switch via environment 'keymap=de') support.
1003 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1004 for cfb_console. Supports cursor blinking.
1005
1006- Video support:
1007 CONFIG_VIDEO
1008
1009 Define this to enable video support (for output to
1010 video).
1011
1012 CONFIG_VIDEO_CT69000
1013
1014 Enable Chips & Technologies 69000 Video chip
1015
1016 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001017 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001018 video output is selected via environment 'videoout'
1019 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1020 assumed.
wdenkc6097192002-11-03 00:24:07 +00001021
wdenkd3602132004-03-25 15:14:43 +00001022 For the CT69000 and SMI_LYNXEM drivers, videomode is
1023 selected via environment 'videomode'. Two diferent ways
wdenkaea86e42004-03-23 22:53:55 +00001024 are possible:
1025 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001026 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001027
1028 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1029 -------------+---------------------------------------------
1030 8 bits | 0x301* 0x303 0x305 0x161 0x307
1031 15 bits | 0x310 0x313 0x316 0x162 0x319
1032 16 bits | 0x311 0x314 0x317 0x163 0x31A
1033 24 bits | 0x312 0x315 0x318 ? 0x31B
1034 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001035 (i.e. setenv videomode 317; saveenv; reset;)
1036
wdenkd3602132004-03-25 15:14:43 +00001037 - "videomode=bootargs" all the video parameters are parsed
wdenkaea86e42004-03-23 22:53:55 +00001038 from the bootargs. (See drivers/videomodes.c)
1039
1040
stroeseb9c17c52003-04-04 15:53:41 +00001041 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001042 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001043 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1044 or CONFIG_VIDEO_SED13806_16BPP
1045
wdenk4e112c12003-06-03 23:54:09 +00001046- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001047 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001048
wdenk57b2d802003-06-27 21:31:46 +00001049 Define this to enable a custom keyboard support.
1050 This simply calls drv_keyboard_init() which must be
1051 defined in your board-specific files.
1052 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001053
wdenkc6097192002-11-03 00:24:07 +00001054- LCD Support: CONFIG_LCD
1055
1056 Define this to enable LCD support (for output to LCD
1057 display); also select one of the supported displays
1058 by defining one of these:
1059
wdenkc0d54ae2003-11-25 16:55:19 +00001060 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001061
wdenkc0d54ae2003-11-25 16:55:19 +00001062 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001063
wdenkc0d54ae2003-11-25 16:55:19 +00001064 CONFIG_NEC_NL6448BC20
1065
1066 NEC NL6448BC20-08. 6.5", 640x480.
1067 Active, color, single scan.
1068
1069 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001070
wdenkc0d54ae2003-11-25 16:55:19 +00001071 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001072 Active, color, single scan.
1073
1074 CONFIG_SHARP_16x9
1075
1076 Sharp 320x240. Active, color, single scan.
1077 It isn't 16x9, and I am not sure what it is.
1078
1079 CONFIG_SHARP_LQ64D341
1080
1081 Sharp LQ64D341 display, 640x480.
1082 Active, color, single scan.
1083
1084 CONFIG_HLD1045
1085
1086 HLD1045 display, 640x480.
1087 Active, color, single scan.
1088
1089 CONFIG_OPTREX_BW
1090
1091 Optrex CBL50840-2 NF-FW 99 22 M5
1092 or
1093 Hitachi LMG6912RPFC-00T
1094 or
1095 Hitachi SP14Q002
1096
1097 320x240. Black & white.
1098
1099 Normally display is black on white background; define
1100 CFG_WHITE_ON_BLACK to get it inverted.
1101
wdenkeb20ad32003-09-05 23:19:14 +00001102- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001103
wdenk57b2d802003-06-27 21:31:46 +00001104 If this option is set, the environment is checked for
1105 a variable "splashimage". If found, the usual display
1106 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001107 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001108 specified in "splashimage" is loaded instead. The
1109 console is redirected to the "nulldev", too. This
1110 allows for a "silent" boot where a splash screen is
1111 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001112
Stefan Roesed9d97742005-09-22 09:04:17 +02001113- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1114
1115 If this option is set, additionally to standard BMP
1116 images, gzipped BMP images can be displayed via the
1117 splashscreen support or the bmp command.
1118
wdenk710e3502003-08-29 20:57:53 +00001119- Compression support:
1120 CONFIG_BZIP2
1121
1122 If this option is set, support for bzip2 compressed
1123 images is included. If not, only uncompressed and gzip
1124 compressed images are supported.
1125
wdenk9c53f402003-10-15 23:53:47 +00001126 NOTE: the bzip2 algorithm requires a lot of RAM, so
1127 the malloc area (as defined by CFG_MALLOC_LEN) should
1128 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001129
wdenk0e2bd9c2004-06-06 21:51:03 +00001130- MII/PHY support:
1131 CONFIG_PHY_ADDR
1132
1133 The address of PHY on MII bus.
1134
1135 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1136
1137 The clock frequency of the MII bus
1138
1139 CONFIG_PHY_GIGE
1140
1141 If this option is set, support for speed/duplex
1142 detection of Gigabit PHY is included.
1143
1144 CONFIG_PHY_RESET_DELAY
1145
1146 Some PHY like Intel LXT971A need extra delay after
1147 reset before any MII register access is possible.
1148 For such PHY, set this option to the usec delay
1149 required. (minimum 300usec for LXT971A)
1150
1151 CONFIG_PHY_CMD_DELAY (ppc4xx)
1152
1153 Some PHY like Intel LXT971A need extra delay after
1154 command issued before MII status register can be read
1155
wdenkc6097192002-11-03 00:24:07 +00001156- Ethernet address:
1157 CONFIG_ETHADDR
1158 CONFIG_ETH2ADDR
1159 CONFIG_ETH3ADDR
1160
1161 Define a default value for ethernet address to use
1162 for the respective ethernet interface, in case this
1163 is not determined automatically.
1164
1165- IP address:
1166 CONFIG_IPADDR
1167
1168 Define a default value for the IP address to use for
1169 the default ethernet interface, in case this is not
1170 determined through e.g. bootp.
1171
1172- Server IP address:
1173 CONFIG_SERVERIP
1174
1175 Defines a default value for theIP address of a TFTP
1176 server to contact when using the "tftboot" command.
1177
1178- BOOTP Recovery Mode:
1179 CONFIG_BOOTP_RANDOM_DELAY
1180
1181 If you have many targets in a network that try to
1182 boot using BOOTP, you may want to avoid that all
1183 systems send out BOOTP requests at precisely the same
1184 moment (which would happen for instance at recovery
1185 from a power failure, when all systems will try to
1186 boot, thus flooding the BOOTP server. Defining
1187 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1188 inserted before sending out BOOTP requests. The
1189 following delays are insterted then:
1190
1191 1st BOOTP request: delay 0 ... 1 sec
1192 2nd BOOTP request: delay 0 ... 2 sec
1193 3rd BOOTP request: delay 0 ... 4 sec
1194 4th and following
1195 BOOTP requests: delay 0 ... 8 sec
1196
stroesee0aadfb2003-08-28 14:17:32 +00001197- DHCP Advanced Options:
1198 CONFIG_BOOTP_MASK
1199
1200 You can fine tune the DHCP functionality by adding
1201 these flags to the CONFIG_BOOTP_MASK define:
1202
1203 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1204 serverip from a DHCP server, it is possible that more
1205 than one DNS serverip is offered to the client.
1206 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1207 serverip will be stored in the additional environment
1208 variable "dnsip2". The first DNS serverip is always
1209 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1210 is added to the CONFIG_BOOTP_MASK.
1211
1212 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1213 to do a dynamic update of a DNS server. To do this, they
1214 need the hostname of the DHCP requester.
1215 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1216 CONFIG_BOOTP_MASK, the content of the "hostname"
1217 environment variable is passed as option 12 to
1218 the DHCP server.
1219
wdenk145d2c12004-04-15 21:48:45 +00001220 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001221 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001222
1223 The device id used in CDP trigger frames.
1224
1225 CONFIG_CDP_DEVICE_ID_PREFIX
1226
1227 A two character string which is prefixed to the MAC address
1228 of the device.
1229
1230 CONFIG_CDP_PORT_ID
1231
1232 A printf format string which contains the ascii name of
1233 the port. Normally is set to "eth%d" which sets
1234 eth0 for the first ethernet, eth1 for the second etc.
1235
1236 CONFIG_CDP_CAPABILITIES
1237
1238 A 32bit integer which indicates the device capabilities;
1239 0x00000010 for a normal host which does not forwards.
1240
1241 CONFIG_CDP_VERSION
1242
1243 An ascii string containing the version of the software.
1244
1245 CONFIG_CDP_PLATFORM
1246
1247 An ascii string containing the name of the platform.
1248
1249 CONFIG_CDP_TRIGGER
1250
1251 A 32bit integer sent on the trigger.
1252
1253 CONFIG_CDP_POWER_CONSUMPTION
1254
1255 A 16bit integer containing the power consumption of the
1256 device in .1 of milliwatts.
1257
1258 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1259
1260 A byte containing the id of the VLAN.
1261
wdenkc6097192002-11-03 00:24:07 +00001262- Status LED: CONFIG_STATUS_LED
1263
1264 Several configurations allow to display the current
1265 status using a LED. For instance, the LED will blink
1266 fast while running U-Boot code, stop blinking as
1267 soon as a reply to a BOOTP request was received, and
1268 start blinking slow once the Linux kernel is running
1269 (supported by a status LED driver in the Linux
1270 kernel). Defining CONFIG_STATUS_LED enables this
1271 feature in U-Boot.
1272
1273- CAN Support: CONFIG_CAN_DRIVER
1274
1275 Defining CONFIG_CAN_DRIVER enables CAN driver support
1276 on those systems that support this (optional)
1277 feature, like the TQM8xxL modules.
1278
1279- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1280
wdenkb9bbd242003-06-30 16:24:52 +00001281 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001282 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1283 include the appropriate I2C driver for the selected cpu.
wdenkc6097192002-11-03 00:24:07 +00001284
wdenk21136db2003-07-16 21:53:01 +00001285 This will allow you to use i2c commands at the u-boot
1286 command line (as long as you set CFG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001287 CONFIG_COMMANDS) and communicate with i2c based realtime
1288 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001289 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001290
Ben Warren45657152006-09-07 16:50:54 -04001291 CONFIG_I2C_CMD_TREE is a recommended option that places
1292 all I2C commands under a single 'i2c' root command. The
1293 older 'imm', 'imd', 'iprobe' etc. commands are considered
1294 deprecated and may disappear in the future.
1295
1296 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001297
wdenk21136db2003-07-16 21:53:01 +00001298 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001299 bit-banging) driver instead of CPM or similar hardware
1300 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001301
wdenk21136db2003-07-16 21:53:01 +00001302 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001303 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001304
wdenkb9bbd242003-06-30 16:24:52 +00001305 In both cases you will need to define CFG_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001306 to be the frequency (in Hz) at which you wish your i2c bus
1307 to run and CFG_I2C_SLAVE to be the address of this node (ie
1308 the cpu's i2c node address).
1309
wdenkb9bbd242003-06-30 16:24:52 +00001310 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1311 sets the cpu up as a master node and so its address should
1312 therefore be cleared to 0 (See, eg, MPC823e User's Manual
wdenk21136db2003-07-16 21:53:01 +00001313 p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001314
wdenk21136db2003-07-16 21:53:01 +00001315 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001316
wdenkb9bbd242003-06-30 16:24:52 +00001317 If you use the software i2c interface (CONFIG_SOFT_I2C)
1318 then the following macros need to be defined (examples are
1319 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001320
1321 I2C_INIT
1322
wdenkb9bbd242003-06-30 16:24:52 +00001323 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001324 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001325
wdenk544e9732004-02-06 23:19:44 +00001326 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001327
wdenkc6097192002-11-03 00:24:07 +00001328 I2C_PORT
1329
wdenk4a5c8a72003-03-06 00:02:04 +00001330 (Only for MPC8260 CPU). The I/O port to use (the code
1331 assumes both bits are on the same port). Valid values
1332 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001333
1334 I2C_ACTIVE
1335
1336 The code necessary to make the I2C data line active
1337 (driven). If the data line is open collector, this
1338 define can be null.
1339
wdenkb9bbd242003-06-30 16:24:52 +00001340 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1341
wdenkc6097192002-11-03 00:24:07 +00001342 I2C_TRISTATE
1343
1344 The code necessary to make the I2C data line tri-stated
1345 (inactive). If the data line is open collector, this
1346 define can be null.
1347
wdenkb9bbd242003-06-30 16:24:52 +00001348 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1349
wdenkc6097192002-11-03 00:24:07 +00001350 I2C_READ
1351
1352 Code that returns TRUE if the I2C data line is high,
1353 FALSE if it is low.
1354
wdenkb9bbd242003-06-30 16:24:52 +00001355 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1356
wdenkc6097192002-11-03 00:24:07 +00001357 I2C_SDA(bit)
1358
1359 If <bit> is TRUE, sets the I2C data line high. If it
1360 is FALSE, it clears it (low).
1361
wdenkb9bbd242003-06-30 16:24:52 +00001362 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001363 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001364 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00001365
wdenkc6097192002-11-03 00:24:07 +00001366 I2C_SCL(bit)
1367
1368 If <bit> is TRUE, sets the I2C clock line high. If it
1369 is FALSE, it clears it (low).
1370
wdenkb9bbd242003-06-30 16:24:52 +00001371 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001372 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00001373 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00001374
wdenkc6097192002-11-03 00:24:07 +00001375 I2C_DELAY
1376
1377 This delay is invoked four times per clock cycle so this
1378 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00001379 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00001380 like:
1381
wdenkb9bbd242003-06-30 16:24:52 +00001382 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001383
wdenkcc1e2562003-03-06 13:39:27 +00001384 CFG_I2C_INIT_BOARD
1385
wdenk57b2d802003-06-27 21:31:46 +00001386 When a board is reset during an i2c bus transfer
1387 chips might think that the current transfer is still
1388 in progress. On some boards it is possible to access
1389 the i2c SCLK line directly, either by using the
1390 processor pin as a GPIO or by having a second pin
1391 connected to the bus. If this option is defined a
1392 custom i2c_init_board() routine in boards/xxx/board.c
1393 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00001394
wdenk0e2bd9c2004-06-06 21:51:03 +00001395 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1396
1397 This option enables configuration of bi_iic_fast[] flags
1398 in u-boot bd_info structure based on u-boot environment
1399 variable "i2cfast". (see also i2cfast)
1400
Ben Warren45657152006-09-07 16:50:54 -04001401 CONFIG_I2C_MULTI_BUS
1402
1403 This option allows the use of multiple I2C buses, each of which
1404 must have a controller. At any point in time, only one bus is
1405 active. To switch to a different bus, use the 'i2c dev' command.
1406 Note that bus numbering is zero-based.
1407
1408 CFG_I2C_NOPROBES
1409
1410 This option specifies a list of I2C devices that will be skipped
1411 when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1412 command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1413 pairs. Otherwise, specify a 1D array of device addresses
1414
1415 e.g.
1416 #undef CONFIG_I2C_MULTI_BUS
1417 #define CFG_I2C_NOPROBES {0x50,0x68}
1418
1419 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1420
1421 #define CONFIG_I2C_MULTI_BUS
1422 #define CFG_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1423
1424 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1425
Timur Tabiab347542006-11-03 19:15:00 -06001426 CFG_SPD_BUS_NUM
1427
1428 If defined, then this indicates the I2C bus number for DDR SPD.
1429 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1430
Stefan Roese096cc9b2007-02-20 10:51:26 +01001431 CFG_RTC_BUS_NUM
1432
1433 If defined, then this indicates the I2C bus number for the RTC.
1434 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1435
1436 CFG_DTT_BUS_NUM
1437
1438 If defined, then this indicates the I2C bus number for the DTT.
1439 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1440
Timur Tabiab347542006-11-03 19:15:00 -06001441 CONFIG_FSL_I2C
1442
1443 Define this option if you want to use Freescale's I2C driver in
1444 drivers/fsl_i2c.c.
1445
1446
wdenkc6097192002-11-03 00:24:07 +00001447- SPI Support: CONFIG_SPI
1448
1449 Enables SPI driver (so far only tested with
1450 SPI EEPROM, also an instance works with Crystal A/D and
1451 D/As on the SACSng board)
1452
1453 CONFIG_SPI_X
1454
1455 Enables extended (16-bit) SPI EEPROM addressing.
1456 (symmetrical to CONFIG_I2C_X)
1457
1458 CONFIG_SOFT_SPI
1459
wdenk4a5c8a72003-03-06 00:02:04 +00001460 Enables a software (bit-bang) SPI driver rather than
1461 using hardware support. This is a general purpose
1462 driver that only requires three general I/O port pins
1463 (two outputs, one input) to function. If this is
1464 defined, the board configuration must define several
1465 SPI configuration items (port pins to use, etc). For
1466 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001467
1468- FPGA Support: CONFIG_FPGA_COUNT
1469
wdenk4a5c8a72003-03-06 00:02:04 +00001470 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001471
wdenk4a5c8a72003-03-06 00:02:04 +00001472 CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001473
wdenk57b2d802003-06-27 21:31:46 +00001474 Used to specify the types of FPGA devices. For example,
1475 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
wdenkc6097192002-11-03 00:24:07 +00001476
wdenk57b2d802003-06-27 21:31:46 +00001477 CFG_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001478
wdenk57b2d802003-06-27 21:31:46 +00001479 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001480
1481 CFG_FPGA_CHECK_BUSY
1482
wdenk4a5c8a72003-03-06 00:02:04 +00001483 Enable checks on FPGA configuration interface busy
1484 status by the configuration function. This option
1485 will require a board or device specific function to
1486 be written.
wdenkc6097192002-11-03 00:24:07 +00001487
1488 CONFIG_FPGA_DELAY
1489
1490 If defined, a function that provides delays in the FPGA
1491 configuration driver.
1492
1493 CFG_FPGA_CHECK_CTRLC
1494 Allow Control-C to interrupt FPGA configuration
1495
1496 CFG_FPGA_CHECK_ERROR
1497
wdenk4a5c8a72003-03-06 00:02:04 +00001498 Check for configuration errors during FPGA bitfile
1499 loading. For example, abort during Virtex II
1500 configuration if the INIT_B line goes low (which
1501 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001502
1503 CFG_FPGA_WAIT_INIT
1504
wdenk4a5c8a72003-03-06 00:02:04 +00001505 Maximum time to wait for the INIT_B line to deassert
1506 after PROB_B has been deasserted during a Virtex II
1507 FPGA configuration sequence. The default time is 500
1508 mS.
wdenkc6097192002-11-03 00:24:07 +00001509
1510 CFG_FPGA_WAIT_BUSY
1511
wdenk4a5c8a72003-03-06 00:02:04 +00001512 Maximum time to wait for BUSY to deassert during
1513 Virtex II FPGA configuration. The default is 5 mS.
wdenkc6097192002-11-03 00:24:07 +00001514
1515 CFG_FPGA_WAIT_CONFIG
1516
wdenk4a5c8a72003-03-06 00:02:04 +00001517 Time to wait after FPGA configuration. The default is
1518 200 mS.
wdenkc6097192002-11-03 00:24:07 +00001519
1520- Configuration Management:
1521 CONFIG_IDENT_STRING
1522
wdenk4a5c8a72003-03-06 00:02:04 +00001523 If defined, this string will be added to the U-Boot
1524 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001525
1526- Vendor Parameter Protection:
1527
wdenk4a5c8a72003-03-06 00:02:04 +00001528 U-Boot considers the values of the environment
1529 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00001530 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00001531 are set once by the board vendor / manufacturer, and
1532 protects these variables from casual modification by
1533 the user. Once set, these variables are read-only,
1534 and write or delete attempts are rejected. You can
1535 change this behviour:
wdenkc6097192002-11-03 00:24:07 +00001536
1537 If CONFIG_ENV_OVERWRITE is #defined in your config
1538 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00001539 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001540 these parameters.
1541
1542 Alternatively, if you #define _both_ CONFIG_ETHADDR
1543 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1544 ethernet address is installed in the environment,
1545 which can be changed exactly ONCE by the user. [The
1546 serial# is unaffected by this, i. e. it remains
1547 read-only.]
1548
1549- Protected RAM:
1550 CONFIG_PRAM
1551
1552 Define this variable to enable the reservation of
1553 "protected RAM", i. e. RAM which is not overwritten
1554 by U-Boot. Define CONFIG_PRAM to hold the number of
1555 kB you want to reserve for pRAM. You can overwrite
1556 this default value by defining an environment
1557 variable "pram" to the number of kB you want to
1558 reserve. Note that the board info structure will
1559 still show the full amount of RAM. If pRAM is
1560 reserved, a new environment variable "mem" will
1561 automatically be defined to hold the amount of
1562 remaining RAM in a form that can be passed as boot
1563 argument to Linux, for instance like that:
1564
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01001565 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001566 saveenv
1567
1568 This way you can tell Linux not to use this memory,
1569 either, which results in a memory region that will
1570 not be affected by reboots.
1571
1572 *WARNING* If your board configuration uses automatic
1573 detection of the RAM size, you must make sure that
1574 this memory test is non-destructive. So far, the
1575 following board configurations are known to be
1576 "pRAM-clean":
1577
1578 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1579 HERMES, IP860, RPXlite, LWMON, LANTEC,
1580 PCU_E, FLAGADM, TQM8260
1581
1582- Error Recovery:
1583 CONFIG_PANIC_HANG
1584
1585 Define this variable to stop the system in case of a
1586 fatal error, so that you have to reset it manually.
1587 This is probably NOT a good idea for an embedded
1588 system where you want to system to reboot
1589 automatically as fast as possible, but it may be
1590 useful during development since you can try to debug
1591 the conditions that lead to the situation.
1592
1593 CONFIG_NET_RETRY_COUNT
1594
wdenk4a5c8a72003-03-06 00:02:04 +00001595 This variable defines the number of retries for
1596 network operations like ARP, RARP, TFTP, or BOOTP
1597 before giving up the operation. If not defined, a
1598 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001599
1600- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001601 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00001602
1603 Enable auto completion of commands using TAB.
1604
Wolfgang Denk018147d2006-11-27 15:32:42 +01001605 Note that this feature has NOT been implemented yet
1606 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02001607
1608
wdenkc6097192002-11-03 00:24:07 +00001609 CFG_HUSH_PARSER
1610
1611 Define this variable to enable the "hush" shell (from
1612 Busybox) as command line interpreter, thus enabling
1613 powerful command line syntax like
1614 if...then...else...fi conditionals or `&&' and '||'
1615 constructs ("shell scripts").
1616
1617 If undefined, you get the old, much simpler behaviour
1618 with a somewhat smaller memory footprint.
1619
1620
1621 CFG_PROMPT_HUSH_PS2
1622
1623 This defines the secondary prompt string, which is
1624 printed when the command interpreter needs more input
1625 to complete a command. Usually "> ".
1626
1627 Note:
1628
wdenk57b2d802003-06-27 21:31:46 +00001629 In the current implementation, the local variables
1630 space and global environment variables space are
1631 separated. Local variables are those you define by
1632 simply typing `name=value'. To access a local
1633 variable later on, you have write `$name' or
1634 `${name}'; to execute the contents of a variable
1635 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001636
wdenk4a5c8a72003-03-06 00:02:04 +00001637 Global environment variables are those you use
1638 setenv/printenv to work with. To run a command stored
1639 in such a variable, you need to use the run command,
1640 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001641
1642 To store commands and special characters in a
1643 variable, please use double quotation marks
1644 surrounding the whole text of the variable, instead
1645 of the backslashes before semicolons and special
1646 symbols.
1647
Wolfgang Denk2039a072006-07-21 11:35:21 +02001648- Commandline Editing and History:
1649 CONFIG_CMDLINE_EDITING
1650
Wolfgang Denkc80857e2006-07-21 11:56:05 +02001651 Enable editiong and History functions for interactive
1652 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02001653
wdenkc0aa5c52003-12-06 19:49:23 +00001654- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001655 CONFIG_EXTRA_ENV_SETTINGS
1656
wdenk4a5c8a72003-03-06 00:02:04 +00001657 Define this to contain any number of null terminated
1658 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00001659 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00001660
wdenk4a5c8a72003-03-06 00:02:04 +00001661 For example, place something like this in your
1662 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001663
1664 #define CONFIG_EXTRA_ENV_SETTINGS \
1665 "myvar1=value1\0" \
1666 "myvar2=value2\0"
1667
wdenk4a5c8a72003-03-06 00:02:04 +00001668 Warning: This method is based on knowledge about the
1669 internal format how the environment is stored by the
1670 U-Boot code. This is NOT an official, exported
1671 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00001672 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001673 You better know what you are doing here.
1674
wdenk4a5c8a72003-03-06 00:02:04 +00001675 Note: overly (ab)use of the default environment is
1676 discouraged. Make sure to check other ways to preset
1677 the environment like the autoscript function or the
1678 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001679
wdenkc0aa5c52003-12-06 19:49:23 +00001680- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00001681 CONFIG_HAS_DATAFLASH
1682
wdenk57b2d802003-06-27 21:31:46 +00001683 Defining this option enables DataFlash features and
1684 allows to read/write in Dataflash via the standard
1685 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00001686
wdenkef893942004-02-23 16:11:30 +00001687- SystemACE Support:
1688 CONFIG_SYSTEMACE
1689
1690 Adding this option adds support for Xilinx SystemACE
1691 chips attached via some sort of local bus. The address
1692 of the chip must alsh be defined in the
1693 CFG_SYSTEMACE_BASE macro. For example:
1694
1695 #define CONFIG_SYSTEMACE
1696 #define CFG_SYSTEMACE_BASE 0xf0000000
1697
1698 When SystemACE support is added, the "ace" device type
1699 becomes available to the fat commands, i.e. fatls.
1700
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001701- TFTP Fixed UDP Port:
1702 CONFIG_TFTP_PORT
1703
Wolfgang Denk227b5192005-09-24 23:25:46 +02001704 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001705 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02001706 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001707 number generator is used.
1708
Wolfgang Denk227b5192005-09-24 23:25:46 +02001709 Also, the environment variable tftpdstp is used to supply
1710 the TFTP UDP destination port value. If tftpdstp isn't
1711 defined, the normal port 69 is used.
1712
1713 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02001714 blindly start the TFTP transfer using the pre-configured
1715 target IP address and UDP port. This has the effect of
1716 "punching through" the (Windows XP) firewall, allowing
1717 the remainder of the TFTP transfer to proceed normally.
1718 A better solution is to properly configure the firewall,
1719 but sometimes that is not allowed.
1720
wdenkc0aa5c52003-12-06 19:49:23 +00001721- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001722 CONFIG_SHOW_BOOT_PROGRESS
1723
wdenk4a5c8a72003-03-06 00:02:04 +00001724 Defining this option allows to add some board-
1725 specific code (calling a user-provided function
1726 "show_boot_progress(int)") that enables you to show
1727 the system's boot progress on some display (for
1728 example, some LED's) on your board. At the moment,
1729 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001730
1731 Arg Where When
1732 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00001733 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001734 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00001735 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001736 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00001737 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001738 4 common/cmd_bootm.c Image data has correct checksum
1739 -4 common/cmd_bootm.c Image is for unsupported architecture
1740 5 common/cmd_bootm.c Architecture check OK
1741 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1742 6 common/cmd_bootm.c Image Type check OK
1743 -6 common/cmd_bootm.c gunzip uncompression error
1744 -7 common/cmd_bootm.c Unimplemented compression type
1745 7 common/cmd_bootm.c Uncompression OK
1746 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1747 8 common/cmd_bootm.c Image Type check OK
1748 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1749 9 common/cmd_bootm.c Start initial ramdisk verification
wdenk544e9732004-02-06 23:19:44 +00001750 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1751 -11 common/cmd_bootm.c Ramdisk header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001752 10 common/cmd_bootm.c Ramdisk header is OK
wdenk544e9732004-02-06 23:19:44 +00001753 -12 common/cmd_bootm.c Ramdisk data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001754 11 common/cmd_bootm.c Ramdisk data has correct checksum
1755 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1756 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1757 13 common/cmd_bootm.c Start multifile image verification
1758 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1759 15 common/cmd_bootm.c All preparation done, transferring control to OS
1760
wdenkd729d302004-02-27 00:07:27 +00001761 -30 lib_ppc/board.c Fatal error, hang the system
1762 -31 post/post.c POST test failed, detected by post_output_backlog()
1763 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00001764
wdenkc6097192002-11-03 00:24:07 +00001765 -1 common/cmd_doc.c Bad usage of "doc" command
1766 -1 common/cmd_doc.c No boot device
1767 -1 common/cmd_doc.c Unknown Chip ID on boot device
1768 -1 common/cmd_doc.c Read Error on boot device
1769 -1 common/cmd_doc.c Image header has bad magic number
1770
1771 -1 common/cmd_ide.c Bad usage of "ide" command
1772 -1 common/cmd_ide.c No boot device
1773 -1 common/cmd_ide.c Unknown boot device
1774 -1 common/cmd_ide.c Unknown partition table
1775 -1 common/cmd_ide.c Invalid partition type
1776 -1 common/cmd_ide.c Read Error on boot device
1777 -1 common/cmd_ide.c Image header has bad magic number
1778
wdenk8706ea82003-09-18 10:02:25 +00001779 -1 common/cmd_nand.c Bad usage of "nand" command
1780 -1 common/cmd_nand.c No boot device
1781 -1 common/cmd_nand.c Unknown Chip ID on boot device
1782 -1 common/cmd_nand.c Read Error on boot device
1783 -1 common/cmd_nand.c Image header has bad magic number
1784
wdenk544e9732004-02-06 23:19:44 +00001785 -1 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001786
1787
1788Modem Support:
1789--------------
1790
wdenk8dba0502003-03-31 16:34:49 +00001791[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001792
1793- Modem support endable:
1794 CONFIG_MODEM_SUPPORT
1795
1796- RTS/CTS Flow control enable:
1797 CONFIG_HWFLOW
1798
1799- Modem debug support:
1800 CONFIG_MODEM_SUPPORT_DEBUG
1801
wdenk4a5c8a72003-03-06 00:02:04 +00001802 Enables debugging stuff (char screen[1024], dbg())
1803 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001804
wdenkc0aa5c52003-12-06 19:49:23 +00001805- Interrupt support (PPC):
1806
wdenk1ebf41e2004-01-02 14:00:00 +00001807 There are common interrupt_init() and timer_interrupt()
1808 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1809 for cpu specific initialization. interrupt_init_cpu()
1810 should set decrementer_count to appropriate value. If
1811 cpu resets decrementer automatically after interrupt
1812 (ppc4xx) it should set decrementer_count to zero.
1813 timer_interrupt() calls timer_interrupt_cpu() for cpu
1814 specific handling. If board has watchdog / status_led
1815 / other_activity_monitor it works automatically from
1816 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00001817
wdenkc6097192002-11-03 00:24:07 +00001818- General:
1819
wdenk4a5c8a72003-03-06 00:02:04 +00001820 In the target system modem support is enabled when a
1821 specific key (key combination) is pressed during
1822 power-on. Otherwise U-Boot will boot normally
1823 (autoboot). The key_pressed() fuction is called from
1824 board_init(). Currently key_pressed() is a dummy
1825 function, returning 1 and thus enabling modem
1826 initialization.
wdenkc6097192002-11-03 00:24:07 +00001827
wdenk4a5c8a72003-03-06 00:02:04 +00001828 If there are no modem init strings in the
1829 environment, U-Boot proceed to autoboot; the
1830 previous output (banner, info printfs) will be
1831 supressed, though.
wdenkc6097192002-11-03 00:24:07 +00001832
1833 See also: doc/README.Modem
1834
1835
wdenkc6097192002-11-03 00:24:07 +00001836Configuration Settings:
1837-----------------------
1838
1839- CFG_LONGHELP: Defined when you want long help messages included;
1840 undefine this when you're short of memory.
1841
1842- CFG_PROMPT: This is what U-Boot prints on the console to
1843 prompt for user input.
1844
1845- CFG_CBSIZE: Buffer size for input from the Console
1846
1847- CFG_PBSIZE: Buffer size for Console output
1848
1849- CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1850
1851- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1852 the application (usually a Linux kernel) when it is
1853 booted
1854
1855- CFG_BAUDRATE_TABLE:
1856 List of legal baudrate settings for this board.
1857
1858- CFG_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00001859 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00001860
1861- CFG_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00001862 If the board specific function
1863 extern int overwrite_console (void);
1864 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00001865 serial port, else the settings in the environment are used.
1866
1867- CFG_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00001868 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00001869
1870- CFG_CONSOLE_ENV_OVERWRITE
1871 Enable overwrite of previous console environment settings.
1872
1873- CFG_MEMTEST_START, CFG_MEMTEST_END:
1874 Begin and End addresses of the area used by the
1875 simple memory test.
1876
1877- CFG_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00001878 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00001879
wdenk5958f4a2003-09-18 09:21:33 +00001880- CFG_MEMTEST_SCRATCH:
1881 Scratch address used by the alternate memory test
1882 You only need to set this if address zero isn't writeable
1883
wdenkc6097192002-11-03 00:24:07 +00001884- CFG_TFTP_LOADADDR:
1885 Default load address for network file downloads
1886
1887- CFG_LOADS_BAUD_CHANGE:
1888 Enable temporary baudrate change while serial download
1889
1890- CFG_SDRAM_BASE:
1891 Physical start address of SDRAM. _Must_ be 0 here.
1892
1893- CFG_MBIO_BASE:
1894 Physical start address of Motherboard I/O (if using a
1895 Cogent motherboard)
1896
1897- CFG_FLASH_BASE:
1898 Physical start address of Flash memory.
1899
1900- CFG_MONITOR_BASE:
1901 Physical start address of boot monitor code (set by
1902 make config files to be same as the text base address
1903 (TEXT_BASE) used when linking) - same as
1904 CFG_FLASH_BASE when booting from flash.
1905
1906- CFG_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00001907 Size of memory reserved for monitor code, used to
1908 determine _at_compile_time_ (!) if the environment is
1909 embedded within the U-Boot image, or in a separate
1910 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001911
1912- CFG_MALLOC_LEN:
1913 Size of DRAM reserved for malloc() use.
1914
Stefan Roese5d5ce292006-03-13 11:16:36 +01001915- CFG_BOOTM_LEN:
1916 Normally compressed uImages are limited to an
1917 uncompressed size of 8 MBytes. If this is not enough,
1918 you can define CFG_BOOTM_LEN in your board config file
1919 to adjust this setting to your needs.
1920
wdenkc6097192002-11-03 00:24:07 +00001921- CFG_BOOTMAPSZ:
1922 Maximum size of memory mapped by the startup code of
1923 the Linux kernel; all data that must be processed by
1924 the Linux kernel (bd_info, boot arguments, eventually
1925 initrd image) must be put below this limit.
1926
1927- CFG_MAX_FLASH_BANKS:
1928 Max number of Flash memory banks
1929
1930- CFG_MAX_FLASH_SECT:
1931 Max number of sectors on a Flash chip
1932
1933- CFG_FLASH_ERASE_TOUT:
1934 Timeout for Flash erase operations (in ms)
1935
1936- CFG_FLASH_WRITE_TOUT:
1937 Timeout for Flash write operations (in ms)
1938
wdenkdccbda02003-07-14 22:13:32 +00001939- CFG_FLASH_LOCK_TOUT
1940 Timeout for Flash set sector lock bit operation (in ms)
1941
1942- CFG_FLASH_UNLOCK_TOUT
1943 Timeout for Flash clear lock bits operation (in ms)
1944
1945- CFG_FLASH_PROTECTION
1946 If defined, hardware flash sectors protection is used
1947 instead of U-Boot software protection.
1948
wdenkc6097192002-11-03 00:24:07 +00001949- CFG_DIRECT_FLASH_TFTP:
1950
1951 Enable TFTP transfers directly to flash memory;
1952 without this option such a download has to be
1953 performed in two steps: (1) download to RAM, and (2)
1954 copy from RAM to flash.
1955
1956 The two-step approach is usually more reliable, since
1957 you can check if the download worked before you erase
1958 the flash, but in some situations (when sytem RAM is
1959 too limited to allow for a tempory copy of the
1960 downloaded image) this option may be very useful.
1961
1962- CFG_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00001963 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00001964 common flash structure for storing flash geometry.
1965
1966- CFG_FLASH_CFI_DRIVER
1967 This option also enables the building of the cfi_flash driver
1968 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001969
Stefan Roesec443fe92005-11-22 13:20:42 +01001970- CFG_FLASH_QUIET_TEST
1971 If this option is defined, the common CFI flash doesn't
1972 print it's warning upon not recognized FLASH banks. This
1973 is useful, if some of the configured banks are only
1974 optionally available.
1975
stroese94ef1cf2003-06-05 15:39:44 +00001976- CFG_RX_ETH_BUFFER:
1977 Defines the number of ethernet receive buffers. On some
1978 ethernet controllers it is recommended to set this value
1979 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1980 buffers can be full shortly after enabling the interface
1981 on high ethernet traffic.
1982 Defaults to 4 if not defined.
1983
wdenkc6097192002-11-03 00:24:07 +00001984The following definitions that deal with the placement and management
1985of environment data (variable area); in general, we support the
1986following configurations:
1987
1988- CFG_ENV_IS_IN_FLASH:
1989
1990 Define this if the environment is in flash memory.
1991
1992 a) The environment occupies one whole flash sector, which is
1993 "embedded" in the text segment with the U-Boot code. This
1994 happens usually with "bottom boot sector" or "top boot
1995 sector" type flash chips, which have several smaller
1996 sectors at the start or the end. For instance, such a
1997 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1998 such a case you would place the environment in one of the
1999 4 kB sectors - with U-Boot code before and after it. With
2000 "top boot sector" type flash chips, you would put the
2001 environment in one of the last sectors, leaving a gap
2002 between U-Boot and the environment.
2003
2004 - CFG_ENV_OFFSET:
2005
2006 Offset of environment data (variable area) to the
2007 beginning of flash memory; for instance, with bottom boot
2008 type flash chips the second sector can be used: the offset
2009 for this sector is given here.
2010
2011 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
2012
2013 - CFG_ENV_ADDR:
2014
2015 This is just another way to specify the start address of
2016 the flash sector containing the environment (instead of
2017 CFG_ENV_OFFSET).
2018
2019 - CFG_ENV_SECT_SIZE:
2020
2021 Size of the sector containing the environment.
2022
2023
2024 b) Sometimes flash chips have few, equal sized, BIG sectors.
2025 In such a case you don't want to spend a whole sector for
2026 the environment.
2027
2028 - CFG_ENV_SIZE:
2029
2030 If you use this in combination with CFG_ENV_IS_IN_FLASH
2031 and CFG_ENV_SECT_SIZE, you can specify to use only a part
2032 of this flash sector for the environment. This saves
2033 memory for the RAM copy of the environment.
2034
2035 It may also save flash memory if you decide to use this
2036 when your environment is "embedded" within U-Boot code,
2037 since then the remainder of the flash sector could be used
2038 for U-Boot code. It should be pointed out that this is
2039 STRONGLY DISCOURAGED from a robustness point of view:
2040 updating the environment in flash makes it always
2041 necessary to erase the WHOLE sector. If something goes
2042 wrong before the contents has been restored from a copy in
2043 RAM, your target system will be dead.
2044
2045 - CFG_ENV_ADDR_REDUND
2046 CFG_ENV_SIZE_REDUND
2047
wdenk4a5c8a72003-03-06 00:02:04 +00002048 These settings describe a second storage area used to hold
2049 a redundand copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00002050 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00002051 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002052
2053BE CAREFUL! Any changes to the flash layout, and some changes to the
2054source code will make it necessary to adapt <board>/u-boot.lds*
2055accordingly!
2056
2057
2058- CFG_ENV_IS_IN_NVRAM:
2059
2060 Define this if you have some non-volatile memory device
2061 (NVRAM, battery buffered SRAM) which you want to use for the
2062 environment.
2063
2064 - CFG_ENV_ADDR:
2065 - CFG_ENV_SIZE:
2066
2067 These two #defines are used to determin the memory area you
2068 want to use for environment. It is assumed that this memory
2069 can just be read and written to, without any special
2070 provision.
2071
2072BE CAREFUL! The first access to the environment happens quite early
2073in U-Boot initalization (when we try to get the setting of for the
2074console baudrate). You *MUST* have mappend your NVRAM area then, or
2075U-Boot will hang.
2076
2077Please note that even with NVRAM we still use a copy of the
2078environment in RAM: we could work on NVRAM directly, but we want to
2079keep settings there always unmodified except somebody uses "saveenv"
2080to save the current settings.
2081
2082
2083- CFG_ENV_IS_IN_EEPROM:
2084
2085 Use this if you have an EEPROM or similar serial access
2086 device and a driver for it.
2087
2088 - CFG_ENV_OFFSET:
2089 - CFG_ENV_SIZE:
2090
2091 These two #defines specify the offset and size of the
2092 environment area within the total memory of your EEPROM.
2093
2094 - CFG_I2C_EEPROM_ADDR:
2095 If defined, specified the chip address of the EEPROM device.
2096 The default address is zero.
2097
2098 - CFG_EEPROM_PAGE_WRITE_BITS:
2099 If defined, the number of bits used to address bytes in a
2100 single page in the EEPROM device. A 64 byte page, for example
2101 would require six bits.
2102
2103 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2104 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00002105 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002106
2107 - CFG_I2C_EEPROM_ADDR_LEN:
2108 The length in bytes of the EEPROM memory array address. Note
2109 that this is NOT the chip address length!
2110
wdenk20c98a62004-04-23 20:32:05 +00002111 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
2112 EEPROM chips that implement "address overflow" are ones
2113 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2114 address and the extra bits end up in the "chip address" bit
2115 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2116 byte chips.
2117
2118 Note that we consider the length of the address field to
2119 still be one byte because the extra address bits are hidden
2120 in the chip address.
2121
wdenkc6097192002-11-03 00:24:07 +00002122 - CFG_EEPROM_SIZE:
2123 The size in bytes of the EEPROM device.
2124
wdenkc6097192002-11-03 00:24:07 +00002125
wdenk86765902003-12-06 23:55:10 +00002126- CFG_ENV_IS_IN_DATAFLASH:
2127
wdenk1ebf41e2004-01-02 14:00:00 +00002128 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00002129 want to use for the environment.
2130
2131 - CFG_ENV_OFFSET:
2132 - CFG_ENV_ADDR:
2133 - CFG_ENV_SIZE:
2134
2135 These three #defines specify the offset and size of the
2136 environment area within the total memory of your DataFlash placed
2137 at the specified address.
2138
wdenk79b59372004-06-09 14:58:14 +00002139- CFG_ENV_IS_IN_NAND:
2140
2141 Define this if you have a NAND device which you want to use
2142 for the environment.
2143
2144 - CFG_ENV_OFFSET:
2145 - CFG_ENV_SIZE:
2146
2147 These two #defines specify the offset and size of the environment
2148 area within the first NAND device.
wdenk86765902003-12-06 23:55:10 +00002149
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01002150 - CFG_ENV_OFFSET_REDUND
2151
2152 This setting describes a second storage area of CFG_ENV_SIZE
2153 size used to hold a redundant copy of the environment data,
2154 so that there is a valid backup copy in case there is a
2155 power failure during a "saveenv" operation.
2156
2157 Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2158 to a block boundary, and CFG_ENV_SIZE must be a multiple of
2159 the NAND devices block size.
2160
wdenkc6097192002-11-03 00:24:07 +00002161- CFG_SPI_INIT_OFFSET
2162
2163 Defines offset to the initial SPI buffer area in DPRAM. The
2164 area is used at an early stage (ROM part) if the environment
2165 is configured to reside in the SPI EEPROM: We need a 520 byte
2166 scratch DPRAM area. It is used between the two initialization
2167 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2168 to be a good choice since it makes it far enough from the
2169 start of the data area as well as from the stack pointer.
2170
2171Please note that the environment is read-only as long as the monitor
2172has been relocated to RAM and a RAM copy of the environment has been
2173created; also, when using EEPROM you will have to use getenv_r()
2174until then to read environment variables.
2175
wdenk8dba0502003-03-31 16:34:49 +00002176The environment is protected by a CRC32 checksum. Before the monitor
2177is relocated into RAM, as a result of a bad CRC you will be working
2178with the compiled-in default environment - *silently*!!! [This is
2179necessary, because the first environment variable we need is the
2180"baudrate" setting for the console - if we have a bad CRC, we don't
2181have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002182
2183Note: once the monitor has been relocated, then it will complain if
2184the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00002185use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002186
wdenk49c3f672003-10-08 22:33:00 +00002187- CFG_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00002188 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00002189
2190 Note: If this option is active, then CFG_FAULT_MII_ADDR
2191 also needs to be defined.
2192
2193- CFG_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00002194 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002195
wdenkf602aa02004-03-13 23:29:43 +00002196- CFG_64BIT_VSPRINTF:
2197 Makes vsprintf (and all *printf functions) support printing
2198 of 64bit values by using the L quantifier
2199
2200- CFG_64BIT_STRTOUL:
2201 Adds simple_strtoull that returns a 64bit value
2202
wdenkc6097192002-11-03 00:24:07 +00002203Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00002204---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002205
2206- CFG_CACHELINE_SIZE:
2207 Cache Line Size of the CPU.
2208
2209- CFG_DEFAULT_IMMR:
2210 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00002211
wdenk9c53f402003-10-15 23:53:47 +00002212 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2213 and RPXsuper) to be able to adjust the position of
2214 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002215
wdenk1272e232002-11-10 22:06:23 +00002216- Floppy Disk Support:
2217 CFG_FDC_DRIVE_NUMBER
2218
2219 the default drive number (default value 0)
2220
2221 CFG_ISA_IO_STRIDE
2222
2223 defines the spacing between fdc chipset registers
2224 (default value 1)
2225
2226 CFG_ISA_IO_OFFSET
2227
wdenk4a5c8a72003-03-06 00:02:04 +00002228 defines the offset of register from address. It
2229 depends on which part of the data bus is connected to
2230 the fdc chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00002231
wdenk4a5c8a72003-03-06 00:02:04 +00002232 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
2233 CFG_FDC_DRIVE_NUMBER are undefined, they take their
2234 default value.
wdenk1272e232002-11-10 22:06:23 +00002235
wdenk4a5c8a72003-03-06 00:02:04 +00002236 if CFG_FDC_HW_INIT is defined, then the function
2237 fdc_hw_init() is called at the beginning of the FDC
2238 setup. fdc_hw_init() must be provided by the board
2239 source code. It is used to make hardware dependant
2240 initializations.
wdenk1272e232002-11-10 22:06:23 +00002241
wdenkb3a4a702004-12-10 11:40:40 +00002242- CFG_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00002243 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00002244 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002245
2246- CFG_INIT_RAM_ADDR:
2247
wdenkeb20ad32003-09-05 23:19:14 +00002248 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002249 initial data and stack; please note that this must be
2250 writable memory that is working WITHOUT special
2251 initialization, i. e. you CANNOT use normal RAM which
2252 will become available only after programming the
2253 memory controller and running certain initialization
2254 sequences.
2255
2256 U-Boot uses the following memory types:
2257 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2258 - MPC824X: data cache
2259 - PPC4xx: data cache
2260
wdenk8dba0502003-03-31 16:34:49 +00002261- CFG_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002262
2263 Offset of the initial data structure in the memory
2264 area defined by CFG_INIT_RAM_ADDR. Usually
wdenk8dba0502003-03-31 16:34:49 +00002265 CFG_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002266 data is located at the end of the available space
2267 (sometimes written as (CFG_INIT_RAM_END -
2268 CFG_INIT_DATA_SIZE), and the initial stack is just
2269 below that area (growing from (CFG_INIT_RAM_ADDR +
wdenk8dba0502003-03-31 16:34:49 +00002270 CFG_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002271
2272 Note:
2273 On the MPC824X (or other systems that use the data
2274 cache for initial memory) the address chosen for
2275 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2276 point to an otherwise UNUSED address space between
2277 the top of RAM and the start of the PCI space.
2278
2279- CFG_SIUMCR: SIU Module Configuration (11-6)
2280
2281- CFG_SYPCR: System Protection Control (11-9)
2282
2283- CFG_TBSCR: Time Base Status and Control (11-26)
2284
2285- CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2286
2287- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2288
2289- CFG_SCCR: System Clock and reset Control Register (15-27)
2290
2291- CFG_OR_TIMING_SDRAM:
2292 SDRAM timing
2293
2294- CFG_MAMR_PTA:
2295 periodic timer for refresh
2296
2297- CFG_DER: Debug Event Register (37-47)
2298
2299- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2300 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2301 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2302 CFG_BR1_PRELIM:
2303 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2304
2305- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2306 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2307 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2308 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2309
2310- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2311 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2312 Machine Mode Register and Memory Periodic Timer
2313 Prescaler definitions (SDRAM timing)
2314
2315- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2316 enable I2C microcode relocation patch (MPC8xx);
2317 define relocation offset in DPRAM [DSP2]
2318
2319- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2320 enable SPI microcode relocation patch (MPC8xx);
2321 define relocation offset in DPRAM [SCC4]
2322
2323- CFG_USE_OSCCLK:
2324 Use OSCM clock mode on MBX8xx board. Be careful,
2325 wrong setting might damage your board. Read
2326 doc/README.MBX before setting this variable!
2327
wdenk2029f4d2002-11-21 23:11:29 +00002328- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00002329 Offset of the bootmode word in DPRAM used by post
2330 (Power On Self Tests). This definition overrides
2331 #define'd default value in commproc.h resp.
2332 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00002333
stroese3d24d6e2003-05-23 11:39:05 +00002334- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2335 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2336 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2337 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2338 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2339 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2340 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
wdenkbf2f8c92003-05-22 22:52:13 +00002341 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2342 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2343
Ben Warren45657152006-09-07 16:50:54 -04002344- CONFIG_SPD_EEPROM
2345 Get DDR timing information from an I2C EEPROM. Common with pluggable
2346 memory modules such as SODIMMs
2347 SPD_EEPROM_ADDRESS
2348 I2C address of the SPD EEPROM
2349
2350- CFG_SPD_BUS_NUM
2351 If SPD EEPROM is on an I2C bus other than the first one, specify here.
2352 Note that the value must resolve to something your driver can deal with.
2353
Timur Tabi054838e2006-10-31 18:44:42 -06002354- CFG_83XX_DDR_USES_CS0
2355 Only for 83xx systems. If specified, then DDR should be configured
2356 using CS0 and CS1 instead of CS2 and CS3.
2357
2358- CFG_83XX_DDR_USES_CS0
2359 Only for 83xx systems. If specified, then DDR should be configured
2360 using CS0 and CS1 instead of CS2 and CS3.
2361
wdenk6203e402004-04-18 10:13:26 +00002362- CONFIG_ETHER_ON_FEC[12]
2363 Define to enable FEC[12] on a 8xx series processor.
2364
2365- CONFIG_FEC[12]_PHY
2366 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00002367 to the given FEC; i. e.
2368 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00002369 means that the PHY with address 4 is connected to FEC1
2370
2371 When set to -1, means to probe for first available.
2372
2373- CONFIG_FEC[12]_PHY_NORXERR
2374 The PHY does not have a RXERR line (RMII only).
2375 (so program the FEC to ignore it).
2376
2377- CONFIG_RMII
2378 Enable RMII mode for all FECs.
2379 Note that this is a global option, we can't
2380 have one FEC in standard MII mode and another in RMII mode.
2381
wdenk20c98a62004-04-23 20:32:05 +00002382- CONFIG_CRC32_VERIFY
2383 Add a verify option to the crc32 command.
2384 The syntax is:
2385
2386 => crc32 -v <address> <count> <crc32>
2387
2388 Where address/count indicate a memory area
2389 and crc32 is the correct crc32 which the
2390 area should have.
2391
wdenk64519362004-07-11 17:40:54 +00002392- CONFIG_LOOPW
2393 Add the "loopw" memory command. This only takes effect if
2394 the memory commands are activated globally (CFG_CMD_MEM).
2395
stroesecc3af832004-12-16 18:46:55 +00002396- CONFIG_MX_CYCLIC
2397 Add the "mdc" and "mwc" memory commands. These are cyclic
2398 "md/mw" commands.
2399 Examples:
2400
wdenk07d7e6b2004-12-16 21:44:03 +00002401 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00002402 This command will print 4 bytes (10,11,12,13) each 500 ms.
2403
wdenk07d7e6b2004-12-16 21:44:03 +00002404 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00002405 This command will write 12345678 to address 100 all 10 ms.
2406
wdenk07d7e6b2004-12-16 21:44:03 +00002407 This only takes effect if the memory commands are activated
stroesecc3af832004-12-16 18:46:55 +00002408 globally (CFG_CMD_MEM).
2409
wdenk3d3d99f2005-04-04 12:44:11 +00002410- CONFIG_SKIP_LOWLEVEL_INIT
2411- CONFIG_SKIP_RELOCATE_UBOOT
2412
wdenke085e5b2005-04-05 23:32:21 +00002413 [ARM only] If these variables are defined, then
2414 certain low level initializations (like setting up
2415 the memory controller) are omitted and/or U-Boot does
2416 not relocate itself into RAM.
2417 Normally these variables MUST NOT be defined. The
2418 only exception is when U-Boot is loaded (to RAM) by
2419 some other boot loader or by a debugger which
2420 performs these intializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00002421
wdenk336b2bc2005-04-02 23:52:25 +00002422
wdenkc6097192002-11-03 00:24:07 +00002423Building the Software:
2424======================
2425
2426Building U-Boot has been tested in native PPC environments (on a
2427PowerBook G3 running LinuxPPC 2000) and in cross environments
2428(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2429NetBSD 1.5 on x86).
2430
2431If you are not using a native PPC environment, it is assumed that you
2432have the GNU cross compiling tools available in your path and named
2433with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2434you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2435the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2436change it to:
2437
2438 CROSS_COMPILE = ppc_4xx-
2439
2440
wdenk544e9732004-02-06 23:19:44 +00002441U-Boot is intended to be simple to build. After installing the
wdenkc6097192002-11-03 00:24:07 +00002442sources you must configure U-Boot for one specific board type. This
2443is done by typing:
2444
2445 make NAME_config
2446
2447where "NAME_config" is the name of one of the existing
2448configurations; the following names are supported:
2449
wdenk914be132004-06-08 00:22:43 +00002450 ADCIOP_config FPS860L_config omap730p2_config
2451 ADS860_config GEN860T_config pcu_e_config
wdenk337f5652004-10-28 00:09:35 +00002452 Alaska8220_config
wdenk914be132004-06-08 00:22:43 +00002453 AR405_config GENIETV_config PIP405_config
2454 at91rm9200dk_config GTH_config QS823_config
2455 CANBT_config hermes_config QS850_config
2456 cmi_mpc5xx_config hymod_config QS860T_config
2457 cogent_common_config IP860_config RPXlite_config
wdenkec432742004-06-09 21:04:48 +00002458 cogent_mpc8260_config IVML24_config RPXlite_DW_config
2459 cogent_mpc8xx_config IVMS8_config RPXsuper_config
2460 CPCI405_config JSE_config rsdproto_config
2461 CPCIISER4_config LANTEC_config Sandpoint8240_config
2462 csb272_config lwmon_config sbc8260_config
wdenk265d2172004-07-10 22:35:59 +00002463 CU824_config MBX860T_config sbc8560_33_config
2464 DUET_ADS_config MBX_config sbc8560_66_config
roy zangd136d662006-11-02 18:49:51 +08002465 EBONY_config mpc7448hpc2_config SM850_config
2466 ELPT860_config MPC8260ADS_config SPD823TS_config
2467 ESTEEM192E_config MPC8540ADS_config stxgp3_config
2468 ETX094_config MPC8540EVAL_config SXNI855T_config
2469 FADS823_config NMPC8560ADS_config TQM823L_config
2470 FADS850SAR_config NETVIA_config TQM850L_config
2471 FADS860T_config omap1510inn_config TQM855L_config
2472 FPS850L_config omap1610h2_config TQM860L_config
2473 omap1610inn_config walnut_config
2474 omap5912osk_config Yukon8220_config
2475 omap2420h4_config ZPC1900_config
wdenk2f0812d2003-10-08 22:45:44 +00002476
wdenk6c59edc2004-05-03 20:45:30 +00002477Note: for some board special configuration names may exist; check if
2478 additional information is available from the board vendor; for
2479 instance, the TQM823L systems are available without (standard)
2480 or with LCD support. You can select such additional "features"
2481 when chosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002482
wdenk6c59edc2004-05-03 20:45:30 +00002483 make TQM823L_config
2484 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002485
wdenk6c59edc2004-05-03 20:45:30 +00002486 make TQM823L_LCD_config
2487 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002488
wdenk6c59edc2004-05-03 20:45:30 +00002489 etc.
wdenkc6097192002-11-03 00:24:07 +00002490
wdenkc6097192002-11-03 00:24:07 +00002491
wdenk6c59edc2004-05-03 20:45:30 +00002492Finally, type "make all", and you should get some working U-Boot
2493images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002494
wdenk6c59edc2004-05-03 20:45:30 +00002495- "u-boot.bin" is a raw binary image
2496- "u-boot" is an image in ELF binary format
2497- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002498
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002499By default the build is performed locally and the objects are saved
2500in the source directory. One of the two methods can be used to change
2501this behavior and build U-Boot to some external directory:
2502
25031. Add O= to the make command line invocations:
2504
2505 make O=/tmp/build distclean
2506 make O=/tmp/build NAME_config
2507 make O=/tmp/build all
2508
25092. Set environment variable BUILD_DIR to point to the desired location:
2510
2511 export BUILD_DIR=/tmp/build
2512 make distclean
2513 make NAME_config
2514 make all
2515
2516Note that the command line "O=" setting overrides the BUILD_DIR environment
2517variable.
2518
wdenkc6097192002-11-03 00:24:07 +00002519
wdenk6c59edc2004-05-03 20:45:30 +00002520Please be aware that the Makefiles assume you are using GNU make, so
2521for instance on NetBSD you might need to use "gmake" instead of
2522native "make".
wdenkc6097192002-11-03 00:24:07 +00002523
wdenkc6097192002-11-03 00:24:07 +00002524
wdenk6c59edc2004-05-03 20:45:30 +00002525If the system board that you have is not listed, then you will need
2526to port U-Boot to your hardware platform. To do this, follow these
2527steps:
wdenkc6097192002-11-03 00:24:07 +00002528
wdenk6c59edc2004-05-03 20:45:30 +000025291. Add a new configuration option for your board to the toplevel
2530 "Makefile" and to the "MAKEALL" script, using the existing
2531 entries as examples. Note that here and at many other places
2532 boards and other names are listed in alphabetical sort order. Please
2533 keep this order.
25342. Create a new directory to hold your board specific code. Add any
2535 files you need. In your board directory, you will need at least
2536 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
25373. Create a new configuration file "include/configs/<board>.h" for
2538 your board
25393. If you're porting U-Boot to a new CPU, then also create a new
2540 directory to hold your CPU specific code. Add any files you need.
25414. Run "make <board>_config" with your new name.
25425. Type "make", and you should get a working "u-boot.srec" file
2543 to be installed on your target system.
25446. Debug and solve any problems that might arise.
2545 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002546
wdenkc6097192002-11-03 00:24:07 +00002547
wdenk6c59edc2004-05-03 20:45:30 +00002548Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2549==============================================================
wdenkc6097192002-11-03 00:24:07 +00002550
wdenk6c59edc2004-05-03 20:45:30 +00002551If you have modified U-Boot sources (for instance added a new board
2552or support for new devices, a new CPU, etc.) you are expected to
2553provide feedback to the other developers. The feedback normally takes
2554the form of a "patch", i. e. a context diff against a certain (latest
2555official or latest in CVS) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002556
wdenk6c59edc2004-05-03 20:45:30 +00002557But before you submit such a patch, please verify that your modifi-
2558cation did not break existing code. At least make sure that *ALL* of
2559the supported boards compile WITHOUT ANY compiler warnings. To do so,
2560just run the "MAKEALL" script, which will configure and build U-Boot
2561for ALL supported system. Be warned, this will take a while. You can
2562select which (cross) compiler to use by passing a `CROSS_COMPILE'
2563environment variable to the script, i. e. to use the cross tools from
2564MontaVista's Hard Hat Linux you can type
wdenkc6097192002-11-03 00:24:07 +00002565
wdenk6c59edc2004-05-03 20:45:30 +00002566 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002567
wdenk6c59edc2004-05-03 20:45:30 +00002568or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002569
wdenk6c59edc2004-05-03 20:45:30 +00002570 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002571
Marian Balakowiczefe063f2006-09-07 17:25:40 +02002572When using the MAKEALL script, the default behaviour is to build U-Boot
2573in the source directory. This location can be changed by setting the
2574BUILD_DIR environment variable. Also, for each target built, the MAKEALL
2575script saves two log files (<target>.ERR and <target>.MAKEALL) in the
2576<source dir>/LOG directory. This default location can be changed by
2577setting the MAKEALL_LOGDIR environment variable. For example:
2578
2579 export BUILD_DIR=/tmp/build
2580 export MAKEALL_LOGDIR=/tmp/log
2581 CROSS_COMPILE=ppc_8xx- MAKEALL
2582
2583With the above settings build objects are saved in the /tmp/build, log
2584files are saved in the /tmp/log and the source tree remains clean during
2585the whole build process.
2586
2587
wdenk6c59edc2004-05-03 20:45:30 +00002588See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002589
wdenkc6097192002-11-03 00:24:07 +00002590
wdenk6c59edc2004-05-03 20:45:30 +00002591Monitor Commands - Overview:
2592============================
wdenkc6097192002-11-03 00:24:07 +00002593
wdenk6c59edc2004-05-03 20:45:30 +00002594go - start application at address 'addr'
2595run - run commands in an environment variable
2596bootm - boot application image from memory
2597bootp - boot image via network using BootP/TFTP protocol
2598tftpboot- boot image via network using TFTP protocol
2599 and env variables "ipaddr" and "serverip"
2600 (and eventually "gatewayip")
2601rarpboot- boot image via network using RARP/TFTP protocol
2602diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2603loads - load S-Record file over serial line
2604loadb - load binary file over serial line (kermit mode)
2605md - memory display
2606mm - memory modify (auto-incrementing)
2607nm - memory modify (constant address)
2608mw - memory write (fill)
2609cp - memory copy
2610cmp - memory compare
2611crc32 - checksum calculation
2612imd - i2c memory display
2613imm - i2c memory modify (auto-incrementing)
2614inm - i2c memory modify (constant address)
2615imw - i2c memory write (fill)
2616icrc32 - i2c checksum calculation
2617iprobe - probe to discover valid I2C chip addresses
2618iloop - infinite loop on address range
2619isdram - print SDRAM configuration information
2620sspi - SPI utility commands
2621base - print or set address offset
2622printenv- print environment variables
2623setenv - set environment variables
2624saveenv - save environment variables to persistent storage
2625protect - enable or disable FLASH write protection
2626erase - erase FLASH memory
2627flinfo - print FLASH memory information
2628bdinfo - print Board Info structure
2629iminfo - print header information for application image
2630coninfo - print console devices and informations
2631ide - IDE sub-system
2632loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00002633loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00002634mtest - simple RAM test
2635icache - enable or disable instruction cache
2636dcache - enable or disable data cache
2637reset - Perform RESET of the CPU
2638echo - echo args to console
2639version - print monitor version
2640help - print online help
2641? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002642
wdenkc6097192002-11-03 00:24:07 +00002643
wdenk6c59edc2004-05-03 20:45:30 +00002644Monitor Commands - Detailed Description:
2645========================================
wdenkc6097192002-11-03 00:24:07 +00002646
wdenk6c59edc2004-05-03 20:45:30 +00002647TODO.
wdenkc6097192002-11-03 00:24:07 +00002648
wdenk6c59edc2004-05-03 20:45:30 +00002649For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002650
2651
wdenk6c59edc2004-05-03 20:45:30 +00002652Environment Variables:
2653======================
wdenkc6097192002-11-03 00:24:07 +00002654
wdenk6c59edc2004-05-03 20:45:30 +00002655U-Boot supports user configuration using Environment Variables which
2656can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002657
wdenk6c59edc2004-05-03 20:45:30 +00002658Environment Variables are set using "setenv", printed using
2659"printenv", and saved to Flash using "saveenv". Using "setenv"
2660without a value can be used to delete a variable from the
2661environment. As long as you don't save the environment you are
2662working with an in-memory copy. In case the Flash area containing the
2663environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002664
wdenk6c59edc2004-05-03 20:45:30 +00002665Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002666
wdenk6c59edc2004-05-03 20:45:30 +00002667 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002668
wdenk6c59edc2004-05-03 20:45:30 +00002669 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002670
wdenk6c59edc2004-05-03 20:45:30 +00002671 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002672
wdenk6c59edc2004-05-03 20:45:30 +00002673 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002674
wdenk6c59edc2004-05-03 20:45:30 +00002675 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002676
wdenk6c59edc2004-05-03 20:45:30 +00002677 autoload - if set to "no" (any string beginning with 'n'),
2678 "bootp" will just load perform a lookup of the
2679 configuration from the BOOTP server, but not try to
2680 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002681
wdenk6c59edc2004-05-03 20:45:30 +00002682 autostart - if set to "yes", an image loaded using the "bootp",
2683 "rarpboot", "tftpboot" or "diskboot" commands will
2684 be automatically started (by internally calling
2685 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002686
wdenk6c59edc2004-05-03 20:45:30 +00002687 If set to "no", a standalone image passed to the
2688 "bootm" command will be copied to the load address
2689 (and eventually uncompressed), but NOT be started.
2690 This can be used to load and uncompress arbitrary
2691 data.
wdenkc6097192002-11-03 00:24:07 +00002692
wdenk0e2bd9c2004-06-06 21:51:03 +00002693 i2cfast - (PPC405GP|PPC405EP only)
2694 if set to 'y' configures Linux I2C driver for fast
2695 mode (400kHZ). This environment variable is used in
2696 initialization code. So, for changes to be effective
2697 it must be saved and board must be reset.
2698
wdenk6c59edc2004-05-03 20:45:30 +00002699 initrd_high - restrict positioning of initrd images:
2700 If this variable is not set, initrd images will be
2701 copied to the highest possible address in RAM; this
2702 is usually what you want since it allows for
2703 maximum initrd size. If for some reason you want to
2704 make sure that the initrd image is loaded below the
2705 CFG_BOOTMAPSZ limit, you can set this environment
2706 variable to a value of "no" or "off" or "0".
2707 Alternatively, you can set it to a maximum upper
2708 address to use (U-Boot will still check that it
2709 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002710
wdenk6c59edc2004-05-03 20:45:30 +00002711 For instance, when you have a system with 16 MB
2712 RAM, and want to reserve 4 MB from use by Linux,
2713 you can do this by adding "mem=12M" to the value of
2714 the "bootargs" variable. However, now you must make
2715 sure that the initrd image is placed in the first
2716 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002717
wdenk6c59edc2004-05-03 20:45:30 +00002718 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002719
wdenk6c59edc2004-05-03 20:45:30 +00002720 If you set initrd_high to 0xFFFFFFFF, this is an
2721 indication to U-Boot that all addresses are legal
2722 for the Linux kernel, including addresses in flash
2723 memory. In this case U-Boot will NOT COPY the
2724 ramdisk at all. This may be useful to reduce the
2725 boot time on your system, but requires that this
2726 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00002727
wdenk6c59edc2004-05-03 20:45:30 +00002728 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002729
wdenk6c59edc2004-05-03 20:45:30 +00002730 loadaddr - Default load address for commands like "bootp",
2731 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002732
wdenk6c59edc2004-05-03 20:45:30 +00002733 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002734
wdenk6c59edc2004-05-03 20:45:30 +00002735 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00002736
wdenk6c59edc2004-05-03 20:45:30 +00002737 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002738
wdenk6c59edc2004-05-03 20:45:30 +00002739 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002740
wdenk6c59edc2004-05-03 20:45:30 +00002741 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002742
wdenk6c59edc2004-05-03 20:45:30 +00002743 ethprime - When CONFIG_NET_MULTI is enabled controls which
2744 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002745
wdenk6c59edc2004-05-03 20:45:30 +00002746 ethact - When CONFIG_NET_MULTI is enabled controls which
2747 interface is currently active. For example you
2748 can do the following
wdenkc6097192002-11-03 00:24:07 +00002749
wdenk6c59edc2004-05-03 20:45:30 +00002750 => setenv ethact FEC ETHERNET
2751 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2752 => setenv ethact SCC ETHERNET
2753 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002754
wdenk6c59edc2004-05-03 20:45:30 +00002755 netretry - When set to "no" each network operation will
2756 either succeed or fail without retrying.
2757 When set to "once" the network operation will
2758 fail when all the available network interfaces
2759 are tried once without success.
2760 Useful on scripts which control the retry operation
2761 themselves.
wdenkc6097192002-11-03 00:24:07 +00002762
Wolfgang Denk227b5192005-09-24 23:25:46 +02002763 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002764 UDP source port.
2765
Wolfgang Denk227b5192005-09-24 23:25:46 +02002766 tftpdstport - If this is set, the value is used for TFTP's UDP
2767 destination port instead of the Well Know Port 69.
2768
wdenk6c59edc2004-05-03 20:45:30 +00002769 vlan - When set to a value < 4095 the traffic over
2770 ethernet is encapsulated/received over 802.1q
2771 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00002772
wdenk6c59edc2004-05-03 20:45:30 +00002773The following environment variables may be used and automatically
2774updated by the network boot commands ("bootp" and "rarpboot"),
2775depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00002776
wdenk6c59edc2004-05-03 20:45:30 +00002777 bootfile - see above
2778 dnsip - IP address of your Domain Name Server
2779 dnsip2 - IP address of your secondary Domain Name Server
2780 gatewayip - IP address of the Gateway (Router) to use
2781 hostname - Target hostname
2782 ipaddr - see above
2783 netmask - Subnet Mask
2784 rootpath - Pathname of the root filesystem on the NFS server
2785 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00002786
wdenk145d2c12004-04-15 21:48:45 +00002787
wdenk6c59edc2004-05-03 20:45:30 +00002788There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002789
wdenk6c59edc2004-05-03 20:45:30 +00002790 serial# - contains hardware identification information such
2791 as type string and/or serial number
2792 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00002793
wdenk6c59edc2004-05-03 20:45:30 +00002794These variables can be set only once (usually during manufacturing of
2795the board). U-Boot refuses to delete or overwrite these variables
2796once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00002797
2798
wdenk6c59edc2004-05-03 20:45:30 +00002799Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002800
wdenk6c59edc2004-05-03 20:45:30 +00002801 ver - Contains the U-Boot version string as printed
2802 with the "version" command. This variable is
2803 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00002804
wdenkc6097192002-11-03 00:24:07 +00002805
wdenk6c59edc2004-05-03 20:45:30 +00002806Please note that changes to some configuration parameters may take
2807only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00002808
stroeseb9c17c52003-04-04 15:53:41 +00002809
wdenk6c59edc2004-05-03 20:45:30 +00002810Command Line Parsing:
2811=====================
stroeseb9c17c52003-04-04 15:53:41 +00002812
wdenk6c59edc2004-05-03 20:45:30 +00002813There are two different command line parsers available with U-Boot:
2814the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00002815
wdenk6c59edc2004-05-03 20:45:30 +00002816Old, simple command line parser:
2817--------------------------------
wdenkc6097192002-11-03 00:24:07 +00002818
wdenk6c59edc2004-05-03 20:45:30 +00002819- supports environment variables (through setenv / saveenv commands)
2820- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002821- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00002822- special characters ('$', ';') can be escaped by prefixing with '\',
2823 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002824 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00002825- You can also escape text by enclosing in single apostrophes, for example:
2826 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00002827
wdenk6c59edc2004-05-03 20:45:30 +00002828Hush shell:
2829-----------
wdenkf4688a22003-05-28 08:06:31 +00002830
wdenk6c59edc2004-05-03 20:45:30 +00002831- similar to Bourne shell, with control structures like
2832 if...then...else...fi, for...do...done; while...do...done,
2833 until...do...done, ...
2834- supports environment ("global") variables (through setenv / saveenv
2835 commands) and local shell variables (through standard shell syntax
2836 "name=value"); only environment variables can be used with "run"
2837 command
wdenkf4688a22003-05-28 08:06:31 +00002838
wdenk6c59edc2004-05-03 20:45:30 +00002839General rules:
2840--------------
wdenkf4688a22003-05-28 08:06:31 +00002841
wdenk6c59edc2004-05-03 20:45:30 +00002842(1) If a command line (or an environment variable executed by a "run"
2843 command) contains several commands separated by semicolon, and
2844 one of these commands fails, then the remaining commands will be
2845 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00002846
wdenk6c59edc2004-05-03 20:45:30 +00002847(2) If you execute several variables with one call to run (i. e.
2848 calling run with a list af variables as arguments), any failing
2849 command will cause "run" to terminate, i. e. the remaining
2850 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00002851
wdenk6c59edc2004-05-03 20:45:30 +00002852Note for Redundant Ethernet Interfaces:
2853=======================================
wdenkf4688a22003-05-28 08:06:31 +00002854
wdenk6c59edc2004-05-03 20:45:30 +00002855Some boards come with redundant ethernet interfaces; U-Boot supports
2856such configurations and is capable of automatic selection of a
2857"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00002858
wdenk6c59edc2004-05-03 20:45:30 +00002859Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2860MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2861"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00002862
wdenk6c59edc2004-05-03 20:45:30 +00002863If the network interface stores some valid MAC address (for instance
2864in SROM), this is used as default address if there is NO correspon-
2865ding setting in the environment; if the corresponding environment
2866variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00002867
wdenk6c59edc2004-05-03 20:45:30 +00002868o If the SROM has a valid MAC address, and there is no address in the
2869 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002870
wdenk6c59edc2004-05-03 20:45:30 +00002871o If there is no valid address in the SROM, and a definition in the
2872 environment exists, then the value from the environment variable is
2873 used.
wdenkc6097192002-11-03 00:24:07 +00002874
wdenk6c59edc2004-05-03 20:45:30 +00002875o If both the SROM and the environment contain a MAC address, and
2876 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002877
wdenk6c59edc2004-05-03 20:45:30 +00002878o If both the SROM and the environment contain a MAC address, and the
2879 addresses differ, the value from the environment is used and a
2880 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002881
wdenk6c59edc2004-05-03 20:45:30 +00002882o If neither SROM nor the environment contain a MAC address, an error
2883 is raised.
wdenkc6097192002-11-03 00:24:07 +00002884
wdenkc6097192002-11-03 00:24:07 +00002885
wdenk6c59edc2004-05-03 20:45:30 +00002886Image Formats:
2887==============
wdenkc6097192002-11-03 00:24:07 +00002888
wdenk6c59edc2004-05-03 20:45:30 +00002889The "boot" commands of this monitor operate on "image" files which
2890can be basicly anything, preceeded by a special header; see the
2891definitions in include/image.h for details; basicly, the header
2892defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002893
wdenk6c59edc2004-05-03 20:45:30 +00002894* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2895 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2896 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2897 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
Wolfgang Denk83c15852006-10-24 14:21:16 +02002898* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk6c59edc2004-05-03 20:45:30 +00002899 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk83c15852006-10-24 14:21:16 +02002900 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00002901* Compression Type (uncompressed, gzip, bzip2)
2902* Load Address
2903* Entry Point
2904* Image Name
2905* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002906
wdenk6c59edc2004-05-03 20:45:30 +00002907The header is marked by a special Magic Number, and both the header
2908and the data portions of the image are secured against corruption by
2909CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002910
wdenkc6097192002-11-03 00:24:07 +00002911
wdenk6c59edc2004-05-03 20:45:30 +00002912Linux Support:
2913==============
wdenkc6097192002-11-03 00:24:07 +00002914
wdenk6c59edc2004-05-03 20:45:30 +00002915Although U-Boot should support any OS or standalone application
2916easily, the main focus has always been on Linux during the design of
2917U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002918
wdenk6c59edc2004-05-03 20:45:30 +00002919U-Boot includes many features that so far have been part of some
2920special "boot loader" code within the Linux kernel. Also, any
2921"initrd" images to be used are no longer part of one big Linux image;
2922instead, kernel and "initrd" are separate images. This implementation
2923serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002924
wdenk6c59edc2004-05-03 20:45:30 +00002925- the same features can be used for other OS or standalone
2926 applications (for instance: using compressed images to reduce the
2927 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002928
wdenk6c59edc2004-05-03 20:45:30 +00002929- it becomes much easier to port new Linux kernel versions because
2930 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002931
wdenk6c59edc2004-05-03 20:45:30 +00002932- the same Linux kernel image can now be used with different "initrd"
2933 images; of course this also means that different kernel images can
2934 be run with the same "initrd". This makes testing easier (you don't
2935 have to build a new "zImage.initrd" Linux image when you just
2936 change a file in your "initrd"). Also, a field-upgrade of the
2937 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002938
wdenkc6097192002-11-03 00:24:07 +00002939
wdenk6c59edc2004-05-03 20:45:30 +00002940Linux HOWTO:
2941============
wdenkc6097192002-11-03 00:24:07 +00002942
wdenk6c59edc2004-05-03 20:45:30 +00002943Porting Linux to U-Boot based systems:
2944---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002945
wdenk6c59edc2004-05-03 20:45:30 +00002946U-Boot cannot save you from doing all the necessary modifications to
2947configure the Linux device drivers for use with your target hardware
2948(no, we don't intend to provide a full virtual machine interface to
2949Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002950
wdenk6c59edc2004-05-03 20:45:30 +00002951But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002952
wdenk6c59edc2004-05-03 20:45:30 +00002953Just make sure your machine specific header file (for instance
2954include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2955Information structure as we define in include/u-boot.h, and make
2956sure that your definition of IMAP_ADDR uses the same value as your
2957U-Boot configuration in CFG_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002958
wdenkc6097192002-11-03 00:24:07 +00002959
wdenk6c59edc2004-05-03 20:45:30 +00002960Configuring the Linux kernel:
2961-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002962
wdenk6c59edc2004-05-03 20:45:30 +00002963No specific requirements for U-Boot. Make sure you have some root
2964device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002965
wdenkc6097192002-11-03 00:24:07 +00002966
wdenk6c59edc2004-05-03 20:45:30 +00002967Building a Linux Image:
2968-----------------------
wdenkc6097192002-11-03 00:24:07 +00002969
wdenk6c59edc2004-05-03 20:45:30 +00002970With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2971not used. If you use recent kernel source, a new build target
2972"uImage" will exist which automatically builds an image usable by
2973U-Boot. Most older kernels also have support for a "pImage" target,
2974which was introduced for our predecessor project PPCBoot and uses a
2975100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002976
wdenk6c59edc2004-05-03 20:45:30 +00002977Example:
wdenkc6097192002-11-03 00:24:07 +00002978
wdenk6c59edc2004-05-03 20:45:30 +00002979 make TQM850L_config
2980 make oldconfig
2981 make dep
2982 make uImage
wdenkc6097192002-11-03 00:24:07 +00002983
wdenk6c59edc2004-05-03 20:45:30 +00002984The "uImage" build target uses a special tool (in 'tools/mkimage') to
2985encapsulate a compressed Linux kernel image with header information,
2986CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002987
wdenk6c59edc2004-05-03 20:45:30 +00002988* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002989
wdenk6c59edc2004-05-03 20:45:30 +00002990* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002991
wdenk6c59edc2004-05-03 20:45:30 +00002992 ${CROSS_COMPILE}-objcopy -O binary \
2993 -R .note -R .comment \
2994 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00002995
wdenk6c59edc2004-05-03 20:45:30 +00002996* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00002997
wdenk6c59edc2004-05-03 20:45:30 +00002998 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00002999
wdenk6c59edc2004-05-03 20:45:30 +00003000* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003001
wdenk6c59edc2004-05-03 20:45:30 +00003002 mkimage -A ppc -O linux -T kernel -C gzip \
3003 -a 0 -e 0 -n "Linux Kernel Image" \
3004 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00003005
wdenkc6097192002-11-03 00:24:07 +00003006
wdenk6c59edc2004-05-03 20:45:30 +00003007The "mkimage" tool can also be used to create ramdisk images for use
3008with U-Boot, either separated from the Linux kernel image, or
3009combined into one file. "mkimage" encapsulates the images with a 64
3010byte header containing information about target architecture,
3011operating system, image type, compression method, entry points, time
3012stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00003013
wdenk6c59edc2004-05-03 20:45:30 +00003014"mkimage" can be called in two ways: to verify existing images and
3015print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003016
wdenk6c59edc2004-05-03 20:45:30 +00003017In the first form (with "-l" option) mkimage lists the information
3018contained in the header of an existing U-Boot image; this includes
3019checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003020
wdenk6c59edc2004-05-03 20:45:30 +00003021 tools/mkimage -l image
3022 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003023
wdenk6c59edc2004-05-03 20:45:30 +00003024The second form (with "-d" option) is used to build a U-Boot image
3025from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003026
wdenk6c59edc2004-05-03 20:45:30 +00003027 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3028 -n name -d data_file image
3029 -A ==> set architecture to 'arch'
3030 -O ==> set operating system to 'os'
3031 -T ==> set image type to 'type'
3032 -C ==> set compression type 'comp'
3033 -a ==> set load address to 'addr' (hex)
3034 -e ==> set entry point to 'ep' (hex)
3035 -n ==> set image name to 'name'
3036 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003037
wdenkcd914452004-05-29 16:53:29 +00003038Right now, all Linux kernels for PowerPC systems use the same load
3039address (0x00000000), but the entry point address depends on the
3040kernel version:
wdenkc6097192002-11-03 00:24:07 +00003041
wdenk6c59edc2004-05-03 20:45:30 +00003042- 2.2.x kernels have the entry point at 0x0000000C,
3043- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003044
wdenk6c59edc2004-05-03 20:45:30 +00003045So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003046
wdenk6c59edc2004-05-03 20:45:30 +00003047 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3048 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3049 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3050 > examples/uImage.TQM850L
3051 Image Name: 2.4.4 kernel for TQM850L
3052 Created: Wed Jul 19 02:34:59 2000
3053 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3054 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3055 Load Address: 0x00000000
3056 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003057
wdenk6c59edc2004-05-03 20:45:30 +00003058To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003059
wdenk6c59edc2004-05-03 20:45:30 +00003060 -> tools/mkimage -l examples/uImage.TQM850L
3061 Image Name: 2.4.4 kernel for TQM850L
3062 Created: Wed Jul 19 02:34:59 2000
3063 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3064 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3065 Load Address: 0x00000000
3066 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003067
wdenk6c59edc2004-05-03 20:45:30 +00003068NOTE: for embedded systems where boot time is critical you can trade
3069speed for memory and install an UNCOMPRESSED image instead: this
3070needs more space in Flash, but boots much faster since it does not
3071need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003072
wdenk6c59edc2004-05-03 20:45:30 +00003073 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3074 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3075 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3076 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3077 > examples/uImage.TQM850L-uncompressed
3078 Image Name: 2.4.4 kernel for TQM850L
3079 Created: Wed Jul 19 02:34:59 2000
3080 Image Type: PowerPC Linux Kernel Image (uncompressed)
3081 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3082 Load Address: 0x00000000
3083 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003084
wdenkc6097192002-11-03 00:24:07 +00003085
wdenk6c59edc2004-05-03 20:45:30 +00003086Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3087when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00003088
wdenk6c59edc2004-05-03 20:45:30 +00003089 -> tools/mkimage -n 'Simple Ramdisk Image' \
3090 > -A ppc -O linux -T ramdisk -C gzip \
3091 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3092 Image Name: Simple Ramdisk Image
3093 Created: Wed Jan 12 14:01:50 2000
3094 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3095 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3096 Load Address: 0x00000000
3097 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003098
wdenkc6097192002-11-03 00:24:07 +00003099
wdenk6c59edc2004-05-03 20:45:30 +00003100Installing a Linux Image:
3101-------------------------
wdenkc6097192002-11-03 00:24:07 +00003102
wdenk6c59edc2004-05-03 20:45:30 +00003103To downloading a U-Boot image over the serial (console) interface,
3104you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00003105
wdenk6c59edc2004-05-03 20:45:30 +00003106 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00003107
wdenk6c59edc2004-05-03 20:45:30 +00003108The 'objcopy' does not understand the information in the U-Boot
3109image header, so the resulting S-Record file will be relative to
3110address 0x00000000. To load it to a given address, you need to
3111specify the target address as 'offset' parameter with the 'loads'
3112command.
wdenkc6097192002-11-03 00:24:07 +00003113
wdenk6c59edc2004-05-03 20:45:30 +00003114Example: install the image to address 0x40100000 (which on the
3115TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003116
wdenk6c59edc2004-05-03 20:45:30 +00003117 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003118
wdenk6c59edc2004-05-03 20:45:30 +00003119 .......... done
3120 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003121
wdenk6c59edc2004-05-03 20:45:30 +00003122 => loads 40100000
3123 ## Ready for S-Record download ...
3124 ~>examples/image.srec
3125 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3126 ...
3127 15989 15990 15991 15992
3128 [file transfer complete]
3129 [connected]
3130 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003131
wdenkc6097192002-11-03 00:24:07 +00003132
wdenk6c59edc2004-05-03 20:45:30 +00003133You can check the success of the download using the 'iminfo' command;
3134this includes a checksum verification so you can be sure no data
3135corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003136
wdenk6c59edc2004-05-03 20:45:30 +00003137 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003138
wdenk6c59edc2004-05-03 20:45:30 +00003139 ## Checking Image at 40100000 ...
3140 Image Name: 2.2.13 for initrd on TQM850L
3141 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3142 Data Size: 335725 Bytes = 327 kB = 0 MB
3143 Load Address: 00000000
3144 Entry Point: 0000000c
3145 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003146
3147
wdenk6c59edc2004-05-03 20:45:30 +00003148Boot Linux:
3149-----------
wdenkc6097192002-11-03 00:24:07 +00003150
wdenk6c59edc2004-05-03 20:45:30 +00003151The "bootm" command is used to boot an application that is stored in
3152memory (RAM or Flash). In case of a Linux kernel image, the contents
3153of the "bootargs" environment variable is passed to the kernel as
3154parameters. You can check and modify this variable using the
3155"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003156
wdenkc6097192002-11-03 00:24:07 +00003157
wdenk6c59edc2004-05-03 20:45:30 +00003158 => printenv bootargs
3159 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003160
wdenk6c59edc2004-05-03 20:45:30 +00003161 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00003162
wdenk6c59edc2004-05-03 20:45:30 +00003163 => printenv bootargs
3164 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00003165
wdenk6c59edc2004-05-03 20:45:30 +00003166 => bootm 40020000
3167 ## Booting Linux kernel at 40020000 ...
3168 Image Name: 2.2.13 for NFS on TQM850L
3169 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3170 Data Size: 381681 Bytes = 372 kB = 0 MB
3171 Load Address: 00000000
3172 Entry Point: 0000000c
3173 Verifying Checksum ... OK
3174 Uncompressing Kernel Image ... OK
3175 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
3176 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3177 time_init: decrementer frequency = 187500000/60
3178 Calibrating delay loop... 49.77 BogoMIPS
3179 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3180 ...
wdenkc6097192002-11-03 00:24:07 +00003181
wdenk6c59edc2004-05-03 20:45:30 +00003182If you want to boot a Linux kernel with initial ram disk, you pass
3183the memory addresses of both the kernel and the initrd image (PPBCOOT
3184format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003185
wdenk6c59edc2004-05-03 20:45:30 +00003186 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003187
wdenk6c59edc2004-05-03 20:45:30 +00003188 ## Checking Image at 40100000 ...
3189 Image Name: 2.2.13 for initrd on TQM850L
3190 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3191 Data Size: 335725 Bytes = 327 kB = 0 MB
3192 Load Address: 00000000
3193 Entry Point: 0000000c
3194 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003195
wdenk6c59edc2004-05-03 20:45:30 +00003196 ## Checking Image at 40200000 ...
3197 Image Name: Simple Ramdisk Image
3198 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3199 Data Size: 566530 Bytes = 553 kB = 0 MB
3200 Load Address: 00000000
3201 Entry Point: 00000000
3202 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003203
wdenk6c59edc2004-05-03 20:45:30 +00003204 => bootm 40100000 40200000
3205 ## Booting Linux kernel at 40100000 ...
3206 Image Name: 2.2.13 for initrd on TQM850L
3207 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3208 Data Size: 335725 Bytes = 327 kB = 0 MB
3209 Load Address: 00000000
3210 Entry Point: 0000000c
3211 Verifying Checksum ... OK
3212 Uncompressing Kernel Image ... OK
3213 ## Loading RAMDisk Image at 40200000 ...
3214 Image Name: Simple Ramdisk Image
3215 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3216 Data Size: 566530 Bytes = 553 kB = 0 MB
3217 Load Address: 00000000
3218 Entry Point: 00000000
3219 Verifying Checksum ... OK
3220 Loading Ramdisk ... OK
3221 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
3222 Boot arguments: root=/dev/ram
3223 time_init: decrementer frequency = 187500000/60
3224 Calibrating delay loop... 49.77 BogoMIPS
3225 ...
3226 RAMDISK: Compressed image found at block 0
3227 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk6c59edc2004-05-03 20:45:30 +00003229 bash#
wdenkc6097192002-11-03 00:24:07 +00003230
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003231Boot Linux and pass a flat device tree:
3232-----------
3233
3234First, U-Boot must be compiled with the appropriate defines. See the section
3235titled "Linux Kernel Interface" above for a more in depth explanation. The
3236following is an example of how to start a kernel and pass an updated
3237flat device tree:
3238
3239=> print oftaddr
3240oftaddr=0x300000
3241=> print oft
3242oft=oftrees/mpc8540ads.dtb
3243=> tftp $oftaddr $oft
3244Speed: 1000, full duplex
3245Using TSEC0 device
3246TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3247Filename 'oftrees/mpc8540ads.dtb'.
3248Load address: 0x300000
3249Loading: #
3250done
3251Bytes transferred = 4106 (100a hex)
3252=> tftp $loadaddr $bootfile
3253Speed: 1000, full duplex
3254Using TSEC0 device
3255TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3256Filename 'uImage'.
3257Load address: 0x200000
3258Loading:############
3259done
3260Bytes transferred = 1029407 (fb51f hex)
3261=> print loadaddr
3262loadaddr=200000
3263=> print oftaddr
3264oftaddr=0x300000
3265=> bootm $loadaddr - $oftaddr
3266## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01003267 Image Name: Linux-2.6.17-dirty
3268 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3269 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003270 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01003271 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05003272 Verifying Checksum ... OK
3273 Uncompressing Kernel Image ... OK
3274Booting using flat device tree at 0x300000
3275Using MPC85xx ADS machine description
3276Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3277[snip]
3278
3279
wdenk6c59edc2004-05-03 20:45:30 +00003280More About U-Boot Image Types:
3281------------------------------
wdenkc6097192002-11-03 00:24:07 +00003282
wdenk6c59edc2004-05-03 20:45:30 +00003283U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00003284
wdenk6c59edc2004-05-03 20:45:30 +00003285 "Standalone Programs" are directly runnable in the environment
3286 provided by U-Boot; it is expected that (if they behave
3287 well) you can continue to work in U-Boot after return from
3288 the Standalone Program.
3289 "OS Kernel Images" are usually images of some Embedded OS which
3290 will take over control completely. Usually these programs
3291 will install their own set of exception handlers, device
3292 drivers, set up the MMU, etc. - this means, that you cannot
3293 expect to re-enter U-Boot except by resetting the CPU.
3294 "RAMDisk Images" are more or less just data blocks, and their
3295 parameters (address, size) are passed to an OS kernel that is
3296 being started.
3297 "Multi-File Images" contain several images, typically an OS
3298 (Linux) kernel image and one or more data images like
3299 RAMDisks. This construct is useful for instance when you want
3300 to boot over the network using BOOTP etc., where the boot
3301 server provides just a single image file, but you want to get
3302 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00003303
wdenk6c59edc2004-05-03 20:45:30 +00003304 "Multi-File Images" start with a list of image sizes, each
3305 image size (in bytes) specified by an "uint32_t" in network
3306 byte order. This list is terminated by an "(uint32_t)0".
3307 Immediately after the terminating 0 follow the images, one by
3308 one, all aligned on "uint32_t" boundaries (size rounded up to
3309 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00003310
wdenk6c59edc2004-05-03 20:45:30 +00003311 "Firmware Images" are binary images containing firmware (like
3312 U-Boot or FPGA images) which usually will be programmed to
3313 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00003314
wdenk6c59edc2004-05-03 20:45:30 +00003315 "Script files" are command sequences that will be executed by
3316 U-Boot's command interpreter; this feature is especially
3317 useful when you configure U-Boot to use a real shell (hush)
3318 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00003319
stroeseb9c17c52003-04-04 15:53:41 +00003320
wdenk6c59edc2004-05-03 20:45:30 +00003321Standalone HOWTO:
3322=================
stroeseb9c17c52003-04-04 15:53:41 +00003323
wdenk6c59edc2004-05-03 20:45:30 +00003324One of the features of U-Boot is that you can dynamically load and
3325run "standalone" applications, which can use some resources of
3326U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00003327
wdenk6c59edc2004-05-03 20:45:30 +00003328Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00003329
wdenk6c59edc2004-05-03 20:45:30 +00003330"Hello World" Demo:
3331-------------------
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk6c59edc2004-05-03 20:45:30 +00003333'examples/hello_world.c' contains a small "Hello World" Demo
3334application; it is automatically compiled when you build U-Boot.
3335It's configured to run at address 0x00040004, so you can play with it
3336like that:
wdenkc6097192002-11-03 00:24:07 +00003337
wdenk6c59edc2004-05-03 20:45:30 +00003338 => loads
3339 ## Ready for S-Record download ...
3340 ~>examples/hello_world.srec
3341 1 2 3 4 5 6 7 8 9 10 11 ...
3342 [file transfer complete]
3343 [connected]
3344 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003345
wdenk6c59edc2004-05-03 20:45:30 +00003346 => go 40004 Hello World! This is a test.
3347 ## Starting application at 0x00040004 ...
3348 Hello World
3349 argc = 7
3350 argv[0] = "40004"
3351 argv[1] = "Hello"
3352 argv[2] = "World!"
3353 argv[3] = "This"
3354 argv[4] = "is"
3355 argv[5] = "a"
3356 argv[6] = "test."
3357 argv[7] = "<NULL>"
3358 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003359
wdenk6c59edc2004-05-03 20:45:30 +00003360 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003361
wdenk6c59edc2004-05-03 20:45:30 +00003362Another example, which demonstrates how to register a CPM interrupt
3363handler with the U-Boot code, can be found in 'examples/timer.c'.
3364Here, a CPM timer is set up to generate an interrupt every second.
3365The interrupt service routine is trivial, just printing a '.'
3366character, but this is just a demo program. The application can be
3367controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003368
wdenk6c59edc2004-05-03 20:45:30 +00003369 ? - print current values og the CPM Timer registers
3370 b - enable interrupts and start timer
3371 e - stop timer and disable interrupts
3372 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003373
wdenk6c59edc2004-05-03 20:45:30 +00003374 => loads
3375 ## Ready for S-Record download ...
3376 ~>examples/timer.srec
3377 1 2 3 4 5 6 7 8 9 10 11 ...
3378 [file transfer complete]
3379 [connected]
3380 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003381
wdenk6c59edc2004-05-03 20:45:30 +00003382 => go 40004
3383 ## Starting application at 0x00040004 ...
3384 TIMERS=0xfff00980
3385 Using timer 1
3386 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003387
wdenk6c59edc2004-05-03 20:45:30 +00003388Hit 'b':
3389 [q, b, e, ?] Set interval 1000000 us
3390 Enabling timer
3391Hit '?':
3392 [q, b, e, ?] ........
3393 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3394Hit '?':
3395 [q, b, e, ?] .
3396 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3397Hit '?':
3398 [q, b, e, ?] .
3399 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3400Hit '?':
3401 [q, b, e, ?] .
3402 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3403Hit 'e':
3404 [q, b, e, ?] ...Stopping timer
3405Hit 'q':
3406 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003407
wdenkc6097192002-11-03 00:24:07 +00003408
wdenk6c59edc2004-05-03 20:45:30 +00003409Minicom warning:
3410================
wdenkc6097192002-11-03 00:24:07 +00003411
wdenk6c59edc2004-05-03 20:45:30 +00003412Over time, many people have reported problems when trying to use the
3413"minicom" terminal emulation program for serial download. I (wd)
3414consider minicom to be broken, and recommend not to use it. Under
3415Unix, I recommend to use C-Kermit for general purpose use (and
3416especially for kermit binary protocol download ("loadb" command), and
3417use "cu" for S-Record download ("loads" command).
wdenkc6097192002-11-03 00:24:07 +00003418
wdenk6c59edc2004-05-03 20:45:30 +00003419Nevertheless, if you absolutely want to use it try adding this
3420configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00003421
wdenk6c59edc2004-05-03 20:45:30 +00003422 Name Program Name U/D FullScr IO-Red. Multi
3423 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3424 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00003425
wdenk8dba0502003-03-31 16:34:49 +00003426
wdenk6c59edc2004-05-03 20:45:30 +00003427NetBSD Notes:
3428=============
wdenkc6097192002-11-03 00:24:07 +00003429
wdenk6c59edc2004-05-03 20:45:30 +00003430Starting at version 0.9.2, U-Boot supports NetBSD both as host
3431(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00003432
wdenk6c59edc2004-05-03 20:45:30 +00003433Building requires a cross environment; it is known to work on
3434NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3435need gmake since the Makefiles are not compatible with BSD make).
3436Note that the cross-powerpc package does not install include files;
3437attempting to build U-Boot will fail because <machine/ansi.h> is
3438missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00003439
wdenk6c59edc2004-05-03 20:45:30 +00003440 # cd /usr/pkg/cross/powerpc-netbsd/include
3441 # mkdir powerpc
3442 # ln -s powerpc machine
3443 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3444 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00003445
wdenk6c59edc2004-05-03 20:45:30 +00003446Native builds *don't* work due to incompatibilities between native
3447and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003448
wdenk6c59edc2004-05-03 20:45:30 +00003449Booting assumes that (the first part of) the image booted is a
3450stage-2 loader which in turn loads and then invokes the kernel
3451proper. Loader sources will eventually appear in the NetBSD source
3452tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00003453meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003454
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk6c59edc2004-05-03 20:45:30 +00003456Implementation Internals:
3457=========================
wdenkc6097192002-11-03 00:24:07 +00003458
wdenk6c59edc2004-05-03 20:45:30 +00003459The following is not intended to be a complete description of every
3460implementation detail. However, it should help to understand the
3461inner workings of U-Boot and make it easier to port it to custom
3462hardware.
wdenkc6097192002-11-03 00:24:07 +00003463
wdenkc6097192002-11-03 00:24:07 +00003464
wdenk6c59edc2004-05-03 20:45:30 +00003465Initial Stack, Global Data:
3466---------------------------
wdenkc6097192002-11-03 00:24:07 +00003467
wdenk6c59edc2004-05-03 20:45:30 +00003468The implementation of U-Boot is complicated by the fact that U-Boot
3469starts running out of ROM (flash memory), usually without access to
3470system RAM (because the memory controller is not initialized yet).
3471This means that we don't have writable Data or BSS segments, and BSS
3472is not initialized as zero. To be able to get a C environment working
3473at all, we have to allocate at least a minimal stack. Implementation
3474options for this are defined and restricted by the CPU used: Some CPU
3475models provide on-chip memory (like the IMMR area on MPC8xx and
3476MPC826x processors), on others (parts of) the data cache can be
3477locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003478
wdenk6c59edc2004-05-03 20:45:30 +00003479 Chris Hallinan posted a good summary of these issues to the
3480 u-boot-users mailing list:
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk6c59edc2004-05-03 20:45:30 +00003482 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3483 From: "Chris Hallinan" <clh@net1plus.com>
3484 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3485 ...
wdenkc6097192002-11-03 00:24:07 +00003486
wdenk6c59edc2004-05-03 20:45:30 +00003487 Correct me if I'm wrong, folks, but the way I understand it
3488 is this: Using DCACHE as initial RAM for Stack, etc, does not
3489 require any physical RAM backing up the cache. The cleverness
3490 is that the cache is being used as a temporary supply of
3491 necessary storage before the SDRAM controller is setup. It's
3492 beyond the scope of this list to expain the details, but you
3493 can see how this works by studying the cache architecture and
3494 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00003495
wdenk6c59edc2004-05-03 20:45:30 +00003496 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3497 is another option for the system designer to use as an
3498 initial stack/ram area prior to SDRAM being available. Either
3499 option should work for you. Using CS 4 should be fine if your
3500 board designers haven't used it for something that would
3501 cause you grief during the initial boot! It is frequently not
3502 used.
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk6c59edc2004-05-03 20:45:30 +00003504 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3505 with your processor/board/system design. The default value
3506 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02003507 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00003508 than your SDRAM module. If you have a 64MB SDRAM module, set
3509 it above 400_0000. Just make sure your board has no resources
3510 that are supposed to respond to that address! That code in
3511 start.S has been around a while and should work as is when
3512 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00003513
wdenk6c59edc2004-05-03 20:45:30 +00003514 -Chris Hallinan
3515 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00003516
wdenk6c59edc2004-05-03 20:45:30 +00003517It is essential to remember this, since it has some impact on the C
3518code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00003519
wdenk6c59edc2004-05-03 20:45:30 +00003520* Initialized global data (data segment) is read-only. Do not attempt
3521 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00003522
wdenk6c59edc2004-05-03 20:45:30 +00003523* Do not use any unitialized global data (or implicitely initialized
3524 as zero data - BSS segment) at all - this is undefined, initiali-
3525 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00003526
wdenk6c59edc2004-05-03 20:45:30 +00003527* Stack space is very limited. Avoid big data buffers or things like
3528 that.
wdenk4a5c8a72003-03-06 00:02:04 +00003529
wdenk6c59edc2004-05-03 20:45:30 +00003530Having only the stack as writable memory limits means we cannot use
3531normal global data to share information beween the code. But it
3532turned out that the implementation of U-Boot can be greatly
3533simplified by making a global data structure (gd_t) available to all
3534functions. We could pass a pointer to this data as argument to _all_
3535functions, but this would bloat the code. Instead we use a feature of
3536the GCC compiler (Global Register Variables) to share the data: we
3537place a pointer (gd) to the global data into a register which we
3538reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003539
wdenk6c59edc2004-05-03 20:45:30 +00003540When choosing a register for such a purpose we are restricted by the
3541relevant (E)ABI specifications for the current architecture, and by
3542GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003543
wdenk6c59edc2004-05-03 20:45:30 +00003544For PowerPC, the following registers have specific use:
3545 R1: stack pointer
3546 R2: TOC pointer
3547 R3-R4: parameter passing and return values
3548 R5-R10: parameter passing
3549 R13: small data area pointer
3550 R30: GOT pointer
3551 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003552
wdenk6c59edc2004-05-03 20:45:30 +00003553 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003554
wdenk6c59edc2004-05-03 20:45:30 +00003555 ==> U-Boot will use R29 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003556
wdenk6c59edc2004-05-03 20:45:30 +00003557 Note: on PPC, we could use a static initializer (since the
3558 address of the global data structure is known at compile time),
3559 but it turned out that reserving a register results in somewhat
3560 smaller code - although the code savings are not that big (on
3561 average for all boards 752 bytes for the whole U-Boot image,
3562 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003563
wdenk6c59edc2004-05-03 20:45:30 +00003564On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003565
wdenk6c59edc2004-05-03 20:45:30 +00003566 R0: function argument word/integer result
3567 R1-R3: function argument word
3568 R9: GOT pointer
3569 R10: stack limit (used only if stack checking if enabled)
3570 R11: argument (frame) pointer
3571 R12: temporary workspace
3572 R13: stack pointer
3573 R14: link register
3574 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003575
wdenk6c59edc2004-05-03 20:45:30 +00003576 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003577
Wolfgang Denk6405a152006-03-31 18:32:53 +02003578NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3579or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003580
wdenk6c59edc2004-05-03 20:45:30 +00003581Memory Management:
3582------------------
wdenkc6097192002-11-03 00:24:07 +00003583
wdenk6c59edc2004-05-03 20:45:30 +00003584U-Boot runs in system state and uses physical addresses, i.e. the
3585MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk6c59edc2004-05-03 20:45:30 +00003587The available memory is mapped to fixed addresses using the memory
3588controller. In this process, a contiguous block is formed for each
3589memory type (Flash, SDRAM, SRAM), even when it consists of several
3590physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003591
wdenk6c59edc2004-05-03 20:45:30 +00003592U-Boot is installed in the first 128 kB of the first Flash bank (on
3593TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3594booting and sizing and initializing DRAM, the code relocates itself
3595to the upper end of DRAM. Immediately below the U-Boot code some
3596memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3597configuration setting]. Below that, a structure with global Board
3598Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003599
wdenk6c59edc2004-05-03 20:45:30 +00003600Additionally, some exception handler code is copied to the low 8 kB
3601of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003602
wdenk6c59edc2004-05-03 20:45:30 +00003603So a typical memory configuration with 16 MB of DRAM could look like
3604this:
wdenkc6097192002-11-03 00:24:07 +00003605
wdenk6c59edc2004-05-03 20:45:30 +00003606 0x0000 0000 Exception Vector code
3607 :
3608 0x0000 1FFF
3609 0x0000 2000 Free for Application Use
3610 :
3611 :
wdenkc6097192002-11-03 00:24:07 +00003612
wdenk6c59edc2004-05-03 20:45:30 +00003613 :
3614 :
3615 0x00FB FF20 Monitor Stack (Growing downward)
3616 0x00FB FFAC Board Info Data and permanent copy of global data
3617 0x00FC 0000 Malloc Arena
3618 :
3619 0x00FD FFFF
3620 0x00FE 0000 RAM Copy of Monitor Code
3621 ... eventually: LCD or video framebuffer
3622 ... eventually: pRAM (Protected RAM - unchanged by reset)
3623 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003624
wdenkc6097192002-11-03 00:24:07 +00003625
wdenk6c59edc2004-05-03 20:45:30 +00003626System Initialization:
3627----------------------
wdenkc6097192002-11-03 00:24:07 +00003628
wdenk6c59edc2004-05-03 20:45:30 +00003629In the reset configuration, U-Boot starts at the reset entry point
3630(on most PowerPC systens at address 0x00000100). Because of the reset
3631configuration for CS0# this is a mirror of the onboard Flash memory.
3632To be able to re-map memory U-Boot then jumps to its link address.
3633To be able to implement the initialization code in C, a (small!)
3634initial stack is set up in the internal Dual Ported RAM (in case CPUs
3635which provide such a feature like MPC8xx or MPC8260), or in a locked
3636part of the data cache. After that, U-Boot initializes the CPU core,
3637the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003638
wdenk6c59edc2004-05-03 20:45:30 +00003639Next, all (potentially) available memory banks are mapped using a
3640preliminary mapping. For example, we put them on 512 MB boundaries
3641(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3642on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3643programmed for SDRAM access. Using the temporary configuration, a
3644simple memory test is run that determines the size of the SDRAM
3645banks.
wdenkc6097192002-11-03 00:24:07 +00003646
wdenk6c59edc2004-05-03 20:45:30 +00003647When there is more than one SDRAM bank, and the banks are of
3648different size, the largest is mapped first. For equal size, the first
3649bank (CS2#) is mapped first. The first mapping is always for address
36500x00000000, with any additional banks following immediately to create
3651contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003652
wdenk6c59edc2004-05-03 20:45:30 +00003653Then, the monitor installs itself at the upper end of the SDRAM area
3654and allocates memory for use by malloc() and for the global Board
3655Info data; also, the exception vector code is copied to the low RAM
3656pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003657
wdenk6c59edc2004-05-03 20:45:30 +00003658Only after this relocation will you have a "normal" C environment;
3659until that you are restricted in several ways, mostly because you are
3660running from ROM, and because the code will have to be relocated to a
3661new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003662
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk6c59edc2004-05-03 20:45:30 +00003664U-Boot Porting Guide:
3665----------------------
wdenkc6097192002-11-03 00:24:07 +00003666
wdenk6c59edc2004-05-03 20:45:30 +00003667[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3668list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003669
wdenkc6097192002-11-03 00:24:07 +00003670
wdenk6c59edc2004-05-03 20:45:30 +00003671int main (int argc, char *argv[])
3672{
3673 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003674
wdenk6c59edc2004-05-03 20:45:30 +00003675 signal (SIGALRM, no_more_time);
3676 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003677
wdenk6c59edc2004-05-03 20:45:30 +00003678 if (available_money > available_manpower) {
3679 pay consultant to port U-Boot;
3680 return 0;
3681 }
wdenkc6097192002-11-03 00:24:07 +00003682
wdenk6c59edc2004-05-03 20:45:30 +00003683 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00003684
wdenk6c59edc2004-05-03 20:45:30 +00003685 Subscribe to u-boot-users mailing list;
wdenkc6097192002-11-03 00:24:07 +00003686
wdenk6c59edc2004-05-03 20:45:30 +00003687 if (clueless) {
3688 email ("Hi, I am new to U-Boot, how do I get started?");
3689 }
wdenkc6097192002-11-03 00:24:07 +00003690
wdenk6c59edc2004-05-03 20:45:30 +00003691 while (learning) {
3692 Read the README file in the top level directory;
3693 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3694 Read the source, Luke;
3695 }
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk6c59edc2004-05-03 20:45:30 +00003697 if (available_money > toLocalCurrency ($2500)) {
3698 Buy a BDI2000;
3699 } else {
3700 Add a lot of aggravation and time;
3701 }
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk6c59edc2004-05-03 20:45:30 +00003703 Create your own board support subdirectory;
wdenk34b613e2002-12-17 01:51:00 +00003704
wdenk6c59edc2004-05-03 20:45:30 +00003705 Create your own board config file;
wdenkc6097192002-11-03 00:24:07 +00003706
wdenk6c59edc2004-05-03 20:45:30 +00003707 while (!running) {
3708 do {
3709 Add / modify source code;
3710 } until (compiles);
3711 Debug;
3712 if (clueless)
3713 email ("Hi, I am having problems...");
wdenk634d2f72004-04-15 23:14:49 +00003714 }
wdenk6c59edc2004-05-03 20:45:30 +00003715 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003716
wdenk6c59edc2004-05-03 20:45:30 +00003717 return 0;
3718}
wdenkc6097192002-11-03 00:24:07 +00003719
wdenk6c59edc2004-05-03 20:45:30 +00003720void no_more_time (int sig)
3721{
3722 hire_a_guru();
3723}
wdenkc6097192002-11-03 00:24:07 +00003724
wdenkc6097192002-11-03 00:24:07 +00003725
wdenk6c59edc2004-05-03 20:45:30 +00003726Coding Standards:
3727-----------------
wdenkc6097192002-11-03 00:24:07 +00003728
wdenk6c59edc2004-05-03 20:45:30 +00003729All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02003730coding style; see the file "Documentation/CodingStyle" and the script
3731"scripts/Lindent" in your Linux kernel source directory. In sources
3732originating from U-Boot a style corresponding to "Lindent -pcs" (adding
3733spaces before parameters to function calls) is actually used.
3734
3735Source files originating from a different project (for example the
3736MTD subsystem) are generally exempt from these guidelines and are not
3737reformated to ease subsequent migration to newer versions of those
3738sources.
wdenkc6097192002-11-03 00:24:07 +00003739
Detlev Zundelaa63d482006-09-01 15:39:02 +02003740Please note that U-Boot is implemented in C (and to some small parts in
3741Assembler); no C++ is used, so please do not use C++ style comments (//)
3742in your code.
wdenkad276f22004-01-04 16:28:35 +00003743
wdenk6c59edc2004-05-03 20:45:30 +00003744Please also stick to the following formatting rules:
3745- remove any trailing white space
3746- use TAB characters for indentation, not spaces
3747- make sure NOT to use DOS '\r\n' line feeds
3748- do not add more than 2 empty lines to source files
3749- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00003750
wdenk6c59edc2004-05-03 20:45:30 +00003751Submissions which do not conform to the standards may be returned
3752with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003753
wdenkc6097192002-11-03 00:24:07 +00003754
wdenk6c59edc2004-05-03 20:45:30 +00003755Submitting Patches:
3756-------------------
wdenkc6097192002-11-03 00:24:07 +00003757
wdenk6c59edc2004-05-03 20:45:30 +00003758Since the number of patches for U-Boot is growing, we need to
3759establish some rules. Submissions which do not conform to these rules
3760may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003761
wdenkcbc49a52005-05-03 14:12:25 +00003762Patches shall be sent to the u-boot-users mailing list.
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk6c59edc2004-05-03 20:45:30 +00003764When you send a patch, please include the following information with
3765it:
wdenkc6097192002-11-03 00:24:07 +00003766
wdenk6c59edc2004-05-03 20:45:30 +00003767* For bug fixes: a description of the bug and how your patch fixes
3768 this bug. Please try to include a way of demonstrating that the
3769 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003770
wdenk6c59edc2004-05-03 20:45:30 +00003771* For new features: a description of the feature and your
3772 implementation.
wdenkc6097192002-11-03 00:24:07 +00003773
wdenk6c59edc2004-05-03 20:45:30 +00003774* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk6c59edc2004-05-03 20:45:30 +00003776* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00003777
wdenk6c59edc2004-05-03 20:45:30 +00003778* When you add support for a new board, don't forget to add this
3779 board to the MAKEALL script, too.
wdenkc6097192002-11-03 00:24:07 +00003780
wdenk6c59edc2004-05-03 20:45:30 +00003781* If your patch adds new configuration options, don't forget to
3782 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00003783
wdenk6c59edc2004-05-03 20:45:30 +00003784* The patch itself. If you are accessing the CVS repository use "cvs
3785 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3786 version of diff does not support these options, then get the latest
3787 version of GNU diff.
wdenkca9bc762003-07-15 07:45:49 +00003788
wdenk6c59edc2004-05-03 20:45:30 +00003789 The current directory when running this command shall be the top
3790 level directory of the U-Boot source tree, or it's parent directory
3791 (i. e. please make sure that your patch includes sufficient
3792 directory information for the affected files).
wdenkc6097192002-11-03 00:24:07 +00003793
wdenk6c59edc2004-05-03 20:45:30 +00003794 We accept patches as plain text, MIME attachments or as uuencoded
3795 gzipped text.
wdenk88e72a32003-06-19 23:04:19 +00003796
wdenk6c59edc2004-05-03 20:45:30 +00003797* If one logical set of modifications affects or creates several
3798 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00003799
wdenk6c59edc2004-05-03 20:45:30 +00003800* Changesets that contain different, unrelated modifications shall be
3801 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00003802
wdenkc6097192002-11-03 00:24:07 +00003803
wdenk6c59edc2004-05-03 20:45:30 +00003804Notes:
wdenkc6097192002-11-03 00:24:07 +00003805
wdenk6c59edc2004-05-03 20:45:30 +00003806* Before sending the patch, run the MAKEALL script on your patched
3807 source tree and make sure that no errors or warnings are reported
3808 for any of the boards.
3809
3810* Keep your modifications to the necessary minimum: A patch
3811 containing several unrelated changes or arbitrary reformats will be
3812 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00003813
wdenk6c59edc2004-05-03 20:45:30 +00003814* If you modify existing code, make sure that your new code does not
3815 add to the memory footprint of the code ;-) Small is beautiful!
3816 When adding new features, these should compile conditionally only
3817 (using #ifdef), and the resulting code with the new feature
3818 disabled must not need more memory than the old code without your
3819 modification.
wdenkcbc49a52005-05-03 14:12:25 +00003820
3821* Remember that there is a size limit of 40 kB per message on the
3822 u-boot-users mailing list. Compression may help.