blob: bfccadff960808def4a0a627c1052aad841bfe7d [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
wdenk3a473b22004-01-03 00:43:19 +00002# (C) Copyright 2000 - 2004
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
28Embedded boards based on PowerPC and ARM processors, which can be
29installed in a boot ROM and used to initialize and test the hardware
30or to download and run application code.
wdenkc6097192002-11-03 00:24:07 +000031
32The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000033the source code originate in the Linux source tree, we have some
34header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000035support booting of Linux images.
36
37Some attention has been paid to make this software easily
38configurable and extendable. For instance, all monitor commands are
39implemented with the same call interface, so that it's very easy to
40add new commands. Also, instead of permanently adding rarely used
41code (for instance hardware test utilities) to the monitor, you can
42load and run it dynamically.
43
44
45Status:
46=======
47
48In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000049Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000050"working". In fact, many of them are used in production systems.
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case of problems see the CHANGELOG and CREDITS files to find out
wdenkc6097192002-11-03 00:24:07 +000053who contributed the specific port.
54
wdenkc6097192002-11-03 00:24:07 +000055
56Where to get help:
57==================
58
wdenk24ee89b2002-11-03 17:56:27 +000059In case you have questions about, problems with or contributions for
60U-Boot you should send a message to the U-Boot mailing list at
61<u-boot-users@lists.sourceforge.net>. There is also an archive of
62previous traffic on the mailing list - please search the archive
wdenkc6097192002-11-03 00:24:07 +000063before asking FAQ's. Please see
64http://lists.sourceforge.net/lists/listinfo/u-boot-users/
65
66
67Where we come from:
68===================
69
70- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000071- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000072- clean up code
73- make it easier to add custom boards
74- make it possible to add other [PowerPC] CPUs
75- extend functions, especially:
76 * Provide extended interface to Linux boot loader
77 * S-Record download
78 * network boot
79 * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000080- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000081- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000082- create U-Boot project (http://sourceforge.net/projects/u-boot)
83
84
85Names and Spelling:
86===================
87
88The "official" name of this project is "Das U-Boot". The spelling
89"U-Boot" shall be used in all written text (documentation, comments
90in source files etc.). Example:
91
92 This is the README file for the U-Boot project.
93
94File names etc. shall be based on the string "u-boot". Examples:
95
96 include/asm-ppc/u-boot.h
97
98 #include <asm/u-boot.h>
99
100Variable names, preprocessor constants etc. shall be either based on
101the string "u_boot" or on "U_BOOT". Example:
102
103 U_BOOT_VERSION u_boot_logo
104 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000105
106
wdenk93f19cc2002-12-17 17:55:09 +0000107Versioning:
108===========
109
110U-Boot uses a 3 level version number containing a version, a
111sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
112sub-version "34", and patchlevel "4".
113
114The patchlevel is used to indicate certain stages of development
115between released versions, i. e. officially released versions of
116U-Boot will always have a patchlevel of "0".
117
118
wdenkc6097192002-11-03 00:24:07 +0000119Directory Hierarchy:
120====================
121
wdenk7152b1d2003-09-05 23:19:14 +0000122- board Board dependent files
123- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000124- cpu CPU specific files
wdenk11dadd52004-02-27 00:07:27 +0000125 - 74xx_7xx Files specific to Motorola MPC74xx and 7xx CPUs
126 - arm720t Files specific to ARM 720 CPUs
127 - arm920t Files specific to ARM 920 CPUs
128 - arm925t Files specific to ARM 925 CPUs
129 - arm926ejs Files specific to ARM 926 CPUs
130 - at91rm9200 Files specific to Atmel AT91RM9200 CPUs
131 - i386 Files specific to i386 CPUs
132 - ixp Files specific to Intel XScale IXP CPUs
133 - mcf52x2 Files specific to Motorola ColdFire MCF52x2 CPUs
134 - mips Files specific to MIPS CPUs
135 - mpc5xx Files specific to Motorola MPC5xx CPUs
136 - mpc5xxx Files specific to Motorola MPC5xxx CPUs
137 - mpc8xx Files specific to Motorola MPC8xx CPUs
138 - mpc824x Files specific to Motorola MPC824x CPUs
139 - mpc8260 Files specific to Motorola MPC8260 CPUs
140 - mpc85xx Files specific to Motorola MPC85xx CPUs
141 - nios Files specific to Altera NIOS CPUs
142 - ppc4xx Files specific to IBM PowerPC 4xx CPUs
143 - pxa Files specific to Intel XScale PXA CPUs
144 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
145 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000146- disk Code for disk drive partition handling
147- doc Documentation (don't expect too much)
wdenk7152b1d2003-09-05 23:19:14 +0000148- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000149- dtt Digital Thermometer and Thermostat drivers
150- examples Example code for standalone applications, etc.
151- include Header Files
wdenk11dadd52004-02-27 00:07:27 +0000152- lib_arm Files generic to ARM architecture
153- lib_generic Files generic to all architectures
154- lib_i386 Files generic to i386 architecture
155- lib_m68k Files generic to m68k architecture
156- lib_mips Files generic to MIPS architecture
157- lib_nios Files generic to NIOS architecture
158- lib_ppc Files generic to PowerPC architecture
wdenkc6097192002-11-03 00:24:07 +0000159- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000160- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000161- rtc Real Time Clock drivers
162- tools Tools to build S-Record or U-Boot images, etc.
163
wdenkc6097192002-11-03 00:24:07 +0000164Software Configuration:
165=======================
166
167Configuration is usually done using C preprocessor defines; the
168rationale behind that is to avoid dead code whenever possible.
169
170There are two classes of configuration variables:
171
172* Configuration _OPTIONS_:
173 These are selectable by the user and have names beginning with
174 "CONFIG_".
175
176* Configuration _SETTINGS_:
177 These depend on the hardware etc. and should not be meddled with if
178 you don't know what you're doing; they have names beginning with
179 "CFG_".
180
181Later we will add a configuration tool - probably similar to or even
182identical to what's used for the Linux kernel. Right now, we have to
183do the configuration by hand, which means creating some symbolic
184links and editing some configuration files. We use the TQM8xxL boards
185as an example here.
186
187
188Selection of Processor Architecture and Board Type:
189---------------------------------------------------
190
191For all supported boards there are ready-to-use default
192configurations available; just type "make <board_name>_config".
193
194Example: For a TQM823L module type:
195
196 cd u-boot
197 make TQM823L_config
198
199For the Cogent platform, you need to specify the cpu type as well;
200e.g. "make cogent_mpc8xx_config". And also configure the cogent
201directory according to the instructions in cogent/README.
202
203
204Configuration Options:
205----------------------
206
207Configuration depends on the combination of board and CPU type; all
208such information is kept in a configuration file
209"include/configs/<board_name>.h".
210
211Example: For a TQM823L module, all configuration settings are in
212"include/configs/TQM823L.h".
213
214
wdenk7f6c2cb2002-11-10 22:06:23 +0000215Many of the options are named exactly as the corresponding Linux
216kernel configuration options. The intention is to make it easier to
217build a config tool - later.
218
219
wdenkc6097192002-11-03 00:24:07 +0000220The following options need to be configured:
221
222- CPU Type: Define exactly one of
223
224 PowerPC based CPUs:
225 -------------------
226 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
wdenk0db5bca2003-03-31 17:27:09 +0000227 or CONFIG_MPC5xx
wdenkc6097192002-11-03 00:24:07 +0000228 or CONFIG_MPC824X, CONFIG_MPC8260
wdenk42d1f032003-10-15 23:53:47 +0000229 or CONFIG_MPC85xx
wdenkc6097192002-11-03 00:24:07 +0000230 or CONFIG_IOP480
231 or CONFIG_405GP
wdenk12f34242003-09-02 22:48:03 +0000232 or CONFIG_405EP
wdenkc6097192002-11-03 00:24:07 +0000233 or CONFIG_440
234 or CONFIG_MPC74xx
wdenk72755c72003-06-20 23:10:58 +0000235 or CONFIG_750FX
wdenkc6097192002-11-03 00:24:07 +0000236
237 ARM based CPUs:
238 ---------------
239 CONFIG_SA1110
240 CONFIG_ARM7
241 CONFIG_PXA250
242
wdenk507bbe32004-04-18 21:13:41 +0000243 MicroBlaze based CPUs:
244 ----------------------
245 CONFIG_MICROBLZE
246
wdenkc6097192002-11-03 00:24:07 +0000247
248- Board Type: Define exactly one of
249
250 PowerPC based boards:
251 ---------------------
252
wdenkdb01a2e2004-04-15 23:14:49 +0000253 CONFIG_ADCIOP, CONFIG_ADS860, CONFIG_AMX860,
254 CONFIG_AR405, CONFIG_BAB7xx, CONFIG_c2mon,
255 CONFIG_CANBT, CONFIG_CCM, CONFIG_CMI,
256 CONFIG_cogent_mpc8260, CONFIG_cogent_mpc8xx, CONFIG_CPCI405,
257 CONFIG_CPCI4052, CONFIG_CPCIISER4, CONFIG_CPU86,
258 CONFIG_CRAYL1, CONFIG_CU824, CONFIG_DASA_SIM,
259 CONFIG_DB64360, CONFIG_DB64460, CONFIG_DU405,
260 CONFIG_DUET_ADS, CONFIG_EBONY, CONFIG_ELPPC,
261 CONFIG_ELPT860, CONFIG_ep8260, CONFIG_ERIC,
262 CONFIG_ESTEEM192E, CONFIG_ETX094, CONFIG_EVB64260,
263 CONFIG_FADS823, CONFIG_FADS850SAR, CONFIG_FADS860T,
264 CONFIG_FLAGADM, CONFIG_FPS850L, CONFIG_FPS860L,
265 CONFIG_GEN860T, CONFIG_GENIETV, CONFIG_GTH,
266 CONFIG_gw8260, CONFIG_hermes, CONFIG_hymod,
267 CONFIG_IAD210, CONFIG_ICU862, CONFIG_IP860,
268 CONFIG_IPHASE4539, CONFIG_IVML24, CONFIG_IVML24_128,
269 CONFIG_IVML24_256, CONFIG_IVMS8, CONFIG_IVMS8_128,
270 CONFIG_IVMS8_256, CONFIG_JSE, CONFIG_LANTEC,
271 CONFIG_lwmon, CONFIG_MBX, CONFIG_MBX860T,
272 CONFIG_MHPC, CONFIG_MIP405, CONFIG_MOUSSE,
273 CONFIG_MPC8260ADS, CONFIG_MPC8540ADS, CONFIG_MPC8560ADS,
274 CONFIG_MUSENKI, CONFIG_MVS1, CONFIG_NETPHONE,
275 CONFIG_NETTA, CONFIG_NETVIA, CONFIG_NX823,
276 CONFIG_OCRTC, CONFIG_ORSG, CONFIG_OXC,
277 CONFIG_PCI405, CONFIG_PCIPPC2, CONFIG_PCIPPC6,
278 CONFIG_pcu_e, CONFIG_PIP405, CONFIG_PM826,
279 CONFIG_ppmc8260, CONFIG_QS823, CONFIG_QS850,
280 CONFIG_QS860T, CONFIG_RBC823, CONFIG_RPXClassic,
281 CONFIG_RPXlite, CONFIG_RPXsuper, CONFIG_rsdproto,
282 CONFIG_sacsng, CONFIG_Sandpoint8240, CONFIG_Sandpoint8245,
283 CONFIG_sbc8260, CONFIG_SM850, CONFIG_SPD823TS,
wdenk7abf0c52004-04-18 21:45:42 +0000284 CONFIG_STXGP3, CONFIG_SXNI855T, CONFIG_TQM823L,
285 CONFIG_TQM8260, CONFIG_TQM850L, CONFIG_TQM855L,
286 CONFIG_TQM860L, CONFIG_TTTech, CONFIG_UTX8245,
287 CONFIG_V37, CONFIG_W7OLMC, CONFIG_W7OLMG,
288 CONFIG_WALNUT405, CONFIG_ZPC1900, CONFIG_ZUMA,
wdenkc6097192002-11-03 00:24:07 +0000289
290 ARM based boards:
291 -----------------
292
wdenkdb01a2e2004-04-15 23:14:49 +0000293 CONFIG_AT91RM9200DK, CONFIG_DNP1110, CONFIG_EP7312,
294 CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE, CONFIG_IMPA7,
295 CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610, CONFIG_LART,
296 CONFIG_LUBBOCK, CONFIG_SHANNON, CONFIG_SMDK2400,
297 CONFIG_SMDK2410, CONFIG_TRAB, CONFIG_VCMA9,
wdenkc6097192002-11-03 00:24:07 +0000298
wdenk507bbe32004-04-18 21:13:41 +0000299 MicroBlaze based boards:
300 ------------------------
301
302 CONFIG_SUZAKU
303
wdenkc6097192002-11-03 00:24:07 +0000304
305- CPU Module Type: (if CONFIG_COGENT is defined)
306 Define exactly one of
307 CONFIG_CMA286_60_OLD
308--- FIXME --- not tested yet:
309 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
310 CONFIG_CMA287_23, CONFIG_CMA287_50
311
312- Motherboard Type: (if CONFIG_COGENT is defined)
313 Define exactly one of
314 CONFIG_CMA101, CONFIG_CMA102
315
316- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
317 Define one or more of
318 CONFIG_CMA302
319
320- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
321 Define one or more of
322 CONFIG_LCD_HEARTBEAT - update a character position on
323 the lcd display every second with
324 a "rotator" |\-/|\-/
325
wdenk2535d602003-07-17 23:16:40 +0000326- Board flavour: (if CONFIG_MPC8260ADS is defined)
327 CONFIG_ADSTYPE
328 Possible values are:
329 CFG_8260ADS - original MPC8260ADS
wdenk180d3f72004-01-04 16:28:35 +0000330 CFG_8266ADS - MPC8266ADS
wdenk54387ac2003-10-08 22:45:44 +0000331 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
wdenk04a85b32004-04-15 18:22:41 +0000332 CFG_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000333
wdenkc6097192002-11-03 00:24:07 +0000334- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000335 Define exactly one of
336 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000337
wdenk75d1ea72004-01-31 20:06:54 +0000338- 8xx CPU Options: (if using an MPC8xx cpu)
wdenkc6097192002-11-03 00:24:07 +0000339 Define one or more of
wdenk5da627a2003-10-09 20:09:04 +0000340 CONFIG_8xx_GCLK_FREQ - if get_gclk_freq() cannot work
341 e.g. if there is no 32KHz
342 reference PIT/RTC clock
wdenkc6097192002-11-03 00:24:07 +0000343
wdenk75d1ea72004-01-31 20:06:54 +0000344- 859/866 CPU options: (if using a MPC859 or MPC866 CPU):
345 CFG_866_OSCCLK
346 CFG_866_CPUCLK_MIN
347 CFG_866_CPUCLK_MAX
348 CFG_866_CPUCLK_DEFAULT
349 See doc/README.MPC866
350
351 CFG_MEASURE_CPUCLK
352
wdenkba56f622004-02-06 23:19:44 +0000353 Define this to measure the actual CPU clock instead
354 of relying on the correctness of the configured
355 values. Mostly useful for board bringup to make sure
356 the PLL is locked at the intended frequency. Note
357 that this requires a (stable) reference clock (32 kHz
358 RTC clock),
wdenk75d1ea72004-01-31 20:06:54 +0000359
wdenk5da627a2003-10-09 20:09:04 +0000360- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000361 CONFIG_CLOCKS_IN_MHZ
362
363 U-Boot stores all clock information in Hz
364 internally. For binary compatibility with older Linux
365 kernels (which expect the clocks passed in the
366 bd_info data to be in MHz) the environment variable
367 "clocks_in_mhz" can be defined so that U-Boot
368 converts clock data to MHZ before passing it to the
369 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000370 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
371 "clocks_in_mhz=1" is automatically included in the
372 default environment.
373
wdenk5da627a2003-10-09 20:09:04 +0000374 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
375
376 When transfering memsize parameter to linux, some versions
377 expect it to be in bytes, others in MB.
378 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
379
wdenkc6097192002-11-03 00:24:07 +0000380- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000381 Depending on board, define exactly one serial port
382 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
383 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
384 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000385
386 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
387 port routines must be defined elsewhere
388 (i.e. serial_init(), serial_getc(), ...)
389
390 CONFIG_CFB_CONSOLE
391 Enables console device for a color framebuffer. Needs following
392 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
393 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
394 (default big endian)
395 VIDEO_HW_RECTFILL graphic chip supports
396 rectangle fill
397 (cf. smiLynxEM)
398 VIDEO_HW_BITBLT graphic chip supports
399 bit-blit (cf. smiLynxEM)
400 VIDEO_VISIBLE_COLS visible pixel columns
401 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000402 VIDEO_VISIBLE_ROWS visible pixel rows
403 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000404 VIDEO_DATA_FORMAT graphic data format
405 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000406 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000407 VIDEO_KBD_INIT_FCT keyboard int fct
408 (i.e. i8042_kbd_init())
409 VIDEO_TSTC_FCT test char fct
410 (i.e. i8042_tstc)
411 VIDEO_GETC_FCT get char fct
412 (i.e. i8042_getc)
413 CONFIG_CONSOLE_CURSOR cursor drawing on/off
414 (requires blink timer
415 cf. i8042.c)
416 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
417 CONFIG_CONSOLE_TIME display time/date info in
418 upper right corner
419 (requires CFG_CMD_DATE)
420 CONFIG_VIDEO_LOGO display Linux logo in
421 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000422 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
423 linux_logo.h for logo.
424 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000425 CONFIG_CONSOLE_EXTRA_INFO
426 addional board info beside
427 the logo
428
wdenk43d96162003-03-06 00:02:04 +0000429 When CONFIG_CFB_CONSOLE is defined, video console is
430 default i/o. Serial console can be forced with
431 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000432
wdenkd4ca31c2004-01-02 14:00:00 +0000433 When CONFIG_SILENT_CONSOLE is defined, all console
434 messages (by U-Boot and Linux!) can be silenced with
435 the "silent" environment variable. See
436 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000437
wdenkc6097192002-11-03 00:24:07 +0000438- Console Baudrate:
439 CONFIG_BAUDRATE - in bps
440 Select one of the baudrates listed in
441 CFG_BAUDRATE_TABLE, see below.
wdenk3bbc8992003-12-07 22:27:15 +0000442 CFG_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000443
444- Interrupt driven serial port input:
445 CONFIG_SERIAL_SOFTWARE_FIFO
446
447 PPC405GP only.
448 Use an interrupt handler for receiving data on the
449 serial port. It also enables using hardware handshake
450 (RTS/CTS) and UART's built-in FIFO. Set the number of
451 bytes the interrupt driven input buffer should have.
452
wdenk109c0e32004-03-23 21:43:07 +0000453 Leave undefined to disable this feature, including
454 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000455
stroese1d49b1f2003-05-23 11:39:05 +0000456- Console UART Number:
457 CONFIG_UART1_CONSOLE
458
459 IBM PPC4xx only.
460 If defined internal UART1 (and not UART0) is used
461 as default U-Boot console.
462
wdenkc6097192002-11-03 00:24:07 +0000463- Boot Delay: CONFIG_BOOTDELAY - in seconds
464 Delay before automatically booting the default image;
465 set to -1 to disable autoboot.
466
467 See doc/README.autoboot for these options that
468 work with CONFIG_BOOTDELAY. None are required.
469 CONFIG_BOOT_RETRY_TIME
470 CONFIG_BOOT_RETRY_MIN
471 CONFIG_AUTOBOOT_KEYED
472 CONFIG_AUTOBOOT_PROMPT
473 CONFIG_AUTOBOOT_DELAY_STR
474 CONFIG_AUTOBOOT_STOP_STR
475 CONFIG_AUTOBOOT_DELAY_STR2
476 CONFIG_AUTOBOOT_STOP_STR2
477 CONFIG_ZERO_BOOTDELAY_CHECK
478 CONFIG_RESET_TO_RETRY
479
480- Autoboot Command:
481 CONFIG_BOOTCOMMAND
482 Only needed when CONFIG_BOOTDELAY is enabled;
483 define a command string that is automatically executed
484 when no character is read on the console interface
485 within "Boot Delay" after reset.
486
487 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000488 This can be used to pass arguments to the bootm
489 command. The value of CONFIG_BOOTARGS goes into the
490 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000491
492 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000493 The value of these goes into the environment as
494 "ramboot" and "nfsboot" respectively, and can be used
495 as a convenience, when switching between booting from
496 ram and nfs.
wdenkc6097192002-11-03 00:24:07 +0000497
498- Pre-Boot Commands:
499 CONFIG_PREBOOT
500
501 When this option is #defined, the existence of the
502 environment variable "preboot" will be checked
503 immediately before starting the CONFIG_BOOTDELAY
504 countdown and/or running the auto-boot command resp.
505 entering interactive mode.
506
507 This feature is especially useful when "preboot" is
508 automatically generated or modified. For an example
509 see the LWMON board specific code: here "preboot" is
510 modified when the user holds down a certain
511 combination of keys on the (special) keyboard when
512 booting the systems
513
514- Serial Download Echo Mode:
515 CONFIG_LOADS_ECHO
516 If defined to 1, all characters received during a
517 serial download (using the "loads" command) are
518 echoed back. This might be needed by some terminal
519 emulations (like "cu"), but may as well just take
520 time on others. This setting #define's the initial
521 value of the "loads_echo" environment variable.
522
523- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
524 CONFIG_KGDB_BAUDRATE
525 Select one of the baudrates listed in
526 CFG_BAUDRATE_TABLE, see below.
527
528- Monitor Functions:
529 CONFIG_COMMANDS
530 Most monitor functions can be selected (or
531 de-selected) by adjusting the definition of
532 CONFIG_COMMANDS; to select individual functions,
533 #define CONFIG_COMMANDS by "OR"ing any of the
534 following values:
535
536 #define enables commands:
537 -------------------------
538 CFG_CMD_ASKENV * ask for env variable
wdenk78137c32003-09-15 18:00:00 +0000539 CFG_CMD_AUTOSCRIPT Autoscript Support
wdenkc6097192002-11-03 00:24:07 +0000540 CFG_CMD_BDI bdinfo
541 CFG_CMD_BEDBUG Include BedBug Debugger
wdenkba56f622004-02-06 23:19:44 +0000542 CFG_CMD_BMP * BMP support
wdenkc6097192002-11-03 00:24:07 +0000543 CFG_CMD_BOOTD bootd
544 CFG_CMD_CACHE icache, dcache
545 CFG_CMD_CONSOLE coninfo
546 CFG_CMD_DATE * support for RTC, date/time...
547 CFG_CMD_DHCP DHCP support
wdenkba56f622004-02-06 23:19:44 +0000548 CFG_CMD_DIAG * Diagnostics
549 CFG_CMD_DOC * Disk-On-Chip Support
550 CFG_CMD_DTT Digital Therm and Thermostat
wdenkc6097192002-11-03 00:24:07 +0000551 CFG_CMD_ECHO * echo arguments
552 CFG_CMD_EEPROM * EEPROM read/write support
553 CFG_CMD_ELF bootelf, bootvx
554 CFG_CMD_ENV saveenv
555 CFG_CMD_FDC * Floppy Disk Support
wdenk71f95112003-06-15 22:40:42 +0000556 CFG_CMD_FAT FAT partition support
wdenk2262cfe2002-11-18 00:14:45 +0000557 CFG_CMD_FDOS * Dos diskette Support
wdenkc6097192002-11-03 00:24:07 +0000558 CFG_CMD_FLASH flinfo, erase, protect
559 CFG_CMD_FPGA FPGA device initialization support
wdenkba56f622004-02-06 23:19:44 +0000560 CFG_CMD_HWFLOW * RTS/CTS hw flow control
wdenkc6097192002-11-03 00:24:07 +0000561 CFG_CMD_I2C * I2C serial bus support
562 CFG_CMD_IDE * IDE harddisk support
563 CFG_CMD_IMI iminfo
wdenkba56f622004-02-06 23:19:44 +0000564 CFG_CMD_IMLS List all found images
wdenkc6097192002-11-03 00:24:07 +0000565 CFG_CMD_IMMAP * IMMR dump support
566 CFG_CMD_IRQ * irqinfo
wdenk2d1a5372004-02-23 19:30:57 +0000567 CFG_CMD_ITEST * Integer/string test of 2 values
wdenkba56f622004-02-06 23:19:44 +0000568 CFG_CMD_JFFS2 * JFFS2 Support
wdenkc6097192002-11-03 00:24:07 +0000569 CFG_CMD_KGDB * kgdb
570 CFG_CMD_LOADB loadb
571 CFG_CMD_LOADS loads
572 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
573 loop, mtest
wdenkba56f622004-02-06 23:19:44 +0000574 CFG_CMD_MISC Misc functions like sleep etc
wdenk71f95112003-06-15 22:40:42 +0000575 CFG_CMD_MMC MMC memory mapped support
wdenkc6097192002-11-03 00:24:07 +0000576 CFG_CMD_MII MII utility commands
wdenkba56f622004-02-06 23:19:44 +0000577 CFG_CMD_NAND * NAND support
wdenkc6097192002-11-03 00:24:07 +0000578 CFG_CMD_NET bootp, tftpboot, rarpboot
579 CFG_CMD_PCI * pciinfo
580 CFG_CMD_PCMCIA * PCMCIA support
wdenkba56f622004-02-06 23:19:44 +0000581 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
582 CFG_CMD_PORTIO * Port I/O
wdenkc6097192002-11-03 00:24:07 +0000583 CFG_CMD_REGINFO * Register dump
584 CFG_CMD_RUN run command in env variable
wdenkba56f622004-02-06 23:19:44 +0000585 CFG_CMD_SAVES save S record dump
wdenkc6097192002-11-03 00:24:07 +0000586 CFG_CMD_SCSI * SCSI Support
wdenkba56f622004-02-06 23:19:44 +0000587 CFG_CMD_SDRAM * print SDRAM configuration information
wdenkc6097192002-11-03 00:24:07 +0000588 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
589 CFG_CMD_SPI * SPI serial bus support
590 CFG_CMD_USB * USB support
wdenkba56f622004-02-06 23:19:44 +0000591 CFG_CMD_VFD * VFD support (TRAB)
wdenkc6097192002-11-03 00:24:07 +0000592 CFG_CMD_BSP * Board SPecific functions
wdenka3d991b2004-04-15 21:48:45 +0000593 CFG_CMD_CDP * Cisco Discover Protocol support
wdenkc6097192002-11-03 00:24:07 +0000594 -----------------------------------------------
595 CFG_CMD_ALL all
596
597 CFG_CMD_DFL Default configuration; at the moment
598 this is includes all commands, except
599 the ones marked with "*" in the list
600 above.
601
602 If you don't define CONFIG_COMMANDS it defaults to
603 CFG_CMD_DFL in include/cmd_confdefs.h. A board can
604 override the default settings in the respective
605 include file.
606
607 EXAMPLE: If you want all functions except of network
608 support you can write:
609
610 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
611
612
613 Note: Don't enable the "icache" and "dcache" commands
wdenk43d96162003-03-06 00:02:04 +0000614 (configuration option CFG_CMD_CACHE) unless you know
615 what you (and your U-Boot users) are doing. Data
616 cache cannot be enabled on systems like the 8xx or
617 8260 (where accesses to the IMMR region must be
618 uncached), and it cannot be disabled on all other
619 systems where we (mis-) use the data cache to hold an
620 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000621
622
623 XXX - this list needs to get updated!
624
625- Watchdog:
626 CONFIG_WATCHDOG
627 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000628 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000629 code for a watchdog. For the 8xx and 8260 CPUs, the
630 SIU Watchdog feature is enabled in the SYPCR
631 register.
632
stroesec1551ea2003-04-04 15:53:41 +0000633- U-Boot Version:
634 CONFIG_VERSION_VARIABLE
635 If this variable is defined, an environment variable
636 named "ver" is created by U-Boot showing the U-Boot
637 version as printed by the "version" command.
638 This variable is readonly.
639
wdenkc6097192002-11-03 00:24:07 +0000640- Real-Time Clock:
641
642 When CFG_CMD_DATE is selected, the type of the RTC
643 has to be selected, too. Define exactly one of the
644 following options:
645
646 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
647 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
648 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000649 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000650 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000651 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000652 CONFIG_RTC_DS164x - use Dallas DS164x RTC
wdenkc6097192002-11-03 00:24:07 +0000653
wdenkb37c7e52003-06-30 16:24:52 +0000654 Note that if the RTC uses I2C, then the I2C interface
655 must also be configured. See I2C Support, below.
656
wdenkc6097192002-11-03 00:24:07 +0000657- Timestamp Support:
658
wdenk43d96162003-03-06 00:02:04 +0000659 When CONFIG_TIMESTAMP is selected, the timestamp
660 (date and time) of an image is printed by image
661 commands like bootm or iminfo. This option is
662 automatically enabled when you select CFG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000663
664- Partition Support:
665 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
666 and/or CONFIG_ISO_PARTITION
667
668 If IDE or SCSI support is enabled (CFG_CMD_IDE or
669 CFG_CMD_SCSI) you must configure support for at least
670 one partition type as well.
671
672- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000673 CONFIG_IDE_RESET_ROUTINE - this is defined in several
674 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000675
wdenk4d13cba2004-03-14 14:09:05 +0000676 CONFIG_IDE_RESET - is this is defined, IDE Reset will
677 be performed by calling the function
678 ide_set_reset(int reset)
679 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000680
681- ATAPI Support:
682 CONFIG_ATAPI
683
684 Set this to enable ATAPI support.
685
wdenkc40b2952004-03-13 23:29:43 +0000686- LBA48 Support
687 CONFIG_LBA48
688
689 Set this to enable support for disks larger than 137GB
690 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
691 Whithout these , LBA48 support uses 32bit variables and will 'only'
692 support disks up to 2.1TB.
693
694 CFG_64BIT_LBA:
695 When enabled, makes the IDE subsystem use 64bit sector addresses.
696 Default is 32bit.
697
wdenkc6097192002-11-03 00:24:07 +0000698- SCSI Support:
699 At the moment only there is only support for the
700 SYM53C8XX SCSI controller; define
701 CONFIG_SCSI_SYM53C8XX to enable it.
702
703 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
704 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
705 CFG_SCSI_MAX_LUN] can be adjusted to define the
706 maximum numbers of LUNs, SCSI ID's and target
707 devices.
708 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
709
710- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000711 CONFIG_E1000
712 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000713
wdenkc6097192002-11-03 00:24:07 +0000714 CONFIG_EEPRO100
715 Support for Intel 82557/82559/82559ER chips.
716 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
717 write routine for first time initialisation.
718
719 CONFIG_TULIP
720 Support for Digital 2114x chips.
721 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
722 modem chip initialisation (KS8761/QS6611).
723
724 CONFIG_NATSEMI
725 Support for National dp83815 chips.
726
727 CONFIG_NS8382X
728 Support for National dp8382[01] gigabit chips.
729
wdenk45219c42003-05-12 21:50:16 +0000730- NETWORK Support (other):
731
732 CONFIG_DRIVER_LAN91C96
733 Support for SMSC's LAN91C96 chips.
734
735 CONFIG_LAN91C96_BASE
736 Define this to hold the physical address
737 of the LAN91C96's I/O space
738
739 CONFIG_LAN91C96_USE_32_BIT
740 Define this to enable 32 bit addressing
741
wdenkc6097192002-11-03 00:24:07 +0000742- USB Support:
743 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000744 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000745 CONFIG_USB_UHCI to enable it.
746 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
747 end define CONFIG_USB_STORAGE to enable the USB
748 storage devices.
749 Note:
750 Supported are USB Keyboards and USB Floppy drives
751 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000752 MPC5200 USB requires additional defines:
753 CONFIG_USB_CLOCK
754 for 528 MHz Clock: 0x0001bbbb
755 CONFIG_USB_CONFIG
756 for differential drivers: 0x00001000
757 for single ended drivers: 0x00005000
758
wdenkc6097192002-11-03 00:24:07 +0000759
wdenk71f95112003-06-15 22:40:42 +0000760- MMC Support:
wdenk8bde7f72003-06-27 21:31:46 +0000761 The MMC controller on the Intel PXA is supported. To
762 enable this define CONFIG_MMC. The MMC can be
763 accessed from the boot prompt by mapping the device
wdenk71f95112003-06-15 22:40:42 +0000764 to physical memory similar to flash. Command line is
765 enabled with CFG_CMD_MMC. The MMC driver also works with
wdenk8bde7f72003-06-27 21:31:46 +0000766 the FAT fs. This is enabled with CFG_CMD_FAT.
wdenk71f95112003-06-15 22:40:42 +0000767
wdenkc6097192002-11-03 00:24:07 +0000768- Keyboard Support:
769 CONFIG_ISA_KEYBOARD
770
771 Define this to enable standard (PC-Style) keyboard
772 support
773
774 CONFIG_I8042_KBD
775 Standard PC keyboard driver with US (is default) and
776 GERMAN key layout (switch via environment 'keymap=de') support.
777 Export function i8042_kbd_init, i8042_tstc and i8042_getc
778 for cfb_console. Supports cursor blinking.
779
780- Video support:
781 CONFIG_VIDEO
782
783 Define this to enable video support (for output to
784 video).
785
786 CONFIG_VIDEO_CT69000
787
788 Enable Chips & Technologies 69000 Video chip
789
790 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000791 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000792 video output is selected via environment 'videoout'
793 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
794 assumed.
wdenkc6097192002-11-03 00:24:07 +0000795
wdenkb79a11c2004-03-25 15:14:43 +0000796 For the CT69000 and SMI_LYNXEM drivers, videomode is
797 selected via environment 'videomode'. Two diferent ways
wdenkeeb1b772004-03-23 22:53:55 +0000798 are possible:
799 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000800 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000801
802 Colors 640x480 800x600 1024x768 1152x864 1280x1024
803 -------------+---------------------------------------------
804 8 bits | 0x301* 0x303 0x305 0x161 0x307
805 15 bits | 0x310 0x313 0x316 0x162 0x319
806 16 bits | 0x311 0x314 0x317 0x163 0x31A
807 24 bits | 0x312 0x315 0x318 ? 0x31B
808 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000809 (i.e. setenv videomode 317; saveenv; reset;)
810
wdenkb79a11c2004-03-25 15:14:43 +0000811 - "videomode=bootargs" all the video parameters are parsed
wdenkeeb1b772004-03-23 22:53:55 +0000812 from the bootargs. (See drivers/videomodes.c)
813
814
stroesec1551ea2003-04-04 15:53:41 +0000815 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +0000816 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +0000817 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
818 or CONFIG_VIDEO_SED13806_16BPP
819
wdenk682011f2003-06-03 23:54:09 +0000820- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +0000821 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +0000822
wdenk8bde7f72003-06-27 21:31:46 +0000823 Define this to enable a custom keyboard support.
824 This simply calls drv_keyboard_init() which must be
825 defined in your board-specific files.
826 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +0000827
wdenkc6097192002-11-03 00:24:07 +0000828- LCD Support: CONFIG_LCD
829
830 Define this to enable LCD support (for output to LCD
831 display); also select one of the supported displays
832 by defining one of these:
833
wdenkfd3103b2003-11-25 16:55:19 +0000834 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000835
wdenkfd3103b2003-11-25 16:55:19 +0000836 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000837
wdenkfd3103b2003-11-25 16:55:19 +0000838 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +0000839
wdenkfd3103b2003-11-25 16:55:19 +0000840 NEC NL6448BC20-08. 6.5", 640x480.
841 Active, color, single scan.
842
843 CONFIG_NEC_NL6448BC33_54
844
845 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000846 Active, color, single scan.
847
848 CONFIG_SHARP_16x9
849
850 Sharp 320x240. Active, color, single scan.
851 It isn't 16x9, and I am not sure what it is.
852
853 CONFIG_SHARP_LQ64D341
854
855 Sharp LQ64D341 display, 640x480.
856 Active, color, single scan.
857
858 CONFIG_HLD1045
859
860 HLD1045 display, 640x480.
861 Active, color, single scan.
862
863 CONFIG_OPTREX_BW
864
865 Optrex CBL50840-2 NF-FW 99 22 M5
866 or
867 Hitachi LMG6912RPFC-00T
868 or
869 Hitachi SP14Q002
870
871 320x240. Black & white.
872
873 Normally display is black on white background; define
874 CFG_WHITE_ON_BLACK to get it inverted.
875
wdenk7152b1d2003-09-05 23:19:14 +0000876- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +0000877
wdenk8bde7f72003-06-27 21:31:46 +0000878 If this option is set, the environment is checked for
879 a variable "splashimage". If found, the usual display
880 of logo, copyright and system information on the LCD
881 is supressed and the BMP image at the address
882 specified in "splashimage" is loaded instead. The
883 console is redirected to the "nulldev", too. This
884 allows for a "silent" boot where a splash screen is
885 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +0000886
wdenkc29fdfc2003-08-29 20:57:53 +0000887- Compression support:
888 CONFIG_BZIP2
889
890 If this option is set, support for bzip2 compressed
891 images is included. If not, only uncompressed and gzip
892 compressed images are supported.
893
wdenk42d1f032003-10-15 23:53:47 +0000894 NOTE: the bzip2 algorithm requires a lot of RAM, so
895 the malloc area (as defined by CFG_MALLOC_LEN) should
896 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +0000897
wdenkc6097192002-11-03 00:24:07 +0000898- Ethernet address:
899 CONFIG_ETHADDR
900 CONFIG_ETH2ADDR
901 CONFIG_ETH3ADDR
902
903 Define a default value for ethernet address to use
904 for the respective ethernet interface, in case this
905 is not determined automatically.
906
907- IP address:
908 CONFIG_IPADDR
909
910 Define a default value for the IP address to use for
911 the default ethernet interface, in case this is not
912 determined through e.g. bootp.
913
914- Server IP address:
915 CONFIG_SERVERIP
916
917 Defines a default value for theIP address of a TFTP
918 server to contact when using the "tftboot" command.
919
920- BOOTP Recovery Mode:
921 CONFIG_BOOTP_RANDOM_DELAY
922
923 If you have many targets in a network that try to
924 boot using BOOTP, you may want to avoid that all
925 systems send out BOOTP requests at precisely the same
926 moment (which would happen for instance at recovery
927 from a power failure, when all systems will try to
928 boot, thus flooding the BOOTP server. Defining
929 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
930 inserted before sending out BOOTP requests. The
931 following delays are insterted then:
932
933 1st BOOTP request: delay 0 ... 1 sec
934 2nd BOOTP request: delay 0 ... 2 sec
935 3rd BOOTP request: delay 0 ... 4 sec
936 4th and following
937 BOOTP requests: delay 0 ... 8 sec
938
stroesefe389a82003-08-28 14:17:32 +0000939- DHCP Advanced Options:
940 CONFIG_BOOTP_MASK
941
942 You can fine tune the DHCP functionality by adding
943 these flags to the CONFIG_BOOTP_MASK define:
944
945 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
946 serverip from a DHCP server, it is possible that more
947 than one DNS serverip is offered to the client.
948 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
949 serverip will be stored in the additional environment
950 variable "dnsip2". The first DNS serverip is always
951 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
952 is added to the CONFIG_BOOTP_MASK.
953
954 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
955 to do a dynamic update of a DNS server. To do this, they
956 need the hostname of the DHCP requester.
957 If CONFIG_BOOP_SEND_HOSTNAME is added to the
958 CONFIG_BOOTP_MASK, the content of the "hostname"
959 environment variable is passed as option 12 to
960 the DHCP server.
961
wdenka3d991b2004-04-15 21:48:45 +0000962 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +0000963 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +0000964
965 The device id used in CDP trigger frames.
966
967 CONFIG_CDP_DEVICE_ID_PREFIX
968
969 A two character string which is prefixed to the MAC address
970 of the device.
971
972 CONFIG_CDP_PORT_ID
973
974 A printf format string which contains the ascii name of
975 the port. Normally is set to "eth%d" which sets
976 eth0 for the first ethernet, eth1 for the second etc.
977
978 CONFIG_CDP_CAPABILITIES
979
980 A 32bit integer which indicates the device capabilities;
981 0x00000010 for a normal host which does not forwards.
982
983 CONFIG_CDP_VERSION
984
985 An ascii string containing the version of the software.
986
987 CONFIG_CDP_PLATFORM
988
989 An ascii string containing the name of the platform.
990
991 CONFIG_CDP_TRIGGER
992
993 A 32bit integer sent on the trigger.
994
995 CONFIG_CDP_POWER_CONSUMPTION
996
997 A 16bit integer containing the power consumption of the
998 device in .1 of milliwatts.
999
1000 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1001
1002 A byte containing the id of the VLAN.
1003
wdenkc6097192002-11-03 00:24:07 +00001004- Status LED: CONFIG_STATUS_LED
1005
1006 Several configurations allow to display the current
1007 status using a LED. For instance, the LED will blink
1008 fast while running U-Boot code, stop blinking as
1009 soon as a reply to a BOOTP request was received, and
1010 start blinking slow once the Linux kernel is running
1011 (supported by a status LED driver in the Linux
1012 kernel). Defining CONFIG_STATUS_LED enables this
1013 feature in U-Boot.
1014
1015- CAN Support: CONFIG_CAN_DRIVER
1016
1017 Defining CONFIG_CAN_DRIVER enables CAN driver support
1018 on those systems that support this (optional)
1019 feature, like the TQM8xxL modules.
1020
1021- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1022
wdenkb37c7e52003-06-30 16:24:52 +00001023 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001024 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1025 include the appropriate I2C driver for the selected cpu.
wdenkc6097192002-11-03 00:24:07 +00001026
wdenk945af8d2003-07-16 21:53:01 +00001027 This will allow you to use i2c commands at the u-boot
1028 command line (as long as you set CFG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001029 CONFIG_COMMANDS) and communicate with i2c based realtime
1030 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001031 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001032
wdenkba56f622004-02-06 23:19:44 +00001033 CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
wdenkc6097192002-11-03 00:24:07 +00001034
wdenk945af8d2003-07-16 21:53:01 +00001035 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001036 bit-banging) driver instead of CPM or similar hardware
1037 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001038
wdenk945af8d2003-07-16 21:53:01 +00001039 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001040 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001041
wdenkb37c7e52003-06-30 16:24:52 +00001042 In both cases you will need to define CFG_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001043 to be the frequency (in Hz) at which you wish your i2c bus
1044 to run and CFG_I2C_SLAVE to be the address of this node (ie
1045 the cpu's i2c node address).
1046
wdenkb37c7e52003-06-30 16:24:52 +00001047 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1048 sets the cpu up as a master node and so its address should
1049 therefore be cleared to 0 (See, eg, MPC823e User's Manual
wdenk945af8d2003-07-16 21:53:01 +00001050 p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001051
wdenk945af8d2003-07-16 21:53:01 +00001052 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001053
1054 If you use the software i2c interface (CONFIG_SOFT_I2C)
1055 then the following macros need to be defined (examples are
1056 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001057
1058 I2C_INIT
1059
wdenkb37c7e52003-06-30 16:24:52 +00001060 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001061 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001062
wdenkba56f622004-02-06 23:19:44 +00001063 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001064
wdenkc6097192002-11-03 00:24:07 +00001065 I2C_PORT
1066
wdenk43d96162003-03-06 00:02:04 +00001067 (Only for MPC8260 CPU). The I/O port to use (the code
1068 assumes both bits are on the same port). Valid values
1069 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001070
1071 I2C_ACTIVE
1072
1073 The code necessary to make the I2C data line active
1074 (driven). If the data line is open collector, this
1075 define can be null.
1076
wdenkb37c7e52003-06-30 16:24:52 +00001077 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1078
wdenkc6097192002-11-03 00:24:07 +00001079 I2C_TRISTATE
1080
1081 The code necessary to make the I2C data line tri-stated
1082 (inactive). If the data line is open collector, this
1083 define can be null.
1084
wdenkb37c7e52003-06-30 16:24:52 +00001085 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1086
wdenkc6097192002-11-03 00:24:07 +00001087 I2C_READ
1088
1089 Code that returns TRUE if the I2C data line is high,
1090 FALSE if it is low.
1091
wdenkb37c7e52003-06-30 16:24:52 +00001092 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1093
wdenkc6097192002-11-03 00:24:07 +00001094 I2C_SDA(bit)
1095
1096 If <bit> is TRUE, sets the I2C data line high. If it
1097 is FALSE, it clears it (low).
1098
wdenkb37c7e52003-06-30 16:24:52 +00001099 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001100 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001101 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001102
wdenkc6097192002-11-03 00:24:07 +00001103 I2C_SCL(bit)
1104
1105 If <bit> is TRUE, sets the I2C clock line high. If it
1106 is FALSE, it clears it (low).
1107
wdenkb37c7e52003-06-30 16:24:52 +00001108 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001109 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001110 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001111
wdenkc6097192002-11-03 00:24:07 +00001112 I2C_DELAY
1113
1114 This delay is invoked four times per clock cycle so this
1115 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001116 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001117 like:
1118
wdenkb37c7e52003-06-30 16:24:52 +00001119 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001120
wdenk47cd00f2003-03-06 13:39:27 +00001121 CFG_I2C_INIT_BOARD
1122
wdenk8bde7f72003-06-27 21:31:46 +00001123 When a board is reset during an i2c bus transfer
1124 chips might think that the current transfer is still
1125 in progress. On some boards it is possible to access
1126 the i2c SCLK line directly, either by using the
1127 processor pin as a GPIO or by having a second pin
1128 connected to the bus. If this option is defined a
1129 custom i2c_init_board() routine in boards/xxx/board.c
1130 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001131
wdenkc6097192002-11-03 00:24:07 +00001132- SPI Support: CONFIG_SPI
1133
1134 Enables SPI driver (so far only tested with
1135 SPI EEPROM, also an instance works with Crystal A/D and
1136 D/As on the SACSng board)
1137
1138 CONFIG_SPI_X
1139
1140 Enables extended (16-bit) SPI EEPROM addressing.
1141 (symmetrical to CONFIG_I2C_X)
1142
1143 CONFIG_SOFT_SPI
1144
wdenk43d96162003-03-06 00:02:04 +00001145 Enables a software (bit-bang) SPI driver rather than
1146 using hardware support. This is a general purpose
1147 driver that only requires three general I/O port pins
1148 (two outputs, one input) to function. If this is
1149 defined, the board configuration must define several
1150 SPI configuration items (port pins to use, etc). For
1151 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001152
1153- FPGA Support: CONFIG_FPGA_COUNT
1154
wdenk43d96162003-03-06 00:02:04 +00001155 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001156
wdenk43d96162003-03-06 00:02:04 +00001157 CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001158
wdenk8bde7f72003-06-27 21:31:46 +00001159 Used to specify the types of FPGA devices. For example,
1160 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
wdenkc6097192002-11-03 00:24:07 +00001161
wdenk8bde7f72003-06-27 21:31:46 +00001162 CFG_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001163
wdenk8bde7f72003-06-27 21:31:46 +00001164 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001165
1166 CFG_FPGA_CHECK_BUSY
1167
wdenk43d96162003-03-06 00:02:04 +00001168 Enable checks on FPGA configuration interface busy
1169 status by the configuration function. This option
1170 will require a board or device specific function to
1171 be written.
wdenkc6097192002-11-03 00:24:07 +00001172
1173 CONFIG_FPGA_DELAY
1174
1175 If defined, a function that provides delays in the FPGA
1176 configuration driver.
1177
1178 CFG_FPGA_CHECK_CTRLC
1179 Allow Control-C to interrupt FPGA configuration
1180
1181 CFG_FPGA_CHECK_ERROR
1182
wdenk43d96162003-03-06 00:02:04 +00001183 Check for configuration errors during FPGA bitfile
1184 loading. For example, abort during Virtex II
1185 configuration if the INIT_B line goes low (which
1186 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001187
1188 CFG_FPGA_WAIT_INIT
1189
wdenk43d96162003-03-06 00:02:04 +00001190 Maximum time to wait for the INIT_B line to deassert
1191 after PROB_B has been deasserted during a Virtex II
1192 FPGA configuration sequence. The default time is 500
1193 mS.
wdenkc6097192002-11-03 00:24:07 +00001194
1195 CFG_FPGA_WAIT_BUSY
1196
wdenk43d96162003-03-06 00:02:04 +00001197 Maximum time to wait for BUSY to deassert during
1198 Virtex II FPGA configuration. The default is 5 mS.
wdenkc6097192002-11-03 00:24:07 +00001199
1200 CFG_FPGA_WAIT_CONFIG
1201
wdenk43d96162003-03-06 00:02:04 +00001202 Time to wait after FPGA configuration. The default is
1203 200 mS.
wdenkc6097192002-11-03 00:24:07 +00001204
1205- Configuration Management:
1206 CONFIG_IDENT_STRING
1207
wdenk43d96162003-03-06 00:02:04 +00001208 If defined, this string will be added to the U-Boot
1209 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001210
1211- Vendor Parameter Protection:
1212
wdenk43d96162003-03-06 00:02:04 +00001213 U-Boot considers the values of the environment
1214 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001215 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001216 are set once by the board vendor / manufacturer, and
1217 protects these variables from casual modification by
1218 the user. Once set, these variables are read-only,
1219 and write or delete attempts are rejected. You can
1220 change this behviour:
wdenkc6097192002-11-03 00:24:07 +00001221
1222 If CONFIG_ENV_OVERWRITE is #defined in your config
1223 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001224 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001225 these parameters.
1226
1227 Alternatively, if you #define _both_ CONFIG_ETHADDR
1228 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1229 ethernet address is installed in the environment,
1230 which can be changed exactly ONCE by the user. [The
1231 serial# is unaffected by this, i. e. it remains
1232 read-only.]
1233
1234- Protected RAM:
1235 CONFIG_PRAM
1236
1237 Define this variable to enable the reservation of
1238 "protected RAM", i. e. RAM which is not overwritten
1239 by U-Boot. Define CONFIG_PRAM to hold the number of
1240 kB you want to reserve for pRAM. You can overwrite
1241 this default value by defining an environment
1242 variable "pram" to the number of kB you want to
1243 reserve. Note that the board info structure will
1244 still show the full amount of RAM. If pRAM is
1245 reserved, a new environment variable "mem" will
1246 automatically be defined to hold the amount of
1247 remaining RAM in a form that can be passed as boot
1248 argument to Linux, for instance like that:
1249
1250 setenv bootargs ... mem=\$(mem)
1251 saveenv
1252
1253 This way you can tell Linux not to use this memory,
1254 either, which results in a memory region that will
1255 not be affected by reboots.
1256
1257 *WARNING* If your board configuration uses automatic
1258 detection of the RAM size, you must make sure that
1259 this memory test is non-destructive. So far, the
1260 following board configurations are known to be
1261 "pRAM-clean":
1262
1263 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1264 HERMES, IP860, RPXlite, LWMON, LANTEC,
1265 PCU_E, FLAGADM, TQM8260
1266
1267- Error Recovery:
1268 CONFIG_PANIC_HANG
1269
1270 Define this variable to stop the system in case of a
1271 fatal error, so that you have to reset it manually.
1272 This is probably NOT a good idea for an embedded
1273 system where you want to system to reboot
1274 automatically as fast as possible, but it may be
1275 useful during development since you can try to debug
1276 the conditions that lead to the situation.
1277
1278 CONFIG_NET_RETRY_COUNT
1279
wdenk43d96162003-03-06 00:02:04 +00001280 This variable defines the number of retries for
1281 network operations like ARP, RARP, TFTP, or BOOTP
1282 before giving up the operation. If not defined, a
1283 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001284
1285- Command Interpreter:
wdenk04a85b32004-04-15 18:22:41 +00001286 CFG_AUTO_COMPLETE
1287
1288 Enable auto completion of commands using TAB.
1289
wdenkc6097192002-11-03 00:24:07 +00001290 CFG_HUSH_PARSER
1291
1292 Define this variable to enable the "hush" shell (from
1293 Busybox) as command line interpreter, thus enabling
1294 powerful command line syntax like
1295 if...then...else...fi conditionals or `&&' and '||'
1296 constructs ("shell scripts").
1297
1298 If undefined, you get the old, much simpler behaviour
1299 with a somewhat smaller memory footprint.
1300
1301
1302 CFG_PROMPT_HUSH_PS2
1303
1304 This defines the secondary prompt string, which is
1305 printed when the command interpreter needs more input
1306 to complete a command. Usually "> ".
1307
1308 Note:
1309
wdenk8bde7f72003-06-27 21:31:46 +00001310 In the current implementation, the local variables
1311 space and global environment variables space are
1312 separated. Local variables are those you define by
1313 simply typing `name=value'. To access a local
1314 variable later on, you have write `$name' or
1315 `${name}'; to execute the contents of a variable
1316 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001317
wdenk43d96162003-03-06 00:02:04 +00001318 Global environment variables are those you use
1319 setenv/printenv to work with. To run a command stored
1320 in such a variable, you need to use the run command,
1321 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001322
1323 To store commands and special characters in a
1324 variable, please use double quotation marks
1325 surrounding the whole text of the variable, instead
1326 of the backslashes before semicolons and special
1327 symbols.
1328
wdenka8c7c702003-12-06 19:49:23 +00001329- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001330 CONFIG_EXTRA_ENV_SETTINGS
1331
wdenk43d96162003-03-06 00:02:04 +00001332 Define this to contain any number of null terminated
1333 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001334 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001335
wdenk43d96162003-03-06 00:02:04 +00001336 For example, place something like this in your
1337 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001338
1339 #define CONFIG_EXTRA_ENV_SETTINGS \
1340 "myvar1=value1\0" \
1341 "myvar2=value2\0"
1342
wdenk43d96162003-03-06 00:02:04 +00001343 Warning: This method is based on knowledge about the
1344 internal format how the environment is stored by the
1345 U-Boot code. This is NOT an official, exported
1346 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001347 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001348 You better know what you are doing here.
1349
wdenk43d96162003-03-06 00:02:04 +00001350 Note: overly (ab)use of the default environment is
1351 discouraged. Make sure to check other ways to preset
1352 the environment like the autoscript function or the
1353 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001354
wdenka8c7c702003-12-06 19:49:23 +00001355- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001356 CONFIG_HAS_DATAFLASH
1357
wdenk8bde7f72003-06-27 21:31:46 +00001358 Defining this option enables DataFlash features and
1359 allows to read/write in Dataflash via the standard
1360 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001361
wdenk3f85ce22004-02-23 16:11:30 +00001362- SystemACE Support:
1363 CONFIG_SYSTEMACE
1364
1365 Adding this option adds support for Xilinx SystemACE
1366 chips attached via some sort of local bus. The address
1367 of the chip must alsh be defined in the
1368 CFG_SYSTEMACE_BASE macro. For example:
1369
1370 #define CONFIG_SYSTEMACE
1371 #define CFG_SYSTEMACE_BASE 0xf0000000
1372
1373 When SystemACE support is added, the "ace" device type
1374 becomes available to the fat commands, i.e. fatls.
1375
wdenka8c7c702003-12-06 19:49:23 +00001376- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001377 CONFIG_SHOW_BOOT_PROGRESS
1378
wdenk43d96162003-03-06 00:02:04 +00001379 Defining this option allows to add some board-
1380 specific code (calling a user-provided function
1381 "show_boot_progress(int)") that enables you to show
1382 the system's boot progress on some display (for
1383 example, some LED's) on your board. At the moment,
1384 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001385
1386 Arg Where When
1387 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001388 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001389 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001390 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001391 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001392 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001393 4 common/cmd_bootm.c Image data has correct checksum
1394 -4 common/cmd_bootm.c Image is for unsupported architecture
1395 5 common/cmd_bootm.c Architecture check OK
1396 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1397 6 common/cmd_bootm.c Image Type check OK
1398 -6 common/cmd_bootm.c gunzip uncompression error
1399 -7 common/cmd_bootm.c Unimplemented compression type
1400 7 common/cmd_bootm.c Uncompression OK
1401 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1402 8 common/cmd_bootm.c Image Type check OK
1403 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1404 9 common/cmd_bootm.c Start initial ramdisk verification
wdenkba56f622004-02-06 23:19:44 +00001405 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1406 -11 common/cmd_bootm.c Ramdisk header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001407 10 common/cmd_bootm.c Ramdisk header is OK
wdenkba56f622004-02-06 23:19:44 +00001408 -12 common/cmd_bootm.c Ramdisk data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001409 11 common/cmd_bootm.c Ramdisk data has correct checksum
1410 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1411 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1412 13 common/cmd_bootm.c Start multifile image verification
1413 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1414 15 common/cmd_bootm.c All preparation done, transferring control to OS
1415
wdenk11dadd52004-02-27 00:07:27 +00001416 -30 lib_ppc/board.c Fatal error, hang the system
1417 -31 post/post.c POST test failed, detected by post_output_backlog()
1418 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001419
wdenkc6097192002-11-03 00:24:07 +00001420 -1 common/cmd_doc.c Bad usage of "doc" command
1421 -1 common/cmd_doc.c No boot device
1422 -1 common/cmd_doc.c Unknown Chip ID on boot device
1423 -1 common/cmd_doc.c Read Error on boot device
1424 -1 common/cmd_doc.c Image header has bad magic number
1425
1426 -1 common/cmd_ide.c Bad usage of "ide" command
1427 -1 common/cmd_ide.c No boot device
1428 -1 common/cmd_ide.c Unknown boot device
1429 -1 common/cmd_ide.c Unknown partition table
1430 -1 common/cmd_ide.c Invalid partition type
1431 -1 common/cmd_ide.c Read Error on boot device
1432 -1 common/cmd_ide.c Image header has bad magic number
1433
wdenk206c60c2003-09-18 10:02:25 +00001434 -1 common/cmd_nand.c Bad usage of "nand" command
1435 -1 common/cmd_nand.c No boot device
1436 -1 common/cmd_nand.c Unknown Chip ID on boot device
1437 -1 common/cmd_nand.c Read Error on boot device
1438 -1 common/cmd_nand.c Image header has bad magic number
1439
wdenkba56f622004-02-06 23:19:44 +00001440 -1 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001441
1442
1443Modem Support:
1444--------------
1445
wdenk85ec0bc2003-03-31 16:34:49 +00001446[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001447
1448- Modem support endable:
1449 CONFIG_MODEM_SUPPORT
1450
1451- RTS/CTS Flow control enable:
1452 CONFIG_HWFLOW
1453
1454- Modem debug support:
1455 CONFIG_MODEM_SUPPORT_DEBUG
1456
wdenk43d96162003-03-06 00:02:04 +00001457 Enables debugging stuff (char screen[1024], dbg())
1458 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001459
wdenka8c7c702003-12-06 19:49:23 +00001460- Interrupt support (PPC):
1461
wdenkd4ca31c2004-01-02 14:00:00 +00001462 There are common interrupt_init() and timer_interrupt()
1463 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1464 for cpu specific initialization. interrupt_init_cpu()
1465 should set decrementer_count to appropriate value. If
1466 cpu resets decrementer automatically after interrupt
1467 (ppc4xx) it should set decrementer_count to zero.
1468 timer_interrupt() calls timer_interrupt_cpu() for cpu
1469 specific handling. If board has watchdog / status_led
1470 / other_activity_monitor it works automatically from
1471 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001472
wdenkc6097192002-11-03 00:24:07 +00001473- General:
1474
wdenk43d96162003-03-06 00:02:04 +00001475 In the target system modem support is enabled when a
1476 specific key (key combination) is pressed during
1477 power-on. Otherwise U-Boot will boot normally
1478 (autoboot). The key_pressed() fuction is called from
1479 board_init(). Currently key_pressed() is a dummy
1480 function, returning 1 and thus enabling modem
1481 initialization.
wdenkc6097192002-11-03 00:24:07 +00001482
wdenk43d96162003-03-06 00:02:04 +00001483 If there are no modem init strings in the
1484 environment, U-Boot proceed to autoboot; the
1485 previous output (banner, info printfs) will be
1486 supressed, though.
wdenkc6097192002-11-03 00:24:07 +00001487
1488 See also: doc/README.Modem
1489
1490
wdenkc6097192002-11-03 00:24:07 +00001491Configuration Settings:
1492-----------------------
1493
1494- CFG_LONGHELP: Defined when you want long help messages included;
1495 undefine this when you're short of memory.
1496
1497- CFG_PROMPT: This is what U-Boot prints on the console to
1498 prompt for user input.
1499
1500- CFG_CBSIZE: Buffer size for input from the Console
1501
1502- CFG_PBSIZE: Buffer size for Console output
1503
1504- CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1505
1506- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1507 the application (usually a Linux kernel) when it is
1508 booted
1509
1510- CFG_BAUDRATE_TABLE:
1511 List of legal baudrate settings for this board.
1512
1513- CFG_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00001514 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00001515
1516- CFG_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00001517 If the board specific function
1518 extern int overwrite_console (void);
1519 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00001520 serial port, else the settings in the environment are used.
1521
1522- CFG_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00001523 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00001524
1525- CFG_CONSOLE_ENV_OVERWRITE
1526 Enable overwrite of previous console environment settings.
1527
1528- CFG_MEMTEST_START, CFG_MEMTEST_END:
1529 Begin and End addresses of the area used by the
1530 simple memory test.
1531
1532- CFG_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00001533 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00001534
wdenk5f535fe2003-09-18 09:21:33 +00001535- CFG_MEMTEST_SCRATCH:
1536 Scratch address used by the alternate memory test
1537 You only need to set this if address zero isn't writeable
1538
wdenkc6097192002-11-03 00:24:07 +00001539- CFG_TFTP_LOADADDR:
1540 Default load address for network file downloads
1541
1542- CFG_LOADS_BAUD_CHANGE:
1543 Enable temporary baudrate change while serial download
1544
1545- CFG_SDRAM_BASE:
1546 Physical start address of SDRAM. _Must_ be 0 here.
1547
1548- CFG_MBIO_BASE:
1549 Physical start address of Motherboard I/O (if using a
1550 Cogent motherboard)
1551
1552- CFG_FLASH_BASE:
1553 Physical start address of Flash memory.
1554
1555- CFG_MONITOR_BASE:
1556 Physical start address of boot monitor code (set by
1557 make config files to be same as the text base address
1558 (TEXT_BASE) used when linking) - same as
1559 CFG_FLASH_BASE when booting from flash.
1560
1561- CFG_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00001562 Size of memory reserved for monitor code, used to
1563 determine _at_compile_time_ (!) if the environment is
1564 embedded within the U-Boot image, or in a separate
1565 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001566
1567- CFG_MALLOC_LEN:
1568 Size of DRAM reserved for malloc() use.
1569
1570- CFG_BOOTMAPSZ:
1571 Maximum size of memory mapped by the startup code of
1572 the Linux kernel; all data that must be processed by
1573 the Linux kernel (bd_info, boot arguments, eventually
1574 initrd image) must be put below this limit.
1575
1576- CFG_MAX_FLASH_BANKS:
1577 Max number of Flash memory banks
1578
1579- CFG_MAX_FLASH_SECT:
1580 Max number of sectors on a Flash chip
1581
1582- CFG_FLASH_ERASE_TOUT:
1583 Timeout for Flash erase operations (in ms)
1584
1585- CFG_FLASH_WRITE_TOUT:
1586 Timeout for Flash write operations (in ms)
1587
wdenk8564acf2003-07-14 22:13:32 +00001588- CFG_FLASH_LOCK_TOUT
1589 Timeout for Flash set sector lock bit operation (in ms)
1590
1591- CFG_FLASH_UNLOCK_TOUT
1592 Timeout for Flash clear lock bits operation (in ms)
1593
1594- CFG_FLASH_PROTECTION
1595 If defined, hardware flash sectors protection is used
1596 instead of U-Boot software protection.
1597
wdenkc6097192002-11-03 00:24:07 +00001598- CFG_DIRECT_FLASH_TFTP:
1599
1600 Enable TFTP transfers directly to flash memory;
1601 without this option such a download has to be
1602 performed in two steps: (1) download to RAM, and (2)
1603 copy from RAM to flash.
1604
1605 The two-step approach is usually more reliable, since
1606 you can check if the download worked before you erase
1607 the flash, but in some situations (when sytem RAM is
1608 too limited to allow for a tempory copy of the
1609 downloaded image) this option may be very useful.
1610
1611- CFG_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00001612 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00001613 common flash structure for storing flash geometry.
1614
1615- CFG_FLASH_CFI_DRIVER
1616 This option also enables the building of the cfi_flash driver
1617 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001618
stroese53cf9432003-06-05 15:39:44 +00001619- CFG_RX_ETH_BUFFER:
1620 Defines the number of ethernet receive buffers. On some
1621 ethernet controllers it is recommended to set this value
1622 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1623 buffers can be full shortly after enabling the interface
1624 on high ethernet traffic.
1625 Defaults to 4 if not defined.
1626
wdenkc6097192002-11-03 00:24:07 +00001627The following definitions that deal with the placement and management
1628of environment data (variable area); in general, we support the
1629following configurations:
1630
1631- CFG_ENV_IS_IN_FLASH:
1632
1633 Define this if the environment is in flash memory.
1634
1635 a) The environment occupies one whole flash sector, which is
1636 "embedded" in the text segment with the U-Boot code. This
1637 happens usually with "bottom boot sector" or "top boot
1638 sector" type flash chips, which have several smaller
1639 sectors at the start or the end. For instance, such a
1640 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1641 such a case you would place the environment in one of the
1642 4 kB sectors - with U-Boot code before and after it. With
1643 "top boot sector" type flash chips, you would put the
1644 environment in one of the last sectors, leaving a gap
1645 between U-Boot and the environment.
1646
1647 - CFG_ENV_OFFSET:
1648
1649 Offset of environment data (variable area) to the
1650 beginning of flash memory; for instance, with bottom boot
1651 type flash chips the second sector can be used: the offset
1652 for this sector is given here.
1653
1654 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1655
1656 - CFG_ENV_ADDR:
1657
1658 This is just another way to specify the start address of
1659 the flash sector containing the environment (instead of
1660 CFG_ENV_OFFSET).
1661
1662 - CFG_ENV_SECT_SIZE:
1663
1664 Size of the sector containing the environment.
1665
1666
1667 b) Sometimes flash chips have few, equal sized, BIG sectors.
1668 In such a case you don't want to spend a whole sector for
1669 the environment.
1670
1671 - CFG_ENV_SIZE:
1672
1673 If you use this in combination with CFG_ENV_IS_IN_FLASH
1674 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1675 of this flash sector for the environment. This saves
1676 memory for the RAM copy of the environment.
1677
1678 It may also save flash memory if you decide to use this
1679 when your environment is "embedded" within U-Boot code,
1680 since then the remainder of the flash sector could be used
1681 for U-Boot code. It should be pointed out that this is
1682 STRONGLY DISCOURAGED from a robustness point of view:
1683 updating the environment in flash makes it always
1684 necessary to erase the WHOLE sector. If something goes
1685 wrong before the contents has been restored from a copy in
1686 RAM, your target system will be dead.
1687
1688 - CFG_ENV_ADDR_REDUND
1689 CFG_ENV_SIZE_REDUND
1690
wdenk43d96162003-03-06 00:02:04 +00001691 These settings describe a second storage area used to hold
1692 a redundand copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00001693 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00001694 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00001695
1696BE CAREFUL! Any changes to the flash layout, and some changes to the
1697source code will make it necessary to adapt <board>/u-boot.lds*
1698accordingly!
1699
1700
1701- CFG_ENV_IS_IN_NVRAM:
1702
1703 Define this if you have some non-volatile memory device
1704 (NVRAM, battery buffered SRAM) which you want to use for the
1705 environment.
1706
1707 - CFG_ENV_ADDR:
1708 - CFG_ENV_SIZE:
1709
1710 These two #defines are used to determin the memory area you
1711 want to use for environment. It is assumed that this memory
1712 can just be read and written to, without any special
1713 provision.
1714
1715BE CAREFUL! The first access to the environment happens quite early
1716in U-Boot initalization (when we try to get the setting of for the
1717console baudrate). You *MUST* have mappend your NVRAM area then, or
1718U-Boot will hang.
1719
1720Please note that even with NVRAM we still use a copy of the
1721environment in RAM: we could work on NVRAM directly, but we want to
1722keep settings there always unmodified except somebody uses "saveenv"
1723to save the current settings.
1724
1725
1726- CFG_ENV_IS_IN_EEPROM:
1727
1728 Use this if you have an EEPROM or similar serial access
1729 device and a driver for it.
1730
1731 - CFG_ENV_OFFSET:
1732 - CFG_ENV_SIZE:
1733
1734 These two #defines specify the offset and size of the
1735 environment area within the total memory of your EEPROM.
1736
1737 - CFG_I2C_EEPROM_ADDR:
1738 If defined, specified the chip address of the EEPROM device.
1739 The default address is zero.
1740
1741 - CFG_EEPROM_PAGE_WRITE_BITS:
1742 If defined, the number of bits used to address bytes in a
1743 single page in the EEPROM device. A 64 byte page, for example
1744 would require six bits.
1745
1746 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1747 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00001748 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00001749
1750 - CFG_I2C_EEPROM_ADDR_LEN:
1751 The length in bytes of the EEPROM memory array address. Note
1752 that this is NOT the chip address length!
1753
wdenk5cf91d62004-04-23 20:32:05 +00001754 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
1755 EEPROM chips that implement "address overflow" are ones
1756 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
1757 address and the extra bits end up in the "chip address" bit
1758 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
1759 byte chips.
1760
1761 Note that we consider the length of the address field to
1762 still be one byte because the extra address bits are hidden
1763 in the chip address.
1764
wdenkc6097192002-11-03 00:24:07 +00001765 - CFG_EEPROM_SIZE:
1766 The size in bytes of the EEPROM device.
1767
wdenkc6097192002-11-03 00:24:07 +00001768
wdenk5779d8d2003-12-06 23:55:10 +00001769- CFG_ENV_IS_IN_DATAFLASH:
1770
wdenkd4ca31c2004-01-02 14:00:00 +00001771 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00001772 want to use for the environment.
1773
1774 - CFG_ENV_OFFSET:
1775 - CFG_ENV_ADDR:
1776 - CFG_ENV_SIZE:
1777
1778 These three #defines specify the offset and size of the
1779 environment area within the total memory of your DataFlash placed
1780 at the specified address.
1781
1782
wdenkc6097192002-11-03 00:24:07 +00001783- CFG_SPI_INIT_OFFSET
1784
1785 Defines offset to the initial SPI buffer area in DPRAM. The
1786 area is used at an early stage (ROM part) if the environment
1787 is configured to reside in the SPI EEPROM: We need a 520 byte
1788 scratch DPRAM area. It is used between the two initialization
1789 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1790 to be a good choice since it makes it far enough from the
1791 start of the data area as well as from the stack pointer.
1792
1793Please note that the environment is read-only as long as the monitor
1794has been relocated to RAM and a RAM copy of the environment has been
1795created; also, when using EEPROM you will have to use getenv_r()
1796until then to read environment variables.
1797
wdenk85ec0bc2003-03-31 16:34:49 +00001798The environment is protected by a CRC32 checksum. Before the monitor
1799is relocated into RAM, as a result of a bad CRC you will be working
1800with the compiled-in default environment - *silently*!!! [This is
1801necessary, because the first environment variable we need is the
1802"baudrate" setting for the console - if we have a bad CRC, we don't
1803have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00001804
1805Note: once the monitor has been relocated, then it will complain if
1806the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00001807use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00001808
wdenkfc3e2162003-10-08 22:33:00 +00001809- CFG_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00001810 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00001811
1812 Note: If this option is active, then CFG_FAULT_MII_ADDR
1813 also needs to be defined.
1814
1815- CFG_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00001816 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00001817
wdenkc40b2952004-03-13 23:29:43 +00001818- CFG_64BIT_VSPRINTF:
1819 Makes vsprintf (and all *printf functions) support printing
1820 of 64bit values by using the L quantifier
1821
1822- CFG_64BIT_STRTOUL:
1823 Adds simple_strtoull that returns a 64bit value
1824
wdenkc6097192002-11-03 00:24:07 +00001825Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00001826---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001827
1828- CFG_CACHELINE_SIZE:
1829 Cache Line Size of the CPU.
1830
1831- CFG_DEFAULT_IMMR:
1832 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00001833
wdenk42d1f032003-10-15 23:53:47 +00001834 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
1835 and RPXsuper) to be able to adjust the position of
1836 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00001837
wdenk7f6c2cb2002-11-10 22:06:23 +00001838- Floppy Disk Support:
1839 CFG_FDC_DRIVE_NUMBER
1840
1841 the default drive number (default value 0)
1842
1843 CFG_ISA_IO_STRIDE
1844
1845 defines the spacing between fdc chipset registers
1846 (default value 1)
1847
1848 CFG_ISA_IO_OFFSET
1849
wdenk43d96162003-03-06 00:02:04 +00001850 defines the offset of register from address. It
1851 depends on which part of the data bus is connected to
1852 the fdc chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00001853
wdenk43d96162003-03-06 00:02:04 +00001854 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
1855 CFG_FDC_DRIVE_NUMBER are undefined, they take their
1856 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00001857
wdenk43d96162003-03-06 00:02:04 +00001858 if CFG_FDC_HW_INIT is defined, then the function
1859 fdc_hw_init() is called at the beginning of the FDC
1860 setup. fdc_hw_init() must be provided by the board
1861 source code. It is used to make hardware dependant
1862 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00001863
wdenkc6097192002-11-03 00:24:07 +00001864- CFG_IMMR: Physical address of the Internal Memory Mapped
1865 Register; DO NOT CHANGE! (11-4)
1866 [MPC8xx systems only]
1867
1868- CFG_INIT_RAM_ADDR:
1869
wdenk7152b1d2003-09-05 23:19:14 +00001870 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00001871 initial data and stack; please note that this must be
1872 writable memory that is working WITHOUT special
1873 initialization, i. e. you CANNOT use normal RAM which
1874 will become available only after programming the
1875 memory controller and running certain initialization
1876 sequences.
1877
1878 U-Boot uses the following memory types:
1879 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
1880 - MPC824X: data cache
1881 - PPC4xx: data cache
1882
wdenk85ec0bc2003-03-31 16:34:49 +00001883- CFG_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00001884
1885 Offset of the initial data structure in the memory
1886 area defined by CFG_INIT_RAM_ADDR. Usually
wdenk85ec0bc2003-03-31 16:34:49 +00001887 CFG_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00001888 data is located at the end of the available space
1889 (sometimes written as (CFG_INIT_RAM_END -
1890 CFG_INIT_DATA_SIZE), and the initial stack is just
1891 below that area (growing from (CFG_INIT_RAM_ADDR +
wdenk85ec0bc2003-03-31 16:34:49 +00001892 CFG_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00001893
1894 Note:
1895 On the MPC824X (or other systems that use the data
1896 cache for initial memory) the address chosen for
1897 CFG_INIT_RAM_ADDR is basically arbitrary - it must
1898 point to an otherwise UNUSED address space between
1899 the top of RAM and the start of the PCI space.
1900
1901- CFG_SIUMCR: SIU Module Configuration (11-6)
1902
1903- CFG_SYPCR: System Protection Control (11-9)
1904
1905- CFG_TBSCR: Time Base Status and Control (11-26)
1906
1907- CFG_PISCR: Periodic Interrupt Status and Control (11-31)
1908
1909- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
1910
1911- CFG_SCCR: System Clock and reset Control Register (15-27)
1912
1913- CFG_OR_TIMING_SDRAM:
1914 SDRAM timing
1915
1916- CFG_MAMR_PTA:
1917 periodic timer for refresh
1918
1919- CFG_DER: Debug Event Register (37-47)
1920
1921- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
1922 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
1923 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
1924 CFG_BR1_PRELIM:
1925 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
1926
1927- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
1928 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
1929 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
1930 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
1931
1932- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
1933 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
1934 Machine Mode Register and Memory Periodic Timer
1935 Prescaler definitions (SDRAM timing)
1936
1937- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
1938 enable I2C microcode relocation patch (MPC8xx);
1939 define relocation offset in DPRAM [DSP2]
1940
1941- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
1942 enable SPI microcode relocation patch (MPC8xx);
1943 define relocation offset in DPRAM [SCC4]
1944
1945- CFG_USE_OSCCLK:
1946 Use OSCM clock mode on MBX8xx board. Be careful,
1947 wrong setting might damage your board. Read
1948 doc/README.MBX before setting this variable!
1949
wdenkea909b72002-11-21 23:11:29 +00001950- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00001951 Offset of the bootmode word in DPRAM used by post
1952 (Power On Self Tests). This definition overrides
1953 #define'd default value in commproc.h resp.
1954 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00001955
stroese1d49b1f2003-05-23 11:39:05 +00001956- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
1957 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
1958 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
1959 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
1960 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
1961 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
1962 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
wdenk5d232d02003-05-22 22:52:13 +00001963 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
1964 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
1965
wdenkc26e4542004-04-18 10:13:26 +00001966- CONFIG_ETHER_ON_FEC[12]
1967 Define to enable FEC[12] on a 8xx series processor.
1968
1969- CONFIG_FEC[12]_PHY
1970 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00001971 to the given FEC; i. e.
1972 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00001973 means that the PHY with address 4 is connected to FEC1
1974
1975 When set to -1, means to probe for first available.
1976
1977- CONFIG_FEC[12]_PHY_NORXERR
1978 The PHY does not have a RXERR line (RMII only).
1979 (so program the FEC to ignore it).
1980
1981- CONFIG_RMII
1982 Enable RMII mode for all FECs.
1983 Note that this is a global option, we can't
1984 have one FEC in standard MII mode and another in RMII mode.
1985
wdenk5cf91d62004-04-23 20:32:05 +00001986- CONFIG_CRC32_VERIFY
1987 Add a verify option to the crc32 command.
1988 The syntax is:
1989
1990 => crc32 -v <address> <count> <crc32>
1991
1992 Where address/count indicate a memory area
1993 and crc32 is the correct crc32 which the
1994 area should have.
1995
wdenkc6097192002-11-03 00:24:07 +00001996Building the Software:
1997======================
1998
1999Building U-Boot has been tested in native PPC environments (on a
2000PowerBook G3 running LinuxPPC 2000) and in cross environments
2001(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2002NetBSD 1.5 on x86).
2003
2004If you are not using a native PPC environment, it is assumed that you
2005have the GNU cross compiling tools available in your path and named
2006with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2007you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2008the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2009change it to:
2010
2011 CROSS_COMPILE = ppc_4xx-
2012
2013
wdenkba56f622004-02-06 23:19:44 +00002014U-Boot is intended to be simple to build. After installing the
wdenkc6097192002-11-03 00:24:07 +00002015sources you must configure U-Boot for one specific board type. This
2016is done by typing:
2017
2018 make NAME_config
2019
2020where "NAME_config" is the name of one of the existing
2021configurations; the following names are supported:
2022
wdenkdb01a2e2004-04-15 23:14:49 +00002023 ADCIOP_config ADS860_config AR405_config
2024 at91rm9200dk_config CANBT_config cmi_mpc5xx_config
2025 cogent_common_config cogent_mpc8260_config cogent_mpc8xx_config
2026 CPCI405_config CPCIISER4_config CU824_config
2027 DUET_ADS_config EBONY_config ELPT860_config
2028 ESTEEM192E_config ETX094_config FADS823_config
2029 FADS850SAR_config FADS860T_config FPS850L_config
2030 FPS860L_config GEN860T_config GENIETV_config
2031 GTH_config hermes_config hymod_config
2032 IP860_config IVML24_config IVMS8_config
2033 JSE_config LANTEC_config lwmon_config
2034 MBX860T_config MBX_config MPC8260ADS_config
2035 MPC8540ADS_config MPC8560ADS_config NETVIA_config
2036 omap1510inn_config omap1610h2_config omap1610inn_config
2037 pcu_e_config PIP405_config QS823_config
2038 QS850_config QS860T_config RPXlite_config
2039 RPXsuper_config rsdproto_config Sandpoint8240_config
2040 sbc8260_config SM850_config SPD823TS_config
wdenk7abf0c52004-04-18 21:45:42 +00002041 stxgp3_config SXNI855T_config TQM823L_config
2042 TQM850L_config TQM855L_config TQM860L_config
2043 WALNUT405_config ZPC1900_config
wdenk54387ac2003-10-08 22:45:44 +00002044
wdenk2729af92004-05-03 20:45:30 +00002045Note: for some board special configuration names may exist; check if
2046 additional information is available from the board vendor; for
2047 instance, the TQM823L systems are available without (standard)
2048 or with LCD support. You can select such additional "features"
2049 when chosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002050
wdenk2729af92004-05-03 20:45:30 +00002051 make TQM823L_config
2052 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002053
wdenk2729af92004-05-03 20:45:30 +00002054 make TQM823L_LCD_config
2055 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002056
wdenk2729af92004-05-03 20:45:30 +00002057 etc.
wdenkc6097192002-11-03 00:24:07 +00002058
wdenkc6097192002-11-03 00:24:07 +00002059
wdenk2729af92004-05-03 20:45:30 +00002060Finally, type "make all", and you should get some working U-Boot
2061images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002062
wdenk2729af92004-05-03 20:45:30 +00002063- "u-boot.bin" is a raw binary image
2064- "u-boot" is an image in ELF binary format
2065- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002066
wdenkc6097192002-11-03 00:24:07 +00002067
wdenk2729af92004-05-03 20:45:30 +00002068Please be aware that the Makefiles assume you are using GNU make, so
2069for instance on NetBSD you might need to use "gmake" instead of
2070native "make".
wdenkc6097192002-11-03 00:24:07 +00002071
wdenkc6097192002-11-03 00:24:07 +00002072
wdenk2729af92004-05-03 20:45:30 +00002073If the system board that you have is not listed, then you will need
2074to port U-Boot to your hardware platform. To do this, follow these
2075steps:
wdenkc6097192002-11-03 00:24:07 +00002076
wdenk2729af92004-05-03 20:45:30 +000020771. Add a new configuration option for your board to the toplevel
2078 "Makefile" and to the "MAKEALL" script, using the existing
2079 entries as examples. Note that here and at many other places
2080 boards and other names are listed in alphabetical sort order. Please
2081 keep this order.
20822. Create a new directory to hold your board specific code. Add any
2083 files you need. In your board directory, you will need at least
2084 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
20853. Create a new configuration file "include/configs/<board>.h" for
2086 your board
20873. If you're porting U-Boot to a new CPU, then also create a new
2088 directory to hold your CPU specific code. Add any files you need.
20894. Run "make <board>_config" with your new name.
20905. Type "make", and you should get a working "u-boot.srec" file
2091 to be installed on your target system.
20926. Debug and solve any problems that might arise.
2093 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002094
wdenkc6097192002-11-03 00:24:07 +00002095
wdenk2729af92004-05-03 20:45:30 +00002096Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2097==============================================================
wdenkc6097192002-11-03 00:24:07 +00002098
wdenk2729af92004-05-03 20:45:30 +00002099If you have modified U-Boot sources (for instance added a new board
2100or support for new devices, a new CPU, etc.) you are expected to
2101provide feedback to the other developers. The feedback normally takes
2102the form of a "patch", i. e. a context diff against a certain (latest
2103official or latest in CVS) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002104
wdenk2729af92004-05-03 20:45:30 +00002105But before you submit such a patch, please verify that your modifi-
2106cation did not break existing code. At least make sure that *ALL* of
2107the supported boards compile WITHOUT ANY compiler warnings. To do so,
2108just run the "MAKEALL" script, which will configure and build U-Boot
2109for ALL supported system. Be warned, this will take a while. You can
2110select which (cross) compiler to use by passing a `CROSS_COMPILE'
2111environment variable to the script, i. e. to use the cross tools from
2112MontaVista's Hard Hat Linux you can type
wdenkc6097192002-11-03 00:24:07 +00002113
wdenk2729af92004-05-03 20:45:30 +00002114 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002115
wdenk2729af92004-05-03 20:45:30 +00002116or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002117
wdenk2729af92004-05-03 20:45:30 +00002118 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002119
wdenk2729af92004-05-03 20:45:30 +00002120See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002121
wdenkc6097192002-11-03 00:24:07 +00002122
wdenk2729af92004-05-03 20:45:30 +00002123Monitor Commands - Overview:
2124============================
wdenkc6097192002-11-03 00:24:07 +00002125
wdenk2729af92004-05-03 20:45:30 +00002126go - start application at address 'addr'
2127run - run commands in an environment variable
2128bootm - boot application image from memory
2129bootp - boot image via network using BootP/TFTP protocol
2130tftpboot- boot image via network using TFTP protocol
2131 and env variables "ipaddr" and "serverip"
2132 (and eventually "gatewayip")
2133rarpboot- boot image via network using RARP/TFTP protocol
2134diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2135loads - load S-Record file over serial line
2136loadb - load binary file over serial line (kermit mode)
2137md - memory display
2138mm - memory modify (auto-incrementing)
2139nm - memory modify (constant address)
2140mw - memory write (fill)
2141cp - memory copy
2142cmp - memory compare
2143crc32 - checksum calculation
2144imd - i2c memory display
2145imm - i2c memory modify (auto-incrementing)
2146inm - i2c memory modify (constant address)
2147imw - i2c memory write (fill)
2148icrc32 - i2c checksum calculation
2149iprobe - probe to discover valid I2C chip addresses
2150iloop - infinite loop on address range
2151isdram - print SDRAM configuration information
2152sspi - SPI utility commands
2153base - print or set address offset
2154printenv- print environment variables
2155setenv - set environment variables
2156saveenv - save environment variables to persistent storage
2157protect - enable or disable FLASH write protection
2158erase - erase FLASH memory
2159flinfo - print FLASH memory information
2160bdinfo - print Board Info structure
2161iminfo - print header information for application image
2162coninfo - print console devices and informations
2163ide - IDE sub-system
2164loop - infinite loop on address range
2165mtest - simple RAM test
2166icache - enable or disable instruction cache
2167dcache - enable or disable data cache
2168reset - Perform RESET of the CPU
2169echo - echo args to console
2170version - print monitor version
2171help - print online help
2172? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002173
wdenkc6097192002-11-03 00:24:07 +00002174
wdenk2729af92004-05-03 20:45:30 +00002175Monitor Commands - Detailed Description:
2176========================================
wdenkc6097192002-11-03 00:24:07 +00002177
wdenk2729af92004-05-03 20:45:30 +00002178TODO.
wdenkc6097192002-11-03 00:24:07 +00002179
wdenk2729af92004-05-03 20:45:30 +00002180For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002181
2182
wdenk2729af92004-05-03 20:45:30 +00002183Environment Variables:
2184======================
wdenkc6097192002-11-03 00:24:07 +00002185
wdenk2729af92004-05-03 20:45:30 +00002186U-Boot supports user configuration using Environment Variables which
2187can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002188
wdenk2729af92004-05-03 20:45:30 +00002189Environment Variables are set using "setenv", printed using
2190"printenv", and saved to Flash using "saveenv". Using "setenv"
2191without a value can be used to delete a variable from the
2192environment. As long as you don't save the environment you are
2193working with an in-memory copy. In case the Flash area containing the
2194environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002195
wdenk2729af92004-05-03 20:45:30 +00002196Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002197
wdenk2729af92004-05-03 20:45:30 +00002198 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002199
wdenk2729af92004-05-03 20:45:30 +00002200 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002201
wdenk2729af92004-05-03 20:45:30 +00002202 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002203
wdenk2729af92004-05-03 20:45:30 +00002204 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002205
wdenk2729af92004-05-03 20:45:30 +00002206 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002207
wdenk2729af92004-05-03 20:45:30 +00002208 autoload - if set to "no" (any string beginning with 'n'),
2209 "bootp" will just load perform a lookup of the
2210 configuration from the BOOTP server, but not try to
2211 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002212
wdenk2729af92004-05-03 20:45:30 +00002213 autostart - if set to "yes", an image loaded using the "bootp",
2214 "rarpboot", "tftpboot" or "diskboot" commands will
2215 be automatically started (by internally calling
2216 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002217
wdenk2729af92004-05-03 20:45:30 +00002218 If set to "no", a standalone image passed to the
2219 "bootm" command will be copied to the load address
2220 (and eventually uncompressed), but NOT be started.
2221 This can be used to load and uncompress arbitrary
2222 data.
wdenkc6097192002-11-03 00:24:07 +00002223
wdenk2729af92004-05-03 20:45:30 +00002224 initrd_high - restrict positioning of initrd images:
2225 If this variable is not set, initrd images will be
2226 copied to the highest possible address in RAM; this
2227 is usually what you want since it allows for
2228 maximum initrd size. If for some reason you want to
2229 make sure that the initrd image is loaded below the
2230 CFG_BOOTMAPSZ limit, you can set this environment
2231 variable to a value of "no" or "off" or "0".
2232 Alternatively, you can set it to a maximum upper
2233 address to use (U-Boot will still check that it
2234 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002235
wdenk2729af92004-05-03 20:45:30 +00002236 For instance, when you have a system with 16 MB
2237 RAM, and want to reserve 4 MB from use by Linux,
2238 you can do this by adding "mem=12M" to the value of
2239 the "bootargs" variable. However, now you must make
2240 sure that the initrd image is placed in the first
2241 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002242
wdenk2729af92004-05-03 20:45:30 +00002243 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002244
wdenk2729af92004-05-03 20:45:30 +00002245 If you set initrd_high to 0xFFFFFFFF, this is an
2246 indication to U-Boot that all addresses are legal
2247 for the Linux kernel, including addresses in flash
2248 memory. In this case U-Boot will NOT COPY the
2249 ramdisk at all. This may be useful to reduce the
2250 boot time on your system, but requires that this
2251 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00002252
wdenk2729af92004-05-03 20:45:30 +00002253 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002254
wdenk2729af92004-05-03 20:45:30 +00002255 loadaddr - Default load address for commands like "bootp",
2256 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002257
wdenk2729af92004-05-03 20:45:30 +00002258 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002259
wdenk2729af92004-05-03 20:45:30 +00002260 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00002261
wdenk2729af92004-05-03 20:45:30 +00002262 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002263
wdenk2729af92004-05-03 20:45:30 +00002264 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002265
wdenk2729af92004-05-03 20:45:30 +00002266 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002267
wdenk2729af92004-05-03 20:45:30 +00002268 ethprime - When CONFIG_NET_MULTI is enabled controls which
2269 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002270
wdenk2729af92004-05-03 20:45:30 +00002271 ethact - When CONFIG_NET_MULTI is enabled controls which
2272 interface is currently active. For example you
2273 can do the following
wdenkc6097192002-11-03 00:24:07 +00002274
wdenk2729af92004-05-03 20:45:30 +00002275 => setenv ethact FEC ETHERNET
2276 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2277 => setenv ethact SCC ETHERNET
2278 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002279
wdenk2729af92004-05-03 20:45:30 +00002280 netretry - When set to "no" each network operation will
2281 either succeed or fail without retrying.
2282 When set to "once" the network operation will
2283 fail when all the available network interfaces
2284 are tried once without success.
2285 Useful on scripts which control the retry operation
2286 themselves.
wdenkc6097192002-11-03 00:24:07 +00002287
wdenk2729af92004-05-03 20:45:30 +00002288 vlan - When set to a value < 4095 the traffic over
2289 ethernet is encapsulated/received over 802.1q
2290 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00002291
wdenk2729af92004-05-03 20:45:30 +00002292The following environment variables may be used and automatically
2293updated by the network boot commands ("bootp" and "rarpboot"),
2294depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00002295
wdenk2729af92004-05-03 20:45:30 +00002296 bootfile - see above
2297 dnsip - IP address of your Domain Name Server
2298 dnsip2 - IP address of your secondary Domain Name Server
2299 gatewayip - IP address of the Gateway (Router) to use
2300 hostname - Target hostname
2301 ipaddr - see above
2302 netmask - Subnet Mask
2303 rootpath - Pathname of the root filesystem on the NFS server
2304 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00002305
wdenka3d991b2004-04-15 21:48:45 +00002306
wdenk2729af92004-05-03 20:45:30 +00002307There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002308
wdenk2729af92004-05-03 20:45:30 +00002309 serial# - contains hardware identification information such
2310 as type string and/or serial number
2311 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00002312
wdenk2729af92004-05-03 20:45:30 +00002313These variables can be set only once (usually during manufacturing of
2314the board). U-Boot refuses to delete or overwrite these variables
2315once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00002316
2317
wdenk2729af92004-05-03 20:45:30 +00002318Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002319
wdenk2729af92004-05-03 20:45:30 +00002320 ver - Contains the U-Boot version string as printed
2321 with the "version" command. This variable is
2322 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00002323
wdenkc6097192002-11-03 00:24:07 +00002324
wdenk2729af92004-05-03 20:45:30 +00002325Please note that changes to some configuration parameters may take
2326only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00002327
stroesec1551ea2003-04-04 15:53:41 +00002328
wdenk2729af92004-05-03 20:45:30 +00002329Command Line Parsing:
2330=====================
stroesec1551ea2003-04-04 15:53:41 +00002331
wdenk2729af92004-05-03 20:45:30 +00002332There are two different command line parsers available with U-Boot:
2333the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00002334
wdenk2729af92004-05-03 20:45:30 +00002335Old, simple command line parser:
2336--------------------------------
wdenkc6097192002-11-03 00:24:07 +00002337
wdenk2729af92004-05-03 20:45:30 +00002338- supports environment variables (through setenv / saveenv commands)
2339- several commands on one line, separated by ';'
2340- variable substitution using "... $(name) ..." syntax
2341- special characters ('$', ';') can be escaped by prefixing with '\',
2342 for example:
2343 setenv bootcmd bootm \$(address)
2344- You can also escape text by enclosing in single apostrophes, for example:
2345 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00002346
wdenk2729af92004-05-03 20:45:30 +00002347Hush shell:
2348-----------
wdenkf07771c2003-05-28 08:06:31 +00002349
wdenk2729af92004-05-03 20:45:30 +00002350- similar to Bourne shell, with control structures like
2351 if...then...else...fi, for...do...done; while...do...done,
2352 until...do...done, ...
2353- supports environment ("global") variables (through setenv / saveenv
2354 commands) and local shell variables (through standard shell syntax
2355 "name=value"); only environment variables can be used with "run"
2356 command
wdenkf07771c2003-05-28 08:06:31 +00002357
wdenk2729af92004-05-03 20:45:30 +00002358General rules:
2359--------------
wdenkf07771c2003-05-28 08:06:31 +00002360
wdenk2729af92004-05-03 20:45:30 +00002361(1) If a command line (or an environment variable executed by a "run"
2362 command) contains several commands separated by semicolon, and
2363 one of these commands fails, then the remaining commands will be
2364 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00002365
wdenk2729af92004-05-03 20:45:30 +00002366(2) If you execute several variables with one call to run (i. e.
2367 calling run with a list af variables as arguments), any failing
2368 command will cause "run" to terminate, i. e. the remaining
2369 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00002370
wdenk2729af92004-05-03 20:45:30 +00002371Note for Redundant Ethernet Interfaces:
2372=======================================
wdenkf07771c2003-05-28 08:06:31 +00002373
wdenk2729af92004-05-03 20:45:30 +00002374Some boards come with redundant ethernet interfaces; U-Boot supports
2375such configurations and is capable of automatic selection of a
2376"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00002377
wdenk2729af92004-05-03 20:45:30 +00002378Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2379MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2380"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00002381
wdenk2729af92004-05-03 20:45:30 +00002382If the network interface stores some valid MAC address (for instance
2383in SROM), this is used as default address if there is NO correspon-
2384ding setting in the environment; if the corresponding environment
2385variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00002386
wdenk2729af92004-05-03 20:45:30 +00002387o If the SROM has a valid MAC address, and there is no address in the
2388 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002389
wdenk2729af92004-05-03 20:45:30 +00002390o If there is no valid address in the SROM, and a definition in the
2391 environment exists, then the value from the environment variable is
2392 used.
wdenkc6097192002-11-03 00:24:07 +00002393
wdenk2729af92004-05-03 20:45:30 +00002394o If both the SROM and the environment contain a MAC address, and
2395 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002396
wdenk2729af92004-05-03 20:45:30 +00002397o If both the SROM and the environment contain a MAC address, and the
2398 addresses differ, the value from the environment is used and a
2399 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002400
wdenk2729af92004-05-03 20:45:30 +00002401o If neither SROM nor the environment contain a MAC address, an error
2402 is raised.
wdenkc6097192002-11-03 00:24:07 +00002403
wdenkc6097192002-11-03 00:24:07 +00002404
wdenk2729af92004-05-03 20:45:30 +00002405Image Formats:
2406==============
wdenkc6097192002-11-03 00:24:07 +00002407
wdenk2729af92004-05-03 20:45:30 +00002408The "boot" commands of this monitor operate on "image" files which
2409can be basicly anything, preceeded by a special header; see the
2410definitions in include/image.h for details; basicly, the header
2411defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002412
wdenk2729af92004-05-03 20:45:30 +00002413* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2414 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2415 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2416 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2417* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2418 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2419 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2420* Compression Type (uncompressed, gzip, bzip2)
2421* Load Address
2422* Entry Point
2423* Image Name
2424* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002425
wdenk2729af92004-05-03 20:45:30 +00002426The header is marked by a special Magic Number, and both the header
2427and the data portions of the image are secured against corruption by
2428CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002429
wdenkc6097192002-11-03 00:24:07 +00002430
wdenk2729af92004-05-03 20:45:30 +00002431Linux Support:
2432==============
wdenkc6097192002-11-03 00:24:07 +00002433
wdenk2729af92004-05-03 20:45:30 +00002434Although U-Boot should support any OS or standalone application
2435easily, the main focus has always been on Linux during the design of
2436U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002437
wdenk2729af92004-05-03 20:45:30 +00002438U-Boot includes many features that so far have been part of some
2439special "boot loader" code within the Linux kernel. Also, any
2440"initrd" images to be used are no longer part of one big Linux image;
2441instead, kernel and "initrd" are separate images. This implementation
2442serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002443
wdenk2729af92004-05-03 20:45:30 +00002444- the same features can be used for other OS or standalone
2445 applications (for instance: using compressed images to reduce the
2446 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002447
wdenk2729af92004-05-03 20:45:30 +00002448- it becomes much easier to port new Linux kernel versions because
2449 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002450
wdenk2729af92004-05-03 20:45:30 +00002451- the same Linux kernel image can now be used with different "initrd"
2452 images; of course this also means that different kernel images can
2453 be run with the same "initrd". This makes testing easier (you don't
2454 have to build a new "zImage.initrd" Linux image when you just
2455 change a file in your "initrd"). Also, a field-upgrade of the
2456 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002457
wdenkc6097192002-11-03 00:24:07 +00002458
wdenk2729af92004-05-03 20:45:30 +00002459Linux HOWTO:
2460============
wdenkc6097192002-11-03 00:24:07 +00002461
wdenk2729af92004-05-03 20:45:30 +00002462Porting Linux to U-Boot based systems:
2463---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002464
wdenk2729af92004-05-03 20:45:30 +00002465U-Boot cannot save you from doing all the necessary modifications to
2466configure the Linux device drivers for use with your target hardware
2467(no, we don't intend to provide a full virtual machine interface to
2468Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002469
wdenk2729af92004-05-03 20:45:30 +00002470But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002471
wdenk2729af92004-05-03 20:45:30 +00002472Just make sure your machine specific header file (for instance
2473include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2474Information structure as we define in include/u-boot.h, and make
2475sure that your definition of IMAP_ADDR uses the same value as your
2476U-Boot configuration in CFG_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002477
wdenkc6097192002-11-03 00:24:07 +00002478
wdenk2729af92004-05-03 20:45:30 +00002479Configuring the Linux kernel:
2480-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002481
wdenk2729af92004-05-03 20:45:30 +00002482No specific requirements for U-Boot. Make sure you have some root
2483device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002484
wdenkc6097192002-11-03 00:24:07 +00002485
wdenk2729af92004-05-03 20:45:30 +00002486Building a Linux Image:
2487-----------------------
wdenkc6097192002-11-03 00:24:07 +00002488
wdenk2729af92004-05-03 20:45:30 +00002489With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2490not used. If you use recent kernel source, a new build target
2491"uImage" will exist which automatically builds an image usable by
2492U-Boot. Most older kernels also have support for a "pImage" target,
2493which was introduced for our predecessor project PPCBoot and uses a
2494100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002495
wdenk2729af92004-05-03 20:45:30 +00002496Example:
wdenkc6097192002-11-03 00:24:07 +00002497
wdenk2729af92004-05-03 20:45:30 +00002498 make TQM850L_config
2499 make oldconfig
2500 make dep
2501 make uImage
wdenkc6097192002-11-03 00:24:07 +00002502
wdenk2729af92004-05-03 20:45:30 +00002503The "uImage" build target uses a special tool (in 'tools/mkimage') to
2504encapsulate a compressed Linux kernel image with header information,
2505CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002506
wdenk2729af92004-05-03 20:45:30 +00002507* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002508
wdenk2729af92004-05-03 20:45:30 +00002509* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002510
wdenk2729af92004-05-03 20:45:30 +00002511 ${CROSS_COMPILE}-objcopy -O binary \
2512 -R .note -R .comment \
2513 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00002514
wdenk2729af92004-05-03 20:45:30 +00002515* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00002516
wdenk2729af92004-05-03 20:45:30 +00002517 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00002518
wdenk2729af92004-05-03 20:45:30 +00002519* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002520
wdenk2729af92004-05-03 20:45:30 +00002521 mkimage -A ppc -O linux -T kernel -C gzip \
2522 -a 0 -e 0 -n "Linux Kernel Image" \
2523 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00002524
wdenk24ee89b2002-11-03 17:56:27 +00002525
wdenk2729af92004-05-03 20:45:30 +00002526The "mkimage" tool can also be used to create ramdisk images for use
2527with U-Boot, either separated from the Linux kernel image, or
2528combined into one file. "mkimage" encapsulates the images with a 64
2529byte header containing information about target architecture,
2530operating system, image type, compression method, entry points, time
2531stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00002532
wdenk2729af92004-05-03 20:45:30 +00002533"mkimage" can be called in two ways: to verify existing images and
2534print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002535
wdenk2729af92004-05-03 20:45:30 +00002536In the first form (with "-l" option) mkimage lists the information
2537contained in the header of an existing U-Boot image; this includes
2538checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002539
wdenk2729af92004-05-03 20:45:30 +00002540 tools/mkimage -l image
2541 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002542
wdenk2729af92004-05-03 20:45:30 +00002543The second form (with "-d" option) is used to build a U-Boot image
2544from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002545
wdenk2729af92004-05-03 20:45:30 +00002546 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2547 -n name -d data_file image
2548 -A ==> set architecture to 'arch'
2549 -O ==> set operating system to 'os'
2550 -T ==> set image type to 'type'
2551 -C ==> set compression type 'comp'
2552 -a ==> set load address to 'addr' (hex)
2553 -e ==> set entry point to 'ep' (hex)
2554 -n ==> set image name to 'name'
2555 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002556
wdenk2729af92004-05-03 20:45:30 +00002557Right now, all Linux kernels use the same load address (0x00000000),
2558but the entry point address depends on the kernel version:
wdenkc6097192002-11-03 00:24:07 +00002559
wdenk2729af92004-05-03 20:45:30 +00002560- 2.2.x kernels have the entry point at 0x0000000C,
2561- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002562
wdenk2729af92004-05-03 20:45:30 +00002563So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002564
wdenk2729af92004-05-03 20:45:30 +00002565 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2566 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2567 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2568 > examples/uImage.TQM850L
2569 Image Name: 2.4.4 kernel for TQM850L
2570 Created: Wed Jul 19 02:34:59 2000
2571 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2572 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2573 Load Address: 0x00000000
2574 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002575
wdenk2729af92004-05-03 20:45:30 +00002576To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002577
wdenk2729af92004-05-03 20:45:30 +00002578 -> tools/mkimage -l examples/uImage.TQM850L
2579 Image Name: 2.4.4 kernel for TQM850L
2580 Created: Wed Jul 19 02:34:59 2000
2581 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2582 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2583 Load Address: 0x00000000
2584 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002585
wdenk2729af92004-05-03 20:45:30 +00002586NOTE: for embedded systems where boot time is critical you can trade
2587speed for memory and install an UNCOMPRESSED image instead: this
2588needs more space in Flash, but boots much faster since it does not
2589need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002590
wdenk2729af92004-05-03 20:45:30 +00002591 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2592 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2593 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2594 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2595 > examples/uImage.TQM850L-uncompressed
2596 Image Name: 2.4.4 kernel for TQM850L
2597 Created: Wed Jul 19 02:34:59 2000
2598 Image Type: PowerPC Linux Kernel Image (uncompressed)
2599 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2600 Load Address: 0x00000000
2601 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002602
wdenkc6097192002-11-03 00:24:07 +00002603
wdenk2729af92004-05-03 20:45:30 +00002604Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2605when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00002606
wdenk2729af92004-05-03 20:45:30 +00002607 -> tools/mkimage -n 'Simple Ramdisk Image' \
2608 > -A ppc -O linux -T ramdisk -C gzip \
2609 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2610 Image Name: Simple Ramdisk Image
2611 Created: Wed Jan 12 14:01:50 2000
2612 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2613 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2614 Load Address: 0x00000000
2615 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00002616
wdenkdb01a2e2004-04-15 23:14:49 +00002617
wdenk2729af92004-05-03 20:45:30 +00002618Installing a Linux Image:
2619-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00002620
wdenk2729af92004-05-03 20:45:30 +00002621To downloading a U-Boot image over the serial (console) interface,
2622you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00002623
wdenk2729af92004-05-03 20:45:30 +00002624 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00002625
wdenk2729af92004-05-03 20:45:30 +00002626The 'objcopy' does not understand the information in the U-Boot
2627image header, so the resulting S-Record file will be relative to
2628address 0x00000000. To load it to a given address, you need to
2629specify the target address as 'offset' parameter with the 'loads'
2630command.
wdenkc6097192002-11-03 00:24:07 +00002631
wdenk2729af92004-05-03 20:45:30 +00002632Example: install the image to address 0x40100000 (which on the
2633TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00002634
wdenk2729af92004-05-03 20:45:30 +00002635 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00002636
wdenk2729af92004-05-03 20:45:30 +00002637 .......... done
2638 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00002639
wdenk2729af92004-05-03 20:45:30 +00002640 => loads 40100000
2641 ## Ready for S-Record download ...
2642 ~>examples/image.srec
2643 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2644 ...
2645 15989 15990 15991 15992
2646 [file transfer complete]
2647 [connected]
2648 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002649
2650
wdenk2729af92004-05-03 20:45:30 +00002651You can check the success of the download using the 'iminfo' command;
2652this includes a checksum verification so you can be sure no data
2653corruption happened:
wdenkc6097192002-11-03 00:24:07 +00002654
wdenk2729af92004-05-03 20:45:30 +00002655 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00002656
wdenk2729af92004-05-03 20:45:30 +00002657 ## Checking Image at 40100000 ...
2658 Image Name: 2.2.13 for initrd on TQM850L
2659 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2660 Data Size: 335725 Bytes = 327 kB = 0 MB
2661 Load Address: 00000000
2662 Entry Point: 0000000c
2663 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002664
2665
wdenk2729af92004-05-03 20:45:30 +00002666Boot Linux:
2667-----------
wdenkc6097192002-11-03 00:24:07 +00002668
wdenk2729af92004-05-03 20:45:30 +00002669The "bootm" command is used to boot an application that is stored in
2670memory (RAM or Flash). In case of a Linux kernel image, the contents
2671of the "bootargs" environment variable is passed to the kernel as
2672parameters. You can check and modify this variable using the
2673"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00002674
2675
wdenk2729af92004-05-03 20:45:30 +00002676 => printenv bootargs
2677 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00002678
wdenk2729af92004-05-03 20:45:30 +00002679 => 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 +00002680
wdenk2729af92004-05-03 20:45:30 +00002681 => printenv bootargs
2682 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 +00002683
wdenk2729af92004-05-03 20:45:30 +00002684 => bootm 40020000
2685 ## Booting Linux kernel at 40020000 ...
2686 Image Name: 2.2.13 for NFS on TQM850L
2687 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2688 Data Size: 381681 Bytes = 372 kB = 0 MB
2689 Load Address: 00000000
2690 Entry Point: 0000000c
2691 Verifying Checksum ... OK
2692 Uncompressing Kernel Image ... OK
2693 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
2694 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2695 time_init: decrementer frequency = 187500000/60
2696 Calibrating delay loop... 49.77 BogoMIPS
2697 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2698 ...
wdenkc6097192002-11-03 00:24:07 +00002699
wdenk2729af92004-05-03 20:45:30 +00002700If you want to boot a Linux kernel with initial ram disk, you pass
2701the memory addresses of both the kernel and the initrd image (PPBCOOT
2702format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00002703
wdenk2729af92004-05-03 20:45:30 +00002704 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00002705
wdenk2729af92004-05-03 20:45:30 +00002706 ## Checking Image at 40100000 ...
2707 Image Name: 2.2.13 for initrd on TQM850L
2708 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2709 Data Size: 335725 Bytes = 327 kB = 0 MB
2710 Load Address: 00000000
2711 Entry Point: 0000000c
2712 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002713
wdenk2729af92004-05-03 20:45:30 +00002714 ## Checking Image at 40200000 ...
2715 Image Name: Simple Ramdisk Image
2716 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2717 Data Size: 566530 Bytes = 553 kB = 0 MB
2718 Load Address: 00000000
2719 Entry Point: 00000000
2720 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002721
wdenk2729af92004-05-03 20:45:30 +00002722 => bootm 40100000 40200000
2723 ## Booting Linux kernel at 40100000 ...
2724 Image Name: 2.2.13 for initrd on TQM850L
2725 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2726 Data Size: 335725 Bytes = 327 kB = 0 MB
2727 Load Address: 00000000
2728 Entry Point: 0000000c
2729 Verifying Checksum ... OK
2730 Uncompressing Kernel Image ... OK
2731 ## Loading RAMDisk Image at 40200000 ...
2732 Image Name: Simple Ramdisk Image
2733 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2734 Data Size: 566530 Bytes = 553 kB = 0 MB
2735 Load Address: 00000000
2736 Entry Point: 00000000
2737 Verifying Checksum ... OK
2738 Loading Ramdisk ... OK
2739 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
2740 Boot arguments: root=/dev/ram
2741 time_init: decrementer frequency = 187500000/60
2742 Calibrating delay loop... 49.77 BogoMIPS
2743 ...
2744 RAMDISK: Compressed image found at block 0
2745 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00002746
wdenk2729af92004-05-03 20:45:30 +00002747 bash#
wdenkc6097192002-11-03 00:24:07 +00002748
wdenk2729af92004-05-03 20:45:30 +00002749More About U-Boot Image Types:
2750------------------------------
wdenk6069ff22003-02-28 00:49:47 +00002751
wdenk2729af92004-05-03 20:45:30 +00002752U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00002753
wdenk2729af92004-05-03 20:45:30 +00002754 "Standalone Programs" are directly runnable in the environment
2755 provided by U-Boot; it is expected that (if they behave
2756 well) you can continue to work in U-Boot after return from
2757 the Standalone Program.
2758 "OS Kernel Images" are usually images of some Embedded OS which
2759 will take over control completely. Usually these programs
2760 will install their own set of exception handlers, device
2761 drivers, set up the MMU, etc. - this means, that you cannot
2762 expect to re-enter U-Boot except by resetting the CPU.
2763 "RAMDisk Images" are more or less just data blocks, and their
2764 parameters (address, size) are passed to an OS kernel that is
2765 being started.
2766 "Multi-File Images" contain several images, typically an OS
2767 (Linux) kernel image and one or more data images like
2768 RAMDisks. This construct is useful for instance when you want
2769 to boot over the network using BOOTP etc., where the boot
2770 server provides just a single image file, but you want to get
2771 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00002772
wdenk2729af92004-05-03 20:45:30 +00002773 "Multi-File Images" start with a list of image sizes, each
2774 image size (in bytes) specified by an "uint32_t" in network
2775 byte order. This list is terminated by an "(uint32_t)0".
2776 Immediately after the terminating 0 follow the images, one by
2777 one, all aligned on "uint32_t" boundaries (size rounded up to
2778 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00002779
wdenk2729af92004-05-03 20:45:30 +00002780 "Firmware Images" are binary images containing firmware (like
2781 U-Boot or FPGA images) which usually will be programmed to
2782 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00002783
wdenk2729af92004-05-03 20:45:30 +00002784 "Script files" are command sequences that will be executed by
2785 U-Boot's command interpreter; this feature is especially
2786 useful when you configure U-Boot to use a real shell (hush)
2787 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00002788
wdenkc6097192002-11-03 00:24:07 +00002789
wdenk2729af92004-05-03 20:45:30 +00002790Standalone HOWTO:
2791=================
wdenkc6097192002-11-03 00:24:07 +00002792
wdenk2729af92004-05-03 20:45:30 +00002793One of the features of U-Boot is that you can dynamically load and
2794run "standalone" applications, which can use some resources of
2795U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00002796
wdenk2729af92004-05-03 20:45:30 +00002797Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00002798
wdenk2729af92004-05-03 20:45:30 +00002799"Hello World" Demo:
2800-------------------
wdenkc6097192002-11-03 00:24:07 +00002801
wdenk2729af92004-05-03 20:45:30 +00002802'examples/hello_world.c' contains a small "Hello World" Demo
2803application; it is automatically compiled when you build U-Boot.
2804It's configured to run at address 0x00040004, so you can play with it
2805like that:
wdenkc6097192002-11-03 00:24:07 +00002806
wdenk2729af92004-05-03 20:45:30 +00002807 => loads
2808 ## Ready for S-Record download ...
2809 ~>examples/hello_world.srec
2810 1 2 3 4 5 6 7 8 9 10 11 ...
2811 [file transfer complete]
2812 [connected]
2813 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00002814
wdenk2729af92004-05-03 20:45:30 +00002815 => go 40004 Hello World! This is a test.
2816 ## Starting application at 0x00040004 ...
2817 Hello World
2818 argc = 7
2819 argv[0] = "40004"
2820 argv[1] = "Hello"
2821 argv[2] = "World!"
2822 argv[3] = "This"
2823 argv[4] = "is"
2824 argv[5] = "a"
2825 argv[6] = "test."
2826 argv[7] = "<NULL>"
2827 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00002828
wdenk2729af92004-05-03 20:45:30 +00002829 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00002830
wdenk2729af92004-05-03 20:45:30 +00002831Another example, which demonstrates how to register a CPM interrupt
2832handler with the U-Boot code, can be found in 'examples/timer.c'.
2833Here, a CPM timer is set up to generate an interrupt every second.
2834The interrupt service routine is trivial, just printing a '.'
2835character, but this is just a demo program. The application can be
2836controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00002837
wdenk2729af92004-05-03 20:45:30 +00002838 ? - print current values og the CPM Timer registers
2839 b - enable interrupts and start timer
2840 e - stop timer and disable interrupts
2841 q - quit application
wdenkc6097192002-11-03 00:24:07 +00002842
wdenk2729af92004-05-03 20:45:30 +00002843 => loads
2844 ## Ready for S-Record download ...
2845 ~>examples/timer.srec
2846 1 2 3 4 5 6 7 8 9 10 11 ...
2847 [file transfer complete]
2848 [connected]
2849 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00002850
wdenk2729af92004-05-03 20:45:30 +00002851 => go 40004
2852 ## Starting application at 0x00040004 ...
2853 TIMERS=0xfff00980
2854 Using timer 1
2855 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00002856
wdenk2729af92004-05-03 20:45:30 +00002857Hit 'b':
2858 [q, b, e, ?] Set interval 1000000 us
2859 Enabling timer
2860Hit '?':
2861 [q, b, e, ?] ........
2862 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
2863Hit '?':
2864 [q, b, e, ?] .
2865 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
2866Hit '?':
2867 [q, b, e, ?] .
2868 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
2869Hit '?':
2870 [q, b, e, ?] .
2871 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
2872Hit 'e':
2873 [q, b, e, ?] ...Stopping timer
2874Hit 'q':
2875 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00002876
2877
wdenk2729af92004-05-03 20:45:30 +00002878Minicom warning:
2879================
wdenk85ec0bc2003-03-31 16:34:49 +00002880
wdenk2729af92004-05-03 20:45:30 +00002881Over time, many people have reported problems when trying to use the
2882"minicom" terminal emulation program for serial download. I (wd)
2883consider minicom to be broken, and recommend not to use it. Under
2884Unix, I recommend to use C-Kermit for general purpose use (and
2885especially for kermit binary protocol download ("loadb" command), and
2886use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00002887
wdenk2729af92004-05-03 20:45:30 +00002888Nevertheless, if you absolutely want to use it try adding this
2889configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00002890
wdenk2729af92004-05-03 20:45:30 +00002891 Name Program Name U/D FullScr IO-Red. Multi
2892 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
2893 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00002894
2895
wdenk2729af92004-05-03 20:45:30 +00002896NetBSD Notes:
2897=============
wdenkc6097192002-11-03 00:24:07 +00002898
wdenk2729af92004-05-03 20:45:30 +00002899Starting at version 0.9.2, U-Boot supports NetBSD both as host
2900(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00002901
wdenk2729af92004-05-03 20:45:30 +00002902Building requires a cross environment; it is known to work on
2903NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
2904need gmake since the Makefiles are not compatible with BSD make).
2905Note that the cross-powerpc package does not install include files;
2906attempting to build U-Boot will fail because <machine/ansi.h> is
2907missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00002908
wdenk2729af92004-05-03 20:45:30 +00002909 # cd /usr/pkg/cross/powerpc-netbsd/include
2910 # mkdir powerpc
2911 # ln -s powerpc machine
2912 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
2913 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00002914
wdenk2729af92004-05-03 20:45:30 +00002915Native builds *don't* work due to incompatibilities between native
2916and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00002917
wdenk2729af92004-05-03 20:45:30 +00002918Booting assumes that (the first part of) the image booted is a
2919stage-2 loader which in turn loads and then invokes the kernel
2920proper. Loader sources will eventually appear in the NetBSD source
2921tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2922meantime, send mail to bruno@exet-ag.de and/or wd@denx.de for
2923details.
wdenkc6097192002-11-03 00:24:07 +00002924
2925
wdenk2729af92004-05-03 20:45:30 +00002926Implementation Internals:
2927=========================
wdenkc6097192002-11-03 00:24:07 +00002928
wdenk2729af92004-05-03 20:45:30 +00002929The following is not intended to be a complete description of every
2930implementation detail. However, it should help to understand the
2931inner workings of U-Boot and make it easier to port it to custom
2932hardware.
wdenkc6097192002-11-03 00:24:07 +00002933
2934
wdenk2729af92004-05-03 20:45:30 +00002935Initial Stack, Global Data:
2936---------------------------
wdenkc6097192002-11-03 00:24:07 +00002937
wdenk2729af92004-05-03 20:45:30 +00002938The implementation of U-Boot is complicated by the fact that U-Boot
2939starts running out of ROM (flash memory), usually without access to
2940system RAM (because the memory controller is not initialized yet).
2941This means that we don't have writable Data or BSS segments, and BSS
2942is not initialized as zero. To be able to get a C environment working
2943at all, we have to allocate at least a minimal stack. Implementation
2944options for this are defined and restricted by the CPU used: Some CPU
2945models provide on-chip memory (like the IMMR area on MPC8xx and
2946MPC826x processors), on others (parts of) the data cache can be
2947locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00002948
wdenk2729af92004-05-03 20:45:30 +00002949 Chris Hallinan posted a good summary of these issues to the
2950 u-boot-users mailing list:
wdenk43d96162003-03-06 00:02:04 +00002951
wdenk2729af92004-05-03 20:45:30 +00002952 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
2953 From: "Chris Hallinan" <clh@net1plus.com>
2954 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
2955 ...
wdenk43d96162003-03-06 00:02:04 +00002956
wdenk2729af92004-05-03 20:45:30 +00002957 Correct me if I'm wrong, folks, but the way I understand it
2958 is this: Using DCACHE as initial RAM for Stack, etc, does not
2959 require any physical RAM backing up the cache. The cleverness
2960 is that the cache is being used as a temporary supply of
2961 necessary storage before the SDRAM controller is setup. It's
2962 beyond the scope of this list to expain the details, but you
2963 can see how this works by studying the cache architecture and
2964 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00002965
wdenk2729af92004-05-03 20:45:30 +00002966 OCM is On Chip Memory, which I believe the 405GP has 4K. It
2967 is another option for the system designer to use as an
2968 initial stack/ram area prior to SDRAM being available. Either
2969 option should work for you. Using CS 4 should be fine if your
2970 board designers haven't used it for something that would
2971 cause you grief during the initial boot! It is frequently not
2972 used.
wdenk43d96162003-03-06 00:02:04 +00002973
wdenk2729af92004-05-03 20:45:30 +00002974 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
2975 with your processor/board/system design. The default value
2976 you will find in any recent u-boot distribution in
2977 Walnut405.h should work for you. I'd set it to a value larger
2978 than your SDRAM module. If you have a 64MB SDRAM module, set
2979 it above 400_0000. Just make sure your board has no resources
2980 that are supposed to respond to that address! That code in
2981 start.S has been around a while and should work as is when
2982 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00002983
wdenk2729af92004-05-03 20:45:30 +00002984 -Chris Hallinan
2985 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00002986
wdenk2729af92004-05-03 20:45:30 +00002987It is essential to remember this, since it has some impact on the C
2988code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00002989
wdenk2729af92004-05-03 20:45:30 +00002990* Initialized global data (data segment) is read-only. Do not attempt
2991 to write it.
wdenkc6097192002-11-03 00:24:07 +00002992
wdenk2729af92004-05-03 20:45:30 +00002993* Do not use any unitialized global data (or implicitely initialized
2994 as zero data - BSS segment) at all - this is undefined, initiali-
2995 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00002996
wdenk2729af92004-05-03 20:45:30 +00002997* Stack space is very limited. Avoid big data buffers or things like
2998 that.
wdenkc6097192002-11-03 00:24:07 +00002999
wdenk2729af92004-05-03 20:45:30 +00003000Having only the stack as writable memory limits means we cannot use
3001normal global data to share information beween the code. But it
3002turned out that the implementation of U-Boot can be greatly
3003simplified by making a global data structure (gd_t) available to all
3004functions. We could pass a pointer to this data as argument to _all_
3005functions, but this would bloat the code. Instead we use a feature of
3006the GCC compiler (Global Register Variables) to share the data: we
3007place a pointer (gd) to the global data into a register which we
3008reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003009
wdenk2729af92004-05-03 20:45:30 +00003010When choosing a register for such a purpose we are restricted by the
3011relevant (E)ABI specifications for the current architecture, and by
3012GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003013
wdenk2729af92004-05-03 20:45:30 +00003014For PowerPC, the following registers have specific use:
3015 R1: stack pointer
3016 R2: TOC pointer
3017 R3-R4: parameter passing and return values
3018 R5-R10: parameter passing
3019 R13: small data area pointer
3020 R30: GOT pointer
3021 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003022
wdenk2729af92004-05-03 20:45:30 +00003023 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003024
wdenk2729af92004-05-03 20:45:30 +00003025 ==> U-Boot will use R29 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003026
wdenk2729af92004-05-03 20:45:30 +00003027 Note: on PPC, we could use a static initializer (since the
3028 address of the global data structure is known at compile time),
3029 but it turned out that reserving a register results in somewhat
3030 smaller code - although the code savings are not that big (on
3031 average for all boards 752 bytes for the whole U-Boot image,
3032 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003033
wdenk2729af92004-05-03 20:45:30 +00003034On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003035
wdenk2729af92004-05-03 20:45:30 +00003036 R0: function argument word/integer result
3037 R1-R3: function argument word
3038 R9: GOT pointer
3039 R10: stack limit (used only if stack checking if enabled)
3040 R11: argument (frame) pointer
3041 R12: temporary workspace
3042 R13: stack pointer
3043 R14: link register
3044 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003045
wdenk2729af92004-05-03 20:45:30 +00003046 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003047
3048
wdenk2729af92004-05-03 20:45:30 +00003049Memory Management:
3050------------------
wdenkc6097192002-11-03 00:24:07 +00003051
wdenk2729af92004-05-03 20:45:30 +00003052U-Boot runs in system state and uses physical addresses, i.e. the
3053MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003054
wdenk2729af92004-05-03 20:45:30 +00003055The available memory is mapped to fixed addresses using the memory
3056controller. In this process, a contiguous block is formed for each
3057memory type (Flash, SDRAM, SRAM), even when it consists of several
3058physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003059
wdenk2729af92004-05-03 20:45:30 +00003060U-Boot is installed in the first 128 kB of the first Flash bank (on
3061TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3062booting and sizing and initializing DRAM, the code relocates itself
3063to the upper end of DRAM. Immediately below the U-Boot code some
3064memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3065configuration setting]. Below that, a structure with global Board
3066Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003067
wdenk2729af92004-05-03 20:45:30 +00003068Additionally, some exception handler code is copied to the low 8 kB
3069of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003070
wdenk2729af92004-05-03 20:45:30 +00003071So a typical memory configuration with 16 MB of DRAM could look like
3072this:
wdenkc6097192002-11-03 00:24:07 +00003073
wdenk2729af92004-05-03 20:45:30 +00003074 0x0000 0000 Exception Vector code
3075 :
3076 0x0000 1FFF
3077 0x0000 2000 Free for Application Use
3078 :
3079 :
wdenkc6097192002-11-03 00:24:07 +00003080
wdenk2729af92004-05-03 20:45:30 +00003081 :
3082 :
3083 0x00FB FF20 Monitor Stack (Growing downward)
3084 0x00FB FFAC Board Info Data and permanent copy of global data
3085 0x00FC 0000 Malloc Arena
3086 :
3087 0x00FD FFFF
3088 0x00FE 0000 RAM Copy of Monitor Code
3089 ... eventually: LCD or video framebuffer
3090 ... eventually: pRAM (Protected RAM - unchanged by reset)
3091 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003092
3093
wdenk2729af92004-05-03 20:45:30 +00003094System Initialization:
3095----------------------
wdenkc6097192002-11-03 00:24:07 +00003096
wdenk2729af92004-05-03 20:45:30 +00003097In the reset configuration, U-Boot starts at the reset entry point
3098(on most PowerPC systens at address 0x00000100). Because of the reset
3099configuration for CS0# this is a mirror of the onboard Flash memory.
3100To be able to re-map memory U-Boot then jumps to its link address.
3101To be able to implement the initialization code in C, a (small!)
3102initial stack is set up in the internal Dual Ported RAM (in case CPUs
3103which provide such a feature like MPC8xx or MPC8260), or in a locked
3104part of the data cache. After that, U-Boot initializes the CPU core,
3105the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003106
wdenk2729af92004-05-03 20:45:30 +00003107Next, all (potentially) available memory banks are mapped using a
3108preliminary mapping. For example, we put them on 512 MB boundaries
3109(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3110on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3111programmed for SDRAM access. Using the temporary configuration, a
3112simple memory test is run that determines the size of the SDRAM
3113banks.
wdenkc6097192002-11-03 00:24:07 +00003114
wdenk2729af92004-05-03 20:45:30 +00003115When there is more than one SDRAM bank, and the banks are of
3116different size, the largest is mapped first. For equal size, the first
3117bank (CS2#) is mapped first. The first mapping is always for address
31180x00000000, with any additional banks following immediately to create
3119contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003120
wdenk2729af92004-05-03 20:45:30 +00003121Then, the monitor installs itself at the upper end of the SDRAM area
3122and allocates memory for use by malloc() and for the global Board
3123Info data; also, the exception vector code is copied to the low RAM
3124pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003125
wdenk2729af92004-05-03 20:45:30 +00003126Only after this relocation will you have a "normal" C environment;
3127until that you are restricted in several ways, mostly because you are
3128running from ROM, and because the code will have to be relocated to a
3129new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003130
3131
wdenk2729af92004-05-03 20:45:30 +00003132U-Boot Porting Guide:
3133----------------------
wdenkc6097192002-11-03 00:24:07 +00003134
wdenk2729af92004-05-03 20:45:30 +00003135[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3136list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003137
3138
wdenk2729af92004-05-03 20:45:30 +00003139int main (int argc, char *argv[])
3140{
3141 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003142
wdenk2729af92004-05-03 20:45:30 +00003143 signal (SIGALRM, no_more_time);
3144 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003145
wdenk2729af92004-05-03 20:45:30 +00003146 if (available_money > available_manpower) {
3147 pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00003148 return 0;
3149 }
3150
wdenk2729af92004-05-03 20:45:30 +00003151 Download latest U-Boot source;
3152
3153 Subscribe to u-boot-users mailing list;
3154
3155 if (clueless) {
3156 email ("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003157 }
3158
wdenk2729af92004-05-03 20:45:30 +00003159 while (learning) {
3160 Read the README file in the top level directory;
3161 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3162 Read the source, Luke;
3163 }
wdenkc6097192002-11-03 00:24:07 +00003164
wdenk2729af92004-05-03 20:45:30 +00003165 if (available_money > toLocalCurrency ($2500)) {
3166 Buy a BDI2000;
3167 } else {
3168 Add a lot of aggravation and time;
3169 }
wdenkc6097192002-11-03 00:24:07 +00003170
wdenk2729af92004-05-03 20:45:30 +00003171 Create your own board support subdirectory;
wdenkc6097192002-11-03 00:24:07 +00003172
wdenk2729af92004-05-03 20:45:30 +00003173 Create your own board config file;
wdenk6aff3112002-12-17 01:51:00 +00003174
wdenk2729af92004-05-03 20:45:30 +00003175 while (!running) {
3176 do {
3177 Add / modify source code;
3178 } until (compiles);
3179 Debug;
3180 if (clueless)
3181 email ("Hi, I am having problems...");
3182 }
3183 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003184
wdenk2729af92004-05-03 20:45:30 +00003185 return 0;
3186}
3187
3188void no_more_time (int sig)
3189{
3190 hire_a_guru();
3191}
wdenkc6097192002-11-03 00:24:07 +00003192
3193
wdenk2729af92004-05-03 20:45:30 +00003194Coding Standards:
3195-----------------
wdenkc6097192002-11-03 00:24:07 +00003196
wdenk2729af92004-05-03 20:45:30 +00003197All contributions to U-Boot should conform to the Linux kernel
3198coding style; see the file "Documentation/CodingStyle" in your Linux
3199kernel source directory.
3200
3201Please note that U-Boot is implemented in C (and to some small parts
3202in Assembler); no C++ is used, so please do not use C++ style
3203comments (//) in your code.
3204
3205Please also stick to the following formatting rules:
3206- remove any trailing white space
3207- use TAB characters for indentation, not spaces
3208- make sure NOT to use DOS '\r\n' line feeds
3209- do not add more than 2 empty lines to source files
3210- do not add trailing empty lines to source files
3211
3212Submissions which do not conform to the standards may be returned
3213with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003214
3215
wdenk2729af92004-05-03 20:45:30 +00003216Submitting Patches:
3217-------------------
wdenkc6097192002-11-03 00:24:07 +00003218
wdenk2729af92004-05-03 20:45:30 +00003219Since the number of patches for U-Boot is growing, we need to
3220establish some rules. Submissions which do not conform to these rules
3221may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003222
3223
wdenk2729af92004-05-03 20:45:30 +00003224When you send a patch, please include the following information with
3225it:
wdenkc6097192002-11-03 00:24:07 +00003226
wdenk2729af92004-05-03 20:45:30 +00003227* For bug fixes: a description of the bug and how your patch fixes
3228 this bug. Please try to include a way of demonstrating that the
3229 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003230
wdenk2729af92004-05-03 20:45:30 +00003231* For new features: a description of the feature and your
3232 implementation.
wdenkc6097192002-11-03 00:24:07 +00003233
wdenk2729af92004-05-03 20:45:30 +00003234* A CHANGELOG entry as plaintext (separate from the patch)
3235
3236* For major contributions, your entry to the CREDITS file
3237
3238* When you add support for a new board, don't forget to add this
3239 board to the MAKEALL script, too.
3240
3241* If your patch adds new configuration options, don't forget to
3242 document these in the README file.
3243
3244* The patch itself. If you are accessing the CVS repository use "cvs
3245 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3246 version of diff does not support these options, then get the latest
3247 version of GNU diff.
3248
3249 The current directory when running this command shall be the top
3250 level directory of the U-Boot source tree, or it's parent directory
3251 (i. e. please make sure that your patch includes sufficient
3252 directory information for the affected files).
3253
3254 We accept patches as plain text, MIME attachments or as uuencoded
3255 gzipped text.
3256
3257* If one logical set of modifications affects or creates several
3258 files, all these changes shall be submitted in a SINGLE patch file.
3259
3260* Changesets that contain different, unrelated modifications shall be
3261 submitted as SEPARATE patches, one patch per changeset.
3262
3263
3264Notes:
3265
3266* Before sending the patch, run the MAKEALL script on your patched
3267 source tree and make sure that no errors or warnings are reported
3268 for any of the boards.
3269
3270* Keep your modifications to the necessary minimum: A patch
3271 containing several unrelated changes or arbitrary reformats will be
3272 returned with a request to re-formatting / split it.
3273
3274* If you modify existing code, make sure that your new code does not
3275 add to the memory footprint of the code ;-) Small is beautiful!
3276 When adding new features, these should compile conditionally only
3277 (using #ifdef), and the resulting code with the new feature
3278 disabled must not need more memory than the old code without your
3279 modification.