blob: 6b94f8482c5c55816a9d878c006d1d64f641aa0b [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
wdenk151ab832005-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
wdenke86e5a02004-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:
103
104 U_BOOT_VERSION u_boot_logo
105 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000106
107
wdenk93f19cc2002-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
wdenk7152b1d2003-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
wdenk983fda82004-10-28 00:09:35 +0000126 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000127 - arm720t Files specific to ARM 720 CPUs
128 - arm920t Files specific to ARM 920 CPUs
wdenka85f9f22005-04-06 13:52:31 +0000129 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk983fda82004-10-28 00:09:35 +0000130 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenk1d9f4102004-10-09 22:21:29 +0000131 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000132 - arm925t Files specific to ARM 925 CPUs
133 - arm926ejs Files specific to ARM 926 CPUs
wdenk8ed96042005-01-09 23:16:25 +0000134 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk72a087e2006-10-24 14:27:35 +0200135 - at32ap Files specific to Atmel AVR32 AP CPUs
wdenk11dadd52004-02-27 00:07:27 +0000136 - i386 Files specific to i386 CPUs
137 - ixp Files specific to Intel XScale IXP CPUs
wdenk983fda82004-10-28 00:09:35 +0000138 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000139 - mips Files specific to MIPS CPUs
wdenk983fda82004-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
wdenk11dadd52004-02-27 00:07:27 +0000147 - nios Files specific to Altera NIOS CPUs
wdenk5c952cf2004-10-10 21:27:30 +0000148 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200149 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenk11dadd52004-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)
wdenk7152b1d2003-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
wdenk11dadd52004-02-27 00:07:27 +0000159- lib_arm Files generic to ARM architecture
Wolfgang Denk7b64fef2006-10-24 14:21:16 +0200160- lib_avr32 Files generic to AVR32 architecture
wdenk11dadd52004-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
wdenkc6097192002-11-03 00:24:07 +0000167- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000168- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000169- rtc Real Time Clock drivers
170- tools Tools to build S-Record or U-Boot images, etc.
171
wdenkc6097192002-11-03 00:24:07 +0000172Software Configuration:
173=======================
174
175Configuration is usually done using C preprocessor defines; the
176rationale behind that is to avoid dead code whenever possible.
177
178There are two classes of configuration variables:
179
180* Configuration _OPTIONS_:
181 These are selectable by the user and have names beginning with
182 "CONFIG_".
183
184* Configuration _SETTINGS_:
185 These depend on the hardware etc. and should not be meddled with if
186 you don't know what you're doing; they have names beginning with
187 "CFG_".
188
189Later we will add a configuration tool - probably similar to or even
190identical to what's used for the Linux kernel. Right now, we have to
191do the configuration by hand, which means creating some symbolic
192links and editing some configuration files. We use the TQM8xxL boards
193as an example here.
194
195
196Selection of Processor Architecture and Board Type:
197---------------------------------------------------
198
199For all supported boards there are ready-to-use default
200configurations available; just type "make <board_name>_config".
201
202Example: For a TQM823L module type:
203
204 cd u-boot
205 make TQM823L_config
206
207For the Cogent platform, you need to specify the cpu type as well;
208e.g. "make cogent_mpc8xx_config". And also configure the cogent
209directory according to the instructions in cogent/README.
210
211
212Configuration Options:
213----------------------
214
215Configuration depends on the combination of board and CPU type; all
216such information is kept in a configuration file
217"include/configs/<board_name>.h".
218
219Example: For a TQM823L module, all configuration settings are in
220"include/configs/TQM823L.h".
221
222
wdenk7f6c2cb2002-11-10 22:06:23 +0000223Many of the options are named exactly as the corresponding Linux
224kernel configuration options. The intention is to make it easier to
225build a config tool - later.
226
227
wdenkc6097192002-11-03 00:24:07 +0000228The following options need to be configured:
229
230- CPU Type: Define exactly one of
231
232 PowerPC based CPUs:
233 -------------------
234 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
wdenk0db5bca2003-03-31 17:27:09 +0000235 or CONFIG_MPC5xx
wdenk983fda82004-10-28 00:09:35 +0000236 or CONFIG_MPC8220
wdenkc6097192002-11-03 00:24:07 +0000237 or CONFIG_MPC824X, CONFIG_MPC8260
wdenk42d1f032003-10-15 23:53:47 +0000238 or CONFIG_MPC85xx
wdenkc6097192002-11-03 00:24:07 +0000239 or CONFIG_IOP480
240 or CONFIG_405GP
wdenk12f34242003-09-02 22:48:03 +0000241 or CONFIG_405EP
wdenkc6097192002-11-03 00:24:07 +0000242 or CONFIG_440
243 or CONFIG_MPC74xx
wdenk72755c72003-06-20 23:10:58 +0000244 or CONFIG_750FX
wdenkc6097192002-11-03 00:24:07 +0000245
246 ARM based CPUs:
247 ---------------
248 CONFIG_SA1110
249 CONFIG_ARM7
250 CONFIG_PXA250
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100251 CONFIG_CPU_MONAHANS
wdenkc6097192002-11-03 00:24:07 +0000252
wdenk507bbe32004-04-18 21:13:41 +0000253 MicroBlaze based CPUs:
254 ----------------------
wdenk857cad32004-07-10 23:48:41 +0000255 CONFIG_MICROBLAZE
wdenk507bbe32004-04-18 21:13:41 +0000256
wdenk5c952cf2004-10-10 21:27:30 +0000257 Nios-2 based CPUs:
258 ----------------------
259 CONFIG_NIOS2
260
Wolfgang Denk72a087e2006-10-24 14:27:35 +0200261 AVR32 based CPUs:
262 ----------------------
263 CONFIG_AT32AP
wdenkc6097192002-11-03 00:24:07 +0000264
265- Board Type: Define exactly one of
266
267 PowerPC based boards:
268 ---------------------
269
Detlev Zundel76544f82006-04-24 17:52:01 +0200270 CONFIG_ADCIOP CONFIG_FPS860L CONFIG_OXC
271 CONFIG_ADS860 CONFIG_GEN860T CONFIG_PCI405
272 CONFIG_AMX860 CONFIG_GENIETV CONFIG_PCIPPC2
273 CONFIG_AP1000 CONFIG_GTH CONFIG_PCIPPC6
274 CONFIG_AR405 CONFIG_gw8260 CONFIG_pcu_e
275 CONFIG_BAB7xx CONFIG_hermes CONFIG_PIP405
276 CONFIG_BC3450 CONFIG_hymod CONFIG_PM826
Wolfgang Denk09e4b0c2006-03-17 11:42:53 +0100277 CONFIG_c2mon CONFIG_IAD210 CONFIG_ppmc8260
278 CONFIG_CANBT CONFIG_ICU862 CONFIG_QS823
279 CONFIG_CCM CONFIG_IP860 CONFIG_QS850
280 CONFIG_CMI CONFIG_IPHASE4539 CONFIG_QS860T
281 CONFIG_cogent_mpc8260 CONFIG_IVML24 CONFIG_RBC823
282 CONFIG_cogent_mpc8xx CONFIG_IVML24_128 CONFIG_RPXClassic
283 CONFIG_CPCI405 CONFIG_IVML24_256 CONFIG_RPXlite
284 CONFIG_CPCI4052 CONFIG_IVMS8 CONFIG_RPXsuper
285 CONFIG_CPCIISER4 CONFIG_IVMS8_128 CONFIG_rsdproto
286 CONFIG_CPU86 CONFIG_IVMS8_256 CONFIG_sacsng
287 CONFIG_CRAYL1 CONFIG_JSE CONFIG_Sandpoint8240
288 CONFIG_CSB272 CONFIG_LANTEC CONFIG_Sandpoint8245
289 CONFIG_CU824 CONFIG_LITE5200B CONFIG_sbc8260
290 CONFIG_DASA_SIM CONFIG_lwmon CONFIG_sbc8560
291 CONFIG_DB64360 CONFIG_MBX CONFIG_SM850
292 CONFIG_DB64460 CONFIG_MBX860T CONFIG_SPD823TS
293 CONFIG_DU405 CONFIG_MHPC CONFIG_STXGP3
294 CONFIG_DUET_ADS CONFIG_MIP405 CONFIG_SXNI855T
295 CONFIG_EBONY CONFIG_MOUSSE CONFIG_TQM823L
296 CONFIG_ELPPC CONFIG_MPC8260ADS CONFIG_TQM8260
297 CONFIG_ELPT860 CONFIG_MPC8540ADS CONFIG_TQM850L
298 CONFIG_ep8260 CONFIG_MPC8540EVAL CONFIG_TQM855L
299 CONFIG_ERIC CONFIG_MPC8560ADS CONFIG_TQM860L
300 CONFIG_ESTEEM192E CONFIG_MUSENKI CONFIG_TTTech
301 CONFIG_ETX094 CONFIG_MVS1 CONFIG_UTX8245
302 CONFIG_EVB64260 CONFIG_NETPHONE CONFIG_V37
303 CONFIG_FADS823 CONFIG_NETTA CONFIG_W7OLMC
304 CONFIG_FADS850SAR CONFIG_NETVIA CONFIG_W7OLMG
305 CONFIG_FADS860T CONFIG_NX823 CONFIG_WALNUT
306 CONFIG_FLAGADM CONFIG_OCRTC CONFIG_ZPC1900
307 CONFIG_FPS850L CONFIG_ORSG CONFIG_ZUMA
Wolfgang Denk3df5bea2005-10-09 01:41:48 +0200308
wdenkc6097192002-11-03 00:24:07 +0000309 ARM based boards:
310 -----------------
311
Wolfgang Denkc570b2f2005-09-26 01:06:33 +0200312 CONFIG_ARMADILLO, CONFIG_AT91RM9200DK, CONFIG_CERF250,
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100313 CONFIG_CSB637, CONFIG_DELTA, CONFIG_DNP1110,
Wolfgang Denkb9365a22006-07-21 11:56:05 +0200314 CONFIG_EP7312, CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE,
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200315 CONFIG_IMPA7, CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610,
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100316 CONFIG_KB9202, CONFIG_LART, CONFIG_LPD7A400,
317 CONFIG_LUBBOCK, CONFIG_OSK_OMAP5912, CONFIG_OMAP2420H4,
Heiko Schocher5720df72006-05-02 07:51:46 +0200318 CONFIG_PLEB2, CONFIG_SHANNON, CONFIG_P2_OMAP730,
319 CONFIG_SMDK2400, CONFIG_SMDK2410, CONFIG_TRAB,
320 CONFIG_VCMA9
wdenkc6097192002-11-03 00:24:07 +0000321
wdenk507bbe32004-04-18 21:13:41 +0000322 MicroBlaze based boards:
323 ------------------------
324
325 CONFIG_SUZAKU
326
wdenk5c952cf2004-10-10 21:27:30 +0000327 Nios-2 based boards:
328 ------------------------
329
330 CONFIG_PCI5441 CONFIG_PK1C20
Scott McNutt9cc83372006-06-08 13:37:39 -0400331 CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40
wdenk5c952cf2004-10-10 21:27:30 +0000332
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200333 AVR32 based boards:
334 -------------------
335
336 CONFIG_ATSTK1000
337
338- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
339 Define exactly one of
340 CONFIG_ATSTK1002
341
wdenkc6097192002-11-03 00:24:07 +0000342
343- CPU Module Type: (if CONFIG_COGENT is defined)
344 Define exactly one of
345 CONFIG_CMA286_60_OLD
346--- FIXME --- not tested yet:
347 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
348 CONFIG_CMA287_23, CONFIG_CMA287_50
349
350- Motherboard Type: (if CONFIG_COGENT is defined)
351 Define exactly one of
352 CONFIG_CMA101, CONFIG_CMA102
353
354- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
355 Define one or more of
356 CONFIG_CMA302
357
358- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
359 Define one or more of
360 CONFIG_LCD_HEARTBEAT - update a character position on
361 the lcd display every second with
362 a "rotator" |\-/|\-/
363
wdenk2535d602003-07-17 23:16:40 +0000364- Board flavour: (if CONFIG_MPC8260ADS is defined)
365 CONFIG_ADSTYPE
366 Possible values are:
367 CFG_8260ADS - original MPC8260ADS
wdenk180d3f72004-01-04 16:28:35 +0000368 CFG_8266ADS - MPC8266ADS
wdenk54387ac2003-10-08 22:45:44 +0000369 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
wdenk04a85b32004-04-15 18:22:41 +0000370 CFG_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000371
wdenkc6097192002-11-03 00:24:07 +0000372- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000373 Define exactly one of
374 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000375
wdenk75d1ea72004-01-31 20:06:54 +0000376- 8xx CPU Options: (if using an MPC8xx cpu)
wdenk66ca92a2004-09-28 17:59:53 +0000377 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
378 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000379 e.g. if there is no 32KHz
380 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000381 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
382 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000383
wdenk66ca92a2004-09-28 17:59:53 +0000384- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
385 CFG_8xx_CPUCLK_MIN
386 CFG_8xx_CPUCLK_MAX
387 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000388 See doc/README.MPC866
389
390 CFG_MEASURE_CPUCLK
391
wdenkba56f622004-02-06 23:19:44 +0000392 Define this to measure the actual CPU clock instead
393 of relying on the correctness of the configured
394 values. Mostly useful for board bringup to make sure
395 the PLL is locked at the intended frequency. Note
396 that this requires a (stable) reference clock (32 kHz
wdenk66ca92a2004-09-28 17:59:53 +0000397 RTC clock or CFG_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000398
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100399- Intel Monahans options:
400 CFG_MONAHANS_RUN_MODE_OSC_RATIO
401
402 Defines the Monahans run mode to oscillator
403 ratio. Valid values are 8, 16, 24, 31. The core
404 frequency is this value multiplied by 13 MHz.
405
406 CFG_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200407
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100408 Defines the Monahans turbo mode to oscillator
409 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200410 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100411 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200412
wdenk5da627a2003-10-09 20:09:04 +0000413- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000414 CONFIG_CLOCKS_IN_MHZ
415
416 U-Boot stores all clock information in Hz
417 internally. For binary compatibility with older Linux
418 kernels (which expect the clocks passed in the
419 bd_info data to be in MHz) the environment variable
420 "clocks_in_mhz" can be defined so that U-Boot
421 converts clock data to MHZ before passing it to the
422 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000423 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
424 "clocks_in_mhz=1" is automatically included in the
425 default environment.
426
wdenk5da627a2003-10-09 20:09:04 +0000427 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
428
429 When transfering memsize parameter to linux, some versions
430 expect it to be in bytes, others in MB.
431 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
432
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200433 CONFIG_OF_FLAT_TREE
434
435 New kernel versions are expecting firmware settings to be
436 passed using flat open firmware trees.
437 The environment variable "disable_of", when set, disables this
438 functionality.
439
440 CONFIG_OF_FLAT_TREE_MAX_SIZE
441
442 The maximum size of the constructed OF tree.
443
444 OF_CPU - The proper name of the cpus node.
Kumar Galac2871f02006-01-11 13:59:02 -0600445 OF_SOC - The proper name of the soc node.
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200446 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600447 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200448
Kumar Galae4f880e2006-01-11 13:49:31 -0600449 CONFIG_OF_HAS_BD_T
450
451 The resulting flat device tree will have a copy of the bd_t.
452 Space should be pre-allocated in the dts for the bd_t.
453
454 CONFIG_OF_HAS_UBOOT_ENV
Stefan Roese15940c92006-03-13 11:16:36 +0100455
Kumar Galae4f880e2006-01-11 13:49:31 -0600456 The resulting flat device tree will have a copy of u-boot's
457 environment variables
458
Kumar Gala4e253132006-01-11 13:54:17 -0600459 CONFIG_OF_BOARD_SETUP
460
461 Board code has addition modification that it wants to make
462 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000463
Matthew McClintock02677682006-06-28 10:41:37 -0500464 CONFIG_OF_BOOT_CPU
465
466 This define fills in the correct boot cpu in the boot
467 param header, the default value is zero if undefined.
468
wdenk6705d812004-08-02 23:22:59 +0000469- Serial Ports:
470 CFG_PL010_SERIAL
471
472 Define this if you want support for Amba PrimeCell PL010 UARTs.
473
474 CFG_PL011_SERIAL
475
476 Define this if you want support for Amba PrimeCell PL011 UARTs.
477
478 CONFIG_PL011_CLOCK
479
480 If you have Amba PrimeCell PL011 UARTs, set this variable to
481 the clock speed of the UARTs.
482
483 CONFIG_PL01x_PORTS
484
485 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
486 define this to a list of base addresses for each (supported)
487 port. See e.g. include/configs/versatile.h
488
489
wdenkc6097192002-11-03 00:24:07 +0000490- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000491 Depending on board, define exactly one serial port
492 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
493 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
494 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000495
496 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
497 port routines must be defined elsewhere
498 (i.e. serial_init(), serial_getc(), ...)
499
500 CONFIG_CFB_CONSOLE
501 Enables console device for a color framebuffer. Needs following
502 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
503 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
504 (default big endian)
505 VIDEO_HW_RECTFILL graphic chip supports
506 rectangle fill
507 (cf. smiLynxEM)
508 VIDEO_HW_BITBLT graphic chip supports
509 bit-blit (cf. smiLynxEM)
510 VIDEO_VISIBLE_COLS visible pixel columns
511 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000512 VIDEO_VISIBLE_ROWS visible pixel rows
513 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000514 VIDEO_DATA_FORMAT graphic data format
515 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000516 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000517 VIDEO_KBD_INIT_FCT keyboard int fct
518 (i.e. i8042_kbd_init())
519 VIDEO_TSTC_FCT test char fct
520 (i.e. i8042_tstc)
521 VIDEO_GETC_FCT get char fct
522 (i.e. i8042_getc)
523 CONFIG_CONSOLE_CURSOR cursor drawing on/off
524 (requires blink timer
525 cf. i8042.c)
526 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
527 CONFIG_CONSOLE_TIME display time/date info in
528 upper right corner
529 (requires CFG_CMD_DATE)
530 CONFIG_VIDEO_LOGO display Linux logo in
531 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000532 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
533 linux_logo.h for logo.
534 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000535 CONFIG_CONSOLE_EXTRA_INFO
536 addional board info beside
537 the logo
538
wdenk43d96162003-03-06 00:02:04 +0000539 When CONFIG_CFB_CONSOLE is defined, video console is
540 default i/o. Serial console can be forced with
541 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000542
wdenkd4ca31c2004-01-02 14:00:00 +0000543 When CONFIG_SILENT_CONSOLE is defined, all console
544 messages (by U-Boot and Linux!) can be silenced with
545 the "silent" environment variable. See
546 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000547
wdenkc6097192002-11-03 00:24:07 +0000548- Console Baudrate:
549 CONFIG_BAUDRATE - in bps
550 Select one of the baudrates listed in
551 CFG_BAUDRATE_TABLE, see below.
wdenk3bbc8992003-12-07 22:27:15 +0000552 CFG_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000553
554- Interrupt driven serial port input:
555 CONFIG_SERIAL_SOFTWARE_FIFO
556
557 PPC405GP only.
558 Use an interrupt handler for receiving data on the
559 serial port. It also enables using hardware handshake
560 (RTS/CTS) and UART's built-in FIFO. Set the number of
561 bytes the interrupt driven input buffer should have.
562
wdenk109c0e32004-03-23 21:43:07 +0000563 Leave undefined to disable this feature, including
564 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000565
stroese1d49b1f2003-05-23 11:39:05 +0000566- Console UART Number:
567 CONFIG_UART1_CONSOLE
568
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200569 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000570 If defined internal UART1 (and not UART0) is used
571 as default U-Boot console.
572
wdenkc6097192002-11-03 00:24:07 +0000573- Boot Delay: CONFIG_BOOTDELAY - in seconds
574 Delay before automatically booting the default image;
575 set to -1 to disable autoboot.
576
577 See doc/README.autoboot for these options that
578 work with CONFIG_BOOTDELAY. None are required.
579 CONFIG_BOOT_RETRY_TIME
580 CONFIG_BOOT_RETRY_MIN
581 CONFIG_AUTOBOOT_KEYED
582 CONFIG_AUTOBOOT_PROMPT
583 CONFIG_AUTOBOOT_DELAY_STR
584 CONFIG_AUTOBOOT_STOP_STR
585 CONFIG_AUTOBOOT_DELAY_STR2
586 CONFIG_AUTOBOOT_STOP_STR2
587 CONFIG_ZERO_BOOTDELAY_CHECK
588 CONFIG_RESET_TO_RETRY
589
590- Autoboot Command:
591 CONFIG_BOOTCOMMAND
592 Only needed when CONFIG_BOOTDELAY is enabled;
593 define a command string that is automatically executed
594 when no character is read on the console interface
595 within "Boot Delay" after reset.
596
597 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000598 This can be used to pass arguments to the bootm
599 command. The value of CONFIG_BOOTARGS goes into the
600 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000601
602 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000603 The value of these goes into the environment as
604 "ramboot" and "nfsboot" respectively, and can be used
605 as a convenience, when switching between booting from
606 ram and nfs.
wdenkc6097192002-11-03 00:24:07 +0000607
608- Pre-Boot Commands:
609 CONFIG_PREBOOT
610
611 When this option is #defined, the existence of the
612 environment variable "preboot" will be checked
613 immediately before starting the CONFIG_BOOTDELAY
614 countdown and/or running the auto-boot command resp.
615 entering interactive mode.
616
617 This feature is especially useful when "preboot" is
618 automatically generated or modified. For an example
619 see the LWMON board specific code: here "preboot" is
620 modified when the user holds down a certain
621 combination of keys on the (special) keyboard when
622 booting the systems
623
624- Serial Download Echo Mode:
625 CONFIG_LOADS_ECHO
626 If defined to 1, all characters received during a
627 serial download (using the "loads" command) are
628 echoed back. This might be needed by some terminal
629 emulations (like "cu"), but may as well just take
630 time on others. This setting #define's the initial
631 value of the "loads_echo" environment variable.
632
633- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
634 CONFIG_KGDB_BAUDRATE
635 Select one of the baudrates listed in
636 CFG_BAUDRATE_TABLE, see below.
637
638- Monitor Functions:
639 CONFIG_COMMANDS
640 Most monitor functions can be selected (or
641 de-selected) by adjusting the definition of
642 CONFIG_COMMANDS; to select individual functions,
643 #define CONFIG_COMMANDS by "OR"ing any of the
644 following values:
645
646 #define enables commands:
647 -------------------------
648 CFG_CMD_ASKENV * ask for env variable
wdenk78137c32003-09-15 18:00:00 +0000649 CFG_CMD_AUTOSCRIPT Autoscript Support
wdenkc6097192002-11-03 00:24:07 +0000650 CFG_CMD_BDI bdinfo
wdenk6705d812004-08-02 23:22:59 +0000651 CFG_CMD_BEDBUG * Include BedBug Debugger
wdenkba56f622004-02-06 23:19:44 +0000652 CFG_CMD_BMP * BMP support
wdenk6705d812004-08-02 23:22:59 +0000653 CFG_CMD_BSP * Board specific commands
wdenkc6097192002-11-03 00:24:07 +0000654 CFG_CMD_BOOTD bootd
wdenk6705d812004-08-02 23:22:59 +0000655 CFG_CMD_CACHE * icache, dcache
wdenkc6097192002-11-03 00:24:07 +0000656 CFG_CMD_CONSOLE coninfo
657 CFG_CMD_DATE * support for RTC, date/time...
wdenk6705d812004-08-02 23:22:59 +0000658 CFG_CMD_DHCP * DHCP support
wdenkba56f622004-02-06 23:19:44 +0000659 CFG_CMD_DIAG * Diagnostics
660 CFG_CMD_DOC * Disk-On-Chip Support
wdenk6705d812004-08-02 23:22:59 +0000661 CFG_CMD_DTT * Digital Therm and Thermostat
Wolfgang Denk953c5b62006-03-12 16:51:59 +0100662 CFG_CMD_ECHO echo arguments
wdenkc6097192002-11-03 00:24:07 +0000663 CFG_CMD_EEPROM * EEPROM read/write support
wdenk6705d812004-08-02 23:22:59 +0000664 CFG_CMD_ELF * bootelf, bootvx
wdenkc6097192002-11-03 00:24:07 +0000665 CFG_CMD_ENV saveenv
666 CFG_CMD_FDC * Floppy Disk Support
wdenk6705d812004-08-02 23:22:59 +0000667 CFG_CMD_FAT * FAT partition support
wdenk2262cfe2002-11-18 00:14:45 +0000668 CFG_CMD_FDOS * Dos diskette Support
wdenkc6097192002-11-03 00:24:07 +0000669 CFG_CMD_FLASH flinfo, erase, protect
670 CFG_CMD_FPGA FPGA device initialization support
wdenkba56f622004-02-06 23:19:44 +0000671 CFG_CMD_HWFLOW * RTS/CTS hw flow control
wdenkc6097192002-11-03 00:24:07 +0000672 CFG_CMD_I2C * I2C serial bus support
673 CFG_CMD_IDE * IDE harddisk support
674 CFG_CMD_IMI iminfo
wdenkba56f622004-02-06 23:19:44 +0000675 CFG_CMD_IMLS List all found images
wdenkc6097192002-11-03 00:24:07 +0000676 CFG_CMD_IMMAP * IMMR dump support
677 CFG_CMD_IRQ * irqinfo
wdenk6705d812004-08-02 23:22:59 +0000678 CFG_CMD_ITEST Integer/string test of 2 values
wdenkba56f622004-02-06 23:19:44 +0000679 CFG_CMD_JFFS2 * JFFS2 Support
wdenkc6097192002-11-03 00:24:07 +0000680 CFG_CMD_KGDB * kgdb
681 CFG_CMD_LOADB loadb
682 CFG_CMD_LOADS loads
683 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
wdenk56523f12004-07-11 17:40:54 +0000684 loop, loopw, mtest
wdenkba56f622004-02-06 23:19:44 +0000685 CFG_CMD_MISC Misc functions like sleep etc
wdenk6705d812004-08-02 23:22:59 +0000686 CFG_CMD_MMC * MMC memory mapped support
687 CFG_CMD_MII * MII utility commands
wdenkba56f622004-02-06 23:19:44 +0000688 CFG_CMD_NAND * NAND support
wdenkc6097192002-11-03 00:24:07 +0000689 CFG_CMD_NET bootp, tftpboot, rarpboot
690 CFG_CMD_PCI * pciinfo
691 CFG_CMD_PCMCIA * PCMCIA support
wdenkba56f622004-02-06 23:19:44 +0000692 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
693 CFG_CMD_PORTIO * Port I/O
wdenkc6097192002-11-03 00:24:07 +0000694 CFG_CMD_REGINFO * Register dump
695 CFG_CMD_RUN run command in env variable
wdenk6705d812004-08-02 23:22:59 +0000696 CFG_CMD_SAVES * save S record dump
wdenkc6097192002-11-03 00:24:07 +0000697 CFG_CMD_SCSI * SCSI Support
wdenkba56f622004-02-06 23:19:44 +0000698 CFG_CMD_SDRAM * print SDRAM configuration information
wdenkb1bf6f22005-04-03 14:52:59 +0000699 (requires CFG_CMD_I2C)
wdenkc6097192002-11-03 00:24:07 +0000700 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
701 CFG_CMD_SPI * SPI serial bus support
702 CFG_CMD_USB * USB support
wdenkba56f622004-02-06 23:19:44 +0000703 CFG_CMD_VFD * VFD support (TRAB)
wdenkc6097192002-11-03 00:24:07 +0000704 CFG_CMD_BSP * Board SPecific functions
wdenka3d991b2004-04-15 21:48:45 +0000705 CFG_CMD_CDP * Cisco Discover Protocol support
wdenkc6097192002-11-03 00:24:07 +0000706 -----------------------------------------------
707 CFG_CMD_ALL all
708
wdenk81050922004-07-11 20:04:51 +0000709 CONFIG_CMD_DFL Default configuration; at the moment
wdenkc6097192002-11-03 00:24:07 +0000710 this is includes all commands, except
711 the ones marked with "*" in the list
712 above.
713
714 If you don't define CONFIG_COMMANDS it defaults to
wdenk81050922004-07-11 20:04:51 +0000715 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
wdenkc6097192002-11-03 00:24:07 +0000716 override the default settings in the respective
717 include file.
718
719 EXAMPLE: If you want all functions except of network
720 support you can write:
721
722 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
723
724
725 Note: Don't enable the "icache" and "dcache" commands
wdenk43d96162003-03-06 00:02:04 +0000726 (configuration option CFG_CMD_CACHE) unless you know
727 what you (and your U-Boot users) are doing. Data
728 cache cannot be enabled on systems like the 8xx or
729 8260 (where accesses to the IMMR region must be
730 uncached), and it cannot be disabled on all other
731 systems where we (mis-) use the data cache to hold an
732 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000733
734
735 XXX - this list needs to get updated!
736
737- Watchdog:
738 CONFIG_WATCHDOG
739 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000740 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000741 code for a watchdog. For the 8xx and 8260 CPUs, the
742 SIU Watchdog feature is enabled in the SYPCR
743 register.
744
stroesec1551ea2003-04-04 15:53:41 +0000745- U-Boot Version:
746 CONFIG_VERSION_VARIABLE
747 If this variable is defined, an environment variable
748 named "ver" is created by U-Boot showing the U-Boot
749 version as printed by the "version" command.
750 This variable is readonly.
751
wdenkc6097192002-11-03 00:24:07 +0000752- Real-Time Clock:
753
754 When CFG_CMD_DATE is selected, the type of the RTC
755 has to be selected, too. Define exactly one of the
756 following options:
757
758 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
759 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
760 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000761 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000762 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000763 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000764 CONFIG_RTC_DS164x - use Dallas DS164x RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000765 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
wdenkc6097192002-11-03 00:24:07 +0000766
wdenkb37c7e52003-06-30 16:24:52 +0000767 Note that if the RTC uses I2C, then the I2C interface
768 must also be configured. See I2C Support, below.
769
wdenkc6097192002-11-03 00:24:07 +0000770- Timestamp Support:
771
wdenk43d96162003-03-06 00:02:04 +0000772 When CONFIG_TIMESTAMP is selected, the timestamp
773 (date and time) of an image is printed by image
774 commands like bootm or iminfo. This option is
775 automatically enabled when you select CFG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000776
777- Partition Support:
778 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
779 and/or CONFIG_ISO_PARTITION
780
781 If IDE or SCSI support is enabled (CFG_CMD_IDE or
782 CFG_CMD_SCSI) you must configure support for at least
783 one partition type as well.
784
785- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000786 CONFIG_IDE_RESET_ROUTINE - this is defined in several
787 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000788
wdenk4d13cba2004-03-14 14:09:05 +0000789 CONFIG_IDE_RESET - is this is defined, IDE Reset will
790 be performed by calling the function
791 ide_set_reset(int reset)
792 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000793
794- ATAPI Support:
795 CONFIG_ATAPI
796
797 Set this to enable ATAPI support.
798
wdenkc40b2952004-03-13 23:29:43 +0000799- LBA48 Support
800 CONFIG_LBA48
801
802 Set this to enable support for disks larger than 137GB
803 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
804 Whithout these , LBA48 support uses 32bit variables and will 'only'
805 support disks up to 2.1TB.
806
807 CFG_64BIT_LBA:
808 When enabled, makes the IDE subsystem use 64bit sector addresses.
809 Default is 32bit.
810
wdenkc6097192002-11-03 00:24:07 +0000811- SCSI Support:
812 At the moment only there is only support for the
813 SYM53C8XX SCSI controller; define
814 CONFIG_SCSI_SYM53C8XX to enable it.
815
816 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
817 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
818 CFG_SCSI_MAX_LUN] can be adjusted to define the
819 maximum numbers of LUNs, SCSI ID's and target
820 devices.
821 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
822
823- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000824 CONFIG_E1000
825 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000826
wdenkc6097192002-11-03 00:24:07 +0000827 CONFIG_EEPRO100
828 Support for Intel 82557/82559/82559ER chips.
829 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
830 write routine for first time initialisation.
831
832 CONFIG_TULIP
833 Support for Digital 2114x chips.
834 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
835 modem chip initialisation (KS8761/QS6611).
836
837 CONFIG_NATSEMI
838 Support for National dp83815 chips.
839
840 CONFIG_NS8382X
841 Support for National dp8382[01] gigabit chips.
842
wdenk45219c42003-05-12 21:50:16 +0000843- NETWORK Support (other):
844
845 CONFIG_DRIVER_LAN91C96
846 Support for SMSC's LAN91C96 chips.
847
848 CONFIG_LAN91C96_BASE
849 Define this to hold the physical address
850 of the LAN91C96's I/O space
851
852 CONFIG_LAN91C96_USE_32_BIT
853 Define this to enable 32 bit addressing
854
wdenkf39748a2004-06-09 13:37:52 +0000855 CONFIG_DRIVER_SMC91111
856 Support for SMSC's LAN91C111 chip
857
858 CONFIG_SMC91111_BASE
859 Define this to hold the physical address
860 of the device (I/O space)
861
862 CONFIG_SMC_USE_32_BIT
863 Define this if data bus is 32 bits
864
865 CONFIG_SMC_USE_IOFUNCS
866 Define this to use i/o functions instead of macros
867 (some hardware wont work with macros)
868
wdenkc6097192002-11-03 00:24:07 +0000869- USB Support:
870 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000871 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000872 CONFIG_USB_UHCI to enable it.
873 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000874 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000875 storage devices.
876 Note:
877 Supported are USB Keyboards and USB Floppy drives
878 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000879 MPC5200 USB requires additional defines:
880 CONFIG_USB_CLOCK
881 for 528 MHz Clock: 0x0001bbbb
882 CONFIG_USB_CONFIG
883 for differential drivers: 0x00001000
884 for single ended drivers: 0x00005000
885
wdenkc6097192002-11-03 00:24:07 +0000886
wdenk71f95112003-06-15 22:40:42 +0000887- MMC Support:
wdenk8bde7f72003-06-27 21:31:46 +0000888 The MMC controller on the Intel PXA is supported. To
889 enable this define CONFIG_MMC. The MMC can be
890 accessed from the boot prompt by mapping the device
wdenk71f95112003-06-15 22:40:42 +0000891 to physical memory similar to flash. Command line is
892 enabled with CFG_CMD_MMC. The MMC driver also works with
wdenk8bde7f72003-06-27 21:31:46 +0000893 the FAT fs. This is enabled with CFG_CMD_FAT.
wdenk71f95112003-06-15 22:40:42 +0000894
wdenk6705d812004-08-02 23:22:59 +0000895- Journaling Flash filesystem support:
896 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
897 CONFIG_JFFS2_NAND_DEV
898 Define these for a default partition on a NAND device
899
900 CFG_JFFS2_FIRST_SECTOR,
901 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
902 Define these for a default partition on a NOR device
903
904 CFG_JFFS_CUSTOM_PART
905 Define this to create an own partition. You have to provide a
906 function struct part_info* jffs2_part_info(int part_num)
907
908 If you define only one JFFS2 partition you may also want to
wdenkefe2a4d2004-12-16 21:44:03 +0000909 #define CFG_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +0000910 to disable the command chpart. This is the default when you
911 have not defined a custom partition
912
wdenkc6097192002-11-03 00:24:07 +0000913- Keyboard Support:
914 CONFIG_ISA_KEYBOARD
915
916 Define this to enable standard (PC-Style) keyboard
917 support
918
919 CONFIG_I8042_KBD
920 Standard PC keyboard driver with US (is default) and
921 GERMAN key layout (switch via environment 'keymap=de') support.
922 Export function i8042_kbd_init, i8042_tstc and i8042_getc
923 for cfb_console. Supports cursor blinking.
924
925- Video support:
926 CONFIG_VIDEO
927
928 Define this to enable video support (for output to
929 video).
930
931 CONFIG_VIDEO_CT69000
932
933 Enable Chips & Technologies 69000 Video chip
934
935 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000936 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000937 video output is selected via environment 'videoout'
938 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
939 assumed.
wdenkc6097192002-11-03 00:24:07 +0000940
wdenkb79a11c2004-03-25 15:14:43 +0000941 For the CT69000 and SMI_LYNXEM drivers, videomode is
942 selected via environment 'videomode'. Two diferent ways
wdenkeeb1b772004-03-23 22:53:55 +0000943 are possible:
944 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000945 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000946
947 Colors 640x480 800x600 1024x768 1152x864 1280x1024
948 -------------+---------------------------------------------
949 8 bits | 0x301* 0x303 0x305 0x161 0x307
950 15 bits | 0x310 0x313 0x316 0x162 0x319
951 16 bits | 0x311 0x314 0x317 0x163 0x31A
952 24 bits | 0x312 0x315 0x318 ? 0x31B
953 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000954 (i.e. setenv videomode 317; saveenv; reset;)
955
wdenkb79a11c2004-03-25 15:14:43 +0000956 - "videomode=bootargs" all the video parameters are parsed
wdenkeeb1b772004-03-23 22:53:55 +0000957 from the bootargs. (See drivers/videomodes.c)
958
959
stroesec1551ea2003-04-04 15:53:41 +0000960 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +0000961 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +0000962 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
963 or CONFIG_VIDEO_SED13806_16BPP
964
wdenk682011f2003-06-03 23:54:09 +0000965- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +0000966 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +0000967
wdenk8bde7f72003-06-27 21:31:46 +0000968 Define this to enable a custom keyboard support.
969 This simply calls drv_keyboard_init() which must be
970 defined in your board-specific files.
971 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +0000972
wdenkc6097192002-11-03 00:24:07 +0000973- LCD Support: CONFIG_LCD
974
975 Define this to enable LCD support (for output to LCD
976 display); also select one of the supported displays
977 by defining one of these:
978
wdenkfd3103b2003-11-25 16:55:19 +0000979 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000980
wdenkfd3103b2003-11-25 16:55:19 +0000981 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000982
wdenkfd3103b2003-11-25 16:55:19 +0000983 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +0000984
wdenkfd3103b2003-11-25 16:55:19 +0000985 NEC NL6448BC20-08. 6.5", 640x480.
986 Active, color, single scan.
987
988 CONFIG_NEC_NL6448BC33_54
989
990 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000991 Active, color, single scan.
992
993 CONFIG_SHARP_16x9
994
995 Sharp 320x240. Active, color, single scan.
996 It isn't 16x9, and I am not sure what it is.
997
998 CONFIG_SHARP_LQ64D341
999
1000 Sharp LQ64D341 display, 640x480.
1001 Active, color, single scan.
1002
1003 CONFIG_HLD1045
1004
1005 HLD1045 display, 640x480.
1006 Active, color, single scan.
1007
1008 CONFIG_OPTREX_BW
1009
1010 Optrex CBL50840-2 NF-FW 99 22 M5
1011 or
1012 Hitachi LMG6912RPFC-00T
1013 or
1014 Hitachi SP14Q002
1015
1016 320x240. Black & white.
1017
1018 Normally display is black on white background; define
1019 CFG_WHITE_ON_BLACK to get it inverted.
1020
wdenk7152b1d2003-09-05 23:19:14 +00001021- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001022
wdenk8bde7f72003-06-27 21:31:46 +00001023 If this option is set, the environment is checked for
1024 a variable "splashimage". If found, the usual display
1025 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001026 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001027 specified in "splashimage" is loaded instead. The
1028 console is redirected to the "nulldev", too. This
1029 allows for a "silent" boot where a splash screen is
1030 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001031
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001032- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1033
1034 If this option is set, additionally to standard BMP
1035 images, gzipped BMP images can be displayed via the
1036 splashscreen support or the bmp command.
1037
wdenkc29fdfc2003-08-29 20:57:53 +00001038- Compression support:
1039 CONFIG_BZIP2
1040
1041 If this option is set, support for bzip2 compressed
1042 images is included. If not, only uncompressed and gzip
1043 compressed images are supported.
1044
wdenk42d1f032003-10-15 23:53:47 +00001045 NOTE: the bzip2 algorithm requires a lot of RAM, so
1046 the malloc area (as defined by CFG_MALLOC_LEN) should
1047 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001048
wdenk17ea1172004-06-06 21:51:03 +00001049- MII/PHY support:
1050 CONFIG_PHY_ADDR
1051
1052 The address of PHY on MII bus.
1053
1054 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1055
1056 The clock frequency of the MII bus
1057
1058 CONFIG_PHY_GIGE
1059
1060 If this option is set, support for speed/duplex
1061 detection of Gigabit PHY is included.
1062
1063 CONFIG_PHY_RESET_DELAY
1064
1065 Some PHY like Intel LXT971A need extra delay after
1066 reset before any MII register access is possible.
1067 For such PHY, set this option to the usec delay
1068 required. (minimum 300usec for LXT971A)
1069
1070 CONFIG_PHY_CMD_DELAY (ppc4xx)
1071
1072 Some PHY like Intel LXT971A need extra delay after
1073 command issued before MII status register can be read
1074
wdenkc6097192002-11-03 00:24:07 +00001075- Ethernet address:
1076 CONFIG_ETHADDR
1077 CONFIG_ETH2ADDR
1078 CONFIG_ETH3ADDR
1079
1080 Define a default value for ethernet address to use
1081 for the respective ethernet interface, in case this
1082 is not determined automatically.
1083
1084- IP address:
1085 CONFIG_IPADDR
1086
1087 Define a default value for the IP address to use for
1088 the default ethernet interface, in case this is not
1089 determined through e.g. bootp.
1090
1091- Server IP address:
1092 CONFIG_SERVERIP
1093
1094 Defines a default value for theIP address of a TFTP
1095 server to contact when using the "tftboot" command.
1096
1097- BOOTP Recovery Mode:
1098 CONFIG_BOOTP_RANDOM_DELAY
1099
1100 If you have many targets in a network that try to
1101 boot using BOOTP, you may want to avoid that all
1102 systems send out BOOTP requests at precisely the same
1103 moment (which would happen for instance at recovery
1104 from a power failure, when all systems will try to
1105 boot, thus flooding the BOOTP server. Defining
1106 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1107 inserted before sending out BOOTP requests. The
1108 following delays are insterted then:
1109
1110 1st BOOTP request: delay 0 ... 1 sec
1111 2nd BOOTP request: delay 0 ... 2 sec
1112 3rd BOOTP request: delay 0 ... 4 sec
1113 4th and following
1114 BOOTP requests: delay 0 ... 8 sec
1115
stroesefe389a82003-08-28 14:17:32 +00001116- DHCP Advanced Options:
1117 CONFIG_BOOTP_MASK
1118
1119 You can fine tune the DHCP functionality by adding
1120 these flags to the CONFIG_BOOTP_MASK define:
1121
1122 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1123 serverip from a DHCP server, it is possible that more
1124 than one DNS serverip is offered to the client.
1125 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1126 serverip will be stored in the additional environment
1127 variable "dnsip2". The first DNS serverip is always
1128 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1129 is added to the CONFIG_BOOTP_MASK.
1130
1131 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1132 to do a dynamic update of a DNS server. To do this, they
1133 need the hostname of the DHCP requester.
1134 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1135 CONFIG_BOOTP_MASK, the content of the "hostname"
1136 environment variable is passed as option 12 to
1137 the DHCP server.
1138
wdenka3d991b2004-04-15 21:48:45 +00001139 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001140 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001141
1142 The device id used in CDP trigger frames.
1143
1144 CONFIG_CDP_DEVICE_ID_PREFIX
1145
1146 A two character string which is prefixed to the MAC address
1147 of the device.
1148
1149 CONFIG_CDP_PORT_ID
1150
1151 A printf format string which contains the ascii name of
1152 the port. Normally is set to "eth%d" which sets
1153 eth0 for the first ethernet, eth1 for the second etc.
1154
1155 CONFIG_CDP_CAPABILITIES
1156
1157 A 32bit integer which indicates the device capabilities;
1158 0x00000010 for a normal host which does not forwards.
1159
1160 CONFIG_CDP_VERSION
1161
1162 An ascii string containing the version of the software.
1163
1164 CONFIG_CDP_PLATFORM
1165
1166 An ascii string containing the name of the platform.
1167
1168 CONFIG_CDP_TRIGGER
1169
1170 A 32bit integer sent on the trigger.
1171
1172 CONFIG_CDP_POWER_CONSUMPTION
1173
1174 A 16bit integer containing the power consumption of the
1175 device in .1 of milliwatts.
1176
1177 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1178
1179 A byte containing the id of the VLAN.
1180
wdenkc6097192002-11-03 00:24:07 +00001181- Status LED: CONFIG_STATUS_LED
1182
1183 Several configurations allow to display the current
1184 status using a LED. For instance, the LED will blink
1185 fast while running U-Boot code, stop blinking as
1186 soon as a reply to a BOOTP request was received, and
1187 start blinking slow once the Linux kernel is running
1188 (supported by a status LED driver in the Linux
1189 kernel). Defining CONFIG_STATUS_LED enables this
1190 feature in U-Boot.
1191
1192- CAN Support: CONFIG_CAN_DRIVER
1193
1194 Defining CONFIG_CAN_DRIVER enables CAN driver support
1195 on those systems that support this (optional)
1196 feature, like the TQM8xxL modules.
1197
1198- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1199
wdenkb37c7e52003-06-30 16:24:52 +00001200 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001201 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1202 include the appropriate I2C driver for the selected cpu.
wdenkc6097192002-11-03 00:24:07 +00001203
wdenk945af8d2003-07-16 21:53:01 +00001204 This will allow you to use i2c commands at the u-boot
1205 command line (as long as you set CFG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001206 CONFIG_COMMANDS) and communicate with i2c based realtime
1207 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001208 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001209
Ben Warrenbb99ad62006-09-07 16:50:54 -04001210 CONFIG_I2C_CMD_TREE is a recommended option that places
1211 all I2C commands under a single 'i2c' root command. The
1212 older 'imm', 'imd', 'iprobe' etc. commands are considered
1213 deprecated and may disappear in the future.
1214
1215 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001216
wdenk945af8d2003-07-16 21:53:01 +00001217 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001218 bit-banging) driver instead of CPM or similar hardware
1219 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001220
wdenk945af8d2003-07-16 21:53:01 +00001221 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001222 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001223
wdenkb37c7e52003-06-30 16:24:52 +00001224 In both cases you will need to define CFG_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001225 to be the frequency (in Hz) at which you wish your i2c bus
1226 to run and CFG_I2C_SLAVE to be the address of this node (ie
1227 the cpu's i2c node address).
1228
wdenkb37c7e52003-06-30 16:24:52 +00001229 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1230 sets the cpu up as a master node and so its address should
1231 therefore be cleared to 0 (See, eg, MPC823e User's Manual
wdenk945af8d2003-07-16 21:53:01 +00001232 p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001233
wdenk945af8d2003-07-16 21:53:01 +00001234 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001235
1236 If you use the software i2c interface (CONFIG_SOFT_I2C)
1237 then the following macros need to be defined (examples are
1238 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001239
1240 I2C_INIT
1241
wdenkb37c7e52003-06-30 16:24:52 +00001242 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001243 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001244
wdenkba56f622004-02-06 23:19:44 +00001245 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001246
wdenkc6097192002-11-03 00:24:07 +00001247 I2C_PORT
1248
wdenk43d96162003-03-06 00:02:04 +00001249 (Only for MPC8260 CPU). The I/O port to use (the code
1250 assumes both bits are on the same port). Valid values
1251 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001252
1253 I2C_ACTIVE
1254
1255 The code necessary to make the I2C data line active
1256 (driven). If the data line is open collector, this
1257 define can be null.
1258
wdenkb37c7e52003-06-30 16:24:52 +00001259 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1260
wdenkc6097192002-11-03 00:24:07 +00001261 I2C_TRISTATE
1262
1263 The code necessary to make the I2C data line tri-stated
1264 (inactive). If the data line is open collector, this
1265 define can be null.
1266
wdenkb37c7e52003-06-30 16:24:52 +00001267 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1268
wdenkc6097192002-11-03 00:24:07 +00001269 I2C_READ
1270
1271 Code that returns TRUE if the I2C data line is high,
1272 FALSE if it is low.
1273
wdenkb37c7e52003-06-30 16:24:52 +00001274 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1275
wdenkc6097192002-11-03 00:24:07 +00001276 I2C_SDA(bit)
1277
1278 If <bit> is TRUE, sets the I2C data line high. If it
1279 is FALSE, it clears it (low).
1280
wdenkb37c7e52003-06-30 16:24:52 +00001281 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001282 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001283 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001284
wdenkc6097192002-11-03 00:24:07 +00001285 I2C_SCL(bit)
1286
1287 If <bit> is TRUE, sets the I2C clock line high. If it
1288 is FALSE, it clears it (low).
1289
wdenkb37c7e52003-06-30 16:24:52 +00001290 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001291 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001292 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001293
wdenkc6097192002-11-03 00:24:07 +00001294 I2C_DELAY
1295
1296 This delay is invoked four times per clock cycle so this
1297 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001298 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001299 like:
1300
wdenkb37c7e52003-06-30 16:24:52 +00001301 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001302
wdenk47cd00f2003-03-06 13:39:27 +00001303 CFG_I2C_INIT_BOARD
1304
wdenk8bde7f72003-06-27 21:31:46 +00001305 When a board is reset during an i2c bus transfer
1306 chips might think that the current transfer is still
1307 in progress. On some boards it is possible to access
1308 the i2c SCLK line directly, either by using the
1309 processor pin as a GPIO or by having a second pin
1310 connected to the bus. If this option is defined a
1311 custom i2c_init_board() routine in boards/xxx/board.c
1312 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001313
wdenk17ea1172004-06-06 21:51:03 +00001314 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1315
1316 This option enables configuration of bi_iic_fast[] flags
1317 in u-boot bd_info structure based on u-boot environment
1318 variable "i2cfast". (see also i2cfast)
1319
Ben Warrenbb99ad62006-09-07 16:50:54 -04001320 CONFIG_I2C_MULTI_BUS
1321
1322 This option allows the use of multiple I2C buses, each of which
1323 must have a controller. At any point in time, only one bus is
1324 active. To switch to a different bus, use the 'i2c dev' command.
1325 Note that bus numbering is zero-based.
1326
1327 CFG_I2C_NOPROBES
1328
1329 This option specifies a list of I2C devices that will be skipped
1330 when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1331 command). If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1332 pairs. Otherwise, specify a 1D array of device addresses
1333
1334 e.g.
1335 #undef CONFIG_I2C_MULTI_BUS
1336 #define CFG_I2C_NOPROBES {0x50,0x68}
1337
1338 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1339
1340 #define CONFIG_I2C_MULTI_BUS
1341 #define CFG_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
1342
1343 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1344
wdenkc6097192002-11-03 00:24:07 +00001345- SPI Support: CONFIG_SPI
1346
1347 Enables SPI driver (so far only tested with
1348 SPI EEPROM, also an instance works with Crystal A/D and
1349 D/As on the SACSng board)
1350
1351 CONFIG_SPI_X
1352
1353 Enables extended (16-bit) SPI EEPROM addressing.
1354 (symmetrical to CONFIG_I2C_X)
1355
1356 CONFIG_SOFT_SPI
1357
wdenk43d96162003-03-06 00:02:04 +00001358 Enables a software (bit-bang) SPI driver rather than
1359 using hardware support. This is a general purpose
1360 driver that only requires three general I/O port pins
1361 (two outputs, one input) to function. If this is
1362 defined, the board configuration must define several
1363 SPI configuration items (port pins to use, etc). For
1364 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001365
1366- FPGA Support: CONFIG_FPGA_COUNT
1367
wdenk43d96162003-03-06 00:02:04 +00001368 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001369
wdenk43d96162003-03-06 00:02:04 +00001370 CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001371
wdenk8bde7f72003-06-27 21:31:46 +00001372 Used to specify the types of FPGA devices. For example,
1373 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
wdenkc6097192002-11-03 00:24:07 +00001374
wdenk8bde7f72003-06-27 21:31:46 +00001375 CFG_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001376
wdenk8bde7f72003-06-27 21:31:46 +00001377 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001378
1379 CFG_FPGA_CHECK_BUSY
1380
wdenk43d96162003-03-06 00:02:04 +00001381 Enable checks on FPGA configuration interface busy
1382 status by the configuration function. This option
1383 will require a board or device specific function to
1384 be written.
wdenkc6097192002-11-03 00:24:07 +00001385
1386 CONFIG_FPGA_DELAY
1387
1388 If defined, a function that provides delays in the FPGA
1389 configuration driver.
1390
1391 CFG_FPGA_CHECK_CTRLC
1392 Allow Control-C to interrupt FPGA configuration
1393
1394 CFG_FPGA_CHECK_ERROR
1395
wdenk43d96162003-03-06 00:02:04 +00001396 Check for configuration errors during FPGA bitfile
1397 loading. For example, abort during Virtex II
1398 configuration if the INIT_B line goes low (which
1399 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001400
1401 CFG_FPGA_WAIT_INIT
1402
wdenk43d96162003-03-06 00:02:04 +00001403 Maximum time to wait for the INIT_B line to deassert
1404 after PROB_B has been deasserted during a Virtex II
1405 FPGA configuration sequence. The default time is 500
1406 mS.
wdenkc6097192002-11-03 00:24:07 +00001407
1408 CFG_FPGA_WAIT_BUSY
1409
wdenk43d96162003-03-06 00:02:04 +00001410 Maximum time to wait for BUSY to deassert during
1411 Virtex II FPGA configuration. The default is 5 mS.
wdenkc6097192002-11-03 00:24:07 +00001412
1413 CFG_FPGA_WAIT_CONFIG
1414
wdenk43d96162003-03-06 00:02:04 +00001415 Time to wait after FPGA configuration. The default is
1416 200 mS.
wdenkc6097192002-11-03 00:24:07 +00001417
1418- Configuration Management:
1419 CONFIG_IDENT_STRING
1420
wdenk43d96162003-03-06 00:02:04 +00001421 If defined, this string will be added to the U-Boot
1422 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001423
1424- Vendor Parameter Protection:
1425
wdenk43d96162003-03-06 00:02:04 +00001426 U-Boot considers the values of the environment
1427 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001428 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001429 are set once by the board vendor / manufacturer, and
1430 protects these variables from casual modification by
1431 the user. Once set, these variables are read-only,
1432 and write or delete attempts are rejected. You can
1433 change this behviour:
wdenkc6097192002-11-03 00:24:07 +00001434
1435 If CONFIG_ENV_OVERWRITE is #defined in your config
1436 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001437 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001438 these parameters.
1439
1440 Alternatively, if you #define _both_ CONFIG_ETHADDR
1441 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1442 ethernet address is installed in the environment,
1443 which can be changed exactly ONCE by the user. [The
1444 serial# is unaffected by this, i. e. it remains
1445 read-only.]
1446
1447- Protected RAM:
1448 CONFIG_PRAM
1449
1450 Define this variable to enable the reservation of
1451 "protected RAM", i. e. RAM which is not overwritten
1452 by U-Boot. Define CONFIG_PRAM to hold the number of
1453 kB you want to reserve for pRAM. You can overwrite
1454 this default value by defining an environment
1455 variable "pram" to the number of kB you want to
1456 reserve. Note that the board info structure will
1457 still show the full amount of RAM. If pRAM is
1458 reserved, a new environment variable "mem" will
1459 automatically be defined to hold the amount of
1460 remaining RAM in a form that can be passed as boot
1461 argument to Linux, for instance like that:
1462
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001463 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001464 saveenv
1465
1466 This way you can tell Linux not to use this memory,
1467 either, which results in a memory region that will
1468 not be affected by reboots.
1469
1470 *WARNING* If your board configuration uses automatic
1471 detection of the RAM size, you must make sure that
1472 this memory test is non-destructive. So far, the
1473 following board configurations are known to be
1474 "pRAM-clean":
1475
1476 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1477 HERMES, IP860, RPXlite, LWMON, LANTEC,
1478 PCU_E, FLAGADM, TQM8260
1479
1480- Error Recovery:
1481 CONFIG_PANIC_HANG
1482
1483 Define this variable to stop the system in case of a
1484 fatal error, so that you have to reset it manually.
1485 This is probably NOT a good idea for an embedded
1486 system where you want to system to reboot
1487 automatically as fast as possible, but it may be
1488 useful during development since you can try to debug
1489 the conditions that lead to the situation.
1490
1491 CONFIG_NET_RETRY_COUNT
1492
wdenk43d96162003-03-06 00:02:04 +00001493 This variable defines the number of retries for
1494 network operations like ARP, RARP, TFTP, or BOOTP
1495 before giving up the operation. If not defined, a
1496 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001497
1498- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001499 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001500
1501 Enable auto completion of commands using TAB.
1502
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001503 Note that this feature has NOT been implemented yet
1504 for the "hush" shell.
1505
1506
wdenkc6097192002-11-03 00:24:07 +00001507 CFG_HUSH_PARSER
1508
1509 Define this variable to enable the "hush" shell (from
1510 Busybox) as command line interpreter, thus enabling
1511 powerful command line syntax like
1512 if...then...else...fi conditionals or `&&' and '||'
1513 constructs ("shell scripts").
1514
1515 If undefined, you get the old, much simpler behaviour
1516 with a somewhat smaller memory footprint.
1517
1518
1519 CFG_PROMPT_HUSH_PS2
1520
1521 This defines the secondary prompt string, which is
1522 printed when the command interpreter needs more input
1523 to complete a command. Usually "> ".
1524
1525 Note:
1526
wdenk8bde7f72003-06-27 21:31:46 +00001527 In the current implementation, the local variables
1528 space and global environment variables space are
1529 separated. Local variables are those you define by
1530 simply typing `name=value'. To access a local
1531 variable later on, you have write `$name' or
1532 `${name}'; to execute the contents of a variable
1533 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001534
wdenk43d96162003-03-06 00:02:04 +00001535 Global environment variables are those you use
1536 setenv/printenv to work with. To run a command stored
1537 in such a variable, you need to use the run command,
1538 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001539
1540 To store commands and special characters in a
1541 variable, please use double quotation marks
1542 surrounding the whole text of the variable, instead
1543 of the backslashes before semicolons and special
1544 symbols.
1545
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001546- Commandline Editing and History:
1547 CONFIG_CMDLINE_EDITING
1548
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001549 Enable editiong and History functions for interactive
1550 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001551
wdenka8c7c702003-12-06 19:49:23 +00001552- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001553 CONFIG_EXTRA_ENV_SETTINGS
1554
wdenk43d96162003-03-06 00:02:04 +00001555 Define this to contain any number of null terminated
1556 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001557 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001558
wdenk43d96162003-03-06 00:02:04 +00001559 For example, place something like this in your
1560 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001561
1562 #define CONFIG_EXTRA_ENV_SETTINGS \
1563 "myvar1=value1\0" \
1564 "myvar2=value2\0"
1565
wdenk43d96162003-03-06 00:02:04 +00001566 Warning: This method is based on knowledge about the
1567 internal format how the environment is stored by the
1568 U-Boot code. This is NOT an official, exported
1569 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001570 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001571 You better know what you are doing here.
1572
wdenk43d96162003-03-06 00:02:04 +00001573 Note: overly (ab)use of the default environment is
1574 discouraged. Make sure to check other ways to preset
1575 the environment like the autoscript function or the
1576 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001577
wdenka8c7c702003-12-06 19:49:23 +00001578- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001579 CONFIG_HAS_DATAFLASH
1580
wdenk8bde7f72003-06-27 21:31:46 +00001581 Defining this option enables DataFlash features and
1582 allows to read/write in Dataflash via the standard
1583 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001584
wdenk3f85ce22004-02-23 16:11:30 +00001585- SystemACE Support:
1586 CONFIG_SYSTEMACE
1587
1588 Adding this option adds support for Xilinx SystemACE
1589 chips attached via some sort of local bus. The address
1590 of the chip must alsh be defined in the
1591 CFG_SYSTEMACE_BASE macro. For example:
1592
1593 #define CONFIG_SYSTEMACE
1594 #define CFG_SYSTEMACE_BASE 0xf0000000
1595
1596 When SystemACE support is added, the "ace" device type
1597 becomes available to the fat commands, i.e. fatls.
1598
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001599- TFTP Fixed UDP Port:
1600 CONFIG_TFTP_PORT
1601
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001602 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001603 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001604 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001605 number generator is used.
1606
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001607 Also, the environment variable tftpdstp is used to supply
1608 the TFTP UDP destination port value. If tftpdstp isn't
1609 defined, the normal port 69 is used.
1610
1611 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001612 blindly start the TFTP transfer using the pre-configured
1613 target IP address and UDP port. This has the effect of
1614 "punching through" the (Windows XP) firewall, allowing
1615 the remainder of the TFTP transfer to proceed normally.
1616 A better solution is to properly configure the firewall,
1617 but sometimes that is not allowed.
1618
wdenka8c7c702003-12-06 19:49:23 +00001619- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001620 CONFIG_SHOW_BOOT_PROGRESS
1621
wdenk43d96162003-03-06 00:02:04 +00001622 Defining this option allows to add some board-
1623 specific code (calling a user-provided function
1624 "show_boot_progress(int)") that enables you to show
1625 the system's boot progress on some display (for
1626 example, some LED's) on your board. At the moment,
1627 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001628
1629 Arg Where When
1630 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001631 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001632 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001633 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001634 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001635 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001636 4 common/cmd_bootm.c Image data has correct checksum
1637 -4 common/cmd_bootm.c Image is for unsupported architecture
1638 5 common/cmd_bootm.c Architecture check OK
1639 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1640 6 common/cmd_bootm.c Image Type check OK
1641 -6 common/cmd_bootm.c gunzip uncompression error
1642 -7 common/cmd_bootm.c Unimplemented compression type
1643 7 common/cmd_bootm.c Uncompression OK
1644 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1645 8 common/cmd_bootm.c Image Type check OK
1646 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1647 9 common/cmd_bootm.c Start initial ramdisk verification
wdenkba56f622004-02-06 23:19:44 +00001648 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1649 -11 common/cmd_bootm.c Ramdisk header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001650 10 common/cmd_bootm.c Ramdisk header is OK
wdenkba56f622004-02-06 23:19:44 +00001651 -12 common/cmd_bootm.c Ramdisk data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001652 11 common/cmd_bootm.c Ramdisk data has correct checksum
1653 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1654 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1655 13 common/cmd_bootm.c Start multifile image verification
1656 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1657 15 common/cmd_bootm.c All preparation done, transferring control to OS
1658
wdenk11dadd52004-02-27 00:07:27 +00001659 -30 lib_ppc/board.c Fatal error, hang the system
1660 -31 post/post.c POST test failed, detected by post_output_backlog()
1661 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001662
wdenkc6097192002-11-03 00:24:07 +00001663 -1 common/cmd_doc.c Bad usage of "doc" command
1664 -1 common/cmd_doc.c No boot device
1665 -1 common/cmd_doc.c Unknown Chip ID on boot device
1666 -1 common/cmd_doc.c Read Error on boot device
1667 -1 common/cmd_doc.c Image header has bad magic number
1668
1669 -1 common/cmd_ide.c Bad usage of "ide" command
1670 -1 common/cmd_ide.c No boot device
1671 -1 common/cmd_ide.c Unknown boot device
1672 -1 common/cmd_ide.c Unknown partition table
1673 -1 common/cmd_ide.c Invalid partition type
1674 -1 common/cmd_ide.c Read Error on boot device
1675 -1 common/cmd_ide.c Image header has bad magic number
1676
wdenk206c60c2003-09-18 10:02:25 +00001677 -1 common/cmd_nand.c Bad usage of "nand" command
1678 -1 common/cmd_nand.c No boot device
1679 -1 common/cmd_nand.c Unknown Chip ID on boot device
1680 -1 common/cmd_nand.c Read Error on boot device
1681 -1 common/cmd_nand.c Image header has bad magic number
1682
wdenkba56f622004-02-06 23:19:44 +00001683 -1 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001684
1685
1686Modem Support:
1687--------------
1688
wdenk85ec0bc2003-03-31 16:34:49 +00001689[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001690
1691- Modem support endable:
1692 CONFIG_MODEM_SUPPORT
1693
1694- RTS/CTS Flow control enable:
1695 CONFIG_HWFLOW
1696
1697- Modem debug support:
1698 CONFIG_MODEM_SUPPORT_DEBUG
1699
wdenk43d96162003-03-06 00:02:04 +00001700 Enables debugging stuff (char screen[1024], dbg())
1701 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001702
wdenka8c7c702003-12-06 19:49:23 +00001703- Interrupt support (PPC):
1704
wdenkd4ca31c2004-01-02 14:00:00 +00001705 There are common interrupt_init() and timer_interrupt()
1706 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1707 for cpu specific initialization. interrupt_init_cpu()
1708 should set decrementer_count to appropriate value. If
1709 cpu resets decrementer automatically after interrupt
1710 (ppc4xx) it should set decrementer_count to zero.
1711 timer_interrupt() calls timer_interrupt_cpu() for cpu
1712 specific handling. If board has watchdog / status_led
1713 / other_activity_monitor it works automatically from
1714 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001715
wdenkc6097192002-11-03 00:24:07 +00001716- General:
1717
wdenk43d96162003-03-06 00:02:04 +00001718 In the target system modem support is enabled when a
1719 specific key (key combination) is pressed during
1720 power-on. Otherwise U-Boot will boot normally
1721 (autoboot). The key_pressed() fuction is called from
1722 board_init(). Currently key_pressed() is a dummy
1723 function, returning 1 and thus enabling modem
1724 initialization.
wdenkc6097192002-11-03 00:24:07 +00001725
wdenk43d96162003-03-06 00:02:04 +00001726 If there are no modem init strings in the
1727 environment, U-Boot proceed to autoboot; the
1728 previous output (banner, info printfs) will be
1729 supressed, though.
wdenkc6097192002-11-03 00:24:07 +00001730
1731 See also: doc/README.Modem
1732
1733
wdenkc6097192002-11-03 00:24:07 +00001734Configuration Settings:
1735-----------------------
1736
1737- CFG_LONGHELP: Defined when you want long help messages included;
1738 undefine this when you're short of memory.
1739
1740- CFG_PROMPT: This is what U-Boot prints on the console to
1741 prompt for user input.
1742
1743- CFG_CBSIZE: Buffer size for input from the Console
1744
1745- CFG_PBSIZE: Buffer size for Console output
1746
1747- CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1748
1749- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1750 the application (usually a Linux kernel) when it is
1751 booted
1752
1753- CFG_BAUDRATE_TABLE:
1754 List of legal baudrate settings for this board.
1755
1756- CFG_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00001757 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00001758
1759- CFG_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00001760 If the board specific function
1761 extern int overwrite_console (void);
1762 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00001763 serial port, else the settings in the environment are used.
1764
1765- CFG_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00001766 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00001767
1768- CFG_CONSOLE_ENV_OVERWRITE
1769 Enable overwrite of previous console environment settings.
1770
1771- CFG_MEMTEST_START, CFG_MEMTEST_END:
1772 Begin and End addresses of the area used by the
1773 simple memory test.
1774
1775- CFG_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00001776 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00001777
wdenk5f535fe2003-09-18 09:21:33 +00001778- CFG_MEMTEST_SCRATCH:
1779 Scratch address used by the alternate memory test
1780 You only need to set this if address zero isn't writeable
1781
wdenkc6097192002-11-03 00:24:07 +00001782- CFG_TFTP_LOADADDR:
1783 Default load address for network file downloads
1784
1785- CFG_LOADS_BAUD_CHANGE:
1786 Enable temporary baudrate change while serial download
1787
1788- CFG_SDRAM_BASE:
1789 Physical start address of SDRAM. _Must_ be 0 here.
1790
1791- CFG_MBIO_BASE:
1792 Physical start address of Motherboard I/O (if using a
1793 Cogent motherboard)
1794
1795- CFG_FLASH_BASE:
1796 Physical start address of Flash memory.
1797
1798- CFG_MONITOR_BASE:
1799 Physical start address of boot monitor code (set by
1800 make config files to be same as the text base address
1801 (TEXT_BASE) used when linking) - same as
1802 CFG_FLASH_BASE when booting from flash.
1803
1804- CFG_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00001805 Size of memory reserved for monitor code, used to
1806 determine _at_compile_time_ (!) if the environment is
1807 embedded within the U-Boot image, or in a separate
1808 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001809
1810- CFG_MALLOC_LEN:
1811 Size of DRAM reserved for malloc() use.
1812
Stefan Roese15940c92006-03-13 11:16:36 +01001813- CFG_BOOTM_LEN:
1814 Normally compressed uImages are limited to an
1815 uncompressed size of 8 MBytes. If this is not enough,
1816 you can define CFG_BOOTM_LEN in your board config file
1817 to adjust this setting to your needs.
1818
wdenkc6097192002-11-03 00:24:07 +00001819- CFG_BOOTMAPSZ:
1820 Maximum size of memory mapped by the startup code of
1821 the Linux kernel; all data that must be processed by
1822 the Linux kernel (bd_info, boot arguments, eventually
1823 initrd image) must be put below this limit.
1824
1825- CFG_MAX_FLASH_BANKS:
1826 Max number of Flash memory banks
1827
1828- CFG_MAX_FLASH_SECT:
1829 Max number of sectors on a Flash chip
1830
1831- CFG_FLASH_ERASE_TOUT:
1832 Timeout for Flash erase operations (in ms)
1833
1834- CFG_FLASH_WRITE_TOUT:
1835 Timeout for Flash write operations (in ms)
1836
wdenk8564acf2003-07-14 22:13:32 +00001837- CFG_FLASH_LOCK_TOUT
1838 Timeout for Flash set sector lock bit operation (in ms)
1839
1840- CFG_FLASH_UNLOCK_TOUT
1841 Timeout for Flash clear lock bits operation (in ms)
1842
1843- CFG_FLASH_PROTECTION
1844 If defined, hardware flash sectors protection is used
1845 instead of U-Boot software protection.
1846
wdenkc6097192002-11-03 00:24:07 +00001847- CFG_DIRECT_FLASH_TFTP:
1848
1849 Enable TFTP transfers directly to flash memory;
1850 without this option such a download has to be
1851 performed in two steps: (1) download to RAM, and (2)
1852 copy from RAM to flash.
1853
1854 The two-step approach is usually more reliable, since
1855 you can check if the download worked before you erase
1856 the flash, but in some situations (when sytem RAM is
1857 too limited to allow for a tempory copy of the
1858 downloaded image) this option may be very useful.
1859
1860- CFG_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00001861 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00001862 common flash structure for storing flash geometry.
1863
1864- CFG_FLASH_CFI_DRIVER
1865 This option also enables the building of the cfi_flash driver
1866 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001867
Stefan Roese5568e612005-11-22 13:20:42 +01001868- CFG_FLASH_QUIET_TEST
1869 If this option is defined, the common CFI flash doesn't
1870 print it's warning upon not recognized FLASH banks. This
1871 is useful, if some of the configured banks are only
1872 optionally available.
1873
stroese53cf9432003-06-05 15:39:44 +00001874- CFG_RX_ETH_BUFFER:
1875 Defines the number of ethernet receive buffers. On some
1876 ethernet controllers it is recommended to set this value
1877 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1878 buffers can be full shortly after enabling the interface
1879 on high ethernet traffic.
1880 Defaults to 4 if not defined.
1881
wdenkc6097192002-11-03 00:24:07 +00001882The following definitions that deal with the placement and management
1883of environment data (variable area); in general, we support the
1884following configurations:
1885
1886- CFG_ENV_IS_IN_FLASH:
1887
1888 Define this if the environment is in flash memory.
1889
1890 a) The environment occupies one whole flash sector, which is
1891 "embedded" in the text segment with the U-Boot code. This
1892 happens usually with "bottom boot sector" or "top boot
1893 sector" type flash chips, which have several smaller
1894 sectors at the start or the end. For instance, such a
1895 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1896 such a case you would place the environment in one of the
1897 4 kB sectors - with U-Boot code before and after it. With
1898 "top boot sector" type flash chips, you would put the
1899 environment in one of the last sectors, leaving a gap
1900 between U-Boot and the environment.
1901
1902 - CFG_ENV_OFFSET:
1903
1904 Offset of environment data (variable area) to the
1905 beginning of flash memory; for instance, with bottom boot
1906 type flash chips the second sector can be used: the offset
1907 for this sector is given here.
1908
1909 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1910
1911 - CFG_ENV_ADDR:
1912
1913 This is just another way to specify the start address of
1914 the flash sector containing the environment (instead of
1915 CFG_ENV_OFFSET).
1916
1917 - CFG_ENV_SECT_SIZE:
1918
1919 Size of the sector containing the environment.
1920
1921
1922 b) Sometimes flash chips have few, equal sized, BIG sectors.
1923 In such a case you don't want to spend a whole sector for
1924 the environment.
1925
1926 - CFG_ENV_SIZE:
1927
1928 If you use this in combination with CFG_ENV_IS_IN_FLASH
1929 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1930 of this flash sector for the environment. This saves
1931 memory for the RAM copy of the environment.
1932
1933 It may also save flash memory if you decide to use this
1934 when your environment is "embedded" within U-Boot code,
1935 since then the remainder of the flash sector could be used
1936 for U-Boot code. It should be pointed out that this is
1937 STRONGLY DISCOURAGED from a robustness point of view:
1938 updating the environment in flash makes it always
1939 necessary to erase the WHOLE sector. If something goes
1940 wrong before the contents has been restored from a copy in
1941 RAM, your target system will be dead.
1942
1943 - CFG_ENV_ADDR_REDUND
1944 CFG_ENV_SIZE_REDUND
1945
wdenk43d96162003-03-06 00:02:04 +00001946 These settings describe a second storage area used to hold
1947 a redundand copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00001948 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00001949 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00001950
1951BE CAREFUL! Any changes to the flash layout, and some changes to the
1952source code will make it necessary to adapt <board>/u-boot.lds*
1953accordingly!
1954
1955
1956- CFG_ENV_IS_IN_NVRAM:
1957
1958 Define this if you have some non-volatile memory device
1959 (NVRAM, battery buffered SRAM) which you want to use for the
1960 environment.
1961
1962 - CFG_ENV_ADDR:
1963 - CFG_ENV_SIZE:
1964
1965 These two #defines are used to determin the memory area you
1966 want to use for environment. It is assumed that this memory
1967 can just be read and written to, without any special
1968 provision.
1969
1970BE CAREFUL! The first access to the environment happens quite early
1971in U-Boot initalization (when we try to get the setting of for the
1972console baudrate). You *MUST* have mappend your NVRAM area then, or
1973U-Boot will hang.
1974
1975Please note that even with NVRAM we still use a copy of the
1976environment in RAM: we could work on NVRAM directly, but we want to
1977keep settings there always unmodified except somebody uses "saveenv"
1978to save the current settings.
1979
1980
1981- CFG_ENV_IS_IN_EEPROM:
1982
1983 Use this if you have an EEPROM or similar serial access
1984 device and a driver for it.
1985
1986 - CFG_ENV_OFFSET:
1987 - CFG_ENV_SIZE:
1988
1989 These two #defines specify the offset and size of the
1990 environment area within the total memory of your EEPROM.
1991
1992 - CFG_I2C_EEPROM_ADDR:
1993 If defined, specified the chip address of the EEPROM device.
1994 The default address is zero.
1995
1996 - CFG_EEPROM_PAGE_WRITE_BITS:
1997 If defined, the number of bits used to address bytes in a
1998 single page in the EEPROM device. A 64 byte page, for example
1999 would require six bits.
2000
2001 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2002 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002003 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002004
2005 - CFG_I2C_EEPROM_ADDR_LEN:
2006 The length in bytes of the EEPROM memory array address. Note
2007 that this is NOT the chip address length!
2008
wdenk5cf91d62004-04-23 20:32:05 +00002009 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
2010 EEPROM chips that implement "address overflow" are ones
2011 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2012 address and the extra bits end up in the "chip address" bit
2013 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2014 byte chips.
2015
2016 Note that we consider the length of the address field to
2017 still be one byte because the extra address bits are hidden
2018 in the chip address.
2019
wdenkc6097192002-11-03 00:24:07 +00002020 - CFG_EEPROM_SIZE:
2021 The size in bytes of the EEPROM device.
2022
wdenkc6097192002-11-03 00:24:07 +00002023
wdenk5779d8d2003-12-06 23:55:10 +00002024- CFG_ENV_IS_IN_DATAFLASH:
2025
wdenkd4ca31c2004-01-02 14:00:00 +00002026 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002027 want to use for the environment.
2028
2029 - CFG_ENV_OFFSET:
2030 - CFG_ENV_ADDR:
2031 - CFG_ENV_SIZE:
2032
2033 These three #defines specify the offset and size of the
2034 environment area within the total memory of your DataFlash placed
2035 at the specified address.
2036
wdenk13a56952004-06-09 14:58:14 +00002037- CFG_ENV_IS_IN_NAND:
2038
2039 Define this if you have a NAND device which you want to use
2040 for the environment.
2041
2042 - CFG_ENV_OFFSET:
2043 - CFG_ENV_SIZE:
2044
2045 These two #defines specify the offset and size of the environment
2046 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00002047
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002048 - CFG_ENV_OFFSET_REDUND
2049
2050 This setting describes a second storage area of CFG_ENV_SIZE
2051 size used to hold a redundant copy of the environment data,
2052 so that there is a valid backup copy in case there is a
2053 power failure during a "saveenv" operation.
2054
2055 Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2056 to a block boundary, and CFG_ENV_SIZE must be a multiple of
2057 the NAND devices block size.
2058
wdenkc6097192002-11-03 00:24:07 +00002059- CFG_SPI_INIT_OFFSET
2060
2061 Defines offset to the initial SPI buffer area in DPRAM. The
2062 area is used at an early stage (ROM part) if the environment
2063 is configured to reside in the SPI EEPROM: We need a 520 byte
2064 scratch DPRAM area. It is used between the two initialization
2065 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2066 to be a good choice since it makes it far enough from the
2067 start of the data area as well as from the stack pointer.
2068
2069Please note that the environment is read-only as long as the monitor
2070has been relocated to RAM and a RAM copy of the environment has been
2071created; also, when using EEPROM you will have to use getenv_r()
2072until then to read environment variables.
2073
wdenk85ec0bc2003-03-31 16:34:49 +00002074The environment is protected by a CRC32 checksum. Before the monitor
2075is relocated into RAM, as a result of a bad CRC you will be working
2076with the compiled-in default environment - *silently*!!! [This is
2077necessary, because the first environment variable we need is the
2078"baudrate" setting for the console - if we have a bad CRC, we don't
2079have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002080
2081Note: once the monitor has been relocated, then it will complain if
2082the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002083use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002084
wdenkfc3e2162003-10-08 22:33:00 +00002085- CFG_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002086 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002087
2088 Note: If this option is active, then CFG_FAULT_MII_ADDR
2089 also needs to be defined.
2090
2091- CFG_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002092 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002093
wdenkc40b2952004-03-13 23:29:43 +00002094- CFG_64BIT_VSPRINTF:
2095 Makes vsprintf (and all *printf functions) support printing
2096 of 64bit values by using the L quantifier
2097
2098- CFG_64BIT_STRTOUL:
2099 Adds simple_strtoull that returns a 64bit value
2100
wdenkc6097192002-11-03 00:24:07 +00002101Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002102---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002103
2104- CFG_CACHELINE_SIZE:
2105 Cache Line Size of the CPU.
2106
2107- CFG_DEFAULT_IMMR:
2108 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002109
wdenk42d1f032003-10-15 23:53:47 +00002110 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2111 and RPXsuper) to be able to adjust the position of
2112 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002113
wdenk7f6c2cb2002-11-10 22:06:23 +00002114- Floppy Disk Support:
2115 CFG_FDC_DRIVE_NUMBER
2116
2117 the default drive number (default value 0)
2118
2119 CFG_ISA_IO_STRIDE
2120
2121 defines the spacing between fdc chipset registers
2122 (default value 1)
2123
2124 CFG_ISA_IO_OFFSET
2125
wdenk43d96162003-03-06 00:02:04 +00002126 defines the offset of register from address. It
2127 depends on which part of the data bus is connected to
2128 the fdc chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002129
wdenk43d96162003-03-06 00:02:04 +00002130 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
2131 CFG_FDC_DRIVE_NUMBER are undefined, they take their
2132 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002133
wdenk43d96162003-03-06 00:02:04 +00002134 if CFG_FDC_HW_INIT is defined, then the function
2135 fdc_hw_init() is called at the beginning of the FDC
2136 setup. fdc_hw_init() must be provided by the board
2137 source code. It is used to make hardware dependant
2138 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002139
wdenk25d67122004-12-10 11:40:40 +00002140- CFG_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002141 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002142 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002143
2144- CFG_INIT_RAM_ADDR:
2145
wdenk7152b1d2003-09-05 23:19:14 +00002146 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002147 initial data and stack; please note that this must be
2148 writable memory that is working WITHOUT special
2149 initialization, i. e. you CANNOT use normal RAM which
2150 will become available only after programming the
2151 memory controller and running certain initialization
2152 sequences.
2153
2154 U-Boot uses the following memory types:
2155 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2156 - MPC824X: data cache
2157 - PPC4xx: data cache
2158
wdenk85ec0bc2003-03-31 16:34:49 +00002159- CFG_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002160
2161 Offset of the initial data structure in the memory
2162 area defined by CFG_INIT_RAM_ADDR. Usually
wdenk85ec0bc2003-03-31 16:34:49 +00002163 CFG_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002164 data is located at the end of the available space
2165 (sometimes written as (CFG_INIT_RAM_END -
2166 CFG_INIT_DATA_SIZE), and the initial stack is just
2167 below that area (growing from (CFG_INIT_RAM_ADDR +
wdenk85ec0bc2003-03-31 16:34:49 +00002168 CFG_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002169
2170 Note:
2171 On the MPC824X (or other systems that use the data
2172 cache for initial memory) the address chosen for
2173 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2174 point to an otherwise UNUSED address space between
2175 the top of RAM and the start of the PCI space.
2176
2177- CFG_SIUMCR: SIU Module Configuration (11-6)
2178
2179- CFG_SYPCR: System Protection Control (11-9)
2180
2181- CFG_TBSCR: Time Base Status and Control (11-26)
2182
2183- CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2184
2185- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2186
2187- CFG_SCCR: System Clock and reset Control Register (15-27)
2188
2189- CFG_OR_TIMING_SDRAM:
2190 SDRAM timing
2191
2192- CFG_MAMR_PTA:
2193 periodic timer for refresh
2194
2195- CFG_DER: Debug Event Register (37-47)
2196
2197- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2198 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2199 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2200 CFG_BR1_PRELIM:
2201 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2202
2203- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2204 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2205 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2206 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2207
2208- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2209 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2210 Machine Mode Register and Memory Periodic Timer
2211 Prescaler definitions (SDRAM timing)
2212
2213- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2214 enable I2C microcode relocation patch (MPC8xx);
2215 define relocation offset in DPRAM [DSP2]
2216
2217- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2218 enable SPI microcode relocation patch (MPC8xx);
2219 define relocation offset in DPRAM [SCC4]
2220
2221- CFG_USE_OSCCLK:
2222 Use OSCM clock mode on MBX8xx board. Be careful,
2223 wrong setting might damage your board. Read
2224 doc/README.MBX before setting this variable!
2225
wdenkea909b72002-11-21 23:11:29 +00002226- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002227 Offset of the bootmode word in DPRAM used by post
2228 (Power On Self Tests). This definition overrides
2229 #define'd default value in commproc.h resp.
2230 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002231
stroese1d49b1f2003-05-23 11:39:05 +00002232- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2233 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2234 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2235 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2236 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2237 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2238 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
wdenk5d232d02003-05-22 22:52:13 +00002239 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2240 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2241
Ben Warrenbb99ad62006-09-07 16:50:54 -04002242- CONFIG_SPD_EEPROM
2243 Get DDR timing information from an I2C EEPROM. Common with pluggable
2244 memory modules such as SODIMMs
2245 SPD_EEPROM_ADDRESS
2246 I2C address of the SPD EEPROM
2247
2248- CFG_SPD_BUS_NUM
2249 If SPD EEPROM is on an I2C bus other than the first one, specify here.
2250 Note that the value must resolve to something your driver can deal with.
2251
wdenkc26e4542004-04-18 10:13:26 +00002252- CONFIG_ETHER_ON_FEC[12]
2253 Define to enable FEC[12] on a 8xx series processor.
2254
2255- CONFIG_FEC[12]_PHY
2256 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002257 to the given FEC; i. e.
2258 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002259 means that the PHY with address 4 is connected to FEC1
2260
2261 When set to -1, means to probe for first available.
2262
2263- CONFIG_FEC[12]_PHY_NORXERR
2264 The PHY does not have a RXERR line (RMII only).
2265 (so program the FEC to ignore it).
2266
2267- CONFIG_RMII
2268 Enable RMII mode for all FECs.
2269 Note that this is a global option, we can't
2270 have one FEC in standard MII mode and another in RMII mode.
2271
wdenk5cf91d62004-04-23 20:32:05 +00002272- CONFIG_CRC32_VERIFY
2273 Add a verify option to the crc32 command.
2274 The syntax is:
2275
2276 => crc32 -v <address> <count> <crc32>
2277
2278 Where address/count indicate a memory area
2279 and crc32 is the correct crc32 which the
2280 area should have.
2281
wdenk56523f12004-07-11 17:40:54 +00002282- CONFIG_LOOPW
2283 Add the "loopw" memory command. This only takes effect if
2284 the memory commands are activated globally (CFG_CMD_MEM).
2285
stroese7b466642004-12-16 18:46:55 +00002286- CONFIG_MX_CYCLIC
2287 Add the "mdc" and "mwc" memory commands. These are cyclic
2288 "md/mw" commands.
2289 Examples:
2290
wdenkefe2a4d2004-12-16 21:44:03 +00002291 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002292 This command will print 4 bytes (10,11,12,13) each 500 ms.
2293
wdenkefe2a4d2004-12-16 21:44:03 +00002294 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002295 This command will write 12345678 to address 100 all 10 ms.
2296
wdenkefe2a4d2004-12-16 21:44:03 +00002297 This only takes effect if the memory commands are activated
stroese7b466642004-12-16 18:46:55 +00002298 globally (CFG_CMD_MEM).
2299
wdenk8aa1a2d2005-04-04 12:44:11 +00002300- CONFIG_SKIP_LOWLEVEL_INIT
2301- CONFIG_SKIP_RELOCATE_UBOOT
2302
wdenk3c2b3d42005-04-05 23:32:21 +00002303 [ARM only] If these variables are defined, then
2304 certain low level initializations (like setting up
2305 the memory controller) are omitted and/or U-Boot does
2306 not relocate itself into RAM.
2307 Normally these variables MUST NOT be defined. The
2308 only exception is when U-Boot is loaded (to RAM) by
2309 some other boot loader or by a debugger which
2310 performs these intializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002311
wdenk400558b2005-04-02 23:52:25 +00002312
wdenkc6097192002-11-03 00:24:07 +00002313Building the Software:
2314======================
2315
2316Building U-Boot has been tested in native PPC environments (on a
2317PowerBook G3 running LinuxPPC 2000) and in cross environments
2318(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2319NetBSD 1.5 on x86).
2320
2321If you are not using a native PPC environment, it is assumed that you
2322have the GNU cross compiling tools available in your path and named
2323with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2324you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2325the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2326change it to:
2327
2328 CROSS_COMPILE = ppc_4xx-
2329
2330
wdenkba56f622004-02-06 23:19:44 +00002331U-Boot is intended to be simple to build. After installing the
wdenkc6097192002-11-03 00:24:07 +00002332sources you must configure U-Boot for one specific board type. This
2333is done by typing:
2334
2335 make NAME_config
2336
2337where "NAME_config" is the name of one of the existing
2338configurations; the following names are supported:
2339
wdenk1eaeb582004-06-08 00:22:43 +00002340 ADCIOP_config FPS860L_config omap730p2_config
2341 ADS860_config GEN860T_config pcu_e_config
wdenk983fda82004-10-28 00:09:35 +00002342 Alaska8220_config
wdenk1eaeb582004-06-08 00:22:43 +00002343 AR405_config GENIETV_config PIP405_config
2344 at91rm9200dk_config GTH_config QS823_config
2345 CANBT_config hermes_config QS850_config
2346 cmi_mpc5xx_config hymod_config QS860T_config
2347 cogent_common_config IP860_config RPXlite_config
wdenke63c8ee2004-06-09 21:04:48 +00002348 cogent_mpc8260_config IVML24_config RPXlite_DW_config
2349 cogent_mpc8xx_config IVMS8_config RPXsuper_config
2350 CPCI405_config JSE_config rsdproto_config
2351 CPCIISER4_config LANTEC_config Sandpoint8240_config
2352 csb272_config lwmon_config sbc8260_config
wdenk466b7412004-07-10 22:35:59 +00002353 CU824_config MBX860T_config sbc8560_33_config
2354 DUET_ADS_config MBX_config sbc8560_66_config
wdenk8b07a112004-07-10 21:45:47 +00002355 EBONY_config MPC8260ADS_config SM850_config
2356 ELPT860_config MPC8540ADS_config SPD823TS_config
Lunsheng Wangb0e32942005-07-29 10:20:29 -05002357 ESTEEM192E_config MPC8540EVAL_config stxgp3_config
2358 ETX094_config MPC8560ADS_config SXNI855T_config
2359 FADS823_config NETVIA_config TQM823L_config
2360 FADS850SAR_config omap1510inn_config TQM850L_config
2361 FADS860T_config omap1610h2_config TQM855L_config
2362 FPS850L_config omap1610inn_config TQM860L_config
Jon Loeliger4b1d95d2005-08-02 13:53:07 -05002363 omap5912osk_config walnut_config
Lunsheng Wangb0e32942005-07-29 10:20:29 -05002364 omap2420h4_config Yukon8220_config
wdenk8b07a112004-07-10 21:45:47 +00002365 ZPC1900_config
wdenk54387ac2003-10-08 22:45:44 +00002366
wdenk2729af92004-05-03 20:45:30 +00002367Note: for some board special configuration names may exist; check if
2368 additional information is available from the board vendor; for
2369 instance, the TQM823L systems are available without (standard)
2370 or with LCD support. You can select such additional "features"
2371 when chosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002372
wdenk2729af92004-05-03 20:45:30 +00002373 make TQM823L_config
2374 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002375
wdenk2729af92004-05-03 20:45:30 +00002376 make TQM823L_LCD_config
2377 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002378
wdenk2729af92004-05-03 20:45:30 +00002379 etc.
wdenkc6097192002-11-03 00:24:07 +00002380
wdenkc6097192002-11-03 00:24:07 +00002381
wdenk2729af92004-05-03 20:45:30 +00002382Finally, type "make all", and you should get some working U-Boot
2383images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002384
wdenk2729af92004-05-03 20:45:30 +00002385- "u-boot.bin" is a raw binary image
2386- "u-boot" is an image in ELF binary format
2387- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002388
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002389By default the build is performed locally and the objects are saved
2390in the source directory. One of the two methods can be used to change
2391this behavior and build U-Boot to some external directory:
2392
23931. Add O= to the make command line invocations:
2394
2395 make O=/tmp/build distclean
2396 make O=/tmp/build NAME_config
2397 make O=/tmp/build all
2398
23992. Set environment variable BUILD_DIR to point to the desired location:
2400
2401 export BUILD_DIR=/tmp/build
2402 make distclean
2403 make NAME_config
2404 make all
2405
2406Note that the command line "O=" setting overrides the BUILD_DIR environment
2407variable.
2408
wdenkc6097192002-11-03 00:24:07 +00002409
wdenk2729af92004-05-03 20:45:30 +00002410Please be aware that the Makefiles assume you are using GNU make, so
2411for instance on NetBSD you might need to use "gmake" instead of
2412native "make".
wdenkc6097192002-11-03 00:24:07 +00002413
wdenkc6097192002-11-03 00:24:07 +00002414
wdenk2729af92004-05-03 20:45:30 +00002415If the system board that you have is not listed, then you will need
2416to port U-Boot to your hardware platform. To do this, follow these
2417steps:
wdenkc6097192002-11-03 00:24:07 +00002418
wdenk2729af92004-05-03 20:45:30 +000024191. Add a new configuration option for your board to the toplevel
2420 "Makefile" and to the "MAKEALL" script, using the existing
2421 entries as examples. Note that here and at many other places
2422 boards and other names are listed in alphabetical sort order. Please
2423 keep this order.
24242. Create a new directory to hold your board specific code. Add any
2425 files you need. In your board directory, you will need at least
2426 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
24273. Create a new configuration file "include/configs/<board>.h" for
2428 your board
24293. If you're porting U-Boot to a new CPU, then also create a new
2430 directory to hold your CPU specific code. Add any files you need.
24314. Run "make <board>_config" with your new name.
24325. Type "make", and you should get a working "u-boot.srec" file
2433 to be installed on your target system.
24346. Debug and solve any problems that might arise.
2435 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002436
wdenkc6097192002-11-03 00:24:07 +00002437
wdenk2729af92004-05-03 20:45:30 +00002438Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2439==============================================================
wdenkc6097192002-11-03 00:24:07 +00002440
wdenk2729af92004-05-03 20:45:30 +00002441If you have modified U-Boot sources (for instance added a new board
2442or support for new devices, a new CPU, etc.) you are expected to
2443provide feedback to the other developers. The feedback normally takes
2444the form of a "patch", i. e. a context diff against a certain (latest
2445official or latest in CVS) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002446
wdenk2729af92004-05-03 20:45:30 +00002447But before you submit such a patch, please verify that your modifi-
2448cation did not break existing code. At least make sure that *ALL* of
2449the supported boards compile WITHOUT ANY compiler warnings. To do so,
2450just run the "MAKEALL" script, which will configure and build U-Boot
2451for ALL supported system. Be warned, this will take a while. You can
2452select which (cross) compiler to use by passing a `CROSS_COMPILE'
2453environment variable to the script, i. e. to use the cross tools from
2454MontaVista's Hard Hat Linux you can type
wdenkc6097192002-11-03 00:24:07 +00002455
wdenk2729af92004-05-03 20:45:30 +00002456 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002457
wdenk2729af92004-05-03 20:45:30 +00002458or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002459
wdenk2729af92004-05-03 20:45:30 +00002460 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002461
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002462When using the MAKEALL script, the default behaviour is to build U-Boot
2463in the source directory. This location can be changed by setting the
2464BUILD_DIR environment variable. Also, for each target built, the MAKEALL
2465script saves two log files (<target>.ERR and <target>.MAKEALL) in the
2466<source dir>/LOG directory. This default location can be changed by
2467setting the MAKEALL_LOGDIR environment variable. For example:
2468
2469 export BUILD_DIR=/tmp/build
2470 export MAKEALL_LOGDIR=/tmp/log
2471 CROSS_COMPILE=ppc_8xx- MAKEALL
2472
2473With the above settings build objects are saved in the /tmp/build, log
2474files are saved in the /tmp/log and the source tree remains clean during
2475the whole build process.
2476
2477
wdenk2729af92004-05-03 20:45:30 +00002478See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002479
wdenkc6097192002-11-03 00:24:07 +00002480
wdenk2729af92004-05-03 20:45:30 +00002481Monitor Commands - Overview:
2482============================
wdenkc6097192002-11-03 00:24:07 +00002483
wdenk2729af92004-05-03 20:45:30 +00002484go - start application at address 'addr'
2485run - run commands in an environment variable
2486bootm - boot application image from memory
2487bootp - boot image via network using BootP/TFTP protocol
2488tftpboot- boot image via network using TFTP protocol
2489 and env variables "ipaddr" and "serverip"
2490 (and eventually "gatewayip")
2491rarpboot- boot image via network using RARP/TFTP protocol
2492diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2493loads - load S-Record file over serial line
2494loadb - load binary file over serial line (kermit mode)
2495md - memory display
2496mm - memory modify (auto-incrementing)
2497nm - memory modify (constant address)
2498mw - memory write (fill)
2499cp - memory copy
2500cmp - memory compare
2501crc32 - checksum calculation
2502imd - i2c memory display
2503imm - i2c memory modify (auto-incrementing)
2504inm - i2c memory modify (constant address)
2505imw - i2c memory write (fill)
2506icrc32 - i2c checksum calculation
2507iprobe - probe to discover valid I2C chip addresses
2508iloop - infinite loop on address range
2509isdram - print SDRAM configuration information
2510sspi - SPI utility commands
2511base - print or set address offset
2512printenv- print environment variables
2513setenv - set environment variables
2514saveenv - save environment variables to persistent storage
2515protect - enable or disable FLASH write protection
2516erase - erase FLASH memory
2517flinfo - print FLASH memory information
2518bdinfo - print Board Info structure
2519iminfo - print header information for application image
2520coninfo - print console devices and informations
2521ide - IDE sub-system
2522loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002523loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002524mtest - simple RAM test
2525icache - enable or disable instruction cache
2526dcache - enable or disable data cache
2527reset - Perform RESET of the CPU
2528echo - echo args to console
2529version - print monitor version
2530help - print online help
2531? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002532
wdenkc6097192002-11-03 00:24:07 +00002533
wdenk2729af92004-05-03 20:45:30 +00002534Monitor Commands - Detailed Description:
2535========================================
wdenkc6097192002-11-03 00:24:07 +00002536
wdenk2729af92004-05-03 20:45:30 +00002537TODO.
wdenkc6097192002-11-03 00:24:07 +00002538
wdenk2729af92004-05-03 20:45:30 +00002539For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002540
2541
wdenk2729af92004-05-03 20:45:30 +00002542Environment Variables:
2543======================
wdenkc6097192002-11-03 00:24:07 +00002544
wdenk2729af92004-05-03 20:45:30 +00002545U-Boot supports user configuration using Environment Variables which
2546can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002547
wdenk2729af92004-05-03 20:45:30 +00002548Environment Variables are set using "setenv", printed using
2549"printenv", and saved to Flash using "saveenv". Using "setenv"
2550without a value can be used to delete a variable from the
2551environment. As long as you don't save the environment you are
2552working with an in-memory copy. In case the Flash area containing the
2553environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002554
wdenk2729af92004-05-03 20:45:30 +00002555Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002556
wdenk2729af92004-05-03 20:45:30 +00002557 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002558
wdenk2729af92004-05-03 20:45:30 +00002559 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002560
wdenk2729af92004-05-03 20:45:30 +00002561 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002562
wdenk2729af92004-05-03 20:45:30 +00002563 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002564
wdenk2729af92004-05-03 20:45:30 +00002565 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002566
wdenk2729af92004-05-03 20:45:30 +00002567 autoload - if set to "no" (any string beginning with 'n'),
2568 "bootp" will just load perform a lookup of the
2569 configuration from the BOOTP server, but not try to
2570 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002571
wdenk2729af92004-05-03 20:45:30 +00002572 autostart - if set to "yes", an image loaded using the "bootp",
2573 "rarpboot", "tftpboot" or "diskboot" commands will
2574 be automatically started (by internally calling
2575 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002576
wdenk2729af92004-05-03 20:45:30 +00002577 If set to "no", a standalone image passed to the
2578 "bootm" command will be copied to the load address
2579 (and eventually uncompressed), but NOT be started.
2580 This can be used to load and uncompress arbitrary
2581 data.
wdenkc6097192002-11-03 00:24:07 +00002582
wdenk17ea1172004-06-06 21:51:03 +00002583 i2cfast - (PPC405GP|PPC405EP only)
2584 if set to 'y' configures Linux I2C driver for fast
2585 mode (400kHZ). This environment variable is used in
2586 initialization code. So, for changes to be effective
2587 it must be saved and board must be reset.
2588
wdenk2729af92004-05-03 20:45:30 +00002589 initrd_high - restrict positioning of initrd images:
2590 If this variable is not set, initrd images will be
2591 copied to the highest possible address in RAM; this
2592 is usually what you want since it allows for
2593 maximum initrd size. If for some reason you want to
2594 make sure that the initrd image is loaded below the
2595 CFG_BOOTMAPSZ limit, you can set this environment
2596 variable to a value of "no" or "off" or "0".
2597 Alternatively, you can set it to a maximum upper
2598 address to use (U-Boot will still check that it
2599 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002600
wdenk2729af92004-05-03 20:45:30 +00002601 For instance, when you have a system with 16 MB
2602 RAM, and want to reserve 4 MB from use by Linux,
2603 you can do this by adding "mem=12M" to the value of
2604 the "bootargs" variable. However, now you must make
2605 sure that the initrd image is placed in the first
2606 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002607
wdenk2729af92004-05-03 20:45:30 +00002608 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002609
wdenk2729af92004-05-03 20:45:30 +00002610 If you set initrd_high to 0xFFFFFFFF, this is an
2611 indication to U-Boot that all addresses are legal
2612 for the Linux kernel, including addresses in flash
2613 memory. In this case U-Boot will NOT COPY the
2614 ramdisk at all. This may be useful to reduce the
2615 boot time on your system, but requires that this
2616 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00002617
wdenk2729af92004-05-03 20:45:30 +00002618 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002619
wdenk2729af92004-05-03 20:45:30 +00002620 loadaddr - Default load address for commands like "bootp",
2621 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002622
wdenk2729af92004-05-03 20:45:30 +00002623 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002624
wdenk2729af92004-05-03 20:45:30 +00002625 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00002626
wdenk2729af92004-05-03 20:45:30 +00002627 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002628
wdenk2729af92004-05-03 20:45:30 +00002629 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002630
wdenk2729af92004-05-03 20:45:30 +00002631 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002632
wdenk2729af92004-05-03 20:45:30 +00002633 ethprime - When CONFIG_NET_MULTI is enabled controls which
2634 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002635
wdenk2729af92004-05-03 20:45:30 +00002636 ethact - When CONFIG_NET_MULTI is enabled controls which
2637 interface is currently active. For example you
2638 can do the following
wdenkc6097192002-11-03 00:24:07 +00002639
wdenk2729af92004-05-03 20:45:30 +00002640 => setenv ethact FEC ETHERNET
2641 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2642 => setenv ethact SCC ETHERNET
2643 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002644
wdenk2729af92004-05-03 20:45:30 +00002645 netretry - When set to "no" each network operation will
2646 either succeed or fail without retrying.
2647 When set to "once" the network operation will
2648 fail when all the available network interfaces
2649 are tried once without success.
2650 Useful on scripts which control the retry operation
2651 themselves.
wdenkc6097192002-11-03 00:24:07 +00002652
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002653 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002654 UDP source port.
2655
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002656 tftpdstport - If this is set, the value is used for TFTP's UDP
2657 destination port instead of the Well Know Port 69.
2658
wdenk2729af92004-05-03 20:45:30 +00002659 vlan - When set to a value < 4095 the traffic over
2660 ethernet is encapsulated/received over 802.1q
2661 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00002662
wdenk2729af92004-05-03 20:45:30 +00002663The following environment variables may be used and automatically
2664updated by the network boot commands ("bootp" and "rarpboot"),
2665depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00002666
wdenk2729af92004-05-03 20:45:30 +00002667 bootfile - see above
2668 dnsip - IP address of your Domain Name Server
2669 dnsip2 - IP address of your secondary Domain Name Server
2670 gatewayip - IP address of the Gateway (Router) to use
2671 hostname - Target hostname
2672 ipaddr - see above
2673 netmask - Subnet Mask
2674 rootpath - Pathname of the root filesystem on the NFS server
2675 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00002676
wdenka3d991b2004-04-15 21:48:45 +00002677
wdenk2729af92004-05-03 20:45:30 +00002678There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002679
wdenk2729af92004-05-03 20:45:30 +00002680 serial# - contains hardware identification information such
2681 as type string and/or serial number
2682 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00002683
wdenk2729af92004-05-03 20:45:30 +00002684These variables can be set only once (usually during manufacturing of
2685the board). U-Boot refuses to delete or overwrite these variables
2686once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00002687
2688
wdenk2729af92004-05-03 20:45:30 +00002689Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002690
wdenk2729af92004-05-03 20:45:30 +00002691 ver - Contains the U-Boot version string as printed
2692 with the "version" command. This variable is
2693 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00002694
wdenkc6097192002-11-03 00:24:07 +00002695
wdenk2729af92004-05-03 20:45:30 +00002696Please note that changes to some configuration parameters may take
2697only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00002698
stroesec1551ea2003-04-04 15:53:41 +00002699
wdenk2729af92004-05-03 20:45:30 +00002700Command Line Parsing:
2701=====================
stroesec1551ea2003-04-04 15:53:41 +00002702
wdenk2729af92004-05-03 20:45:30 +00002703There are two different command line parsers available with U-Boot:
2704the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00002705
wdenk2729af92004-05-03 20:45:30 +00002706Old, simple command line parser:
2707--------------------------------
wdenkc6097192002-11-03 00:24:07 +00002708
wdenk2729af92004-05-03 20:45:30 +00002709- supports environment variables (through setenv / saveenv commands)
2710- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002711- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00002712- special characters ('$', ';') can be escaped by prefixing with '\',
2713 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002714 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00002715- You can also escape text by enclosing in single apostrophes, for example:
2716 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00002717
wdenk2729af92004-05-03 20:45:30 +00002718Hush shell:
2719-----------
wdenkf07771c2003-05-28 08:06:31 +00002720
wdenk2729af92004-05-03 20:45:30 +00002721- similar to Bourne shell, with control structures like
2722 if...then...else...fi, for...do...done; while...do...done,
2723 until...do...done, ...
2724- supports environment ("global") variables (through setenv / saveenv
2725 commands) and local shell variables (through standard shell syntax
2726 "name=value"); only environment variables can be used with "run"
2727 command
wdenkf07771c2003-05-28 08:06:31 +00002728
wdenk2729af92004-05-03 20:45:30 +00002729General rules:
2730--------------
wdenkf07771c2003-05-28 08:06:31 +00002731
wdenk2729af92004-05-03 20:45:30 +00002732(1) If a command line (or an environment variable executed by a "run"
2733 command) contains several commands separated by semicolon, and
2734 one of these commands fails, then the remaining commands will be
2735 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00002736
wdenk2729af92004-05-03 20:45:30 +00002737(2) If you execute several variables with one call to run (i. e.
2738 calling run with a list af variables as arguments), any failing
2739 command will cause "run" to terminate, i. e. the remaining
2740 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00002741
wdenk2729af92004-05-03 20:45:30 +00002742Note for Redundant Ethernet Interfaces:
2743=======================================
wdenkf07771c2003-05-28 08:06:31 +00002744
wdenk2729af92004-05-03 20:45:30 +00002745Some boards come with redundant ethernet interfaces; U-Boot supports
2746such configurations and is capable of automatic selection of a
2747"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00002748
wdenk2729af92004-05-03 20:45:30 +00002749Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2750MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2751"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00002752
wdenk2729af92004-05-03 20:45:30 +00002753If the network interface stores some valid MAC address (for instance
2754in SROM), this is used as default address if there is NO correspon-
2755ding setting in the environment; if the corresponding environment
2756variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00002757
wdenk2729af92004-05-03 20:45:30 +00002758o If the SROM has a valid MAC address, and there is no address in the
2759 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002760
wdenk2729af92004-05-03 20:45:30 +00002761o If there is no valid address in the SROM, and a definition in the
2762 environment exists, then the value from the environment variable is
2763 used.
wdenkc6097192002-11-03 00:24:07 +00002764
wdenk2729af92004-05-03 20:45:30 +00002765o If both the SROM and the environment contain a MAC address, and
2766 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002767
wdenk2729af92004-05-03 20:45:30 +00002768o If both the SROM and the environment contain a MAC address, and the
2769 addresses differ, the value from the environment is used and a
2770 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002771
wdenk2729af92004-05-03 20:45:30 +00002772o If neither SROM nor the environment contain a MAC address, an error
2773 is raised.
wdenkc6097192002-11-03 00:24:07 +00002774
wdenkc6097192002-11-03 00:24:07 +00002775
wdenk2729af92004-05-03 20:45:30 +00002776Image Formats:
2777==============
wdenkc6097192002-11-03 00:24:07 +00002778
wdenk2729af92004-05-03 20:45:30 +00002779The "boot" commands of this monitor operate on "image" files which
2780can be basicly anything, preceeded by a special header; see the
2781definitions in include/image.h for details; basicly, the header
2782defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002783
wdenk2729af92004-05-03 20:45:30 +00002784* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2785 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2786 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2787 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02002788* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk2729af92004-05-03 20:45:30 +00002789 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02002790 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00002791* Compression Type (uncompressed, gzip, bzip2)
2792* Load Address
2793* Entry Point
2794* Image Name
2795* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002796
wdenk2729af92004-05-03 20:45:30 +00002797The header is marked by a special Magic Number, and both the header
2798and the data portions of the image are secured against corruption by
2799CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002800
wdenkc6097192002-11-03 00:24:07 +00002801
wdenk2729af92004-05-03 20:45:30 +00002802Linux Support:
2803==============
wdenkc6097192002-11-03 00:24:07 +00002804
wdenk2729af92004-05-03 20:45:30 +00002805Although U-Boot should support any OS or standalone application
2806easily, the main focus has always been on Linux during the design of
2807U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002808
wdenk2729af92004-05-03 20:45:30 +00002809U-Boot includes many features that so far have been part of some
2810special "boot loader" code within the Linux kernel. Also, any
2811"initrd" images to be used are no longer part of one big Linux image;
2812instead, kernel and "initrd" are separate images. This implementation
2813serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002814
wdenk2729af92004-05-03 20:45:30 +00002815- the same features can be used for other OS or standalone
2816 applications (for instance: using compressed images to reduce the
2817 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002818
wdenk2729af92004-05-03 20:45:30 +00002819- it becomes much easier to port new Linux kernel versions because
2820 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002821
wdenk2729af92004-05-03 20:45:30 +00002822- the same Linux kernel image can now be used with different "initrd"
2823 images; of course this also means that different kernel images can
2824 be run with the same "initrd". This makes testing easier (you don't
2825 have to build a new "zImage.initrd" Linux image when you just
2826 change a file in your "initrd"). Also, a field-upgrade of the
2827 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002828
wdenkc6097192002-11-03 00:24:07 +00002829
wdenk2729af92004-05-03 20:45:30 +00002830Linux HOWTO:
2831============
wdenkc6097192002-11-03 00:24:07 +00002832
wdenk2729af92004-05-03 20:45:30 +00002833Porting Linux to U-Boot based systems:
2834---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002835
wdenk2729af92004-05-03 20:45:30 +00002836U-Boot cannot save you from doing all the necessary modifications to
2837configure the Linux device drivers for use with your target hardware
2838(no, we don't intend to provide a full virtual machine interface to
2839Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002840
wdenk2729af92004-05-03 20:45:30 +00002841But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002842
wdenk2729af92004-05-03 20:45:30 +00002843Just make sure your machine specific header file (for instance
2844include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2845Information structure as we define in include/u-boot.h, and make
2846sure that your definition of IMAP_ADDR uses the same value as your
2847U-Boot configuration in CFG_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002848
wdenkc6097192002-11-03 00:24:07 +00002849
wdenk2729af92004-05-03 20:45:30 +00002850Configuring the Linux kernel:
2851-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002852
wdenk2729af92004-05-03 20:45:30 +00002853No specific requirements for U-Boot. Make sure you have some root
2854device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002855
wdenkc6097192002-11-03 00:24:07 +00002856
wdenk2729af92004-05-03 20:45:30 +00002857Building a Linux Image:
2858-----------------------
wdenkc6097192002-11-03 00:24:07 +00002859
wdenk2729af92004-05-03 20:45:30 +00002860With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2861not used. If you use recent kernel source, a new build target
2862"uImage" will exist which automatically builds an image usable by
2863U-Boot. Most older kernels also have support for a "pImage" target,
2864which was introduced for our predecessor project PPCBoot and uses a
2865100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002866
wdenk2729af92004-05-03 20:45:30 +00002867Example:
wdenkc6097192002-11-03 00:24:07 +00002868
wdenk2729af92004-05-03 20:45:30 +00002869 make TQM850L_config
2870 make oldconfig
2871 make dep
2872 make uImage
wdenkc6097192002-11-03 00:24:07 +00002873
wdenk2729af92004-05-03 20:45:30 +00002874The "uImage" build target uses a special tool (in 'tools/mkimage') to
2875encapsulate a compressed Linux kernel image with header information,
2876CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002877
wdenk2729af92004-05-03 20:45:30 +00002878* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002879
wdenk2729af92004-05-03 20:45:30 +00002880* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002881
wdenk2729af92004-05-03 20:45:30 +00002882 ${CROSS_COMPILE}-objcopy -O binary \
2883 -R .note -R .comment \
2884 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00002885
wdenk2729af92004-05-03 20:45:30 +00002886* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00002887
wdenk2729af92004-05-03 20:45:30 +00002888 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00002889
wdenk2729af92004-05-03 20:45:30 +00002890* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002891
wdenk2729af92004-05-03 20:45:30 +00002892 mkimage -A ppc -O linux -T kernel -C gzip \
2893 -a 0 -e 0 -n "Linux Kernel Image" \
2894 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00002895
wdenk24ee89b2002-11-03 17:56:27 +00002896
wdenk2729af92004-05-03 20:45:30 +00002897The "mkimage" tool can also be used to create ramdisk images for use
2898with U-Boot, either separated from the Linux kernel image, or
2899combined into one file. "mkimage" encapsulates the images with a 64
2900byte header containing information about target architecture,
2901operating system, image type, compression method, entry points, time
2902stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00002903
wdenk2729af92004-05-03 20:45:30 +00002904"mkimage" can be called in two ways: to verify existing images and
2905print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002906
wdenk2729af92004-05-03 20:45:30 +00002907In the first form (with "-l" option) mkimage lists the information
2908contained in the header of an existing U-Boot image; this includes
2909checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002910
wdenk2729af92004-05-03 20:45:30 +00002911 tools/mkimage -l image
2912 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002913
wdenk2729af92004-05-03 20:45:30 +00002914The second form (with "-d" option) is used to build a U-Boot image
2915from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002916
wdenk2729af92004-05-03 20:45:30 +00002917 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2918 -n name -d data_file image
2919 -A ==> set architecture to 'arch'
2920 -O ==> set operating system to 'os'
2921 -T ==> set image type to 'type'
2922 -C ==> set compression type 'comp'
2923 -a ==> set load address to 'addr' (hex)
2924 -e ==> set entry point to 'ep' (hex)
2925 -n ==> set image name to 'name'
2926 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002927
wdenk69459792004-05-29 16:53:29 +00002928Right now, all Linux kernels for PowerPC systems use the same load
2929address (0x00000000), but the entry point address depends on the
2930kernel version:
wdenkc6097192002-11-03 00:24:07 +00002931
wdenk2729af92004-05-03 20:45:30 +00002932- 2.2.x kernels have the entry point at 0x0000000C,
2933- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002934
wdenk2729af92004-05-03 20:45:30 +00002935So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002936
wdenk2729af92004-05-03 20:45:30 +00002937 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2938 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2939 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2940 > examples/uImage.TQM850L
2941 Image Name: 2.4.4 kernel for TQM850L
2942 Created: Wed Jul 19 02:34:59 2000
2943 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2944 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2945 Load Address: 0x00000000
2946 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002947
wdenk2729af92004-05-03 20:45:30 +00002948To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002949
wdenk2729af92004-05-03 20:45:30 +00002950 -> tools/mkimage -l examples/uImage.TQM850L
2951 Image Name: 2.4.4 kernel for TQM850L
2952 Created: Wed Jul 19 02:34:59 2000
2953 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2954 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2955 Load Address: 0x00000000
2956 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002957
wdenk2729af92004-05-03 20:45:30 +00002958NOTE: for embedded systems where boot time is critical you can trade
2959speed for memory and install an UNCOMPRESSED image instead: this
2960needs more space in Flash, but boots much faster since it does not
2961need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002962
wdenk2729af92004-05-03 20:45:30 +00002963 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2964 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2965 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2966 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2967 > examples/uImage.TQM850L-uncompressed
2968 Image Name: 2.4.4 kernel for TQM850L
2969 Created: Wed Jul 19 02:34:59 2000
2970 Image Type: PowerPC Linux Kernel Image (uncompressed)
2971 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2972 Load Address: 0x00000000
2973 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002974
wdenkc6097192002-11-03 00:24:07 +00002975
wdenk2729af92004-05-03 20:45:30 +00002976Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2977when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00002978
wdenk2729af92004-05-03 20:45:30 +00002979 -> tools/mkimage -n 'Simple Ramdisk Image' \
2980 > -A ppc -O linux -T ramdisk -C gzip \
2981 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2982 Image Name: Simple Ramdisk Image
2983 Created: Wed Jan 12 14:01:50 2000
2984 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2985 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2986 Load Address: 0x00000000
2987 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00002988
wdenkdb01a2e2004-04-15 23:14:49 +00002989
wdenk2729af92004-05-03 20:45:30 +00002990Installing a Linux Image:
2991-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00002992
wdenk2729af92004-05-03 20:45:30 +00002993To downloading a U-Boot image over the serial (console) interface,
2994you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00002995
wdenk2729af92004-05-03 20:45:30 +00002996 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00002997
wdenk2729af92004-05-03 20:45:30 +00002998The 'objcopy' does not understand the information in the U-Boot
2999image header, so the resulting S-Record file will be relative to
3000address 0x00000000. To load it to a given address, you need to
3001specify the target address as 'offset' parameter with the 'loads'
3002command.
wdenkc6097192002-11-03 00:24:07 +00003003
wdenk2729af92004-05-03 20:45:30 +00003004Example: install the image to address 0x40100000 (which on the
3005TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003006
wdenk2729af92004-05-03 20:45:30 +00003007 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003008
wdenk2729af92004-05-03 20:45:30 +00003009 .......... done
3010 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003011
wdenk2729af92004-05-03 20:45:30 +00003012 => loads 40100000
3013 ## Ready for S-Record download ...
3014 ~>examples/image.srec
3015 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3016 ...
3017 15989 15990 15991 15992
3018 [file transfer complete]
3019 [connected]
3020 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003021
3022
wdenk2729af92004-05-03 20:45:30 +00003023You can check the success of the download using the 'iminfo' command;
3024this includes a checksum verification so you can be sure no data
3025corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003026
wdenk2729af92004-05-03 20:45:30 +00003027 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003028
wdenk2729af92004-05-03 20:45:30 +00003029 ## Checking Image at 40100000 ...
3030 Image Name: 2.2.13 for initrd on TQM850L
3031 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3032 Data Size: 335725 Bytes = 327 kB = 0 MB
3033 Load Address: 00000000
3034 Entry Point: 0000000c
3035 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003036
3037
wdenk2729af92004-05-03 20:45:30 +00003038Boot Linux:
3039-----------
wdenkc6097192002-11-03 00:24:07 +00003040
wdenk2729af92004-05-03 20:45:30 +00003041The "bootm" command is used to boot an application that is stored in
3042memory (RAM or Flash). In case of a Linux kernel image, the contents
3043of the "bootargs" environment variable is passed to the kernel as
3044parameters. You can check and modify this variable using the
3045"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003046
3047
wdenk2729af92004-05-03 20:45:30 +00003048 => printenv bootargs
3049 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003050
wdenk2729af92004-05-03 20:45:30 +00003051 => 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 +00003052
wdenk2729af92004-05-03 20:45:30 +00003053 => printenv bootargs
3054 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 +00003055
wdenk2729af92004-05-03 20:45:30 +00003056 => bootm 40020000
3057 ## Booting Linux kernel at 40020000 ...
3058 Image Name: 2.2.13 for NFS on TQM850L
3059 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3060 Data Size: 381681 Bytes = 372 kB = 0 MB
3061 Load Address: 00000000
3062 Entry Point: 0000000c
3063 Verifying Checksum ... OK
3064 Uncompressing Kernel Image ... OK
3065 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
3066 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3067 time_init: decrementer frequency = 187500000/60
3068 Calibrating delay loop... 49.77 BogoMIPS
3069 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3070 ...
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072If you want to boot a Linux kernel with initial ram disk, you pass
3073the memory addresses of both the kernel and the initrd image (PPBCOOT
3074format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003075
wdenk2729af92004-05-03 20:45:30 +00003076 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003077
wdenk2729af92004-05-03 20:45:30 +00003078 ## Checking Image at 40100000 ...
3079 Image Name: 2.2.13 for initrd on TQM850L
3080 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3081 Data Size: 335725 Bytes = 327 kB = 0 MB
3082 Load Address: 00000000
3083 Entry Point: 0000000c
3084 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003085
wdenk2729af92004-05-03 20:45:30 +00003086 ## Checking Image at 40200000 ...
3087 Image Name: Simple Ramdisk Image
3088 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3089 Data Size: 566530 Bytes = 553 kB = 0 MB
3090 Load Address: 00000000
3091 Entry Point: 00000000
3092 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003093
wdenk2729af92004-05-03 20:45:30 +00003094 => bootm 40100000 40200000
3095 ## Booting Linux kernel at 40100000 ...
3096 Image Name: 2.2.13 for initrd on TQM850L
3097 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3098 Data Size: 335725 Bytes = 327 kB = 0 MB
3099 Load Address: 00000000
3100 Entry Point: 0000000c
3101 Verifying Checksum ... OK
3102 Uncompressing Kernel Image ... OK
3103 ## Loading RAMDisk Image at 40200000 ...
3104 Image Name: Simple Ramdisk Image
3105 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3106 Data Size: 566530 Bytes = 553 kB = 0 MB
3107 Load Address: 00000000
3108 Entry Point: 00000000
3109 Verifying Checksum ... OK
3110 Loading Ramdisk ... OK
3111 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
3112 Boot arguments: root=/dev/ram
3113 time_init: decrementer frequency = 187500000/60
3114 Calibrating delay loop... 49.77 BogoMIPS
3115 ...
3116 RAMDISK: Compressed image found at block 0
3117 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003118
wdenk2729af92004-05-03 20:45:30 +00003119 bash#
wdenkc6097192002-11-03 00:24:07 +00003120
Matthew McClintock02677682006-06-28 10:41:37 -05003121Boot Linux and pass a flat device tree:
3122-----------
3123
3124First, U-Boot must be compiled with the appropriate defines. See the section
3125titled "Linux Kernel Interface" above for a more in depth explanation. The
3126following is an example of how to start a kernel and pass an updated
3127flat device tree:
3128
3129=> print oftaddr
3130oftaddr=0x300000
3131=> print oft
3132oft=oftrees/mpc8540ads.dtb
3133=> tftp $oftaddr $oft
3134Speed: 1000, full duplex
3135Using TSEC0 device
3136TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3137Filename 'oftrees/mpc8540ads.dtb'.
3138Load address: 0x300000
3139Loading: #
3140done
3141Bytes transferred = 4106 (100a hex)
3142=> tftp $loadaddr $bootfile
3143Speed: 1000, full duplex
3144Using TSEC0 device
3145TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3146Filename 'uImage'.
3147Load address: 0x200000
3148Loading:############
3149done
3150Bytes transferred = 1029407 (fb51f hex)
3151=> print loadaddr
3152loadaddr=200000
3153=> print oftaddr
3154oftaddr=0x300000
3155=> bootm $loadaddr - $oftaddr
3156## Booting image at 00200000 ...
3157 Image Name: Linux-2.6.17-dirty
3158 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3159 Data Size: 1029343 Bytes = 1005.2 kB
3160 Load Address: 00000000
3161 Entry Point: 00000000
3162 Verifying Checksum ... OK
3163 Uncompressing Kernel Image ... OK
3164Booting using flat device tree at 0x300000
3165Using MPC85xx ADS machine description
3166Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3167[snip]
3168
3169
wdenk2729af92004-05-03 20:45:30 +00003170More About U-Boot Image Types:
3171------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003172
wdenk2729af92004-05-03 20:45:30 +00003173U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003174
wdenk2729af92004-05-03 20:45:30 +00003175 "Standalone Programs" are directly runnable in the environment
3176 provided by U-Boot; it is expected that (if they behave
3177 well) you can continue to work in U-Boot after return from
3178 the Standalone Program.
3179 "OS Kernel Images" are usually images of some Embedded OS which
3180 will take over control completely. Usually these programs
3181 will install their own set of exception handlers, device
3182 drivers, set up the MMU, etc. - this means, that you cannot
3183 expect to re-enter U-Boot except by resetting the CPU.
3184 "RAMDisk Images" are more or less just data blocks, and their
3185 parameters (address, size) are passed to an OS kernel that is
3186 being started.
3187 "Multi-File Images" contain several images, typically an OS
3188 (Linux) kernel image and one or more data images like
3189 RAMDisks. This construct is useful for instance when you want
3190 to boot over the network using BOOTP etc., where the boot
3191 server provides just a single image file, but you want to get
3192 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003193
wdenk2729af92004-05-03 20:45:30 +00003194 "Multi-File Images" start with a list of image sizes, each
3195 image size (in bytes) specified by an "uint32_t" in network
3196 byte order. This list is terminated by an "(uint32_t)0".
3197 Immediately after the terminating 0 follow the images, one by
3198 one, all aligned on "uint32_t" boundaries (size rounded up to
3199 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003200
wdenk2729af92004-05-03 20:45:30 +00003201 "Firmware Images" are binary images containing firmware (like
3202 U-Boot or FPGA images) which usually will be programmed to
3203 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003204
wdenk2729af92004-05-03 20:45:30 +00003205 "Script files" are command sequences that will be executed by
3206 U-Boot's command interpreter; this feature is especially
3207 useful when you configure U-Boot to use a real shell (hush)
3208 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003209
wdenkc6097192002-11-03 00:24:07 +00003210
wdenk2729af92004-05-03 20:45:30 +00003211Standalone HOWTO:
3212=================
wdenkc6097192002-11-03 00:24:07 +00003213
wdenk2729af92004-05-03 20:45:30 +00003214One of the features of U-Boot is that you can dynamically load and
3215run "standalone" applications, which can use some resources of
3216U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003217
wdenk2729af92004-05-03 20:45:30 +00003218Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003219
wdenk2729af92004-05-03 20:45:30 +00003220"Hello World" Demo:
3221-------------------
wdenkc6097192002-11-03 00:24:07 +00003222
wdenk2729af92004-05-03 20:45:30 +00003223'examples/hello_world.c' contains a small "Hello World" Demo
3224application; it is automatically compiled when you build U-Boot.
3225It's configured to run at address 0x00040004, so you can play with it
3226like that:
wdenkc6097192002-11-03 00:24:07 +00003227
wdenk2729af92004-05-03 20:45:30 +00003228 => loads
3229 ## Ready for S-Record download ...
3230 ~>examples/hello_world.srec
3231 1 2 3 4 5 6 7 8 9 10 11 ...
3232 [file transfer complete]
3233 [connected]
3234 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk2729af92004-05-03 20:45:30 +00003236 => go 40004 Hello World! This is a test.
3237 ## Starting application at 0x00040004 ...
3238 Hello World
3239 argc = 7
3240 argv[0] = "40004"
3241 argv[1] = "Hello"
3242 argv[2] = "World!"
3243 argv[3] = "This"
3244 argv[4] = "is"
3245 argv[5] = "a"
3246 argv[6] = "test."
3247 argv[7] = "<NULL>"
3248 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003249
wdenk2729af92004-05-03 20:45:30 +00003250 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003251
wdenk2729af92004-05-03 20:45:30 +00003252Another example, which demonstrates how to register a CPM interrupt
3253handler with the U-Boot code, can be found in 'examples/timer.c'.
3254Here, a CPM timer is set up to generate an interrupt every second.
3255The interrupt service routine is trivial, just printing a '.'
3256character, but this is just a demo program. The application can be
3257controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003258
wdenk2729af92004-05-03 20:45:30 +00003259 ? - print current values og the CPM Timer registers
3260 b - enable interrupts and start timer
3261 e - stop timer and disable interrupts
3262 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003263
wdenk2729af92004-05-03 20:45:30 +00003264 => loads
3265 ## Ready for S-Record download ...
3266 ~>examples/timer.srec
3267 1 2 3 4 5 6 7 8 9 10 11 ...
3268 [file transfer complete]
3269 [connected]
3270 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003271
wdenk2729af92004-05-03 20:45:30 +00003272 => go 40004
3273 ## Starting application at 0x00040004 ...
3274 TIMERS=0xfff00980
3275 Using timer 1
3276 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003277
wdenk2729af92004-05-03 20:45:30 +00003278Hit 'b':
3279 [q, b, e, ?] Set interval 1000000 us
3280 Enabling timer
3281Hit '?':
3282 [q, b, e, ?] ........
3283 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3284Hit '?':
3285 [q, b, e, ?] .
3286 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3287Hit '?':
3288 [q, b, e, ?] .
3289 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3290Hit '?':
3291 [q, b, e, ?] .
3292 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3293Hit 'e':
3294 [q, b, e, ?] ...Stopping timer
3295Hit 'q':
3296 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003297
3298
wdenk2729af92004-05-03 20:45:30 +00003299Minicom warning:
3300================
wdenk85ec0bc2003-03-31 16:34:49 +00003301
wdenk2729af92004-05-03 20:45:30 +00003302Over time, many people have reported problems when trying to use the
3303"minicom" terminal emulation program for serial download. I (wd)
3304consider minicom to be broken, and recommend not to use it. Under
3305Unix, I recommend to use C-Kermit for general purpose use (and
3306especially for kermit binary protocol download ("loadb" command), and
3307use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003308
wdenk2729af92004-05-03 20:45:30 +00003309Nevertheless, if you absolutely want to use it try adding this
3310configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003311
wdenk2729af92004-05-03 20:45:30 +00003312 Name Program Name U/D FullScr IO-Red. Multi
3313 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3314 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003315
3316
wdenk2729af92004-05-03 20:45:30 +00003317NetBSD Notes:
3318=============
wdenkc6097192002-11-03 00:24:07 +00003319
wdenk2729af92004-05-03 20:45:30 +00003320Starting at version 0.9.2, U-Boot supports NetBSD both as host
3321(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003322
wdenk2729af92004-05-03 20:45:30 +00003323Building requires a cross environment; it is known to work on
3324NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3325need gmake since the Makefiles are not compatible with BSD make).
3326Note that the cross-powerpc package does not install include files;
3327attempting to build U-Boot will fail because <machine/ansi.h> is
3328missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003329
wdenk2729af92004-05-03 20:45:30 +00003330 # cd /usr/pkg/cross/powerpc-netbsd/include
3331 # mkdir powerpc
3332 # ln -s powerpc machine
3333 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3334 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003335
wdenk2729af92004-05-03 20:45:30 +00003336Native builds *don't* work due to incompatibilities between native
3337and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003338
wdenk2729af92004-05-03 20:45:30 +00003339Booting assumes that (the first part of) the image booted is a
3340stage-2 loader which in turn loads and then invokes the kernel
3341proper. Loader sources will eventually appear in the NetBSD source
3342tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003343meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003344
3345
wdenk2729af92004-05-03 20:45:30 +00003346Implementation Internals:
3347=========================
wdenkc6097192002-11-03 00:24:07 +00003348
wdenk2729af92004-05-03 20:45:30 +00003349The following is not intended to be a complete description of every
3350implementation detail. However, it should help to understand the
3351inner workings of U-Boot and make it easier to port it to custom
3352hardware.
wdenkc6097192002-11-03 00:24:07 +00003353
3354
wdenk2729af92004-05-03 20:45:30 +00003355Initial Stack, Global Data:
3356---------------------------
wdenkc6097192002-11-03 00:24:07 +00003357
wdenk2729af92004-05-03 20:45:30 +00003358The implementation of U-Boot is complicated by the fact that U-Boot
3359starts running out of ROM (flash memory), usually without access to
3360system RAM (because the memory controller is not initialized yet).
3361This means that we don't have writable Data or BSS segments, and BSS
3362is not initialized as zero. To be able to get a C environment working
3363at all, we have to allocate at least a minimal stack. Implementation
3364options for this are defined and restricted by the CPU used: Some CPU
3365models provide on-chip memory (like the IMMR area on MPC8xx and
3366MPC826x processors), on others (parts of) the data cache can be
3367locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003368
wdenk2729af92004-05-03 20:45:30 +00003369 Chris Hallinan posted a good summary of these issues to the
3370 u-boot-users mailing list:
wdenk43d96162003-03-06 00:02:04 +00003371
wdenk2729af92004-05-03 20:45:30 +00003372 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3373 From: "Chris Hallinan" <clh@net1plus.com>
3374 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3375 ...
wdenk43d96162003-03-06 00:02:04 +00003376
wdenk2729af92004-05-03 20:45:30 +00003377 Correct me if I'm wrong, folks, but the way I understand it
3378 is this: Using DCACHE as initial RAM for Stack, etc, does not
3379 require any physical RAM backing up the cache. The cleverness
3380 is that the cache is being used as a temporary supply of
3381 necessary storage before the SDRAM controller is setup. It's
3382 beyond the scope of this list to expain the details, but you
3383 can see how this works by studying the cache architecture and
3384 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003385
wdenk2729af92004-05-03 20:45:30 +00003386 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3387 is another option for the system designer to use as an
3388 initial stack/ram area prior to SDRAM being available. Either
3389 option should work for you. Using CS 4 should be fine if your
3390 board designers haven't used it for something that would
3391 cause you grief during the initial boot! It is frequently not
3392 used.
wdenk43d96162003-03-06 00:02:04 +00003393
wdenk2729af92004-05-03 20:45:30 +00003394 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3395 with your processor/board/system design. The default value
3396 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003397 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003398 than your SDRAM module. If you have a 64MB SDRAM module, set
3399 it above 400_0000. Just make sure your board has no resources
3400 that are supposed to respond to that address! That code in
3401 start.S has been around a while and should work as is when
3402 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003403
wdenk2729af92004-05-03 20:45:30 +00003404 -Chris Hallinan
3405 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003406
wdenk2729af92004-05-03 20:45:30 +00003407It is essential to remember this, since it has some impact on the C
3408code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003409
wdenk2729af92004-05-03 20:45:30 +00003410* Initialized global data (data segment) is read-only. Do not attempt
3411 to write it.
wdenkc6097192002-11-03 00:24:07 +00003412
wdenk2729af92004-05-03 20:45:30 +00003413* Do not use any unitialized global data (or implicitely initialized
3414 as zero data - BSS segment) at all - this is undefined, initiali-
3415 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003416
wdenk2729af92004-05-03 20:45:30 +00003417* Stack space is very limited. Avoid big data buffers or things like
3418 that.
wdenkc6097192002-11-03 00:24:07 +00003419
wdenk2729af92004-05-03 20:45:30 +00003420Having only the stack as writable memory limits means we cannot use
3421normal global data to share information beween the code. But it
3422turned out that the implementation of U-Boot can be greatly
3423simplified by making a global data structure (gd_t) available to all
3424functions. We could pass a pointer to this data as argument to _all_
3425functions, but this would bloat the code. Instead we use a feature of
3426the GCC compiler (Global Register Variables) to share the data: we
3427place a pointer (gd) to the global data into a register which we
3428reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003429
wdenk2729af92004-05-03 20:45:30 +00003430When choosing a register for such a purpose we are restricted by the
3431relevant (E)ABI specifications for the current architecture, and by
3432GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003433
wdenk2729af92004-05-03 20:45:30 +00003434For PowerPC, the following registers have specific use:
3435 R1: stack pointer
3436 R2: TOC pointer
3437 R3-R4: parameter passing and return values
3438 R5-R10: parameter passing
3439 R13: small data area pointer
3440 R30: GOT pointer
3441 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003442
wdenk2729af92004-05-03 20:45:30 +00003443 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003444
wdenk2729af92004-05-03 20:45:30 +00003445 ==> U-Boot will use R29 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003446
wdenk2729af92004-05-03 20:45:30 +00003447 Note: on PPC, we could use a static initializer (since the
3448 address of the global data structure is known at compile time),
3449 but it turned out that reserving a register results in somewhat
3450 smaller code - although the code savings are not that big (on
3451 average for all boards 752 bytes for the whole U-Boot image,
3452 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003453
wdenk2729af92004-05-03 20:45:30 +00003454On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003455
wdenk2729af92004-05-03 20:45:30 +00003456 R0: function argument word/integer result
3457 R1-R3: function argument word
3458 R9: GOT pointer
3459 R10: stack limit (used only if stack checking if enabled)
3460 R11: argument (frame) pointer
3461 R12: temporary workspace
3462 R13: stack pointer
3463 R14: link register
3464 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003465
wdenk2729af92004-05-03 20:45:30 +00003466 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003467
Wolfgang Denkd87080b2006-03-31 18:32:53 +02003468NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3469or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003470
wdenk2729af92004-05-03 20:45:30 +00003471Memory Management:
3472------------------
wdenkc6097192002-11-03 00:24:07 +00003473
wdenk2729af92004-05-03 20:45:30 +00003474U-Boot runs in system state and uses physical addresses, i.e. the
3475MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003476
wdenk2729af92004-05-03 20:45:30 +00003477The available memory is mapped to fixed addresses using the memory
3478controller. In this process, a contiguous block is formed for each
3479memory type (Flash, SDRAM, SRAM), even when it consists of several
3480physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003481
wdenk2729af92004-05-03 20:45:30 +00003482U-Boot is installed in the first 128 kB of the first Flash bank (on
3483TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3484booting and sizing and initializing DRAM, the code relocates itself
3485to the upper end of DRAM. Immediately below the U-Boot code some
3486memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3487configuration setting]. Below that, a structure with global Board
3488Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003489
wdenk2729af92004-05-03 20:45:30 +00003490Additionally, some exception handler code is copied to the low 8 kB
3491of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003492
wdenk2729af92004-05-03 20:45:30 +00003493So a typical memory configuration with 16 MB of DRAM could look like
3494this:
wdenkc6097192002-11-03 00:24:07 +00003495
wdenk2729af92004-05-03 20:45:30 +00003496 0x0000 0000 Exception Vector code
3497 :
3498 0x0000 1FFF
3499 0x0000 2000 Free for Application Use
3500 :
3501 :
wdenkc6097192002-11-03 00:24:07 +00003502
wdenk2729af92004-05-03 20:45:30 +00003503 :
3504 :
3505 0x00FB FF20 Monitor Stack (Growing downward)
3506 0x00FB FFAC Board Info Data and permanent copy of global data
3507 0x00FC 0000 Malloc Arena
3508 :
3509 0x00FD FFFF
3510 0x00FE 0000 RAM Copy of Monitor Code
3511 ... eventually: LCD or video framebuffer
3512 ... eventually: pRAM (Protected RAM - unchanged by reset)
3513 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003514
3515
wdenk2729af92004-05-03 20:45:30 +00003516System Initialization:
3517----------------------
wdenkc6097192002-11-03 00:24:07 +00003518
wdenk2729af92004-05-03 20:45:30 +00003519In the reset configuration, U-Boot starts at the reset entry point
3520(on most PowerPC systens at address 0x00000100). Because of the reset
3521configuration for CS0# this is a mirror of the onboard Flash memory.
3522To be able to re-map memory U-Boot then jumps to its link address.
3523To be able to implement the initialization code in C, a (small!)
3524initial stack is set up in the internal Dual Ported RAM (in case CPUs
3525which provide such a feature like MPC8xx or MPC8260), or in a locked
3526part of the data cache. After that, U-Boot initializes the CPU core,
3527the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003528
wdenk2729af92004-05-03 20:45:30 +00003529Next, all (potentially) available memory banks are mapped using a
3530preliminary mapping. For example, we put them on 512 MB boundaries
3531(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3532on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3533programmed for SDRAM access. Using the temporary configuration, a
3534simple memory test is run that determines the size of the SDRAM
3535banks.
wdenkc6097192002-11-03 00:24:07 +00003536
wdenk2729af92004-05-03 20:45:30 +00003537When there is more than one SDRAM bank, and the banks are of
3538different size, the largest is mapped first. For equal size, the first
3539bank (CS2#) is mapped first. The first mapping is always for address
35400x00000000, with any additional banks following immediately to create
3541contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543Then, the monitor installs itself at the upper end of the SDRAM area
3544and allocates memory for use by malloc() and for the global Board
3545Info data; also, the exception vector code is copied to the low RAM
3546pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003547
wdenk2729af92004-05-03 20:45:30 +00003548Only after this relocation will you have a "normal" C environment;
3549until that you are restricted in several ways, mostly because you are
3550running from ROM, and because the code will have to be relocated to a
3551new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003552
3553
wdenk2729af92004-05-03 20:45:30 +00003554U-Boot Porting Guide:
3555----------------------
wdenkc6097192002-11-03 00:24:07 +00003556
wdenk2729af92004-05-03 20:45:30 +00003557[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3558list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003559
3560
wdenk2729af92004-05-03 20:45:30 +00003561int main (int argc, char *argv[])
3562{
3563 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003564
wdenk2729af92004-05-03 20:45:30 +00003565 signal (SIGALRM, no_more_time);
3566 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003567
wdenk2729af92004-05-03 20:45:30 +00003568 if (available_money > available_manpower) {
3569 pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00003570 return 0;
3571 }
3572
wdenk2729af92004-05-03 20:45:30 +00003573 Download latest U-Boot source;
3574
3575 Subscribe to u-boot-users mailing list;
3576
3577 if (clueless) {
3578 email ("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003579 }
3580
wdenk2729af92004-05-03 20:45:30 +00003581 while (learning) {
3582 Read the README file in the top level directory;
3583 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3584 Read the source, Luke;
3585 }
wdenkc6097192002-11-03 00:24:07 +00003586
wdenk2729af92004-05-03 20:45:30 +00003587 if (available_money > toLocalCurrency ($2500)) {
3588 Buy a BDI2000;
3589 } else {
3590 Add a lot of aggravation and time;
3591 }
wdenkc6097192002-11-03 00:24:07 +00003592
wdenk2729af92004-05-03 20:45:30 +00003593 Create your own board support subdirectory;
wdenkc6097192002-11-03 00:24:07 +00003594
wdenk2729af92004-05-03 20:45:30 +00003595 Create your own board config file;
wdenk6aff3112002-12-17 01:51:00 +00003596
wdenk2729af92004-05-03 20:45:30 +00003597 while (!running) {
3598 do {
3599 Add / modify source code;
3600 } until (compiles);
3601 Debug;
3602 if (clueless)
3603 email ("Hi, I am having problems...");
3604 }
3605 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003606
wdenk2729af92004-05-03 20:45:30 +00003607 return 0;
3608}
3609
3610void no_more_time (int sig)
3611{
3612 hire_a_guru();
3613}
wdenkc6097192002-11-03 00:24:07 +00003614
3615
wdenk2729af92004-05-03 20:45:30 +00003616Coding Standards:
3617-----------------
wdenkc6097192002-11-03 00:24:07 +00003618
wdenk2729af92004-05-03 20:45:30 +00003619All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02003620coding style; see the file "Documentation/CodingStyle" and the script
3621"scripts/Lindent" in your Linux kernel source directory. In sources
3622originating from U-Boot a style corresponding to "Lindent -pcs" (adding
3623spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00003624
Detlev Zundel2c051652006-09-01 15:39:02 +02003625Source files originating from a different project (for example the
3626MTD subsystem) are generally exempt from these guidelines and are not
3627reformated to ease subsequent migration to newer versions of those
3628sources.
3629
3630Please note that U-Boot is implemented in C (and to some small parts in
3631Assembler); no C++ is used, so please do not use C++ style comments (//)
3632in your code.
wdenk2729af92004-05-03 20:45:30 +00003633
3634Please also stick to the following formatting rules:
3635- remove any trailing white space
3636- use TAB characters for indentation, not spaces
3637- make sure NOT to use DOS '\r\n' line feeds
3638- do not add more than 2 empty lines to source files
3639- do not add trailing empty lines to source files
3640
3641Submissions which do not conform to the standards may be returned
3642with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003643
3644
wdenk2729af92004-05-03 20:45:30 +00003645Submitting Patches:
3646-------------------
wdenkc6097192002-11-03 00:24:07 +00003647
wdenk2729af92004-05-03 20:45:30 +00003648Since the number of patches for U-Boot is growing, we need to
3649establish some rules. Submissions which do not conform to these rules
3650may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003651
wdenk90dc6702005-05-03 14:12:25 +00003652Patches shall be sent to the u-boot-users mailing list.
wdenkc6097192002-11-03 00:24:07 +00003653
wdenk2729af92004-05-03 20:45:30 +00003654When you send a patch, please include the following information with
3655it:
wdenkc6097192002-11-03 00:24:07 +00003656
wdenk2729af92004-05-03 20:45:30 +00003657* For bug fixes: a description of the bug and how your patch fixes
3658 this bug. Please try to include a way of demonstrating that the
3659 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003660
wdenk2729af92004-05-03 20:45:30 +00003661* For new features: a description of the feature and your
3662 implementation.
wdenkc6097192002-11-03 00:24:07 +00003663
wdenk2729af92004-05-03 20:45:30 +00003664* A CHANGELOG entry as plaintext (separate from the patch)
3665
3666* For major contributions, your entry to the CREDITS file
3667
3668* When you add support for a new board, don't forget to add this
3669 board to the MAKEALL script, too.
3670
3671* If your patch adds new configuration options, don't forget to
3672 document these in the README file.
3673
3674* The patch itself. If you are accessing the CVS repository use "cvs
3675 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3676 version of diff does not support these options, then get the latest
3677 version of GNU diff.
3678
3679 The current directory when running this command shall be the top
3680 level directory of the U-Boot source tree, or it's parent directory
3681 (i. e. please make sure that your patch includes sufficient
3682 directory information for the affected files).
3683
3684 We accept patches as plain text, MIME attachments or as uuencoded
3685 gzipped text.
3686
3687* If one logical set of modifications affects or creates several
3688 files, all these changes shall be submitted in a SINGLE patch file.
3689
3690* Changesets that contain different, unrelated modifications shall be
3691 submitted as SEPARATE patches, one patch per changeset.
3692
3693
3694Notes:
3695
3696* Before sending the patch, run the MAKEALL script on your patched
3697 source tree and make sure that no errors or warnings are reported
3698 for any of the boards.
3699
3700* Keep your modifications to the necessary minimum: A patch
3701 containing several unrelated changes or arbitrary reformats will be
3702 returned with a request to re-formatting / split it.
3703
3704* If you modify existing code, make sure that your new code does not
3705 add to the memory footprint of the code ;-) Small is beautiful!
3706 When adding new features, these should compile conditionally only
3707 (using #ifdef), and the resulting code with the new feature
3708 disabled must not need more memory than the old code without your
3709 modification.
wdenk90dc6702005-05-03 14:12:25 +00003710
3711* Remember that there is a size limit of 40 kB per message on the
3712 u-boot-users mailing list. Compression may help.