blob: 9455cc22e3fc445eebf8cd50a66679422c96afa1 [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
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
wdenkc6097192002-11-03 00:24:07 +000054who contributed the specific port.
55
wdenkc6097192002-11-03 00:24:07 +000056
57Where to get help:
58==================
59
wdenk24ee89b2002-11-03 17:56:27 +000060In case you have questions about, problems with or contributions for
61U-Boot you should send a message to the U-Boot mailing list at
62<u-boot-users@lists.sourceforge.net>. There is also an archive of
63previous traffic on the mailing list - please search the archive
wdenkc6097192002-11-03 00:24:07 +000064before asking FAQ's. Please see
65http://lists.sourceforge.net/lists/listinfo/u-boot-users/
66
67
68Where we come from:
69===================
70
71- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000072- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000073- clean up code
74- make it easier to add custom boards
75- make it possible to add other [PowerPC] CPUs
76- extend functions, especially:
77 * Provide extended interface to Linux boot loader
78 * S-Record download
79 * network boot
80 * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000081- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000082- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000083- create U-Boot project (http://sourceforge.net/projects/u-boot)
84
85
86Names and Spelling:
87===================
88
89The "official" name of this project is "Das U-Boot". The spelling
90"U-Boot" shall be used in all written text (documentation, comments
91in source files etc.). Example:
92
93 This is the README file for the U-Boot project.
94
95File names etc. shall be based on the string "u-boot". Examples:
96
97 include/asm-ppc/u-boot.h
98
99 #include <asm/u-boot.h>
100
101Variable names, preprocessor constants etc. shall be either based on
102the string "u_boot" or on "U_BOOT". Example:
103
104 U_BOOT_VERSION u_boot_logo
105 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000106
107
wdenk93f19cc2002-12-17 17:55:09 +0000108Versioning:
109===========
110
111U-Boot uses a 3 level version number containing a version, a
112sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
113sub-version "34", and patchlevel "4".
114
115The patchlevel is used to indicate certain stages of development
116between released versions, i. e. officially released versions of
117U-Boot will always have a patchlevel of "0".
118
119
wdenkc6097192002-11-03 00:24:07 +0000120Directory Hierarchy:
121====================
122
wdenk7152b1d2003-09-05 23:19:14 +0000123- board Board dependent files
124- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000125- cpu CPU specific files
wdenk983fda82004-10-28 00:09:35 +0000126 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000127 - arm720t Files specific to ARM 720 CPUs
128 - arm920t Files specific to ARM 920 CPUs
wdenk983fda82004-10-28 00:09:35 +0000129 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenk1d9f4102004-10-09 22:21:29 +0000130 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000131 - arm925t Files specific to ARM 925 CPUs
132 - arm926ejs Files specific to ARM 926 CPUs
133 - at91rm9200 Files specific to Atmel AT91RM9200 CPUs
134 - i386 Files specific to i386 CPUs
135 - ixp Files specific to Intel XScale IXP CPUs
wdenk983fda82004-10-28 00:09:35 +0000136 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000137 - mips Files specific to MIPS CPUs
wdenk983fda82004-10-28 00:09:35 +0000138 - mpc5xx Files specific to Freescale MPC5xx CPUs
139 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
140 - mpc8xx Files specific to Freescale MPC8xx CPUs
141 - mpc8220 Files specific to Freescale MPC8220 CPUs
142 - mpc824x Files specific to Freescale MPC824x CPUs
143 - mpc8260 Files specific to Freescale MPC8260 CPUs
144 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000145 - nios Files specific to Altera NIOS CPUs
wdenk5c952cf2004-10-10 21:27:30 +0000146 - nios2 Files specific to Altera Nios-II CPUs
wdenk11dadd52004-02-27 00:07:27 +0000147 - ppc4xx Files specific to IBM PowerPC 4xx CPUs
148 - pxa Files specific to Intel XScale PXA CPUs
149 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
150 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000151- disk Code for disk drive partition handling
152- doc Documentation (don't expect too much)
wdenk7152b1d2003-09-05 23:19:14 +0000153- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000154- dtt Digital Thermometer and Thermostat drivers
155- examples Example code for standalone applications, etc.
156- include Header Files
wdenk11dadd52004-02-27 00:07:27 +0000157- lib_arm Files generic to ARM architecture
158- lib_generic Files generic to all architectures
159- lib_i386 Files generic to i386 architecture
160- lib_m68k Files generic to m68k architecture
161- lib_mips Files generic to MIPS architecture
162- lib_nios Files generic to NIOS architecture
163- lib_ppc Files generic to PowerPC architecture
wdenkc6097192002-11-03 00:24:07 +0000164- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000165- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000166- rtc Real Time Clock drivers
167- tools Tools to build S-Record or U-Boot images, etc.
168
wdenkc6097192002-11-03 00:24:07 +0000169Software Configuration:
170=======================
171
172Configuration is usually done using C preprocessor defines; the
173rationale behind that is to avoid dead code whenever possible.
174
175There are two classes of configuration variables:
176
177* Configuration _OPTIONS_:
178 These are selectable by the user and have names beginning with
179 "CONFIG_".
180
181* Configuration _SETTINGS_:
182 These depend on the hardware etc. and should not be meddled with if
183 you don't know what you're doing; they have names beginning with
184 "CFG_".
185
186Later we will add a configuration tool - probably similar to or even
187identical to what's used for the Linux kernel. Right now, we have to
188do the configuration by hand, which means creating some symbolic
189links and editing some configuration files. We use the TQM8xxL boards
190as an example here.
191
192
193Selection of Processor Architecture and Board Type:
194---------------------------------------------------
195
196For all supported boards there are ready-to-use default
197configurations available; just type "make <board_name>_config".
198
199Example: For a TQM823L module type:
200
201 cd u-boot
202 make TQM823L_config
203
204For the Cogent platform, you need to specify the cpu type as well;
205e.g. "make cogent_mpc8xx_config". And also configure the cogent
206directory according to the instructions in cogent/README.
207
208
209Configuration Options:
210----------------------
211
212Configuration depends on the combination of board and CPU type; all
213such information is kept in a configuration file
214"include/configs/<board_name>.h".
215
216Example: For a TQM823L module, all configuration settings are in
217"include/configs/TQM823L.h".
218
219
wdenk7f6c2cb2002-11-10 22:06:23 +0000220Many of the options are named exactly as the corresponding Linux
221kernel configuration options. The intention is to make it easier to
222build a config tool - later.
223
224
wdenkc6097192002-11-03 00:24:07 +0000225The following options need to be configured:
226
227- CPU Type: Define exactly one of
228
229 PowerPC based CPUs:
230 -------------------
231 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
wdenk0db5bca2003-03-31 17:27:09 +0000232 or CONFIG_MPC5xx
wdenk983fda82004-10-28 00:09:35 +0000233 or CONFIG_MPC8220
wdenkc6097192002-11-03 00:24:07 +0000234 or CONFIG_MPC824X, CONFIG_MPC8260
wdenk42d1f032003-10-15 23:53:47 +0000235 or CONFIG_MPC85xx
wdenkc6097192002-11-03 00:24:07 +0000236 or CONFIG_IOP480
237 or CONFIG_405GP
wdenk12f34242003-09-02 22:48:03 +0000238 or CONFIG_405EP
wdenkc6097192002-11-03 00:24:07 +0000239 or CONFIG_440
240 or CONFIG_MPC74xx
wdenk72755c72003-06-20 23:10:58 +0000241 or CONFIG_750FX
wdenkc6097192002-11-03 00:24:07 +0000242
243 ARM based CPUs:
244 ---------------
245 CONFIG_SA1110
246 CONFIG_ARM7
247 CONFIG_PXA250
248
wdenk507bbe32004-04-18 21:13:41 +0000249 MicroBlaze based CPUs:
250 ----------------------
wdenk857cad32004-07-10 23:48:41 +0000251 CONFIG_MICROBLAZE
wdenk507bbe32004-04-18 21:13:41 +0000252
wdenk5c952cf2004-10-10 21:27:30 +0000253 Nios-2 based CPUs:
254 ----------------------
255 CONFIG_NIOS2
256
wdenkc6097192002-11-03 00:24:07 +0000257
258- Board Type: Define exactly one of
259
260 PowerPC based boards:
261 ---------------------
262
wdenk17ea1172004-06-06 21:51:03 +0000263 CONFIG_ADCIOP CONFIG_GEN860T CONFIG_PCI405
264 CONFIG_ADS860 CONFIG_GENIETV CONFIG_PCIPPC2
265 CONFIG_AMX860 CONFIG_GTH CONFIG_PCIPPC6
266 CONFIG_AR405 CONFIG_gw8260 CONFIG_pcu_e
267 CONFIG_BAB7xx CONFIG_hermes CONFIG_PIP405
268 CONFIG_c2mon CONFIG_hymod CONFIG_PM826
269 CONFIG_CANBT CONFIG_IAD210 CONFIG_ppmc8260
270 CONFIG_CCM CONFIG_ICU862 CONFIG_QS823
271 CONFIG_CMI CONFIG_IP860 CONFIG_QS850
272 CONFIG_cogent_mpc8260 CONFIG_IPHASE4539 CONFIG_QS860T
273 CONFIG_cogent_mpc8xx CONFIG_IVML24 CONFIG_RBC823
274 CONFIG_CPCI405 CONFIG_IVML24_128 CONFIG_RPXClassic
275 CONFIG_CPCI4052 CONFIG_IVML24_256 CONFIG_RPXlite
276 CONFIG_CPCIISER4 CONFIG_IVMS8 CONFIG_RPXsuper
277 CONFIG_CPU86 CONFIG_IVMS8_128 CONFIG_rsdproto
278 CONFIG_CRAYL1 CONFIG_IVMS8_256 CONFIG_sacsng
279 CONFIG_CSB272 CONFIG_JSE CONFIG_Sandpoint8240
280 CONFIG_CU824 CONFIG_LANTEC CONFIG_Sandpoint8245
281 CONFIG_DASA_SIM CONFIG_lwmon CONFIG_sbc8260
wdenk8b07a112004-07-10 21:45:47 +0000282 CONFIG_DB64360 CONFIG_MBX CONFIG_sbc8560
283 CONFIG_DB64460 CONFIG_MBX860T CONFIG_SM850
284 CONFIG_DU405 CONFIG_MHPC CONFIG_SPD823TS
285 CONFIG_DUET_ADS CONFIG_MIP405 CONFIG_STXGP3
286 CONFIG_EBONY CONFIG_MOUSSE CONFIG_SXNI855T
287 CONFIG_ELPPC CONFIG_MPC8260ADS CONFIG_TQM823L
288 CONFIG_ELPT860 CONFIG_MPC8540ADS CONFIG_TQM8260
289 CONFIG_ep8260 CONFIG_MPC8560ADS CONFIG_TQM850L
290 CONFIG_ERIC CONFIG_MUSENKI CONFIG_TQM855L
291 CONFIG_ESTEEM192E CONFIG_MVS1 CONFIG_TQM860L
292 CONFIG_ETX094 CONFIG_NETPHONE CONFIG_TTTech
293 CONFIG_EVB64260 CONFIG_NETTA CONFIG_UTX8245
294 CONFIG_FADS823 CONFIG_NETVIA CONFIG_V37
295 CONFIG_FADS850SAR CONFIG_NX823 CONFIG_W7OLMC
296 CONFIG_FADS860T CONFIG_OCRTC CONFIG_W7OLMG
297 CONFIG_FLAGADM CONFIG_ORSG CONFIG_WALNUT405
298 CONFIG_FPS850L CONFIG_OXC CONFIG_ZPC1900
299 CONFIG_FPS860L CONFIG_ZUMA
wdenkc6097192002-11-03 00:24:07 +0000300
301 ARM based boards:
302 -----------------
303
wdenkb8c83182004-07-11 22:37:59 +0000304 CONFIG_AT91RM9200DK, CONFIG_CERF250, CONFIG_DNP1110,
305 CONFIG_EP7312, CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE,
306 CONFIG_IMPA7, CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610,
307 CONFIG_LART, CONFIG_LPD7A400 CONFIG_LUBBOCK,
308 CONFIG_OSK_OMAP5912, CONFIG_SHANNON, CONFIG_P2_OMAP730,
309 CONFIG_SMDK2400, CONFIG_SMDK2410, CONFIG_TRAB,
310 CONFIG_VCMA9
wdenkc6097192002-11-03 00:24:07 +0000311
wdenk507bbe32004-04-18 21:13:41 +0000312 MicroBlaze based boards:
313 ------------------------
314
315 CONFIG_SUZAKU
316
wdenk5c952cf2004-10-10 21:27:30 +0000317 Nios-2 based boards:
318 ------------------------
319
320 CONFIG_PCI5441 CONFIG_PK1C20
321
wdenkc6097192002-11-03 00:24:07 +0000322
323- CPU Module Type: (if CONFIG_COGENT is defined)
324 Define exactly one of
325 CONFIG_CMA286_60_OLD
326--- FIXME --- not tested yet:
327 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
328 CONFIG_CMA287_23, CONFIG_CMA287_50
329
330- Motherboard Type: (if CONFIG_COGENT is defined)
331 Define exactly one of
332 CONFIG_CMA101, CONFIG_CMA102
333
334- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
335 Define one or more of
336 CONFIG_CMA302
337
338- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
339 Define one or more of
340 CONFIG_LCD_HEARTBEAT - update a character position on
341 the lcd display every second with
342 a "rotator" |\-/|\-/
343
wdenk2535d602003-07-17 23:16:40 +0000344- Board flavour: (if CONFIG_MPC8260ADS is defined)
345 CONFIG_ADSTYPE
346 Possible values are:
347 CFG_8260ADS - original MPC8260ADS
wdenk180d3f72004-01-04 16:28:35 +0000348 CFG_8266ADS - MPC8266ADS
wdenk54387ac2003-10-08 22:45:44 +0000349 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
wdenk04a85b32004-04-15 18:22:41 +0000350 CFG_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000351
wdenkc6097192002-11-03 00:24:07 +0000352- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000353 Define exactly one of
354 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000355
wdenk75d1ea72004-01-31 20:06:54 +0000356- 8xx CPU Options: (if using an MPC8xx cpu)
wdenk66ca92a2004-09-28 17:59:53 +0000357 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
358 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000359 e.g. if there is no 32KHz
360 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000361 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
362 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000363
wdenk66ca92a2004-09-28 17:59:53 +0000364- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
365 CFG_8xx_CPUCLK_MIN
366 CFG_8xx_CPUCLK_MAX
367 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000368 See doc/README.MPC866
369
370 CFG_MEASURE_CPUCLK
371
wdenkba56f622004-02-06 23:19:44 +0000372 Define this to measure the actual CPU clock instead
373 of relying on the correctness of the configured
374 values. Mostly useful for board bringup to make sure
375 the PLL is locked at the intended frequency. Note
376 that this requires a (stable) reference clock (32 kHz
wdenk66ca92a2004-09-28 17:59:53 +0000377 RTC clock or CFG_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000378
wdenk5da627a2003-10-09 20:09:04 +0000379- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000380 CONFIG_CLOCKS_IN_MHZ
381
382 U-Boot stores all clock information in Hz
383 internally. For binary compatibility with older Linux
384 kernels (which expect the clocks passed in the
385 bd_info data to be in MHz) the environment variable
386 "clocks_in_mhz" can be defined so that U-Boot
387 converts clock data to MHZ before passing it to the
388 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000389 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
390 "clocks_in_mhz=1" is automatically included in the
391 default environment.
392
wdenk5da627a2003-10-09 20:09:04 +0000393 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
394
395 When transfering memsize parameter to linux, some versions
396 expect it to be in bytes, others in MB.
397 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
398
wdenk6705d812004-08-02 23:22:59 +0000399- Serial Ports:
400 CFG_PL010_SERIAL
401
402 Define this if you want support for Amba PrimeCell PL010 UARTs.
403
404 CFG_PL011_SERIAL
405
406 Define this if you want support for Amba PrimeCell PL011 UARTs.
407
408 CONFIG_PL011_CLOCK
409
410 If you have Amba PrimeCell PL011 UARTs, set this variable to
411 the clock speed of the UARTs.
412
413 CONFIG_PL01x_PORTS
414
415 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
416 define this to a list of base addresses for each (supported)
417 port. See e.g. include/configs/versatile.h
418
419
wdenkc6097192002-11-03 00:24:07 +0000420- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000421 Depending on board, define exactly one serial port
422 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
423 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
424 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000425
426 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
427 port routines must be defined elsewhere
428 (i.e. serial_init(), serial_getc(), ...)
429
430 CONFIG_CFB_CONSOLE
431 Enables console device for a color framebuffer. Needs following
432 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
433 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
434 (default big endian)
435 VIDEO_HW_RECTFILL graphic chip supports
436 rectangle fill
437 (cf. smiLynxEM)
438 VIDEO_HW_BITBLT graphic chip supports
439 bit-blit (cf. smiLynxEM)
440 VIDEO_VISIBLE_COLS visible pixel columns
441 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000442 VIDEO_VISIBLE_ROWS visible pixel rows
443 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000444 VIDEO_DATA_FORMAT graphic data format
445 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000446 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000447 VIDEO_KBD_INIT_FCT keyboard int fct
448 (i.e. i8042_kbd_init())
449 VIDEO_TSTC_FCT test char fct
450 (i.e. i8042_tstc)
451 VIDEO_GETC_FCT get char fct
452 (i.e. i8042_getc)
453 CONFIG_CONSOLE_CURSOR cursor drawing on/off
454 (requires blink timer
455 cf. i8042.c)
456 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
457 CONFIG_CONSOLE_TIME display time/date info in
458 upper right corner
459 (requires CFG_CMD_DATE)
460 CONFIG_VIDEO_LOGO display Linux logo in
461 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000462 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
463 linux_logo.h for logo.
464 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000465 CONFIG_CONSOLE_EXTRA_INFO
466 addional board info beside
467 the logo
468
wdenk43d96162003-03-06 00:02:04 +0000469 When CONFIG_CFB_CONSOLE is defined, video console is
470 default i/o. Serial console can be forced with
471 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000472
wdenkd4ca31c2004-01-02 14:00:00 +0000473 When CONFIG_SILENT_CONSOLE is defined, all console
474 messages (by U-Boot and Linux!) can be silenced with
475 the "silent" environment variable. See
476 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000477
wdenkc6097192002-11-03 00:24:07 +0000478- Console Baudrate:
479 CONFIG_BAUDRATE - in bps
480 Select one of the baudrates listed in
481 CFG_BAUDRATE_TABLE, see below.
wdenk3bbc8992003-12-07 22:27:15 +0000482 CFG_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000483
484- Interrupt driven serial port input:
485 CONFIG_SERIAL_SOFTWARE_FIFO
486
487 PPC405GP only.
488 Use an interrupt handler for receiving data on the
489 serial port. It also enables using hardware handshake
490 (RTS/CTS) and UART's built-in FIFO. Set the number of
491 bytes the interrupt driven input buffer should have.
492
wdenk109c0e32004-03-23 21:43:07 +0000493 Leave undefined to disable this feature, including
494 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000495
stroese1d49b1f2003-05-23 11:39:05 +0000496- Console UART Number:
497 CONFIG_UART1_CONSOLE
498
499 IBM PPC4xx only.
500 If defined internal UART1 (and not UART0) is used
501 as default U-Boot console.
502
wdenkc6097192002-11-03 00:24:07 +0000503- Boot Delay: CONFIG_BOOTDELAY - in seconds
504 Delay before automatically booting the default image;
505 set to -1 to disable autoboot.
506
507 See doc/README.autoboot for these options that
508 work with CONFIG_BOOTDELAY. None are required.
509 CONFIG_BOOT_RETRY_TIME
510 CONFIG_BOOT_RETRY_MIN
511 CONFIG_AUTOBOOT_KEYED
512 CONFIG_AUTOBOOT_PROMPT
513 CONFIG_AUTOBOOT_DELAY_STR
514 CONFIG_AUTOBOOT_STOP_STR
515 CONFIG_AUTOBOOT_DELAY_STR2
516 CONFIG_AUTOBOOT_STOP_STR2
517 CONFIG_ZERO_BOOTDELAY_CHECK
518 CONFIG_RESET_TO_RETRY
519
520- Autoboot Command:
521 CONFIG_BOOTCOMMAND
522 Only needed when CONFIG_BOOTDELAY is enabled;
523 define a command string that is automatically executed
524 when no character is read on the console interface
525 within "Boot Delay" after reset.
526
527 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000528 This can be used to pass arguments to the bootm
529 command. The value of CONFIG_BOOTARGS goes into the
530 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000531
532 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000533 The value of these goes into the environment as
534 "ramboot" and "nfsboot" respectively, and can be used
535 as a convenience, when switching between booting from
536 ram and nfs.
wdenkc6097192002-11-03 00:24:07 +0000537
538- Pre-Boot Commands:
539 CONFIG_PREBOOT
540
541 When this option is #defined, the existence of the
542 environment variable "preboot" will be checked
543 immediately before starting the CONFIG_BOOTDELAY
544 countdown and/or running the auto-boot command resp.
545 entering interactive mode.
546
547 This feature is especially useful when "preboot" is
548 automatically generated or modified. For an example
549 see the LWMON board specific code: here "preboot" is
550 modified when the user holds down a certain
551 combination of keys on the (special) keyboard when
552 booting the systems
553
554- Serial Download Echo Mode:
555 CONFIG_LOADS_ECHO
556 If defined to 1, all characters received during a
557 serial download (using the "loads" command) are
558 echoed back. This might be needed by some terminal
559 emulations (like "cu"), but may as well just take
560 time on others. This setting #define's the initial
561 value of the "loads_echo" environment variable.
562
563- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
564 CONFIG_KGDB_BAUDRATE
565 Select one of the baudrates listed in
566 CFG_BAUDRATE_TABLE, see below.
567
568- Monitor Functions:
569 CONFIG_COMMANDS
570 Most monitor functions can be selected (or
571 de-selected) by adjusting the definition of
572 CONFIG_COMMANDS; to select individual functions,
573 #define CONFIG_COMMANDS by "OR"ing any of the
574 following values:
575
576 #define enables commands:
577 -------------------------
578 CFG_CMD_ASKENV * ask for env variable
wdenk78137c32003-09-15 18:00:00 +0000579 CFG_CMD_AUTOSCRIPT Autoscript Support
wdenkc6097192002-11-03 00:24:07 +0000580 CFG_CMD_BDI bdinfo
wdenk6705d812004-08-02 23:22:59 +0000581 CFG_CMD_BEDBUG * Include BedBug Debugger
wdenkba56f622004-02-06 23:19:44 +0000582 CFG_CMD_BMP * BMP support
wdenk6705d812004-08-02 23:22:59 +0000583 CFG_CMD_BSP * Board specific commands
wdenkc6097192002-11-03 00:24:07 +0000584 CFG_CMD_BOOTD bootd
wdenk6705d812004-08-02 23:22:59 +0000585 CFG_CMD_CACHE * icache, dcache
wdenkc6097192002-11-03 00:24:07 +0000586 CFG_CMD_CONSOLE coninfo
587 CFG_CMD_DATE * support for RTC, date/time...
wdenk6705d812004-08-02 23:22:59 +0000588 CFG_CMD_DHCP * DHCP support
wdenkba56f622004-02-06 23:19:44 +0000589 CFG_CMD_DIAG * Diagnostics
590 CFG_CMD_DOC * Disk-On-Chip Support
wdenk6705d812004-08-02 23:22:59 +0000591 CFG_CMD_DTT * Digital Therm and Thermostat
wdenkc6097192002-11-03 00:24:07 +0000592 CFG_CMD_ECHO * echo arguments
593 CFG_CMD_EEPROM * EEPROM read/write support
wdenk6705d812004-08-02 23:22:59 +0000594 CFG_CMD_ELF * bootelf, bootvx
wdenkc6097192002-11-03 00:24:07 +0000595 CFG_CMD_ENV saveenv
596 CFG_CMD_FDC * Floppy Disk Support
wdenk6705d812004-08-02 23:22:59 +0000597 CFG_CMD_FAT * FAT partition support
wdenk2262cfe2002-11-18 00:14:45 +0000598 CFG_CMD_FDOS * Dos diskette Support
wdenkc6097192002-11-03 00:24:07 +0000599 CFG_CMD_FLASH flinfo, erase, protect
600 CFG_CMD_FPGA FPGA device initialization support
wdenkba56f622004-02-06 23:19:44 +0000601 CFG_CMD_HWFLOW * RTS/CTS hw flow control
wdenkc6097192002-11-03 00:24:07 +0000602 CFG_CMD_I2C * I2C serial bus support
603 CFG_CMD_IDE * IDE harddisk support
604 CFG_CMD_IMI iminfo
wdenkba56f622004-02-06 23:19:44 +0000605 CFG_CMD_IMLS List all found images
wdenkc6097192002-11-03 00:24:07 +0000606 CFG_CMD_IMMAP * IMMR dump support
607 CFG_CMD_IRQ * irqinfo
wdenk6705d812004-08-02 23:22:59 +0000608 CFG_CMD_ITEST Integer/string test of 2 values
wdenkba56f622004-02-06 23:19:44 +0000609 CFG_CMD_JFFS2 * JFFS2 Support
wdenkc6097192002-11-03 00:24:07 +0000610 CFG_CMD_KGDB * kgdb
611 CFG_CMD_LOADB loadb
612 CFG_CMD_LOADS loads
613 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
wdenk56523f12004-07-11 17:40:54 +0000614 loop, loopw, mtest
wdenkba56f622004-02-06 23:19:44 +0000615 CFG_CMD_MISC Misc functions like sleep etc
wdenk6705d812004-08-02 23:22:59 +0000616 CFG_CMD_MMC * MMC memory mapped support
617 CFG_CMD_MII * MII utility commands
wdenkba56f622004-02-06 23:19:44 +0000618 CFG_CMD_NAND * NAND support
wdenkc6097192002-11-03 00:24:07 +0000619 CFG_CMD_NET bootp, tftpboot, rarpboot
620 CFG_CMD_PCI * pciinfo
621 CFG_CMD_PCMCIA * PCMCIA support
wdenkba56f622004-02-06 23:19:44 +0000622 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
623 CFG_CMD_PORTIO * Port I/O
wdenkc6097192002-11-03 00:24:07 +0000624 CFG_CMD_REGINFO * Register dump
625 CFG_CMD_RUN run command in env variable
wdenk6705d812004-08-02 23:22:59 +0000626 CFG_CMD_SAVES * save S record dump
wdenkc6097192002-11-03 00:24:07 +0000627 CFG_CMD_SCSI * SCSI Support
wdenkba56f622004-02-06 23:19:44 +0000628 CFG_CMD_SDRAM * print SDRAM configuration information
wdenkc6097192002-11-03 00:24:07 +0000629 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
630 CFG_CMD_SPI * SPI serial bus support
631 CFG_CMD_USB * USB support
wdenkba56f622004-02-06 23:19:44 +0000632 CFG_CMD_VFD * VFD support (TRAB)
wdenkc6097192002-11-03 00:24:07 +0000633 CFG_CMD_BSP * Board SPecific functions
wdenka3d991b2004-04-15 21:48:45 +0000634 CFG_CMD_CDP * Cisco Discover Protocol support
wdenkc6097192002-11-03 00:24:07 +0000635 -----------------------------------------------
636 CFG_CMD_ALL all
637
wdenk81050922004-07-11 20:04:51 +0000638 CONFIG_CMD_DFL Default configuration; at the moment
wdenkc6097192002-11-03 00:24:07 +0000639 this is includes all commands, except
640 the ones marked with "*" in the list
641 above.
642
643 If you don't define CONFIG_COMMANDS it defaults to
wdenk81050922004-07-11 20:04:51 +0000644 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
wdenkc6097192002-11-03 00:24:07 +0000645 override the default settings in the respective
646 include file.
647
648 EXAMPLE: If you want all functions except of network
649 support you can write:
650
651 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
652
653
654 Note: Don't enable the "icache" and "dcache" commands
wdenk43d96162003-03-06 00:02:04 +0000655 (configuration option CFG_CMD_CACHE) unless you know
656 what you (and your U-Boot users) are doing. Data
657 cache cannot be enabled on systems like the 8xx or
658 8260 (where accesses to the IMMR region must be
659 uncached), and it cannot be disabled on all other
660 systems where we (mis-) use the data cache to hold an
661 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000662
663
664 XXX - this list needs to get updated!
665
666- Watchdog:
667 CONFIG_WATCHDOG
668 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000669 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000670 code for a watchdog. For the 8xx and 8260 CPUs, the
671 SIU Watchdog feature is enabled in the SYPCR
672 register.
673
stroesec1551ea2003-04-04 15:53:41 +0000674- U-Boot Version:
675 CONFIG_VERSION_VARIABLE
676 If this variable is defined, an environment variable
677 named "ver" is created by U-Boot showing the U-Boot
678 version as printed by the "version" command.
679 This variable is readonly.
680
wdenkc6097192002-11-03 00:24:07 +0000681- Real-Time Clock:
682
683 When CFG_CMD_DATE is selected, the type of the RTC
684 has to be selected, too. Define exactly one of the
685 following options:
686
687 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
688 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
689 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000690 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000691 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000692 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000693 CONFIG_RTC_DS164x - use Dallas DS164x RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000694 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
wdenkc6097192002-11-03 00:24:07 +0000695
wdenkb37c7e52003-06-30 16:24:52 +0000696 Note that if the RTC uses I2C, then the I2C interface
697 must also be configured. See I2C Support, below.
698
wdenkc6097192002-11-03 00:24:07 +0000699- Timestamp Support:
700
wdenk43d96162003-03-06 00:02:04 +0000701 When CONFIG_TIMESTAMP is selected, the timestamp
702 (date and time) of an image is printed by image
703 commands like bootm or iminfo. This option is
704 automatically enabled when you select CFG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000705
706- Partition Support:
707 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
708 and/or CONFIG_ISO_PARTITION
709
710 If IDE or SCSI support is enabled (CFG_CMD_IDE or
711 CFG_CMD_SCSI) you must configure support for at least
712 one partition type as well.
713
714- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000715 CONFIG_IDE_RESET_ROUTINE - this is defined in several
716 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000717
wdenk4d13cba2004-03-14 14:09:05 +0000718 CONFIG_IDE_RESET - is this is defined, IDE Reset will
719 be performed by calling the function
720 ide_set_reset(int reset)
721 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000722
723- ATAPI Support:
724 CONFIG_ATAPI
725
726 Set this to enable ATAPI support.
727
wdenkc40b2952004-03-13 23:29:43 +0000728- LBA48 Support
729 CONFIG_LBA48
730
731 Set this to enable support for disks larger than 137GB
732 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
733 Whithout these , LBA48 support uses 32bit variables and will 'only'
734 support disks up to 2.1TB.
735
736 CFG_64BIT_LBA:
737 When enabled, makes the IDE subsystem use 64bit sector addresses.
738 Default is 32bit.
739
wdenkc6097192002-11-03 00:24:07 +0000740- SCSI Support:
741 At the moment only there is only support for the
742 SYM53C8XX SCSI controller; define
743 CONFIG_SCSI_SYM53C8XX to enable it.
744
745 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
746 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
747 CFG_SCSI_MAX_LUN] can be adjusted to define the
748 maximum numbers of LUNs, SCSI ID's and target
749 devices.
750 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
751
752- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000753 CONFIG_E1000
754 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000755
wdenkc6097192002-11-03 00:24:07 +0000756 CONFIG_EEPRO100
757 Support for Intel 82557/82559/82559ER chips.
758 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
759 write routine for first time initialisation.
760
761 CONFIG_TULIP
762 Support for Digital 2114x chips.
763 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
764 modem chip initialisation (KS8761/QS6611).
765
766 CONFIG_NATSEMI
767 Support for National dp83815 chips.
768
769 CONFIG_NS8382X
770 Support for National dp8382[01] gigabit chips.
771
wdenk45219c42003-05-12 21:50:16 +0000772- NETWORK Support (other):
773
774 CONFIG_DRIVER_LAN91C96
775 Support for SMSC's LAN91C96 chips.
776
777 CONFIG_LAN91C96_BASE
778 Define this to hold the physical address
779 of the LAN91C96's I/O space
780
781 CONFIG_LAN91C96_USE_32_BIT
782 Define this to enable 32 bit addressing
783
wdenkf39748a2004-06-09 13:37:52 +0000784 CONFIG_DRIVER_SMC91111
785 Support for SMSC's LAN91C111 chip
786
787 CONFIG_SMC91111_BASE
788 Define this to hold the physical address
789 of the device (I/O space)
790
791 CONFIG_SMC_USE_32_BIT
792 Define this if data bus is 32 bits
793
794 CONFIG_SMC_USE_IOFUNCS
795 Define this to use i/o functions instead of macros
796 (some hardware wont work with macros)
797
wdenkc6097192002-11-03 00:24:07 +0000798- USB Support:
799 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000800 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000801 CONFIG_USB_UHCI to enable it.
802 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000803 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000804 storage devices.
805 Note:
806 Supported are USB Keyboards and USB Floppy drives
807 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000808 MPC5200 USB requires additional defines:
809 CONFIG_USB_CLOCK
810 for 528 MHz Clock: 0x0001bbbb
811 CONFIG_USB_CONFIG
812 for differential drivers: 0x00001000
813 for single ended drivers: 0x00005000
814
wdenkc6097192002-11-03 00:24:07 +0000815
wdenk71f95112003-06-15 22:40:42 +0000816- MMC Support:
wdenk8bde7f72003-06-27 21:31:46 +0000817 The MMC controller on the Intel PXA is supported. To
818 enable this define CONFIG_MMC. The MMC can be
819 accessed from the boot prompt by mapping the device
wdenk71f95112003-06-15 22:40:42 +0000820 to physical memory similar to flash. Command line is
821 enabled with CFG_CMD_MMC. The MMC driver also works with
wdenk8bde7f72003-06-27 21:31:46 +0000822 the FAT fs. This is enabled with CFG_CMD_FAT.
wdenk71f95112003-06-15 22:40:42 +0000823
wdenk6705d812004-08-02 23:22:59 +0000824- Journaling Flash filesystem support:
825 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
826 CONFIG_JFFS2_NAND_DEV
827 Define these for a default partition on a NAND device
828
829 CFG_JFFS2_FIRST_SECTOR,
830 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
831 Define these for a default partition on a NOR device
832
833 CFG_JFFS_CUSTOM_PART
834 Define this to create an own partition. You have to provide a
835 function struct part_info* jffs2_part_info(int part_num)
836
837 If you define only one JFFS2 partition you may also want to
838 #define CFG_JFFS_SINGLE_PART 1
839 to disable the command chpart. This is the default when you
840 have not defined a custom partition
841
wdenkc6097192002-11-03 00:24:07 +0000842- Keyboard Support:
843 CONFIG_ISA_KEYBOARD
844
845 Define this to enable standard (PC-Style) keyboard
846 support
847
848 CONFIG_I8042_KBD
849 Standard PC keyboard driver with US (is default) and
850 GERMAN key layout (switch via environment 'keymap=de') support.
851 Export function i8042_kbd_init, i8042_tstc and i8042_getc
852 for cfb_console. Supports cursor blinking.
853
854- Video support:
855 CONFIG_VIDEO
856
857 Define this to enable video support (for output to
858 video).
859
860 CONFIG_VIDEO_CT69000
861
862 Enable Chips & Technologies 69000 Video chip
863
864 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000865 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000866 video output is selected via environment 'videoout'
867 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
868 assumed.
wdenkc6097192002-11-03 00:24:07 +0000869
wdenkb79a11c2004-03-25 15:14:43 +0000870 For the CT69000 and SMI_LYNXEM drivers, videomode is
871 selected via environment 'videomode'. Two diferent ways
wdenkeeb1b772004-03-23 22:53:55 +0000872 are possible:
873 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000874 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000875
876 Colors 640x480 800x600 1024x768 1152x864 1280x1024
877 -------------+---------------------------------------------
878 8 bits | 0x301* 0x303 0x305 0x161 0x307
879 15 bits | 0x310 0x313 0x316 0x162 0x319
880 16 bits | 0x311 0x314 0x317 0x163 0x31A
881 24 bits | 0x312 0x315 0x318 ? 0x31B
882 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000883 (i.e. setenv videomode 317; saveenv; reset;)
884
wdenkb79a11c2004-03-25 15:14:43 +0000885 - "videomode=bootargs" all the video parameters are parsed
wdenkeeb1b772004-03-23 22:53:55 +0000886 from the bootargs. (See drivers/videomodes.c)
887
888
stroesec1551ea2003-04-04 15:53:41 +0000889 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +0000890 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +0000891 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
892 or CONFIG_VIDEO_SED13806_16BPP
893
wdenk682011f2003-06-03 23:54:09 +0000894- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +0000895 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +0000896
wdenk8bde7f72003-06-27 21:31:46 +0000897 Define this to enable a custom keyboard support.
898 This simply calls drv_keyboard_init() which must be
899 defined in your board-specific files.
900 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +0000901
wdenkc6097192002-11-03 00:24:07 +0000902- LCD Support: CONFIG_LCD
903
904 Define this to enable LCD support (for output to LCD
905 display); also select one of the supported displays
906 by defining one of these:
907
wdenkfd3103b2003-11-25 16:55:19 +0000908 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000909
wdenkfd3103b2003-11-25 16:55:19 +0000910 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000911
wdenkfd3103b2003-11-25 16:55:19 +0000912 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +0000913
wdenkfd3103b2003-11-25 16:55:19 +0000914 NEC NL6448BC20-08. 6.5", 640x480.
915 Active, color, single scan.
916
917 CONFIG_NEC_NL6448BC33_54
918
919 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000920 Active, color, single scan.
921
922 CONFIG_SHARP_16x9
923
924 Sharp 320x240. Active, color, single scan.
925 It isn't 16x9, and I am not sure what it is.
926
927 CONFIG_SHARP_LQ64D341
928
929 Sharp LQ64D341 display, 640x480.
930 Active, color, single scan.
931
932 CONFIG_HLD1045
933
934 HLD1045 display, 640x480.
935 Active, color, single scan.
936
937 CONFIG_OPTREX_BW
938
939 Optrex CBL50840-2 NF-FW 99 22 M5
940 or
941 Hitachi LMG6912RPFC-00T
942 or
943 Hitachi SP14Q002
944
945 320x240. Black & white.
946
947 Normally display is black on white background; define
948 CFG_WHITE_ON_BLACK to get it inverted.
949
wdenk7152b1d2003-09-05 23:19:14 +0000950- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +0000951
wdenk8bde7f72003-06-27 21:31:46 +0000952 If this option is set, the environment is checked for
953 a variable "splashimage". If found, the usual display
954 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +0000955 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +0000956 specified in "splashimage" is loaded instead. The
957 console is redirected to the "nulldev", too. This
958 allows for a "silent" boot where a splash screen is
959 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +0000960
wdenkc29fdfc2003-08-29 20:57:53 +0000961- Compression support:
962 CONFIG_BZIP2
963
964 If this option is set, support for bzip2 compressed
965 images is included. If not, only uncompressed and gzip
966 compressed images are supported.
967
wdenk42d1f032003-10-15 23:53:47 +0000968 NOTE: the bzip2 algorithm requires a lot of RAM, so
969 the malloc area (as defined by CFG_MALLOC_LEN) should
970 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +0000971
wdenk17ea1172004-06-06 21:51:03 +0000972- MII/PHY support:
973 CONFIG_PHY_ADDR
974
975 The address of PHY on MII bus.
976
977 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
978
979 The clock frequency of the MII bus
980
981 CONFIG_PHY_GIGE
982
983 If this option is set, support for speed/duplex
984 detection of Gigabit PHY is included.
985
986 CONFIG_PHY_RESET_DELAY
987
988 Some PHY like Intel LXT971A need extra delay after
989 reset before any MII register access is possible.
990 For such PHY, set this option to the usec delay
991 required. (minimum 300usec for LXT971A)
992
993 CONFIG_PHY_CMD_DELAY (ppc4xx)
994
995 Some PHY like Intel LXT971A need extra delay after
996 command issued before MII status register can be read
997
wdenkc6097192002-11-03 00:24:07 +0000998- Ethernet address:
999 CONFIG_ETHADDR
1000 CONFIG_ETH2ADDR
1001 CONFIG_ETH3ADDR
1002
1003 Define a default value for ethernet address to use
1004 for the respective ethernet interface, in case this
1005 is not determined automatically.
1006
1007- IP address:
1008 CONFIG_IPADDR
1009
1010 Define a default value for the IP address to use for
1011 the default ethernet interface, in case this is not
1012 determined through e.g. bootp.
1013
1014- Server IP address:
1015 CONFIG_SERVERIP
1016
1017 Defines a default value for theIP address of a TFTP
1018 server to contact when using the "tftboot" command.
1019
1020- BOOTP Recovery Mode:
1021 CONFIG_BOOTP_RANDOM_DELAY
1022
1023 If you have many targets in a network that try to
1024 boot using BOOTP, you may want to avoid that all
1025 systems send out BOOTP requests at precisely the same
1026 moment (which would happen for instance at recovery
1027 from a power failure, when all systems will try to
1028 boot, thus flooding the BOOTP server. Defining
1029 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1030 inserted before sending out BOOTP requests. The
1031 following delays are insterted then:
1032
1033 1st BOOTP request: delay 0 ... 1 sec
1034 2nd BOOTP request: delay 0 ... 2 sec
1035 3rd BOOTP request: delay 0 ... 4 sec
1036 4th and following
1037 BOOTP requests: delay 0 ... 8 sec
1038
stroesefe389a82003-08-28 14:17:32 +00001039- DHCP Advanced Options:
1040 CONFIG_BOOTP_MASK
1041
1042 You can fine tune the DHCP functionality by adding
1043 these flags to the CONFIG_BOOTP_MASK define:
1044
1045 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1046 serverip from a DHCP server, it is possible that more
1047 than one DNS serverip is offered to the client.
1048 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1049 serverip will be stored in the additional environment
1050 variable "dnsip2". The first DNS serverip is always
1051 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1052 is added to the CONFIG_BOOTP_MASK.
1053
1054 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1055 to do a dynamic update of a DNS server. To do this, they
1056 need the hostname of the DHCP requester.
1057 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1058 CONFIG_BOOTP_MASK, the content of the "hostname"
1059 environment variable is passed as option 12 to
1060 the DHCP server.
1061
wdenka3d991b2004-04-15 21:48:45 +00001062 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001063 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001064
1065 The device id used in CDP trigger frames.
1066
1067 CONFIG_CDP_DEVICE_ID_PREFIX
1068
1069 A two character string which is prefixed to the MAC address
1070 of the device.
1071
1072 CONFIG_CDP_PORT_ID
1073
1074 A printf format string which contains the ascii name of
1075 the port. Normally is set to "eth%d" which sets
1076 eth0 for the first ethernet, eth1 for the second etc.
1077
1078 CONFIG_CDP_CAPABILITIES
1079
1080 A 32bit integer which indicates the device capabilities;
1081 0x00000010 for a normal host which does not forwards.
1082
1083 CONFIG_CDP_VERSION
1084
1085 An ascii string containing the version of the software.
1086
1087 CONFIG_CDP_PLATFORM
1088
1089 An ascii string containing the name of the platform.
1090
1091 CONFIG_CDP_TRIGGER
1092
1093 A 32bit integer sent on the trigger.
1094
1095 CONFIG_CDP_POWER_CONSUMPTION
1096
1097 A 16bit integer containing the power consumption of the
1098 device in .1 of milliwatts.
1099
1100 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1101
1102 A byte containing the id of the VLAN.
1103
wdenkc6097192002-11-03 00:24:07 +00001104- Status LED: CONFIG_STATUS_LED
1105
1106 Several configurations allow to display the current
1107 status using a LED. For instance, the LED will blink
1108 fast while running U-Boot code, stop blinking as
1109 soon as a reply to a BOOTP request was received, and
1110 start blinking slow once the Linux kernel is running
1111 (supported by a status LED driver in the Linux
1112 kernel). Defining CONFIG_STATUS_LED enables this
1113 feature in U-Boot.
1114
1115- CAN Support: CONFIG_CAN_DRIVER
1116
1117 Defining CONFIG_CAN_DRIVER enables CAN driver support
1118 on those systems that support this (optional)
1119 feature, like the TQM8xxL modules.
1120
1121- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1122
wdenkb37c7e52003-06-30 16:24:52 +00001123 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001124 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1125 include the appropriate I2C driver for the selected cpu.
wdenkc6097192002-11-03 00:24:07 +00001126
wdenk945af8d2003-07-16 21:53:01 +00001127 This will allow you to use i2c commands at the u-boot
1128 command line (as long as you set CFG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001129 CONFIG_COMMANDS) and communicate with i2c based realtime
1130 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001131 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001132
wdenkba56f622004-02-06 23:19:44 +00001133 CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
wdenkc6097192002-11-03 00:24:07 +00001134
wdenk945af8d2003-07-16 21:53:01 +00001135 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001136 bit-banging) driver instead of CPM or similar hardware
1137 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001138
wdenk945af8d2003-07-16 21:53:01 +00001139 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001140 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001141
wdenkb37c7e52003-06-30 16:24:52 +00001142 In both cases you will need to define CFG_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001143 to be the frequency (in Hz) at which you wish your i2c bus
1144 to run and CFG_I2C_SLAVE to be the address of this node (ie
1145 the cpu's i2c node address).
1146
wdenkb37c7e52003-06-30 16:24:52 +00001147 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1148 sets the cpu up as a master node and so its address should
1149 therefore be cleared to 0 (See, eg, MPC823e User's Manual
wdenk945af8d2003-07-16 21:53:01 +00001150 p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001151
wdenk945af8d2003-07-16 21:53:01 +00001152 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001153
1154 If you use the software i2c interface (CONFIG_SOFT_I2C)
1155 then the following macros need to be defined (examples are
1156 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001157
1158 I2C_INIT
1159
wdenkb37c7e52003-06-30 16:24:52 +00001160 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001161 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001162
wdenkba56f622004-02-06 23:19:44 +00001163 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001164
wdenkc6097192002-11-03 00:24:07 +00001165 I2C_PORT
1166
wdenk43d96162003-03-06 00:02:04 +00001167 (Only for MPC8260 CPU). The I/O port to use (the code
1168 assumes both bits are on the same port). Valid values
1169 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001170
1171 I2C_ACTIVE
1172
1173 The code necessary to make the I2C data line active
1174 (driven). If the data line is open collector, this
1175 define can be null.
1176
wdenkb37c7e52003-06-30 16:24:52 +00001177 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1178
wdenkc6097192002-11-03 00:24:07 +00001179 I2C_TRISTATE
1180
1181 The code necessary to make the I2C data line tri-stated
1182 (inactive). If the data line is open collector, this
1183 define can be null.
1184
wdenkb37c7e52003-06-30 16:24:52 +00001185 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1186
wdenkc6097192002-11-03 00:24:07 +00001187 I2C_READ
1188
1189 Code that returns TRUE if the I2C data line is high,
1190 FALSE if it is low.
1191
wdenkb37c7e52003-06-30 16:24:52 +00001192 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1193
wdenkc6097192002-11-03 00:24:07 +00001194 I2C_SDA(bit)
1195
1196 If <bit> is TRUE, sets the I2C data line high. If it
1197 is FALSE, it clears it (low).
1198
wdenkb37c7e52003-06-30 16:24:52 +00001199 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001200 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001201 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001202
wdenkc6097192002-11-03 00:24:07 +00001203 I2C_SCL(bit)
1204
1205 If <bit> is TRUE, sets the I2C clock line high. If it
1206 is FALSE, it clears it (low).
1207
wdenkb37c7e52003-06-30 16:24:52 +00001208 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001209 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001210 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001211
wdenkc6097192002-11-03 00:24:07 +00001212 I2C_DELAY
1213
1214 This delay is invoked four times per clock cycle so this
1215 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001216 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001217 like:
1218
wdenkb37c7e52003-06-30 16:24:52 +00001219 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001220
wdenk47cd00f2003-03-06 13:39:27 +00001221 CFG_I2C_INIT_BOARD
1222
wdenk8bde7f72003-06-27 21:31:46 +00001223 When a board is reset during an i2c bus transfer
1224 chips might think that the current transfer is still
1225 in progress. On some boards it is possible to access
1226 the i2c SCLK line directly, either by using the
1227 processor pin as a GPIO or by having a second pin
1228 connected to the bus. If this option is defined a
1229 custom i2c_init_board() routine in boards/xxx/board.c
1230 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001231
wdenk17ea1172004-06-06 21:51:03 +00001232 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1233
1234 This option enables configuration of bi_iic_fast[] flags
1235 in u-boot bd_info structure based on u-boot environment
1236 variable "i2cfast". (see also i2cfast)
1237
wdenkc6097192002-11-03 00:24:07 +00001238- SPI Support: CONFIG_SPI
1239
1240 Enables SPI driver (so far only tested with
1241 SPI EEPROM, also an instance works with Crystal A/D and
1242 D/As on the SACSng board)
1243
1244 CONFIG_SPI_X
1245
1246 Enables extended (16-bit) SPI EEPROM addressing.
1247 (symmetrical to CONFIG_I2C_X)
1248
1249 CONFIG_SOFT_SPI
1250
wdenk43d96162003-03-06 00:02:04 +00001251 Enables a software (bit-bang) SPI driver rather than
1252 using hardware support. This is a general purpose
1253 driver that only requires three general I/O port pins
1254 (two outputs, one input) to function. If this is
1255 defined, the board configuration must define several
1256 SPI configuration items (port pins to use, etc). For
1257 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001258
1259- FPGA Support: CONFIG_FPGA_COUNT
1260
wdenk43d96162003-03-06 00:02:04 +00001261 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001262
wdenk43d96162003-03-06 00:02:04 +00001263 CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001264
wdenk8bde7f72003-06-27 21:31:46 +00001265 Used to specify the types of FPGA devices. For example,
1266 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
wdenkc6097192002-11-03 00:24:07 +00001267
wdenk8bde7f72003-06-27 21:31:46 +00001268 CFG_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001269
wdenk8bde7f72003-06-27 21:31:46 +00001270 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001271
1272 CFG_FPGA_CHECK_BUSY
1273
wdenk43d96162003-03-06 00:02:04 +00001274 Enable checks on FPGA configuration interface busy
1275 status by the configuration function. This option
1276 will require a board or device specific function to
1277 be written.
wdenkc6097192002-11-03 00:24:07 +00001278
1279 CONFIG_FPGA_DELAY
1280
1281 If defined, a function that provides delays in the FPGA
1282 configuration driver.
1283
1284 CFG_FPGA_CHECK_CTRLC
1285 Allow Control-C to interrupt FPGA configuration
1286
1287 CFG_FPGA_CHECK_ERROR
1288
wdenk43d96162003-03-06 00:02:04 +00001289 Check for configuration errors during FPGA bitfile
1290 loading. For example, abort during Virtex II
1291 configuration if the INIT_B line goes low (which
1292 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001293
1294 CFG_FPGA_WAIT_INIT
1295
wdenk43d96162003-03-06 00:02:04 +00001296 Maximum time to wait for the INIT_B line to deassert
1297 after PROB_B has been deasserted during a Virtex II
1298 FPGA configuration sequence. The default time is 500
1299 mS.
wdenkc6097192002-11-03 00:24:07 +00001300
1301 CFG_FPGA_WAIT_BUSY
1302
wdenk43d96162003-03-06 00:02:04 +00001303 Maximum time to wait for BUSY to deassert during
1304 Virtex II FPGA configuration. The default is 5 mS.
wdenkc6097192002-11-03 00:24:07 +00001305
1306 CFG_FPGA_WAIT_CONFIG
1307
wdenk43d96162003-03-06 00:02:04 +00001308 Time to wait after FPGA configuration. The default is
1309 200 mS.
wdenkc6097192002-11-03 00:24:07 +00001310
1311- Configuration Management:
1312 CONFIG_IDENT_STRING
1313
wdenk43d96162003-03-06 00:02:04 +00001314 If defined, this string will be added to the U-Boot
1315 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001316
1317- Vendor Parameter Protection:
1318
wdenk43d96162003-03-06 00:02:04 +00001319 U-Boot considers the values of the environment
1320 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001321 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001322 are set once by the board vendor / manufacturer, and
1323 protects these variables from casual modification by
1324 the user. Once set, these variables are read-only,
1325 and write or delete attempts are rejected. You can
1326 change this behviour:
wdenkc6097192002-11-03 00:24:07 +00001327
1328 If CONFIG_ENV_OVERWRITE is #defined in your config
1329 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001330 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001331 these parameters.
1332
1333 Alternatively, if you #define _both_ CONFIG_ETHADDR
1334 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1335 ethernet address is installed in the environment,
1336 which can be changed exactly ONCE by the user. [The
1337 serial# is unaffected by this, i. e. it remains
1338 read-only.]
1339
1340- Protected RAM:
1341 CONFIG_PRAM
1342
1343 Define this variable to enable the reservation of
1344 "protected RAM", i. e. RAM which is not overwritten
1345 by U-Boot. Define CONFIG_PRAM to hold the number of
1346 kB you want to reserve for pRAM. You can overwrite
1347 this default value by defining an environment
1348 variable "pram" to the number of kB you want to
1349 reserve. Note that the board info structure will
1350 still show the full amount of RAM. If pRAM is
1351 reserved, a new environment variable "mem" will
1352 automatically be defined to hold the amount of
1353 remaining RAM in a form that can be passed as boot
1354 argument to Linux, for instance like that:
1355
1356 setenv bootargs ... mem=\$(mem)
1357 saveenv
1358
1359 This way you can tell Linux not to use this memory,
1360 either, which results in a memory region that will
1361 not be affected by reboots.
1362
1363 *WARNING* If your board configuration uses automatic
1364 detection of the RAM size, you must make sure that
1365 this memory test is non-destructive. So far, the
1366 following board configurations are known to be
1367 "pRAM-clean":
1368
1369 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1370 HERMES, IP860, RPXlite, LWMON, LANTEC,
1371 PCU_E, FLAGADM, TQM8260
1372
1373- Error Recovery:
1374 CONFIG_PANIC_HANG
1375
1376 Define this variable to stop the system in case of a
1377 fatal error, so that you have to reset it manually.
1378 This is probably NOT a good idea for an embedded
1379 system where you want to system to reboot
1380 automatically as fast as possible, but it may be
1381 useful during development since you can try to debug
1382 the conditions that lead to the situation.
1383
1384 CONFIG_NET_RETRY_COUNT
1385
wdenk43d96162003-03-06 00:02:04 +00001386 This variable defines the number of retries for
1387 network operations like ARP, RARP, TFTP, or BOOTP
1388 before giving up the operation. If not defined, a
1389 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001390
1391- Command Interpreter:
wdenk04a85b32004-04-15 18:22:41 +00001392 CFG_AUTO_COMPLETE
1393
1394 Enable auto completion of commands using TAB.
1395
wdenkc6097192002-11-03 00:24:07 +00001396 CFG_HUSH_PARSER
1397
1398 Define this variable to enable the "hush" shell (from
1399 Busybox) as command line interpreter, thus enabling
1400 powerful command line syntax like
1401 if...then...else...fi conditionals or `&&' and '||'
1402 constructs ("shell scripts").
1403
1404 If undefined, you get the old, much simpler behaviour
1405 with a somewhat smaller memory footprint.
1406
1407
1408 CFG_PROMPT_HUSH_PS2
1409
1410 This defines the secondary prompt string, which is
1411 printed when the command interpreter needs more input
1412 to complete a command. Usually "> ".
1413
1414 Note:
1415
wdenk8bde7f72003-06-27 21:31:46 +00001416 In the current implementation, the local variables
1417 space and global environment variables space are
1418 separated. Local variables are those you define by
1419 simply typing `name=value'. To access a local
1420 variable later on, you have write `$name' or
1421 `${name}'; to execute the contents of a variable
1422 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001423
wdenk43d96162003-03-06 00:02:04 +00001424 Global environment variables are those you use
1425 setenv/printenv to work with. To run a command stored
1426 in such a variable, you need to use the run command,
1427 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001428
1429 To store commands and special characters in a
1430 variable, please use double quotation marks
1431 surrounding the whole text of the variable, instead
1432 of the backslashes before semicolons and special
1433 symbols.
1434
wdenka8c7c702003-12-06 19:49:23 +00001435- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001436 CONFIG_EXTRA_ENV_SETTINGS
1437
wdenk43d96162003-03-06 00:02:04 +00001438 Define this to contain any number of null terminated
1439 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001440 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001441
wdenk43d96162003-03-06 00:02:04 +00001442 For example, place something like this in your
1443 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001444
1445 #define CONFIG_EXTRA_ENV_SETTINGS \
1446 "myvar1=value1\0" \
1447 "myvar2=value2\0"
1448
wdenk43d96162003-03-06 00:02:04 +00001449 Warning: This method is based on knowledge about the
1450 internal format how the environment is stored by the
1451 U-Boot code. This is NOT an official, exported
1452 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001453 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001454 You better know what you are doing here.
1455
wdenk43d96162003-03-06 00:02:04 +00001456 Note: overly (ab)use of the default environment is
1457 discouraged. Make sure to check other ways to preset
1458 the environment like the autoscript function or the
1459 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001460
wdenka8c7c702003-12-06 19:49:23 +00001461- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001462 CONFIG_HAS_DATAFLASH
1463
wdenk8bde7f72003-06-27 21:31:46 +00001464 Defining this option enables DataFlash features and
1465 allows to read/write in Dataflash via the standard
1466 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001467
wdenk3f85ce22004-02-23 16:11:30 +00001468- SystemACE Support:
1469 CONFIG_SYSTEMACE
1470
1471 Adding this option adds support for Xilinx SystemACE
1472 chips attached via some sort of local bus. The address
1473 of the chip must alsh be defined in the
1474 CFG_SYSTEMACE_BASE macro. For example:
1475
1476 #define CONFIG_SYSTEMACE
1477 #define CFG_SYSTEMACE_BASE 0xf0000000
1478
1479 When SystemACE support is added, the "ace" device type
1480 becomes available to the fat commands, i.e. fatls.
1481
wdenka8c7c702003-12-06 19:49:23 +00001482- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001483 CONFIG_SHOW_BOOT_PROGRESS
1484
wdenk43d96162003-03-06 00:02:04 +00001485 Defining this option allows to add some board-
1486 specific code (calling a user-provided function
1487 "show_boot_progress(int)") that enables you to show
1488 the system's boot progress on some display (for
1489 example, some LED's) on your board. At the moment,
1490 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001491
1492 Arg Where When
1493 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001494 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001495 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001496 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001497 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001498 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001499 4 common/cmd_bootm.c Image data has correct checksum
1500 -4 common/cmd_bootm.c Image is for unsupported architecture
1501 5 common/cmd_bootm.c Architecture check OK
1502 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1503 6 common/cmd_bootm.c Image Type check OK
1504 -6 common/cmd_bootm.c gunzip uncompression error
1505 -7 common/cmd_bootm.c Unimplemented compression type
1506 7 common/cmd_bootm.c Uncompression OK
1507 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1508 8 common/cmd_bootm.c Image Type check OK
1509 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1510 9 common/cmd_bootm.c Start initial ramdisk verification
wdenkba56f622004-02-06 23:19:44 +00001511 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1512 -11 common/cmd_bootm.c Ramdisk header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001513 10 common/cmd_bootm.c Ramdisk header is OK
wdenkba56f622004-02-06 23:19:44 +00001514 -12 common/cmd_bootm.c Ramdisk data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001515 11 common/cmd_bootm.c Ramdisk data has correct checksum
1516 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1517 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1518 13 common/cmd_bootm.c Start multifile image verification
1519 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1520 15 common/cmd_bootm.c All preparation done, transferring control to OS
1521
wdenk11dadd52004-02-27 00:07:27 +00001522 -30 lib_ppc/board.c Fatal error, hang the system
1523 -31 post/post.c POST test failed, detected by post_output_backlog()
1524 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001525
wdenkc6097192002-11-03 00:24:07 +00001526 -1 common/cmd_doc.c Bad usage of "doc" command
1527 -1 common/cmd_doc.c No boot device
1528 -1 common/cmd_doc.c Unknown Chip ID on boot device
1529 -1 common/cmd_doc.c Read Error on boot device
1530 -1 common/cmd_doc.c Image header has bad magic number
1531
1532 -1 common/cmd_ide.c Bad usage of "ide" command
1533 -1 common/cmd_ide.c No boot device
1534 -1 common/cmd_ide.c Unknown boot device
1535 -1 common/cmd_ide.c Unknown partition table
1536 -1 common/cmd_ide.c Invalid partition type
1537 -1 common/cmd_ide.c Read Error on boot device
1538 -1 common/cmd_ide.c Image header has bad magic number
1539
wdenk206c60c2003-09-18 10:02:25 +00001540 -1 common/cmd_nand.c Bad usage of "nand" command
1541 -1 common/cmd_nand.c No boot device
1542 -1 common/cmd_nand.c Unknown Chip ID on boot device
1543 -1 common/cmd_nand.c Read Error on boot device
1544 -1 common/cmd_nand.c Image header has bad magic number
1545
wdenkba56f622004-02-06 23:19:44 +00001546 -1 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001547
1548
1549Modem Support:
1550--------------
1551
wdenk85ec0bc2003-03-31 16:34:49 +00001552[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001553
1554- Modem support endable:
1555 CONFIG_MODEM_SUPPORT
1556
1557- RTS/CTS Flow control enable:
1558 CONFIG_HWFLOW
1559
1560- Modem debug support:
1561 CONFIG_MODEM_SUPPORT_DEBUG
1562
wdenk43d96162003-03-06 00:02:04 +00001563 Enables debugging stuff (char screen[1024], dbg())
1564 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001565
wdenka8c7c702003-12-06 19:49:23 +00001566- Interrupt support (PPC):
1567
wdenkd4ca31c2004-01-02 14:00:00 +00001568 There are common interrupt_init() and timer_interrupt()
1569 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1570 for cpu specific initialization. interrupt_init_cpu()
1571 should set decrementer_count to appropriate value. If
1572 cpu resets decrementer automatically after interrupt
1573 (ppc4xx) it should set decrementer_count to zero.
1574 timer_interrupt() calls timer_interrupt_cpu() for cpu
1575 specific handling. If board has watchdog / status_led
1576 / other_activity_monitor it works automatically from
1577 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001578
wdenkc6097192002-11-03 00:24:07 +00001579- General:
1580
wdenk43d96162003-03-06 00:02:04 +00001581 In the target system modem support is enabled when a
1582 specific key (key combination) is pressed during
1583 power-on. Otherwise U-Boot will boot normally
1584 (autoboot). The key_pressed() fuction is called from
1585 board_init(). Currently key_pressed() is a dummy
1586 function, returning 1 and thus enabling modem
1587 initialization.
wdenkc6097192002-11-03 00:24:07 +00001588
wdenk43d96162003-03-06 00:02:04 +00001589 If there are no modem init strings in the
1590 environment, U-Boot proceed to autoboot; the
1591 previous output (banner, info printfs) will be
1592 supressed, though.
wdenkc6097192002-11-03 00:24:07 +00001593
1594 See also: doc/README.Modem
1595
1596
wdenkc6097192002-11-03 00:24:07 +00001597Configuration Settings:
1598-----------------------
1599
1600- CFG_LONGHELP: Defined when you want long help messages included;
1601 undefine this when you're short of memory.
1602
1603- CFG_PROMPT: This is what U-Boot prints on the console to
1604 prompt for user input.
1605
1606- CFG_CBSIZE: Buffer size for input from the Console
1607
1608- CFG_PBSIZE: Buffer size for Console output
1609
1610- CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1611
1612- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1613 the application (usually a Linux kernel) when it is
1614 booted
1615
1616- CFG_BAUDRATE_TABLE:
1617 List of legal baudrate settings for this board.
1618
1619- CFG_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00001620 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00001621
1622- CFG_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00001623 If the board specific function
1624 extern int overwrite_console (void);
1625 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00001626 serial port, else the settings in the environment are used.
1627
1628- CFG_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00001629 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00001630
1631- CFG_CONSOLE_ENV_OVERWRITE
1632 Enable overwrite of previous console environment settings.
1633
1634- CFG_MEMTEST_START, CFG_MEMTEST_END:
1635 Begin and End addresses of the area used by the
1636 simple memory test.
1637
1638- CFG_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00001639 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00001640
wdenk5f535fe2003-09-18 09:21:33 +00001641- CFG_MEMTEST_SCRATCH:
1642 Scratch address used by the alternate memory test
1643 You only need to set this if address zero isn't writeable
1644
wdenkc6097192002-11-03 00:24:07 +00001645- CFG_TFTP_LOADADDR:
1646 Default load address for network file downloads
1647
1648- CFG_LOADS_BAUD_CHANGE:
1649 Enable temporary baudrate change while serial download
1650
1651- CFG_SDRAM_BASE:
1652 Physical start address of SDRAM. _Must_ be 0 here.
1653
1654- CFG_MBIO_BASE:
1655 Physical start address of Motherboard I/O (if using a
1656 Cogent motherboard)
1657
1658- CFG_FLASH_BASE:
1659 Physical start address of Flash memory.
1660
1661- CFG_MONITOR_BASE:
1662 Physical start address of boot monitor code (set by
1663 make config files to be same as the text base address
1664 (TEXT_BASE) used when linking) - same as
1665 CFG_FLASH_BASE when booting from flash.
1666
1667- CFG_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00001668 Size of memory reserved for monitor code, used to
1669 determine _at_compile_time_ (!) if the environment is
1670 embedded within the U-Boot image, or in a separate
1671 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001672
1673- CFG_MALLOC_LEN:
1674 Size of DRAM reserved for malloc() use.
1675
1676- CFG_BOOTMAPSZ:
1677 Maximum size of memory mapped by the startup code of
1678 the Linux kernel; all data that must be processed by
1679 the Linux kernel (bd_info, boot arguments, eventually
1680 initrd image) must be put below this limit.
1681
1682- CFG_MAX_FLASH_BANKS:
1683 Max number of Flash memory banks
1684
1685- CFG_MAX_FLASH_SECT:
1686 Max number of sectors on a Flash chip
1687
1688- CFG_FLASH_ERASE_TOUT:
1689 Timeout for Flash erase operations (in ms)
1690
1691- CFG_FLASH_WRITE_TOUT:
1692 Timeout for Flash write operations (in ms)
1693
wdenk8564acf2003-07-14 22:13:32 +00001694- CFG_FLASH_LOCK_TOUT
1695 Timeout for Flash set sector lock bit operation (in ms)
1696
1697- CFG_FLASH_UNLOCK_TOUT
1698 Timeout for Flash clear lock bits operation (in ms)
1699
1700- CFG_FLASH_PROTECTION
1701 If defined, hardware flash sectors protection is used
1702 instead of U-Boot software protection.
1703
wdenkc6097192002-11-03 00:24:07 +00001704- CFG_DIRECT_FLASH_TFTP:
1705
1706 Enable TFTP transfers directly to flash memory;
1707 without this option such a download has to be
1708 performed in two steps: (1) download to RAM, and (2)
1709 copy from RAM to flash.
1710
1711 The two-step approach is usually more reliable, since
1712 you can check if the download worked before you erase
1713 the flash, but in some situations (when sytem RAM is
1714 too limited to allow for a tempory copy of the
1715 downloaded image) this option may be very useful.
1716
1717- CFG_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00001718 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00001719 common flash structure for storing flash geometry.
1720
1721- CFG_FLASH_CFI_DRIVER
1722 This option also enables the building of the cfi_flash driver
1723 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001724
stroese53cf9432003-06-05 15:39:44 +00001725- CFG_RX_ETH_BUFFER:
1726 Defines the number of ethernet receive buffers. On some
1727 ethernet controllers it is recommended to set this value
1728 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1729 buffers can be full shortly after enabling the interface
1730 on high ethernet traffic.
1731 Defaults to 4 if not defined.
1732
wdenkc6097192002-11-03 00:24:07 +00001733The following definitions that deal with the placement and management
1734of environment data (variable area); in general, we support the
1735following configurations:
1736
1737- CFG_ENV_IS_IN_FLASH:
1738
1739 Define this if the environment is in flash memory.
1740
1741 a) The environment occupies one whole flash sector, which is
1742 "embedded" in the text segment with the U-Boot code. This
1743 happens usually with "bottom boot sector" or "top boot
1744 sector" type flash chips, which have several smaller
1745 sectors at the start or the end. For instance, such a
1746 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1747 such a case you would place the environment in one of the
1748 4 kB sectors - with U-Boot code before and after it. With
1749 "top boot sector" type flash chips, you would put the
1750 environment in one of the last sectors, leaving a gap
1751 between U-Boot and the environment.
1752
1753 - CFG_ENV_OFFSET:
1754
1755 Offset of environment data (variable area) to the
1756 beginning of flash memory; for instance, with bottom boot
1757 type flash chips the second sector can be used: the offset
1758 for this sector is given here.
1759
1760 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1761
1762 - CFG_ENV_ADDR:
1763
1764 This is just another way to specify the start address of
1765 the flash sector containing the environment (instead of
1766 CFG_ENV_OFFSET).
1767
1768 - CFG_ENV_SECT_SIZE:
1769
1770 Size of the sector containing the environment.
1771
1772
1773 b) Sometimes flash chips have few, equal sized, BIG sectors.
1774 In such a case you don't want to spend a whole sector for
1775 the environment.
1776
1777 - CFG_ENV_SIZE:
1778
1779 If you use this in combination with CFG_ENV_IS_IN_FLASH
1780 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1781 of this flash sector for the environment. This saves
1782 memory for the RAM copy of the environment.
1783
1784 It may also save flash memory if you decide to use this
1785 when your environment is "embedded" within U-Boot code,
1786 since then the remainder of the flash sector could be used
1787 for U-Boot code. It should be pointed out that this is
1788 STRONGLY DISCOURAGED from a robustness point of view:
1789 updating the environment in flash makes it always
1790 necessary to erase the WHOLE sector. If something goes
1791 wrong before the contents has been restored from a copy in
1792 RAM, your target system will be dead.
1793
1794 - CFG_ENV_ADDR_REDUND
1795 CFG_ENV_SIZE_REDUND
1796
wdenk43d96162003-03-06 00:02:04 +00001797 These settings describe a second storage area used to hold
1798 a redundand copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00001799 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00001800 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00001801
1802BE CAREFUL! Any changes to the flash layout, and some changes to the
1803source code will make it necessary to adapt <board>/u-boot.lds*
1804accordingly!
1805
1806
1807- CFG_ENV_IS_IN_NVRAM:
1808
1809 Define this if you have some non-volatile memory device
1810 (NVRAM, battery buffered SRAM) which you want to use for the
1811 environment.
1812
1813 - CFG_ENV_ADDR:
1814 - CFG_ENV_SIZE:
1815
1816 These two #defines are used to determin the memory area you
1817 want to use for environment. It is assumed that this memory
1818 can just be read and written to, without any special
1819 provision.
1820
1821BE CAREFUL! The first access to the environment happens quite early
1822in U-Boot initalization (when we try to get the setting of for the
1823console baudrate). You *MUST* have mappend your NVRAM area then, or
1824U-Boot will hang.
1825
1826Please note that even with NVRAM we still use a copy of the
1827environment in RAM: we could work on NVRAM directly, but we want to
1828keep settings there always unmodified except somebody uses "saveenv"
1829to save the current settings.
1830
1831
1832- CFG_ENV_IS_IN_EEPROM:
1833
1834 Use this if you have an EEPROM or similar serial access
1835 device and a driver for it.
1836
1837 - CFG_ENV_OFFSET:
1838 - CFG_ENV_SIZE:
1839
1840 These two #defines specify the offset and size of the
1841 environment area within the total memory of your EEPROM.
1842
1843 - CFG_I2C_EEPROM_ADDR:
1844 If defined, specified the chip address of the EEPROM device.
1845 The default address is zero.
1846
1847 - CFG_EEPROM_PAGE_WRITE_BITS:
1848 If defined, the number of bits used to address bytes in a
1849 single page in the EEPROM device. A 64 byte page, for example
1850 would require six bits.
1851
1852 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1853 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00001854 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00001855
1856 - CFG_I2C_EEPROM_ADDR_LEN:
1857 The length in bytes of the EEPROM memory array address. Note
1858 that this is NOT the chip address length!
1859
wdenk5cf91d62004-04-23 20:32:05 +00001860 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
1861 EEPROM chips that implement "address overflow" are ones
1862 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
1863 address and the extra bits end up in the "chip address" bit
1864 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
1865 byte chips.
1866
1867 Note that we consider the length of the address field to
1868 still be one byte because the extra address bits are hidden
1869 in the chip address.
1870
wdenkc6097192002-11-03 00:24:07 +00001871 - CFG_EEPROM_SIZE:
1872 The size in bytes of the EEPROM device.
1873
wdenkc6097192002-11-03 00:24:07 +00001874
wdenk5779d8d2003-12-06 23:55:10 +00001875- CFG_ENV_IS_IN_DATAFLASH:
1876
wdenkd4ca31c2004-01-02 14:00:00 +00001877 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00001878 want to use for the environment.
1879
1880 - CFG_ENV_OFFSET:
1881 - CFG_ENV_ADDR:
1882 - CFG_ENV_SIZE:
1883
1884 These three #defines specify the offset and size of the
1885 environment area within the total memory of your DataFlash placed
1886 at the specified address.
1887
wdenk13a56952004-06-09 14:58:14 +00001888- CFG_ENV_IS_IN_NAND:
1889
1890 Define this if you have a NAND device which you want to use
1891 for the environment.
1892
1893 - CFG_ENV_OFFSET:
1894 - CFG_ENV_SIZE:
1895
1896 These two #defines specify the offset and size of the environment
1897 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00001898
wdenkc6097192002-11-03 00:24:07 +00001899- CFG_SPI_INIT_OFFSET
1900
1901 Defines offset to the initial SPI buffer area in DPRAM. The
1902 area is used at an early stage (ROM part) if the environment
1903 is configured to reside in the SPI EEPROM: We need a 520 byte
1904 scratch DPRAM area. It is used between the two initialization
1905 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1906 to be a good choice since it makes it far enough from the
1907 start of the data area as well as from the stack pointer.
1908
1909Please note that the environment is read-only as long as the monitor
1910has been relocated to RAM and a RAM copy of the environment has been
1911created; also, when using EEPROM you will have to use getenv_r()
1912until then to read environment variables.
1913
wdenk85ec0bc2003-03-31 16:34:49 +00001914The environment is protected by a CRC32 checksum. Before the monitor
1915is relocated into RAM, as a result of a bad CRC you will be working
1916with the compiled-in default environment - *silently*!!! [This is
1917necessary, because the first environment variable we need is the
1918"baudrate" setting for the console - if we have a bad CRC, we don't
1919have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00001920
1921Note: once the monitor has been relocated, then it will complain if
1922the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00001923use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00001924
wdenkfc3e2162003-10-08 22:33:00 +00001925- CFG_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00001926 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00001927
1928 Note: If this option is active, then CFG_FAULT_MII_ADDR
1929 also needs to be defined.
1930
1931- CFG_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00001932 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00001933
wdenkc40b2952004-03-13 23:29:43 +00001934- CFG_64BIT_VSPRINTF:
1935 Makes vsprintf (and all *printf functions) support printing
1936 of 64bit values by using the L quantifier
1937
1938- CFG_64BIT_STRTOUL:
1939 Adds simple_strtoull that returns a 64bit value
1940
wdenkc6097192002-11-03 00:24:07 +00001941Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00001942---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001943
1944- CFG_CACHELINE_SIZE:
1945 Cache Line Size of the CPU.
1946
1947- CFG_DEFAULT_IMMR:
1948 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00001949
wdenk42d1f032003-10-15 23:53:47 +00001950 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
1951 and RPXsuper) to be able to adjust the position of
1952 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00001953
wdenk7f6c2cb2002-11-10 22:06:23 +00001954- Floppy Disk Support:
1955 CFG_FDC_DRIVE_NUMBER
1956
1957 the default drive number (default value 0)
1958
1959 CFG_ISA_IO_STRIDE
1960
1961 defines the spacing between fdc chipset registers
1962 (default value 1)
1963
1964 CFG_ISA_IO_OFFSET
1965
wdenk43d96162003-03-06 00:02:04 +00001966 defines the offset of register from address. It
1967 depends on which part of the data bus is connected to
1968 the fdc chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00001969
wdenk43d96162003-03-06 00:02:04 +00001970 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
1971 CFG_FDC_DRIVE_NUMBER are undefined, they take their
1972 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00001973
wdenk43d96162003-03-06 00:02:04 +00001974 if CFG_FDC_HW_INIT is defined, then the function
1975 fdc_hw_init() is called at the beginning of the FDC
1976 setup. fdc_hw_init() must be provided by the board
1977 source code. It is used to make hardware dependant
1978 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00001979
wdenk25d67122004-12-10 11:40:40 +00001980- CFG_IMMR: Physical address of the Internal Memory.
1981 DO NOT CHANGE unless you know exactly what you're
1982 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00001983
1984- CFG_INIT_RAM_ADDR:
1985
wdenk7152b1d2003-09-05 23:19:14 +00001986 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00001987 initial data and stack; please note that this must be
1988 writable memory that is working WITHOUT special
1989 initialization, i. e. you CANNOT use normal RAM which
1990 will become available only after programming the
1991 memory controller and running certain initialization
1992 sequences.
1993
1994 U-Boot uses the following memory types:
1995 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
1996 - MPC824X: data cache
1997 - PPC4xx: data cache
1998
wdenk85ec0bc2003-03-31 16:34:49 +00001999- CFG_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002000
2001 Offset of the initial data structure in the memory
2002 area defined by CFG_INIT_RAM_ADDR. Usually
wdenk85ec0bc2003-03-31 16:34:49 +00002003 CFG_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002004 data is located at the end of the available space
2005 (sometimes written as (CFG_INIT_RAM_END -
2006 CFG_INIT_DATA_SIZE), and the initial stack is just
2007 below that area (growing from (CFG_INIT_RAM_ADDR +
wdenk85ec0bc2003-03-31 16:34:49 +00002008 CFG_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002009
2010 Note:
2011 On the MPC824X (or other systems that use the data
2012 cache for initial memory) the address chosen for
2013 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2014 point to an otherwise UNUSED address space between
2015 the top of RAM and the start of the PCI space.
2016
2017- CFG_SIUMCR: SIU Module Configuration (11-6)
2018
2019- CFG_SYPCR: System Protection Control (11-9)
2020
2021- CFG_TBSCR: Time Base Status and Control (11-26)
2022
2023- CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2024
2025- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2026
2027- CFG_SCCR: System Clock and reset Control Register (15-27)
2028
2029- CFG_OR_TIMING_SDRAM:
2030 SDRAM timing
2031
2032- CFG_MAMR_PTA:
2033 periodic timer for refresh
2034
2035- CFG_DER: Debug Event Register (37-47)
2036
2037- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2038 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2039 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2040 CFG_BR1_PRELIM:
2041 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2042
2043- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2044 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2045 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2046 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2047
2048- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2049 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2050 Machine Mode Register and Memory Periodic Timer
2051 Prescaler definitions (SDRAM timing)
2052
2053- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2054 enable I2C microcode relocation patch (MPC8xx);
2055 define relocation offset in DPRAM [DSP2]
2056
2057- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2058 enable SPI microcode relocation patch (MPC8xx);
2059 define relocation offset in DPRAM [SCC4]
2060
2061- CFG_USE_OSCCLK:
2062 Use OSCM clock mode on MBX8xx board. Be careful,
2063 wrong setting might damage your board. Read
2064 doc/README.MBX before setting this variable!
2065
wdenkea909b72002-11-21 23:11:29 +00002066- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002067 Offset of the bootmode word in DPRAM used by post
2068 (Power On Self Tests). This definition overrides
2069 #define'd default value in commproc.h resp.
2070 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002071
stroese1d49b1f2003-05-23 11:39:05 +00002072- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2073 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2074 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2075 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2076 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2077 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2078 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
wdenk5d232d02003-05-22 22:52:13 +00002079 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2080 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2081
wdenkc26e4542004-04-18 10:13:26 +00002082- CONFIG_ETHER_ON_FEC[12]
2083 Define to enable FEC[12] on a 8xx series processor.
2084
2085- CONFIG_FEC[12]_PHY
2086 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002087 to the given FEC; i. e.
2088 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002089 means that the PHY with address 4 is connected to FEC1
2090
2091 When set to -1, means to probe for first available.
2092
2093- CONFIG_FEC[12]_PHY_NORXERR
2094 The PHY does not have a RXERR line (RMII only).
2095 (so program the FEC to ignore it).
2096
2097- CONFIG_RMII
2098 Enable RMII mode for all FECs.
2099 Note that this is a global option, we can't
2100 have one FEC in standard MII mode and another in RMII mode.
2101
wdenk5cf91d62004-04-23 20:32:05 +00002102- CONFIG_CRC32_VERIFY
2103 Add a verify option to the crc32 command.
2104 The syntax is:
2105
2106 => crc32 -v <address> <count> <crc32>
2107
2108 Where address/count indicate a memory area
2109 and crc32 is the correct crc32 which the
2110 area should have.
2111
wdenk56523f12004-07-11 17:40:54 +00002112- CONFIG_LOOPW
2113 Add the "loopw" memory command. This only takes effect if
2114 the memory commands are activated globally (CFG_CMD_MEM).
2115
stroese7b466642004-12-16 18:46:55 +00002116- CONFIG_MX_CYCLIC
2117 Add the "mdc" and "mwc" memory commands. These are cyclic
2118 "md/mw" commands.
2119 Examples:
2120
2121 => mdc.b 10 4 500
2122 This command will print 4 bytes (10,11,12,13) each 500 ms.
2123
2124 => mwc.l 100 12345678 10
2125 This command will write 12345678 to address 100 all 10 ms.
2126
2127 This only takes effect if the memory commands are activated
2128 globally (CFG_CMD_MEM).
2129
wdenkc6097192002-11-03 00:24:07 +00002130Building the Software:
2131======================
2132
2133Building U-Boot has been tested in native PPC environments (on a
2134PowerBook G3 running LinuxPPC 2000) and in cross environments
2135(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2136NetBSD 1.5 on x86).
2137
2138If you are not using a native PPC environment, it is assumed that you
2139have the GNU cross compiling tools available in your path and named
2140with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2141you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2142the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2143change it to:
2144
2145 CROSS_COMPILE = ppc_4xx-
2146
2147
wdenkba56f622004-02-06 23:19:44 +00002148U-Boot is intended to be simple to build. After installing the
wdenkc6097192002-11-03 00:24:07 +00002149sources you must configure U-Boot for one specific board type. This
2150is done by typing:
2151
2152 make NAME_config
2153
2154where "NAME_config" is the name of one of the existing
2155configurations; the following names are supported:
2156
wdenk1eaeb582004-06-08 00:22:43 +00002157 ADCIOP_config FPS860L_config omap730p2_config
2158 ADS860_config GEN860T_config pcu_e_config
wdenk983fda82004-10-28 00:09:35 +00002159 Alaska8220_config
wdenk1eaeb582004-06-08 00:22:43 +00002160 AR405_config GENIETV_config PIP405_config
2161 at91rm9200dk_config GTH_config QS823_config
2162 CANBT_config hermes_config QS850_config
2163 cmi_mpc5xx_config hymod_config QS860T_config
2164 cogent_common_config IP860_config RPXlite_config
wdenke63c8ee2004-06-09 21:04:48 +00002165 cogent_mpc8260_config IVML24_config RPXlite_DW_config
2166 cogent_mpc8xx_config IVMS8_config RPXsuper_config
2167 CPCI405_config JSE_config rsdproto_config
2168 CPCIISER4_config LANTEC_config Sandpoint8240_config
2169 csb272_config lwmon_config sbc8260_config
wdenk466b7412004-07-10 22:35:59 +00002170 CU824_config MBX860T_config sbc8560_33_config
2171 DUET_ADS_config MBX_config sbc8560_66_config
wdenk8b07a112004-07-10 21:45:47 +00002172 EBONY_config MPC8260ADS_config SM850_config
2173 ELPT860_config MPC8540ADS_config SPD823TS_config
2174 ESTEEM192E_config MPC8560ADS_config stxgp3_config
2175 ETX094_config NETVIA_config SXNI855T_config
2176 FADS823_config omap1510inn_config TQM823L_config
2177 FADS850SAR_config omap1610h2_config TQM850L_config
2178 FADS860T_config omap1610inn_config TQM855L_config
2179 FPS850L_config omap5912osk_config TQM860L_config
2180 WALNUT405_config
wdenk983fda82004-10-28 00:09:35 +00002181 Yukon8220_config
wdenk8b07a112004-07-10 21:45:47 +00002182 ZPC1900_config
wdenk54387ac2003-10-08 22:45:44 +00002183
wdenk2729af92004-05-03 20:45:30 +00002184Note: for some board special configuration names may exist; check if
2185 additional information is available from the board vendor; for
2186 instance, the TQM823L systems are available without (standard)
2187 or with LCD support. You can select such additional "features"
2188 when chosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002189
wdenk2729af92004-05-03 20:45:30 +00002190 make TQM823L_config
2191 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002192
wdenk2729af92004-05-03 20:45:30 +00002193 make TQM823L_LCD_config
2194 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002195
wdenk2729af92004-05-03 20:45:30 +00002196 etc.
wdenkc6097192002-11-03 00:24:07 +00002197
wdenkc6097192002-11-03 00:24:07 +00002198
wdenk2729af92004-05-03 20:45:30 +00002199Finally, type "make all", and you should get some working U-Boot
2200images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002201
wdenk2729af92004-05-03 20:45:30 +00002202- "u-boot.bin" is a raw binary image
2203- "u-boot" is an image in ELF binary format
2204- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002205
wdenkc6097192002-11-03 00:24:07 +00002206
wdenk2729af92004-05-03 20:45:30 +00002207Please be aware that the Makefiles assume you are using GNU make, so
2208for instance on NetBSD you might need to use "gmake" instead of
2209native "make".
wdenkc6097192002-11-03 00:24:07 +00002210
wdenkc6097192002-11-03 00:24:07 +00002211
wdenk2729af92004-05-03 20:45:30 +00002212If the system board that you have is not listed, then you will need
2213to port U-Boot to your hardware platform. To do this, follow these
2214steps:
wdenkc6097192002-11-03 00:24:07 +00002215
wdenk2729af92004-05-03 20:45:30 +000022161. Add a new configuration option for your board to the toplevel
2217 "Makefile" and to the "MAKEALL" script, using the existing
2218 entries as examples. Note that here and at many other places
2219 boards and other names are listed in alphabetical sort order. Please
2220 keep this order.
22212. Create a new directory to hold your board specific code. Add any
2222 files you need. In your board directory, you will need at least
2223 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
22243. Create a new configuration file "include/configs/<board>.h" for
2225 your board
22263. If you're porting U-Boot to a new CPU, then also create a new
2227 directory to hold your CPU specific code. Add any files you need.
22284. Run "make <board>_config" with your new name.
22295. Type "make", and you should get a working "u-boot.srec" file
2230 to be installed on your target system.
22316. Debug and solve any problems that might arise.
2232 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002233
wdenkc6097192002-11-03 00:24:07 +00002234
wdenk2729af92004-05-03 20:45:30 +00002235Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2236==============================================================
wdenkc6097192002-11-03 00:24:07 +00002237
wdenk2729af92004-05-03 20:45:30 +00002238If you have modified U-Boot sources (for instance added a new board
2239or support for new devices, a new CPU, etc.) you are expected to
2240provide feedback to the other developers. The feedback normally takes
2241the form of a "patch", i. e. a context diff against a certain (latest
2242official or latest in CVS) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002243
wdenk2729af92004-05-03 20:45:30 +00002244But before you submit such a patch, please verify that your modifi-
2245cation did not break existing code. At least make sure that *ALL* of
2246the supported boards compile WITHOUT ANY compiler warnings. To do so,
2247just run the "MAKEALL" script, which will configure and build U-Boot
2248for ALL supported system. Be warned, this will take a while. You can
2249select which (cross) compiler to use by passing a `CROSS_COMPILE'
2250environment variable to the script, i. e. to use the cross tools from
2251MontaVista's Hard Hat Linux you can type
wdenkc6097192002-11-03 00:24:07 +00002252
wdenk2729af92004-05-03 20:45:30 +00002253 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002254
wdenk2729af92004-05-03 20:45:30 +00002255or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002256
wdenk2729af92004-05-03 20:45:30 +00002257 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002258
wdenk2729af92004-05-03 20:45:30 +00002259See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002260
wdenkc6097192002-11-03 00:24:07 +00002261
wdenk2729af92004-05-03 20:45:30 +00002262Monitor Commands - Overview:
2263============================
wdenkc6097192002-11-03 00:24:07 +00002264
wdenk2729af92004-05-03 20:45:30 +00002265go - start application at address 'addr'
2266run - run commands in an environment variable
2267bootm - boot application image from memory
2268bootp - boot image via network using BootP/TFTP protocol
2269tftpboot- boot image via network using TFTP protocol
2270 and env variables "ipaddr" and "serverip"
2271 (and eventually "gatewayip")
2272rarpboot- boot image via network using RARP/TFTP protocol
2273diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2274loads - load S-Record file over serial line
2275loadb - load binary file over serial line (kermit mode)
2276md - memory display
2277mm - memory modify (auto-incrementing)
2278nm - memory modify (constant address)
2279mw - memory write (fill)
2280cp - memory copy
2281cmp - memory compare
2282crc32 - checksum calculation
2283imd - i2c memory display
2284imm - i2c memory modify (auto-incrementing)
2285inm - i2c memory modify (constant address)
2286imw - i2c memory write (fill)
2287icrc32 - i2c checksum calculation
2288iprobe - probe to discover valid I2C chip addresses
2289iloop - infinite loop on address range
2290isdram - print SDRAM configuration information
2291sspi - SPI utility commands
2292base - print or set address offset
2293printenv- print environment variables
2294setenv - set environment variables
2295saveenv - save environment variables to persistent storage
2296protect - enable or disable FLASH write protection
2297erase - erase FLASH memory
2298flinfo - print FLASH memory information
2299bdinfo - print Board Info structure
2300iminfo - print header information for application image
2301coninfo - print console devices and informations
2302ide - IDE sub-system
2303loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002304loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002305mtest - simple RAM test
2306icache - enable or disable instruction cache
2307dcache - enable or disable data cache
2308reset - Perform RESET of the CPU
2309echo - echo args to console
2310version - print monitor version
2311help - print online help
2312? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002313
wdenkc6097192002-11-03 00:24:07 +00002314
wdenk2729af92004-05-03 20:45:30 +00002315Monitor Commands - Detailed Description:
2316========================================
wdenkc6097192002-11-03 00:24:07 +00002317
wdenk2729af92004-05-03 20:45:30 +00002318TODO.
wdenkc6097192002-11-03 00:24:07 +00002319
wdenk2729af92004-05-03 20:45:30 +00002320For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002321
2322
wdenk2729af92004-05-03 20:45:30 +00002323Environment Variables:
2324======================
wdenkc6097192002-11-03 00:24:07 +00002325
wdenk2729af92004-05-03 20:45:30 +00002326U-Boot supports user configuration using Environment Variables which
2327can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002328
wdenk2729af92004-05-03 20:45:30 +00002329Environment Variables are set using "setenv", printed using
2330"printenv", and saved to Flash using "saveenv". Using "setenv"
2331without a value can be used to delete a variable from the
2332environment. As long as you don't save the environment you are
2333working with an in-memory copy. In case the Flash area containing the
2334environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002335
wdenk2729af92004-05-03 20:45:30 +00002336Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002337
wdenk2729af92004-05-03 20:45:30 +00002338 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002339
wdenk2729af92004-05-03 20:45:30 +00002340 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002341
wdenk2729af92004-05-03 20:45:30 +00002342 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002343
wdenk2729af92004-05-03 20:45:30 +00002344 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002345
wdenk2729af92004-05-03 20:45:30 +00002346 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002347
wdenk2729af92004-05-03 20:45:30 +00002348 autoload - if set to "no" (any string beginning with 'n'),
2349 "bootp" will just load perform a lookup of the
2350 configuration from the BOOTP server, but not try to
2351 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002352
wdenk2729af92004-05-03 20:45:30 +00002353 autostart - if set to "yes", an image loaded using the "bootp",
2354 "rarpboot", "tftpboot" or "diskboot" commands will
2355 be automatically started (by internally calling
2356 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002357
wdenk2729af92004-05-03 20:45:30 +00002358 If set to "no", a standalone image passed to the
2359 "bootm" command will be copied to the load address
2360 (and eventually uncompressed), but NOT be started.
2361 This can be used to load and uncompress arbitrary
2362 data.
wdenkc6097192002-11-03 00:24:07 +00002363
wdenk17ea1172004-06-06 21:51:03 +00002364 i2cfast - (PPC405GP|PPC405EP only)
2365 if set to 'y' configures Linux I2C driver for fast
2366 mode (400kHZ). This environment variable is used in
2367 initialization code. So, for changes to be effective
2368 it must be saved and board must be reset.
2369
wdenk2729af92004-05-03 20:45:30 +00002370 initrd_high - restrict positioning of initrd images:
2371 If this variable is not set, initrd images will be
2372 copied to the highest possible address in RAM; this
2373 is usually what you want since it allows for
2374 maximum initrd size. If for some reason you want to
2375 make sure that the initrd image is loaded below the
2376 CFG_BOOTMAPSZ limit, you can set this environment
2377 variable to a value of "no" or "off" or "0".
2378 Alternatively, you can set it to a maximum upper
2379 address to use (U-Boot will still check that it
2380 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002381
wdenk2729af92004-05-03 20:45:30 +00002382 For instance, when you have a system with 16 MB
2383 RAM, and want to reserve 4 MB from use by Linux,
2384 you can do this by adding "mem=12M" to the value of
2385 the "bootargs" variable. However, now you must make
2386 sure that the initrd image is placed in the first
2387 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002388
wdenk2729af92004-05-03 20:45:30 +00002389 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002390
wdenk2729af92004-05-03 20:45:30 +00002391 If you set initrd_high to 0xFFFFFFFF, this is an
2392 indication to U-Boot that all addresses are legal
2393 for the Linux kernel, including addresses in flash
2394 memory. In this case U-Boot will NOT COPY the
2395 ramdisk at all. This may be useful to reduce the
2396 boot time on your system, but requires that this
2397 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00002398
wdenk2729af92004-05-03 20:45:30 +00002399 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002400
wdenk2729af92004-05-03 20:45:30 +00002401 loadaddr - Default load address for commands like "bootp",
2402 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002403
wdenk2729af92004-05-03 20:45:30 +00002404 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002405
wdenk2729af92004-05-03 20:45:30 +00002406 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00002407
wdenk2729af92004-05-03 20:45:30 +00002408 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002409
wdenk2729af92004-05-03 20:45:30 +00002410 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002411
wdenk2729af92004-05-03 20:45:30 +00002412 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002413
wdenk2729af92004-05-03 20:45:30 +00002414 ethprime - When CONFIG_NET_MULTI is enabled controls which
2415 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002416
wdenk2729af92004-05-03 20:45:30 +00002417 ethact - When CONFIG_NET_MULTI is enabled controls which
2418 interface is currently active. For example you
2419 can do the following
wdenkc6097192002-11-03 00:24:07 +00002420
wdenk2729af92004-05-03 20:45:30 +00002421 => setenv ethact FEC ETHERNET
2422 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2423 => setenv ethact SCC ETHERNET
2424 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002425
wdenk2729af92004-05-03 20:45:30 +00002426 netretry - When set to "no" each network operation will
2427 either succeed or fail without retrying.
2428 When set to "once" the network operation will
2429 fail when all the available network interfaces
2430 are tried once without success.
2431 Useful on scripts which control the retry operation
2432 themselves.
wdenkc6097192002-11-03 00:24:07 +00002433
wdenk2729af92004-05-03 20:45:30 +00002434 vlan - When set to a value < 4095 the traffic over
2435 ethernet is encapsulated/received over 802.1q
2436 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00002437
wdenk2729af92004-05-03 20:45:30 +00002438The following environment variables may be used and automatically
2439updated by the network boot commands ("bootp" and "rarpboot"),
2440depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00002441
wdenk2729af92004-05-03 20:45:30 +00002442 bootfile - see above
2443 dnsip - IP address of your Domain Name Server
2444 dnsip2 - IP address of your secondary Domain Name Server
2445 gatewayip - IP address of the Gateway (Router) to use
2446 hostname - Target hostname
2447 ipaddr - see above
2448 netmask - Subnet Mask
2449 rootpath - Pathname of the root filesystem on the NFS server
2450 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00002451
wdenka3d991b2004-04-15 21:48:45 +00002452
wdenk2729af92004-05-03 20:45:30 +00002453There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002454
wdenk2729af92004-05-03 20:45:30 +00002455 serial# - contains hardware identification information such
2456 as type string and/or serial number
2457 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00002458
wdenk2729af92004-05-03 20:45:30 +00002459These variables can be set only once (usually during manufacturing of
2460the board). U-Boot refuses to delete or overwrite these variables
2461once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00002462
2463
wdenk2729af92004-05-03 20:45:30 +00002464Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002465
wdenk2729af92004-05-03 20:45:30 +00002466 ver - Contains the U-Boot version string as printed
2467 with the "version" command. This variable is
2468 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00002469
wdenkc6097192002-11-03 00:24:07 +00002470
wdenk2729af92004-05-03 20:45:30 +00002471Please note that changes to some configuration parameters may take
2472only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00002473
stroesec1551ea2003-04-04 15:53:41 +00002474
wdenk2729af92004-05-03 20:45:30 +00002475Command Line Parsing:
2476=====================
stroesec1551ea2003-04-04 15:53:41 +00002477
wdenk2729af92004-05-03 20:45:30 +00002478There are two different command line parsers available with U-Boot:
2479the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00002480
wdenk2729af92004-05-03 20:45:30 +00002481Old, simple command line parser:
2482--------------------------------
wdenkc6097192002-11-03 00:24:07 +00002483
wdenk2729af92004-05-03 20:45:30 +00002484- supports environment variables (through setenv / saveenv commands)
2485- several commands on one line, separated by ';'
2486- variable substitution using "... $(name) ..." syntax
2487- special characters ('$', ';') can be escaped by prefixing with '\',
2488 for example:
2489 setenv bootcmd bootm \$(address)
2490- You can also escape text by enclosing in single apostrophes, for example:
2491 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00002492
wdenk2729af92004-05-03 20:45:30 +00002493Hush shell:
2494-----------
wdenkf07771c2003-05-28 08:06:31 +00002495
wdenk2729af92004-05-03 20:45:30 +00002496- similar to Bourne shell, with control structures like
2497 if...then...else...fi, for...do...done; while...do...done,
2498 until...do...done, ...
2499- supports environment ("global") variables (through setenv / saveenv
2500 commands) and local shell variables (through standard shell syntax
2501 "name=value"); only environment variables can be used with "run"
2502 command
wdenkf07771c2003-05-28 08:06:31 +00002503
wdenk2729af92004-05-03 20:45:30 +00002504General rules:
2505--------------
wdenkf07771c2003-05-28 08:06:31 +00002506
wdenk2729af92004-05-03 20:45:30 +00002507(1) If a command line (or an environment variable executed by a "run"
2508 command) contains several commands separated by semicolon, and
2509 one of these commands fails, then the remaining commands will be
2510 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00002511
wdenk2729af92004-05-03 20:45:30 +00002512(2) If you execute several variables with one call to run (i. e.
2513 calling run with a list af variables as arguments), any failing
2514 command will cause "run" to terminate, i. e. the remaining
2515 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00002516
wdenk2729af92004-05-03 20:45:30 +00002517Note for Redundant Ethernet Interfaces:
2518=======================================
wdenkf07771c2003-05-28 08:06:31 +00002519
wdenk2729af92004-05-03 20:45:30 +00002520Some boards come with redundant ethernet interfaces; U-Boot supports
2521such configurations and is capable of automatic selection of a
2522"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00002523
wdenk2729af92004-05-03 20:45:30 +00002524Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2525MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2526"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00002527
wdenk2729af92004-05-03 20:45:30 +00002528If the network interface stores some valid MAC address (for instance
2529in SROM), this is used as default address if there is NO correspon-
2530ding setting in the environment; if the corresponding environment
2531variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00002532
wdenk2729af92004-05-03 20:45:30 +00002533o If the SROM has a valid MAC address, and there is no address in the
2534 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002535
wdenk2729af92004-05-03 20:45:30 +00002536o If there is no valid address in the SROM, and a definition in the
2537 environment exists, then the value from the environment variable is
2538 used.
wdenkc6097192002-11-03 00:24:07 +00002539
wdenk2729af92004-05-03 20:45:30 +00002540o If both the SROM and the environment contain a MAC address, and
2541 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002542
wdenk2729af92004-05-03 20:45:30 +00002543o If both the SROM and the environment contain a MAC address, and the
2544 addresses differ, the value from the environment is used and a
2545 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002546
wdenk2729af92004-05-03 20:45:30 +00002547o If neither SROM nor the environment contain a MAC address, an error
2548 is raised.
wdenkc6097192002-11-03 00:24:07 +00002549
wdenkc6097192002-11-03 00:24:07 +00002550
wdenk2729af92004-05-03 20:45:30 +00002551Image Formats:
2552==============
wdenkc6097192002-11-03 00:24:07 +00002553
wdenk2729af92004-05-03 20:45:30 +00002554The "boot" commands of this monitor operate on "image" files which
2555can be basicly anything, preceeded by a special header; see the
2556definitions in include/image.h for details; basicly, the header
2557defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002558
wdenk2729af92004-05-03 20:45:30 +00002559* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2560 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2561 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2562 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2563* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2564 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2565 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2566* Compression Type (uncompressed, gzip, bzip2)
2567* Load Address
2568* Entry Point
2569* Image Name
2570* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002571
wdenk2729af92004-05-03 20:45:30 +00002572The header is marked by a special Magic Number, and both the header
2573and the data portions of the image are secured against corruption by
2574CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002575
wdenkc6097192002-11-03 00:24:07 +00002576
wdenk2729af92004-05-03 20:45:30 +00002577Linux Support:
2578==============
wdenkc6097192002-11-03 00:24:07 +00002579
wdenk2729af92004-05-03 20:45:30 +00002580Although U-Boot should support any OS or standalone application
2581easily, the main focus has always been on Linux during the design of
2582U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002583
wdenk2729af92004-05-03 20:45:30 +00002584U-Boot includes many features that so far have been part of some
2585special "boot loader" code within the Linux kernel. Also, any
2586"initrd" images to be used are no longer part of one big Linux image;
2587instead, kernel and "initrd" are separate images. This implementation
2588serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002589
wdenk2729af92004-05-03 20:45:30 +00002590- the same features can be used for other OS or standalone
2591 applications (for instance: using compressed images to reduce the
2592 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002593
wdenk2729af92004-05-03 20:45:30 +00002594- it becomes much easier to port new Linux kernel versions because
2595 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002596
wdenk2729af92004-05-03 20:45:30 +00002597- the same Linux kernel image can now be used with different "initrd"
2598 images; of course this also means that different kernel images can
2599 be run with the same "initrd". This makes testing easier (you don't
2600 have to build a new "zImage.initrd" Linux image when you just
2601 change a file in your "initrd"). Also, a field-upgrade of the
2602 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002603
wdenkc6097192002-11-03 00:24:07 +00002604
wdenk2729af92004-05-03 20:45:30 +00002605Linux HOWTO:
2606============
wdenkc6097192002-11-03 00:24:07 +00002607
wdenk2729af92004-05-03 20:45:30 +00002608Porting Linux to U-Boot based systems:
2609---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002610
wdenk2729af92004-05-03 20:45:30 +00002611U-Boot cannot save you from doing all the necessary modifications to
2612configure the Linux device drivers for use with your target hardware
2613(no, we don't intend to provide a full virtual machine interface to
2614Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002615
wdenk2729af92004-05-03 20:45:30 +00002616But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002617
wdenk2729af92004-05-03 20:45:30 +00002618Just make sure your machine specific header file (for instance
2619include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2620Information structure as we define in include/u-boot.h, and make
2621sure that your definition of IMAP_ADDR uses the same value as your
2622U-Boot configuration in CFG_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002623
wdenkc6097192002-11-03 00:24:07 +00002624
wdenk2729af92004-05-03 20:45:30 +00002625Configuring the Linux kernel:
2626-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002627
wdenk2729af92004-05-03 20:45:30 +00002628No specific requirements for U-Boot. Make sure you have some root
2629device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002630
wdenkc6097192002-11-03 00:24:07 +00002631
wdenk2729af92004-05-03 20:45:30 +00002632Building a Linux Image:
2633-----------------------
wdenkc6097192002-11-03 00:24:07 +00002634
wdenk2729af92004-05-03 20:45:30 +00002635With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2636not used. If you use recent kernel source, a new build target
2637"uImage" will exist which automatically builds an image usable by
2638U-Boot. Most older kernels also have support for a "pImage" target,
2639which was introduced for our predecessor project PPCBoot and uses a
2640100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002641
wdenk2729af92004-05-03 20:45:30 +00002642Example:
wdenkc6097192002-11-03 00:24:07 +00002643
wdenk2729af92004-05-03 20:45:30 +00002644 make TQM850L_config
2645 make oldconfig
2646 make dep
2647 make uImage
wdenkc6097192002-11-03 00:24:07 +00002648
wdenk2729af92004-05-03 20:45:30 +00002649The "uImage" build target uses a special tool (in 'tools/mkimage') to
2650encapsulate a compressed Linux kernel image with header information,
2651CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002652
wdenk2729af92004-05-03 20:45:30 +00002653* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002654
wdenk2729af92004-05-03 20:45:30 +00002655* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002656
wdenk2729af92004-05-03 20:45:30 +00002657 ${CROSS_COMPILE}-objcopy -O binary \
2658 -R .note -R .comment \
2659 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00002660
wdenk2729af92004-05-03 20:45:30 +00002661* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00002662
wdenk2729af92004-05-03 20:45:30 +00002663 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00002664
wdenk2729af92004-05-03 20:45:30 +00002665* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002666
wdenk2729af92004-05-03 20:45:30 +00002667 mkimage -A ppc -O linux -T kernel -C gzip \
2668 -a 0 -e 0 -n "Linux Kernel Image" \
2669 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00002670
wdenk24ee89b2002-11-03 17:56:27 +00002671
wdenk2729af92004-05-03 20:45:30 +00002672The "mkimage" tool can also be used to create ramdisk images for use
2673with U-Boot, either separated from the Linux kernel image, or
2674combined into one file. "mkimage" encapsulates the images with a 64
2675byte header containing information about target architecture,
2676operating system, image type, compression method, entry points, time
2677stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00002678
wdenk2729af92004-05-03 20:45:30 +00002679"mkimage" can be called in two ways: to verify existing images and
2680print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002681
wdenk2729af92004-05-03 20:45:30 +00002682In the first form (with "-l" option) mkimage lists the information
2683contained in the header of an existing U-Boot image; this includes
2684checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002685
wdenk2729af92004-05-03 20:45:30 +00002686 tools/mkimage -l image
2687 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002688
wdenk2729af92004-05-03 20:45:30 +00002689The second form (with "-d" option) is used to build a U-Boot image
2690from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002691
wdenk2729af92004-05-03 20:45:30 +00002692 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2693 -n name -d data_file image
2694 -A ==> set architecture to 'arch'
2695 -O ==> set operating system to 'os'
2696 -T ==> set image type to 'type'
2697 -C ==> set compression type 'comp'
2698 -a ==> set load address to 'addr' (hex)
2699 -e ==> set entry point to 'ep' (hex)
2700 -n ==> set image name to 'name'
2701 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002702
wdenk69459792004-05-29 16:53:29 +00002703Right now, all Linux kernels for PowerPC systems use the same load
2704address (0x00000000), but the entry point address depends on the
2705kernel version:
wdenkc6097192002-11-03 00:24:07 +00002706
wdenk2729af92004-05-03 20:45:30 +00002707- 2.2.x kernels have the entry point at 0x0000000C,
2708- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002709
wdenk2729af92004-05-03 20:45:30 +00002710So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002711
wdenk2729af92004-05-03 20:45:30 +00002712 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2713 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2714 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2715 > examples/uImage.TQM850L
2716 Image Name: 2.4.4 kernel for TQM850L
2717 Created: Wed Jul 19 02:34:59 2000
2718 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2719 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2720 Load Address: 0x00000000
2721 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002722
wdenk2729af92004-05-03 20:45:30 +00002723To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002724
wdenk2729af92004-05-03 20:45:30 +00002725 -> tools/mkimage -l examples/uImage.TQM850L
2726 Image Name: 2.4.4 kernel for TQM850L
2727 Created: Wed Jul 19 02:34:59 2000
2728 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2729 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2730 Load Address: 0x00000000
2731 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002732
wdenk2729af92004-05-03 20:45:30 +00002733NOTE: for embedded systems where boot time is critical you can trade
2734speed for memory and install an UNCOMPRESSED image instead: this
2735needs more space in Flash, but boots much faster since it does not
2736need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002737
wdenk2729af92004-05-03 20:45:30 +00002738 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2739 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2740 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2741 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2742 > examples/uImage.TQM850L-uncompressed
2743 Image Name: 2.4.4 kernel for TQM850L
2744 Created: Wed Jul 19 02:34:59 2000
2745 Image Type: PowerPC Linux Kernel Image (uncompressed)
2746 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2747 Load Address: 0x00000000
2748 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002749
wdenkc6097192002-11-03 00:24:07 +00002750
wdenk2729af92004-05-03 20:45:30 +00002751Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2752when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00002753
wdenk2729af92004-05-03 20:45:30 +00002754 -> tools/mkimage -n 'Simple Ramdisk Image' \
2755 > -A ppc -O linux -T ramdisk -C gzip \
2756 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2757 Image Name: Simple Ramdisk Image
2758 Created: Wed Jan 12 14:01:50 2000
2759 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2760 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2761 Load Address: 0x00000000
2762 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00002763
wdenkdb01a2e2004-04-15 23:14:49 +00002764
wdenk2729af92004-05-03 20:45:30 +00002765Installing a Linux Image:
2766-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00002767
wdenk2729af92004-05-03 20:45:30 +00002768To downloading a U-Boot image over the serial (console) interface,
2769you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00002770
wdenk2729af92004-05-03 20:45:30 +00002771 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00002772
wdenk2729af92004-05-03 20:45:30 +00002773The 'objcopy' does not understand the information in the U-Boot
2774image header, so the resulting S-Record file will be relative to
2775address 0x00000000. To load it to a given address, you need to
2776specify the target address as 'offset' parameter with the 'loads'
2777command.
wdenkc6097192002-11-03 00:24:07 +00002778
wdenk2729af92004-05-03 20:45:30 +00002779Example: install the image to address 0x40100000 (which on the
2780TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00002781
wdenk2729af92004-05-03 20:45:30 +00002782 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00002783
wdenk2729af92004-05-03 20:45:30 +00002784 .......... done
2785 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00002786
wdenk2729af92004-05-03 20:45:30 +00002787 => loads 40100000
2788 ## Ready for S-Record download ...
2789 ~>examples/image.srec
2790 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2791 ...
2792 15989 15990 15991 15992
2793 [file transfer complete]
2794 [connected]
2795 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002796
2797
wdenk2729af92004-05-03 20:45:30 +00002798You can check the success of the download using the 'iminfo' command;
2799this includes a checksum verification so you can be sure no data
2800corruption happened:
wdenkc6097192002-11-03 00:24:07 +00002801
wdenk2729af92004-05-03 20:45:30 +00002802 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00002803
wdenk2729af92004-05-03 20:45:30 +00002804 ## Checking Image at 40100000 ...
2805 Image Name: 2.2.13 for initrd on TQM850L
2806 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2807 Data Size: 335725 Bytes = 327 kB = 0 MB
2808 Load Address: 00000000
2809 Entry Point: 0000000c
2810 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002811
2812
wdenk2729af92004-05-03 20:45:30 +00002813Boot Linux:
2814-----------
wdenkc6097192002-11-03 00:24:07 +00002815
wdenk2729af92004-05-03 20:45:30 +00002816The "bootm" command is used to boot an application that is stored in
2817memory (RAM or Flash). In case of a Linux kernel image, the contents
2818of the "bootargs" environment variable is passed to the kernel as
2819parameters. You can check and modify this variable using the
2820"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00002821
2822
wdenk2729af92004-05-03 20:45:30 +00002823 => printenv bootargs
2824 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00002825
wdenk2729af92004-05-03 20:45:30 +00002826 => 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 +00002827
wdenk2729af92004-05-03 20:45:30 +00002828 => printenv bootargs
2829 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 +00002830
wdenk2729af92004-05-03 20:45:30 +00002831 => bootm 40020000
2832 ## Booting Linux kernel at 40020000 ...
2833 Image Name: 2.2.13 for NFS on TQM850L
2834 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2835 Data Size: 381681 Bytes = 372 kB = 0 MB
2836 Load Address: 00000000
2837 Entry Point: 0000000c
2838 Verifying Checksum ... OK
2839 Uncompressing Kernel Image ... OK
2840 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
2841 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2842 time_init: decrementer frequency = 187500000/60
2843 Calibrating delay loop... 49.77 BogoMIPS
2844 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2845 ...
wdenkc6097192002-11-03 00:24:07 +00002846
wdenk2729af92004-05-03 20:45:30 +00002847If you want to boot a Linux kernel with initial ram disk, you pass
2848the memory addresses of both the kernel and the initrd image (PPBCOOT
2849format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00002850
wdenk2729af92004-05-03 20:45:30 +00002851 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00002852
wdenk2729af92004-05-03 20:45:30 +00002853 ## Checking Image at 40100000 ...
2854 Image Name: 2.2.13 for initrd on TQM850L
2855 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2856 Data Size: 335725 Bytes = 327 kB = 0 MB
2857 Load Address: 00000000
2858 Entry Point: 0000000c
2859 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002860
wdenk2729af92004-05-03 20:45:30 +00002861 ## Checking Image at 40200000 ...
2862 Image Name: Simple Ramdisk Image
2863 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2864 Data Size: 566530 Bytes = 553 kB = 0 MB
2865 Load Address: 00000000
2866 Entry Point: 00000000
2867 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002868
wdenk2729af92004-05-03 20:45:30 +00002869 => bootm 40100000 40200000
2870 ## Booting Linux kernel at 40100000 ...
2871 Image Name: 2.2.13 for initrd on TQM850L
2872 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2873 Data Size: 335725 Bytes = 327 kB = 0 MB
2874 Load Address: 00000000
2875 Entry Point: 0000000c
2876 Verifying Checksum ... OK
2877 Uncompressing Kernel Image ... OK
2878 ## Loading RAMDisk Image at 40200000 ...
2879 Image Name: Simple Ramdisk Image
2880 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2881 Data Size: 566530 Bytes = 553 kB = 0 MB
2882 Load Address: 00000000
2883 Entry Point: 00000000
2884 Verifying Checksum ... OK
2885 Loading Ramdisk ... OK
2886 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
2887 Boot arguments: root=/dev/ram
2888 time_init: decrementer frequency = 187500000/60
2889 Calibrating delay loop... 49.77 BogoMIPS
2890 ...
2891 RAMDISK: Compressed image found at block 0
2892 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00002893
wdenk2729af92004-05-03 20:45:30 +00002894 bash#
wdenkc6097192002-11-03 00:24:07 +00002895
wdenk2729af92004-05-03 20:45:30 +00002896More About U-Boot Image Types:
2897------------------------------
wdenk6069ff22003-02-28 00:49:47 +00002898
wdenk2729af92004-05-03 20:45:30 +00002899U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00002900
wdenk2729af92004-05-03 20:45:30 +00002901 "Standalone Programs" are directly runnable in the environment
2902 provided by U-Boot; it is expected that (if they behave
2903 well) you can continue to work in U-Boot after return from
2904 the Standalone Program.
2905 "OS Kernel Images" are usually images of some Embedded OS which
2906 will take over control completely. Usually these programs
2907 will install their own set of exception handlers, device
2908 drivers, set up the MMU, etc. - this means, that you cannot
2909 expect to re-enter U-Boot except by resetting the CPU.
2910 "RAMDisk Images" are more or less just data blocks, and their
2911 parameters (address, size) are passed to an OS kernel that is
2912 being started.
2913 "Multi-File Images" contain several images, typically an OS
2914 (Linux) kernel image and one or more data images like
2915 RAMDisks. This construct is useful for instance when you want
2916 to boot over the network using BOOTP etc., where the boot
2917 server provides just a single image file, but you want to get
2918 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00002919
wdenk2729af92004-05-03 20:45:30 +00002920 "Multi-File Images" start with a list of image sizes, each
2921 image size (in bytes) specified by an "uint32_t" in network
2922 byte order. This list is terminated by an "(uint32_t)0".
2923 Immediately after the terminating 0 follow the images, one by
2924 one, all aligned on "uint32_t" boundaries (size rounded up to
2925 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00002926
wdenk2729af92004-05-03 20:45:30 +00002927 "Firmware Images" are binary images containing firmware (like
2928 U-Boot or FPGA images) which usually will be programmed to
2929 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00002930
wdenk2729af92004-05-03 20:45:30 +00002931 "Script files" are command sequences that will be executed by
2932 U-Boot's command interpreter; this feature is especially
2933 useful when you configure U-Boot to use a real shell (hush)
2934 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00002935
wdenkc6097192002-11-03 00:24:07 +00002936
wdenk2729af92004-05-03 20:45:30 +00002937Standalone HOWTO:
2938=================
wdenkc6097192002-11-03 00:24:07 +00002939
wdenk2729af92004-05-03 20:45:30 +00002940One of the features of U-Boot is that you can dynamically load and
2941run "standalone" applications, which can use some resources of
2942U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00002943
wdenk2729af92004-05-03 20:45:30 +00002944Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00002945
wdenk2729af92004-05-03 20:45:30 +00002946"Hello World" Demo:
2947-------------------
wdenkc6097192002-11-03 00:24:07 +00002948
wdenk2729af92004-05-03 20:45:30 +00002949'examples/hello_world.c' contains a small "Hello World" Demo
2950application; it is automatically compiled when you build U-Boot.
2951It's configured to run at address 0x00040004, so you can play with it
2952like that:
wdenkc6097192002-11-03 00:24:07 +00002953
wdenk2729af92004-05-03 20:45:30 +00002954 => loads
2955 ## Ready for S-Record download ...
2956 ~>examples/hello_world.srec
2957 1 2 3 4 5 6 7 8 9 10 11 ...
2958 [file transfer complete]
2959 [connected]
2960 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00002961
wdenk2729af92004-05-03 20:45:30 +00002962 => go 40004 Hello World! This is a test.
2963 ## Starting application at 0x00040004 ...
2964 Hello World
2965 argc = 7
2966 argv[0] = "40004"
2967 argv[1] = "Hello"
2968 argv[2] = "World!"
2969 argv[3] = "This"
2970 argv[4] = "is"
2971 argv[5] = "a"
2972 argv[6] = "test."
2973 argv[7] = "<NULL>"
2974 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00002975
wdenk2729af92004-05-03 20:45:30 +00002976 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00002977
wdenk2729af92004-05-03 20:45:30 +00002978Another example, which demonstrates how to register a CPM interrupt
2979handler with the U-Boot code, can be found in 'examples/timer.c'.
2980Here, a CPM timer is set up to generate an interrupt every second.
2981The interrupt service routine is trivial, just printing a '.'
2982character, but this is just a demo program. The application can be
2983controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00002984
wdenk2729af92004-05-03 20:45:30 +00002985 ? - print current values og the CPM Timer registers
2986 b - enable interrupts and start timer
2987 e - stop timer and disable interrupts
2988 q - quit application
wdenkc6097192002-11-03 00:24:07 +00002989
wdenk2729af92004-05-03 20:45:30 +00002990 => loads
2991 ## Ready for S-Record download ...
2992 ~>examples/timer.srec
2993 1 2 3 4 5 6 7 8 9 10 11 ...
2994 [file transfer complete]
2995 [connected]
2996 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00002997
wdenk2729af92004-05-03 20:45:30 +00002998 => go 40004
2999 ## Starting application at 0x00040004 ...
3000 TIMERS=0xfff00980
3001 Using timer 1
3002 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003003
wdenk2729af92004-05-03 20:45:30 +00003004Hit 'b':
3005 [q, b, e, ?] Set interval 1000000 us
3006 Enabling timer
3007Hit '?':
3008 [q, b, e, ?] ........
3009 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3010Hit '?':
3011 [q, b, e, ?] .
3012 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3013Hit '?':
3014 [q, b, e, ?] .
3015 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3016Hit '?':
3017 [q, b, e, ?] .
3018 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3019Hit 'e':
3020 [q, b, e, ?] ...Stopping timer
3021Hit 'q':
3022 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003023
3024
wdenk2729af92004-05-03 20:45:30 +00003025Minicom warning:
3026================
wdenk85ec0bc2003-03-31 16:34:49 +00003027
wdenk2729af92004-05-03 20:45:30 +00003028Over time, many people have reported problems when trying to use the
3029"minicom" terminal emulation program for serial download. I (wd)
3030consider minicom to be broken, and recommend not to use it. Under
3031Unix, I recommend to use C-Kermit for general purpose use (and
3032especially for kermit binary protocol download ("loadb" command), and
3033use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003034
wdenk2729af92004-05-03 20:45:30 +00003035Nevertheless, if you absolutely want to use it try adding this
3036configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003037
wdenk2729af92004-05-03 20:45:30 +00003038 Name Program Name U/D FullScr IO-Red. Multi
3039 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3040 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003041
3042
wdenk2729af92004-05-03 20:45:30 +00003043NetBSD Notes:
3044=============
wdenkc6097192002-11-03 00:24:07 +00003045
wdenk2729af92004-05-03 20:45:30 +00003046Starting at version 0.9.2, U-Boot supports NetBSD both as host
3047(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003048
wdenk2729af92004-05-03 20:45:30 +00003049Building requires a cross environment; it is known to work on
3050NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3051need gmake since the Makefiles are not compatible with BSD make).
3052Note that the cross-powerpc package does not install include files;
3053attempting to build U-Boot will fail because <machine/ansi.h> is
3054missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003055
wdenk2729af92004-05-03 20:45:30 +00003056 # cd /usr/pkg/cross/powerpc-netbsd/include
3057 # mkdir powerpc
3058 # ln -s powerpc machine
3059 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3060 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003061
wdenk2729af92004-05-03 20:45:30 +00003062Native builds *don't* work due to incompatibilities between native
3063and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003064
wdenk2729af92004-05-03 20:45:30 +00003065Booting assumes that (the first part of) the image booted is a
3066stage-2 loader which in turn loads and then invokes the kernel
3067proper. Loader sources will eventually appear in the NetBSD source
3068tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3069meantime, send mail to bruno@exet-ag.de and/or wd@denx.de for
3070details.
wdenkc6097192002-11-03 00:24:07 +00003071
3072
wdenk2729af92004-05-03 20:45:30 +00003073Implementation Internals:
3074=========================
wdenkc6097192002-11-03 00:24:07 +00003075
wdenk2729af92004-05-03 20:45:30 +00003076The following is not intended to be a complete description of every
3077implementation detail. However, it should help to understand the
3078inner workings of U-Boot and make it easier to port it to custom
3079hardware.
wdenkc6097192002-11-03 00:24:07 +00003080
3081
wdenk2729af92004-05-03 20:45:30 +00003082Initial Stack, Global Data:
3083---------------------------
wdenkc6097192002-11-03 00:24:07 +00003084
wdenk2729af92004-05-03 20:45:30 +00003085The implementation of U-Boot is complicated by the fact that U-Boot
3086starts running out of ROM (flash memory), usually without access to
3087system RAM (because the memory controller is not initialized yet).
3088This means that we don't have writable Data or BSS segments, and BSS
3089is not initialized as zero. To be able to get a C environment working
3090at all, we have to allocate at least a minimal stack. Implementation
3091options for this are defined and restricted by the CPU used: Some CPU
3092models provide on-chip memory (like the IMMR area on MPC8xx and
3093MPC826x processors), on others (parts of) the data cache can be
3094locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003095
wdenk2729af92004-05-03 20:45:30 +00003096 Chris Hallinan posted a good summary of these issues to the
3097 u-boot-users mailing list:
wdenk43d96162003-03-06 00:02:04 +00003098
wdenk2729af92004-05-03 20:45:30 +00003099 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3100 From: "Chris Hallinan" <clh@net1plus.com>
3101 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3102 ...
wdenk43d96162003-03-06 00:02:04 +00003103
wdenk2729af92004-05-03 20:45:30 +00003104 Correct me if I'm wrong, folks, but the way I understand it
3105 is this: Using DCACHE as initial RAM for Stack, etc, does not
3106 require any physical RAM backing up the cache. The cleverness
3107 is that the cache is being used as a temporary supply of
3108 necessary storage before the SDRAM controller is setup. It's
3109 beyond the scope of this list to expain the details, but you
3110 can see how this works by studying the cache architecture and
3111 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003112
wdenk2729af92004-05-03 20:45:30 +00003113 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3114 is another option for the system designer to use as an
3115 initial stack/ram area prior to SDRAM being available. Either
3116 option should work for you. Using CS 4 should be fine if your
3117 board designers haven't used it for something that would
3118 cause you grief during the initial boot! It is frequently not
3119 used.
wdenk43d96162003-03-06 00:02:04 +00003120
wdenk2729af92004-05-03 20:45:30 +00003121 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3122 with your processor/board/system design. The default value
3123 you will find in any recent u-boot distribution in
3124 Walnut405.h should work for you. I'd set it to a value larger
3125 than your SDRAM module. If you have a 64MB SDRAM module, set
3126 it above 400_0000. Just make sure your board has no resources
3127 that are supposed to respond to that address! That code in
3128 start.S has been around a while and should work as is when
3129 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003130
wdenk2729af92004-05-03 20:45:30 +00003131 -Chris Hallinan
3132 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003133
wdenk2729af92004-05-03 20:45:30 +00003134It is essential to remember this, since it has some impact on the C
3135code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003136
wdenk2729af92004-05-03 20:45:30 +00003137* Initialized global data (data segment) is read-only. Do not attempt
3138 to write it.
wdenkc6097192002-11-03 00:24:07 +00003139
wdenk2729af92004-05-03 20:45:30 +00003140* Do not use any unitialized global data (or implicitely initialized
3141 as zero data - BSS segment) at all - this is undefined, initiali-
3142 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003143
wdenk2729af92004-05-03 20:45:30 +00003144* Stack space is very limited. Avoid big data buffers or things like
3145 that.
wdenkc6097192002-11-03 00:24:07 +00003146
wdenk2729af92004-05-03 20:45:30 +00003147Having only the stack as writable memory limits means we cannot use
3148normal global data to share information beween the code. But it
3149turned out that the implementation of U-Boot can be greatly
3150simplified by making a global data structure (gd_t) available to all
3151functions. We could pass a pointer to this data as argument to _all_
3152functions, but this would bloat the code. Instead we use a feature of
3153the GCC compiler (Global Register Variables) to share the data: we
3154place a pointer (gd) to the global data into a register which we
3155reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003156
wdenk2729af92004-05-03 20:45:30 +00003157When choosing a register for such a purpose we are restricted by the
3158relevant (E)ABI specifications for the current architecture, and by
3159GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003160
wdenk2729af92004-05-03 20:45:30 +00003161For PowerPC, the following registers have specific use:
3162 R1: stack pointer
3163 R2: TOC pointer
3164 R3-R4: parameter passing and return values
3165 R5-R10: parameter passing
3166 R13: small data area pointer
3167 R30: GOT pointer
3168 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003169
wdenk2729af92004-05-03 20:45:30 +00003170 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003171
wdenk2729af92004-05-03 20:45:30 +00003172 ==> U-Boot will use R29 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003173
wdenk2729af92004-05-03 20:45:30 +00003174 Note: on PPC, we could use a static initializer (since the
3175 address of the global data structure is known at compile time),
3176 but it turned out that reserving a register results in somewhat
3177 smaller code - although the code savings are not that big (on
3178 average for all boards 752 bytes for the whole U-Boot image,
3179 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003180
wdenk2729af92004-05-03 20:45:30 +00003181On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003182
wdenk2729af92004-05-03 20:45:30 +00003183 R0: function argument word/integer result
3184 R1-R3: function argument word
3185 R9: GOT pointer
3186 R10: stack limit (used only if stack checking if enabled)
3187 R11: argument (frame) pointer
3188 R12: temporary workspace
3189 R13: stack pointer
3190 R14: link register
3191 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003192
wdenk2729af92004-05-03 20:45:30 +00003193 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003194
3195
wdenk2729af92004-05-03 20:45:30 +00003196Memory Management:
3197------------------
wdenkc6097192002-11-03 00:24:07 +00003198
wdenk2729af92004-05-03 20:45:30 +00003199U-Boot runs in system state and uses physical addresses, i.e. the
3200MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003201
wdenk2729af92004-05-03 20:45:30 +00003202The available memory is mapped to fixed addresses using the memory
3203controller. In this process, a contiguous block is formed for each
3204memory type (Flash, SDRAM, SRAM), even when it consists of several
3205physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003206
wdenk2729af92004-05-03 20:45:30 +00003207U-Boot is installed in the first 128 kB of the first Flash bank (on
3208TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3209booting and sizing and initializing DRAM, the code relocates itself
3210to the upper end of DRAM. Immediately below the U-Boot code some
3211memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3212configuration setting]. Below that, a structure with global Board
3213Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003214
wdenk2729af92004-05-03 20:45:30 +00003215Additionally, some exception handler code is copied to the low 8 kB
3216of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003217
wdenk2729af92004-05-03 20:45:30 +00003218So a typical memory configuration with 16 MB of DRAM could look like
3219this:
wdenkc6097192002-11-03 00:24:07 +00003220
wdenk2729af92004-05-03 20:45:30 +00003221 0x0000 0000 Exception Vector code
3222 :
3223 0x0000 1FFF
3224 0x0000 2000 Free for Application Use
3225 :
3226 :
wdenkc6097192002-11-03 00:24:07 +00003227
wdenk2729af92004-05-03 20:45:30 +00003228 :
3229 :
3230 0x00FB FF20 Monitor Stack (Growing downward)
3231 0x00FB FFAC Board Info Data and permanent copy of global data
3232 0x00FC 0000 Malloc Arena
3233 :
3234 0x00FD FFFF
3235 0x00FE 0000 RAM Copy of Monitor Code
3236 ... eventually: LCD or video framebuffer
3237 ... eventually: pRAM (Protected RAM - unchanged by reset)
3238 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003239
3240
wdenk2729af92004-05-03 20:45:30 +00003241System Initialization:
3242----------------------
wdenkc6097192002-11-03 00:24:07 +00003243
wdenk2729af92004-05-03 20:45:30 +00003244In the reset configuration, U-Boot starts at the reset entry point
3245(on most PowerPC systens at address 0x00000100). Because of the reset
3246configuration for CS0# this is a mirror of the onboard Flash memory.
3247To be able to re-map memory U-Boot then jumps to its link address.
3248To be able to implement the initialization code in C, a (small!)
3249initial stack is set up in the internal Dual Ported RAM (in case CPUs
3250which provide such a feature like MPC8xx or MPC8260), or in a locked
3251part of the data cache. After that, U-Boot initializes the CPU core,
3252the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003253
wdenk2729af92004-05-03 20:45:30 +00003254Next, all (potentially) available memory banks are mapped using a
3255preliminary mapping. For example, we put them on 512 MB boundaries
3256(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3257on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3258programmed for SDRAM access. Using the temporary configuration, a
3259simple memory test is run that determines the size of the SDRAM
3260banks.
wdenkc6097192002-11-03 00:24:07 +00003261
wdenk2729af92004-05-03 20:45:30 +00003262When there is more than one SDRAM bank, and the banks are of
3263different size, the largest is mapped first. For equal size, the first
3264bank (CS2#) is mapped first. The first mapping is always for address
32650x00000000, with any additional banks following immediately to create
3266contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003267
wdenk2729af92004-05-03 20:45:30 +00003268Then, the monitor installs itself at the upper end of the SDRAM area
3269and allocates memory for use by malloc() and for the global Board
3270Info data; also, the exception vector code is copied to the low RAM
3271pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003272
wdenk2729af92004-05-03 20:45:30 +00003273Only after this relocation will you have a "normal" C environment;
3274until that you are restricted in several ways, mostly because you are
3275running from ROM, and because the code will have to be relocated to a
3276new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003277
3278
wdenk2729af92004-05-03 20:45:30 +00003279U-Boot Porting Guide:
3280----------------------
wdenkc6097192002-11-03 00:24:07 +00003281
wdenk2729af92004-05-03 20:45:30 +00003282[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3283list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003284
3285
wdenk2729af92004-05-03 20:45:30 +00003286int main (int argc, char *argv[])
3287{
3288 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003289
wdenk2729af92004-05-03 20:45:30 +00003290 signal (SIGALRM, no_more_time);
3291 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk2729af92004-05-03 20:45:30 +00003293 if (available_money > available_manpower) {
3294 pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00003295 return 0;
3296 }
3297
wdenk2729af92004-05-03 20:45:30 +00003298 Download latest U-Boot source;
3299
3300 Subscribe to u-boot-users mailing list;
3301
3302 if (clueless) {
3303 email ("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003304 }
3305
wdenk2729af92004-05-03 20:45:30 +00003306 while (learning) {
3307 Read the README file in the top level directory;
3308 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3309 Read the source, Luke;
3310 }
wdenkc6097192002-11-03 00:24:07 +00003311
wdenk2729af92004-05-03 20:45:30 +00003312 if (available_money > toLocalCurrency ($2500)) {
3313 Buy a BDI2000;
3314 } else {
3315 Add a lot of aggravation and time;
3316 }
wdenkc6097192002-11-03 00:24:07 +00003317
wdenk2729af92004-05-03 20:45:30 +00003318 Create your own board support subdirectory;
wdenkc6097192002-11-03 00:24:07 +00003319
wdenk2729af92004-05-03 20:45:30 +00003320 Create your own board config file;
wdenk6aff3112002-12-17 01:51:00 +00003321
wdenk2729af92004-05-03 20:45:30 +00003322 while (!running) {
3323 do {
3324 Add / modify source code;
3325 } until (compiles);
3326 Debug;
3327 if (clueless)
3328 email ("Hi, I am having problems...");
3329 }
3330 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003331
wdenk2729af92004-05-03 20:45:30 +00003332 return 0;
3333}
3334
3335void no_more_time (int sig)
3336{
3337 hire_a_guru();
3338}
wdenkc6097192002-11-03 00:24:07 +00003339
3340
wdenk2729af92004-05-03 20:45:30 +00003341Coding Standards:
3342-----------------
wdenkc6097192002-11-03 00:24:07 +00003343
wdenk2729af92004-05-03 20:45:30 +00003344All contributions to U-Boot should conform to the Linux kernel
3345coding style; see the file "Documentation/CodingStyle" in your Linux
3346kernel source directory.
3347
3348Please note that U-Boot is implemented in C (and to some small parts
3349in Assembler); no C++ is used, so please do not use C++ style
3350comments (//) in your code.
3351
3352Please also stick to the following formatting rules:
3353- remove any trailing white space
3354- use TAB characters for indentation, not spaces
3355- make sure NOT to use DOS '\r\n' line feeds
3356- do not add more than 2 empty lines to source files
3357- do not add trailing empty lines to source files
3358
3359Submissions which do not conform to the standards may be returned
3360with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003361
3362
wdenk2729af92004-05-03 20:45:30 +00003363Submitting Patches:
3364-------------------
wdenkc6097192002-11-03 00:24:07 +00003365
wdenk2729af92004-05-03 20:45:30 +00003366Since the number of patches for U-Boot is growing, we need to
3367establish some rules. Submissions which do not conform to these rules
3368may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003369
3370
wdenk2729af92004-05-03 20:45:30 +00003371When you send a patch, please include the following information with
3372it:
wdenkc6097192002-11-03 00:24:07 +00003373
wdenk2729af92004-05-03 20:45:30 +00003374* For bug fixes: a description of the bug and how your patch fixes
3375 this bug. Please try to include a way of demonstrating that the
3376 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003377
wdenk2729af92004-05-03 20:45:30 +00003378* For new features: a description of the feature and your
3379 implementation.
wdenkc6097192002-11-03 00:24:07 +00003380
wdenk2729af92004-05-03 20:45:30 +00003381* A CHANGELOG entry as plaintext (separate from the patch)
3382
3383* For major contributions, your entry to the CREDITS file
3384
3385* When you add support for a new board, don't forget to add this
3386 board to the MAKEALL script, too.
3387
3388* If your patch adds new configuration options, don't forget to
3389 document these in the README file.
3390
3391* The patch itself. If you are accessing the CVS repository use "cvs
3392 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3393 version of diff does not support these options, then get the latest
3394 version of GNU diff.
3395
3396 The current directory when running this command shall be the top
3397 level directory of the U-Boot source tree, or it's parent directory
3398 (i. e. please make sure that your patch includes sufficient
3399 directory information for the affected files).
3400
3401 We accept patches as plain text, MIME attachments or as uuencoded
3402 gzipped text.
3403
3404* If one logical set of modifications affects or creates several
3405 files, all these changes shall be submitted in a SINGLE patch file.
3406
3407* Changesets that contain different, unrelated modifications shall be
3408 submitted as SEPARATE patches, one patch per changeset.
3409
3410
3411Notes:
3412
3413* Before sending the patch, run the MAKEALL script on your patched
3414 source tree and make sure that no errors or warnings are reported
3415 for any of the boards.
3416
3417* Keep your modifications to the necessary minimum: A patch
3418 containing several unrelated changes or arbitrary reformats will be
3419 returned with a request to re-formatting / split it.
3420
3421* If you modify existing code, make sure that your new code does not
3422 add to the memory footprint of the code ;-) Small is beautiful!
3423 When adding new features, these should compile conditionally only
3424 (using #ifdef), and the resulting code with the new feature
3425 disabled must not need more memory than the old code without your
3426 modification.