blob: 3b36e50e11d5995fb2b36dbebaf3b1a097aec4f5 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
wdenk151ab832005-02-24 22:44:16 +00002# (C) Copyright 2000 - 2005
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
wdenkc6097192002-11-03 00:24:07 +000054who contributed the specific port.
55
wdenkc6097192002-11-03 00:24:07 +000056
57Where to get help:
58==================
59
wdenk24ee89b2002-11-03 17:56:27 +000060In case you have questions about, problems with or contributions for
61U-Boot you should send a message to the U-Boot mailing list at
62<u-boot-users@lists.sourceforge.net>. There is also an archive of
63previous traffic on the mailing list - please search the archive
wdenkc6097192002-11-03 00:24:07 +000064before asking FAQ's. Please see
65http://lists.sourceforge.net/lists/listinfo/u-boot-users/
66
67
68Where we come from:
69===================
70
71- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000072- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000073- clean up code
74- make it easier to add custom boards
75- make it possible to add other [PowerPC] CPUs
76- extend functions, especially:
77 * Provide extended interface to Linux boot loader
78 * S-Record download
79 * network boot
80 * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000081- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000082- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000083- create U-Boot project (http://sourceforge.net/projects/u-boot)
84
85
86Names and Spelling:
87===================
88
89The "official" name of this project is "Das U-Boot". The spelling
90"U-Boot" shall be used in all written text (documentation, comments
91in source files etc.). Example:
92
93 This is the README file for the U-Boot project.
94
95File names etc. shall be based on the string "u-boot". Examples:
96
97 include/asm-ppc/u-boot.h
98
99 #include <asm/u-boot.h>
100
101Variable names, preprocessor constants etc. shall be either based on
102the string "u_boot" or on "U_BOOT". Example:
103
104 U_BOOT_VERSION u_boot_logo
105 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000106
107
wdenk93f19cc2002-12-17 17:55:09 +0000108Versioning:
109===========
110
111U-Boot uses a 3 level version number containing a version, a
112sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
113sub-version "34", and patchlevel "4".
114
115The patchlevel is used to indicate certain stages of development
116between released versions, i. e. officially released versions of
117U-Boot will always have a patchlevel of "0".
118
119
wdenkc6097192002-11-03 00:24:07 +0000120Directory Hierarchy:
121====================
122
wdenk7152b1d2003-09-05 23:19:14 +0000123- board Board dependent files
124- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000125- cpu CPU specific files
wdenk983fda82004-10-28 00:09:35 +0000126 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000127 - arm720t Files specific to ARM 720 CPUs
128 - arm920t Files specific to ARM 920 CPUs
wdenka85f9f22005-04-06 13:52:31 +0000129 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk983fda82004-10-28 00:09:35 +0000130 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenk1d9f4102004-10-09 22:21:29 +0000131 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000132 - arm925t Files specific to ARM 925 CPUs
133 - arm926ejs Files specific to ARM 926 CPUs
wdenk8ed96042005-01-09 23:16:25 +0000134 - arm1136 Files specific to ARM 1136 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000135 - i386 Files specific to i386 CPUs
136 - ixp Files specific to Intel XScale IXP CPUs
wdenk983fda82004-10-28 00:09:35 +0000137 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000138 - mips Files specific to MIPS CPUs
wdenk983fda82004-10-28 00:09:35 +0000139 - mpc5xx Files specific to Freescale MPC5xx CPUs
140 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
141 - mpc8xx Files specific to Freescale MPC8xx CPUs
142 - mpc8220 Files specific to Freescale MPC8220 CPUs
143 - mpc824x Files specific to Freescale MPC824x CPUs
144 - mpc8260 Files specific to Freescale MPC8260 CPUs
145 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000146 - nios Files specific to Altera NIOS CPUs
wdenk5c952cf2004-10-10 21:27:30 +0000147 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200148 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000149 - pxa Files specific to Intel XScale PXA CPUs
150 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
151 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000152- disk Code for disk drive partition handling
153- doc Documentation (don't expect too much)
wdenk7152b1d2003-09-05 23:19:14 +0000154- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000155- dtt Digital Thermometer and Thermostat drivers
156- examples Example code for standalone applications, etc.
157- include Header Files
wdenk11dadd52004-02-27 00:07:27 +0000158- lib_arm Files generic to ARM architecture
159- lib_generic Files generic to all architectures
160- lib_i386 Files generic to i386 architecture
161- lib_m68k Files generic to m68k architecture
162- lib_mips Files generic to MIPS architecture
163- lib_nios Files generic to NIOS architecture
164- lib_ppc Files generic to PowerPC architecture
wdenkc6097192002-11-03 00:24:07 +0000165- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000166- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000167- rtc Real Time Clock drivers
168- tools Tools to build S-Record or U-Boot images, etc.
169
wdenkc6097192002-11-03 00:24:07 +0000170Software Configuration:
171=======================
172
173Configuration is usually done using C preprocessor defines; the
174rationale behind that is to avoid dead code whenever possible.
175
176There are two classes of configuration variables:
177
178* Configuration _OPTIONS_:
179 These are selectable by the user and have names beginning with
180 "CONFIG_".
181
182* Configuration _SETTINGS_:
183 These depend on the hardware etc. and should not be meddled with if
184 you don't know what you're doing; they have names beginning with
185 "CFG_".
186
187Later we will add a configuration tool - probably similar to or even
188identical to what's used for the Linux kernel. Right now, we have to
189do the configuration by hand, which means creating some symbolic
190links and editing some configuration files. We use the TQM8xxL boards
191as an example here.
192
193
194Selection of Processor Architecture and Board Type:
195---------------------------------------------------
196
197For all supported boards there are ready-to-use default
198configurations available; just type "make <board_name>_config".
199
200Example: For a TQM823L module type:
201
202 cd u-boot
203 make TQM823L_config
204
205For the Cogent platform, you need to specify the cpu type as well;
206e.g. "make cogent_mpc8xx_config". And also configure the cogent
207directory according to the instructions in cogent/README.
208
209
210Configuration Options:
211----------------------
212
213Configuration depends on the combination of board and CPU type; all
214such information is kept in a configuration file
215"include/configs/<board_name>.h".
216
217Example: For a TQM823L module, all configuration settings are in
218"include/configs/TQM823L.h".
219
220
wdenk7f6c2cb2002-11-10 22:06:23 +0000221Many of the options are named exactly as the corresponding Linux
222kernel configuration options. The intention is to make it easier to
223build a config tool - later.
224
225
wdenkc6097192002-11-03 00:24:07 +0000226The following options need to be configured:
227
228- CPU Type: Define exactly one of
229
230 PowerPC based CPUs:
231 -------------------
232 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860
wdenk0db5bca2003-03-31 17:27:09 +0000233 or CONFIG_MPC5xx
wdenk983fda82004-10-28 00:09:35 +0000234 or CONFIG_MPC8220
wdenkc6097192002-11-03 00:24:07 +0000235 or CONFIG_MPC824X, CONFIG_MPC8260
wdenk42d1f032003-10-15 23:53:47 +0000236 or CONFIG_MPC85xx
wdenkc6097192002-11-03 00:24:07 +0000237 or CONFIG_IOP480
238 or CONFIG_405GP
wdenk12f34242003-09-02 22:48:03 +0000239 or CONFIG_405EP
wdenkc6097192002-11-03 00:24:07 +0000240 or CONFIG_440
241 or CONFIG_MPC74xx
wdenk72755c72003-06-20 23:10:58 +0000242 or CONFIG_750FX
wdenkc6097192002-11-03 00:24:07 +0000243
244 ARM based CPUs:
245 ---------------
246 CONFIG_SA1110
247 CONFIG_ARM7
248 CONFIG_PXA250
249
wdenk507bbe32004-04-18 21:13:41 +0000250 MicroBlaze based CPUs:
251 ----------------------
wdenk857cad32004-07-10 23:48:41 +0000252 CONFIG_MICROBLAZE
wdenk507bbe32004-04-18 21:13:41 +0000253
wdenk5c952cf2004-10-10 21:27:30 +0000254 Nios-2 based CPUs:
255 ----------------------
256 CONFIG_NIOS2
257
wdenkc6097192002-11-03 00:24:07 +0000258
259- Board Type: Define exactly one of
260
261 PowerPC based boards:
262 ---------------------
263
wdenk17ea1172004-06-06 21:51:03 +0000264 CONFIG_ADCIOP CONFIG_GEN860T CONFIG_PCI405
265 CONFIG_ADS860 CONFIG_GENIETV CONFIG_PCIPPC2
266 CONFIG_AMX860 CONFIG_GTH CONFIG_PCIPPC6
267 CONFIG_AR405 CONFIG_gw8260 CONFIG_pcu_e
268 CONFIG_BAB7xx CONFIG_hermes CONFIG_PIP405
269 CONFIG_c2mon CONFIG_hymod CONFIG_PM826
270 CONFIG_CANBT CONFIG_IAD210 CONFIG_ppmc8260
271 CONFIG_CCM CONFIG_ICU862 CONFIG_QS823
272 CONFIG_CMI CONFIG_IP860 CONFIG_QS850
273 CONFIG_cogent_mpc8260 CONFIG_IPHASE4539 CONFIG_QS860T
274 CONFIG_cogent_mpc8xx CONFIG_IVML24 CONFIG_RBC823
275 CONFIG_CPCI405 CONFIG_IVML24_128 CONFIG_RPXClassic
276 CONFIG_CPCI4052 CONFIG_IVML24_256 CONFIG_RPXlite
277 CONFIG_CPCIISER4 CONFIG_IVMS8 CONFIG_RPXsuper
278 CONFIG_CPU86 CONFIG_IVMS8_128 CONFIG_rsdproto
279 CONFIG_CRAYL1 CONFIG_IVMS8_256 CONFIG_sacsng
280 CONFIG_CSB272 CONFIG_JSE CONFIG_Sandpoint8240
281 CONFIG_CU824 CONFIG_LANTEC CONFIG_Sandpoint8245
282 CONFIG_DASA_SIM CONFIG_lwmon CONFIG_sbc8260
wdenk8b07a112004-07-10 21:45:47 +0000283 CONFIG_DB64360 CONFIG_MBX CONFIG_sbc8560
284 CONFIG_DB64460 CONFIG_MBX860T CONFIG_SM850
285 CONFIG_DU405 CONFIG_MHPC CONFIG_SPD823TS
286 CONFIG_DUET_ADS CONFIG_MIP405 CONFIG_STXGP3
287 CONFIG_EBONY CONFIG_MOUSSE CONFIG_SXNI855T
288 CONFIG_ELPPC CONFIG_MPC8260ADS CONFIG_TQM823L
289 CONFIG_ELPT860 CONFIG_MPC8540ADS CONFIG_TQM8260
Lunsheng Wangb0e32942005-07-29 10:20:29 -0500290 CONFIG_ep8260 CONFIG_MPC8540EVAL CONFIG_TQM850L
291 CONFIG_ERIC CONFIG_MPC8560ADS CONFIG_TQM855L
292 CONFIG_ESTEEM192E CONFIG_MUSENKI CONFIG_TQM860L
293 CONFIG_ETX094 CONFIG_MVS1 CONFIG_TTTech
294 CONFIG_EVB64260 CONFIG_NETPHONE CONFIG_UTX8245
295 CONFIG_FADS823 CONFIG_NETTA CONFIG_V37
296 CONFIG_FADS850SAR CONFIG_NETVIA CONFIG_W7OLMC
297 CONFIG_FADS860T CONFIG_NX823 CONFIG_W7OLMG
Jon Loeliger4b1d95d2005-08-02 13:53:07 -0500298 CONFIG_FLAGADM CONFIG_OCRTC CONFIG_WALNUT
Lunsheng Wangb0e32942005-07-29 10:20:29 -0500299 CONFIG_FPS850L CONFIG_ORSG CONFIG_ZPC1900
300 CONFIG_FPS860L CONFIG_OXC CONFIG_ZUMA
wdenkc6097192002-11-03 00:24:07 +0000301
302 ARM based boards:
303 -----------------
304
wdenk8ed96042005-01-09 23:16:25 +0000305 CONFIG_AT91RM9200DK, CONFIG_CERF250, CONFIG_DNP1110,
306 CONFIG_EP7312, CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE,
307 CONFIG_IMPA7, CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610,
308 CONFIG_LART, CONFIG_LPD7A400 CONFIG_LUBBOCK,
309 CONFIG_OSK_OMAP5912, CONFIG_OMAP2420H4, CONFIG_SHANNON,
310 CONFIG_P2_OMAP730, CONFIG_SMDK2400, CONFIG_SMDK2410,
311 CONFIG_TRAB, CONFIG_VCMA9
wdenkc6097192002-11-03 00:24:07 +0000312
wdenk507bbe32004-04-18 21:13:41 +0000313 MicroBlaze based boards:
314 ------------------------
315
316 CONFIG_SUZAKU
317
wdenk5c952cf2004-10-10 21:27:30 +0000318 Nios-2 based boards:
319 ------------------------
320
321 CONFIG_PCI5441 CONFIG_PK1C20
322
wdenkc6097192002-11-03 00:24:07 +0000323
324- CPU Module Type: (if CONFIG_COGENT is defined)
325 Define exactly one of
326 CONFIG_CMA286_60_OLD
327--- FIXME --- not tested yet:
328 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
329 CONFIG_CMA287_23, CONFIG_CMA287_50
330
331- Motherboard Type: (if CONFIG_COGENT is defined)
332 Define exactly one of
333 CONFIG_CMA101, CONFIG_CMA102
334
335- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
336 Define one or more of
337 CONFIG_CMA302
338
339- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
340 Define one or more of
341 CONFIG_LCD_HEARTBEAT - update a character position on
342 the lcd display every second with
343 a "rotator" |\-/|\-/
344
wdenk2535d602003-07-17 23:16:40 +0000345- Board flavour: (if CONFIG_MPC8260ADS is defined)
346 CONFIG_ADSTYPE
347 Possible values are:
348 CFG_8260ADS - original MPC8260ADS
wdenk180d3f72004-01-04 16:28:35 +0000349 CFG_8266ADS - MPC8266ADS
wdenk54387ac2003-10-08 22:45:44 +0000350 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
wdenk04a85b32004-04-15 18:22:41 +0000351 CFG_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000352
wdenkc6097192002-11-03 00:24:07 +0000353- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000354 Define exactly one of
355 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000356
wdenk75d1ea72004-01-31 20:06:54 +0000357- 8xx CPU Options: (if using an MPC8xx cpu)
wdenk66ca92a2004-09-28 17:59:53 +0000358 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
359 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000360 e.g. if there is no 32KHz
361 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000362 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
363 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000364
wdenk66ca92a2004-09-28 17:59:53 +0000365- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
366 CFG_8xx_CPUCLK_MIN
367 CFG_8xx_CPUCLK_MAX
368 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000369 See doc/README.MPC866
370
371 CFG_MEASURE_CPUCLK
372
wdenkba56f622004-02-06 23:19:44 +0000373 Define this to measure the actual CPU clock instead
374 of relying on the correctness of the configured
375 values. Mostly useful for board bringup to make sure
376 the PLL is locked at the intended frequency. Note
377 that this requires a (stable) reference clock (32 kHz
wdenk66ca92a2004-09-28 17:59:53 +0000378 RTC clock or CFG_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000379
wdenk5da627a2003-10-09 20:09:04 +0000380- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000381 CONFIG_CLOCKS_IN_MHZ
382
383 U-Boot stores all clock information in Hz
384 internally. For binary compatibility with older Linux
385 kernels (which expect the clocks passed in the
386 bd_info data to be in MHz) the environment variable
387 "clocks_in_mhz" can be defined so that U-Boot
388 converts clock data to MHZ before passing it to the
389 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000390 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
391 "clocks_in_mhz=1" is automatically included in the
392 default environment.
393
wdenk5da627a2003-10-09 20:09:04 +0000394 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
395
396 When transfering memsize parameter to linux, some versions
397 expect it to be in bytes, others in MB.
398 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
399
wdenk6705d812004-08-02 23:22:59 +0000400- Serial Ports:
401 CFG_PL010_SERIAL
402
403 Define this if you want support for Amba PrimeCell PL010 UARTs.
404
405 CFG_PL011_SERIAL
406
407 Define this if you want support for Amba PrimeCell PL011 UARTs.
408
409 CONFIG_PL011_CLOCK
410
411 If you have Amba PrimeCell PL011 UARTs, set this variable to
412 the clock speed of the UARTs.
413
414 CONFIG_PL01x_PORTS
415
416 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
417 define this to a list of base addresses for each (supported)
418 port. See e.g. include/configs/versatile.h
419
420
wdenkc6097192002-11-03 00:24:07 +0000421- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000422 Depending on board, define exactly one serial port
423 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
424 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
425 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000426
427 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
428 port routines must be defined elsewhere
429 (i.e. serial_init(), serial_getc(), ...)
430
431 CONFIG_CFB_CONSOLE
432 Enables console device for a color framebuffer. Needs following
433 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
434 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
435 (default big endian)
436 VIDEO_HW_RECTFILL graphic chip supports
437 rectangle fill
438 (cf. smiLynxEM)
439 VIDEO_HW_BITBLT graphic chip supports
440 bit-blit (cf. smiLynxEM)
441 VIDEO_VISIBLE_COLS visible pixel columns
442 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000443 VIDEO_VISIBLE_ROWS visible pixel rows
444 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000445 VIDEO_DATA_FORMAT graphic data format
446 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000447 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000448 VIDEO_KBD_INIT_FCT keyboard int fct
449 (i.e. i8042_kbd_init())
450 VIDEO_TSTC_FCT test char fct
451 (i.e. i8042_tstc)
452 VIDEO_GETC_FCT get char fct
453 (i.e. i8042_getc)
454 CONFIG_CONSOLE_CURSOR cursor drawing on/off
455 (requires blink timer
456 cf. i8042.c)
457 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
458 CONFIG_CONSOLE_TIME display time/date info in
459 upper right corner
460 (requires CFG_CMD_DATE)
461 CONFIG_VIDEO_LOGO display Linux logo in
462 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000463 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
464 linux_logo.h for logo.
465 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000466 CONFIG_CONSOLE_EXTRA_INFO
467 addional board info beside
468 the logo
469
wdenk43d96162003-03-06 00:02:04 +0000470 When CONFIG_CFB_CONSOLE is defined, video console is
471 default i/o. Serial console can be forced with
472 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000473
wdenkd4ca31c2004-01-02 14:00:00 +0000474 When CONFIG_SILENT_CONSOLE is defined, all console
475 messages (by U-Boot and Linux!) can be silenced with
476 the "silent" environment variable. See
477 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000478
wdenkc6097192002-11-03 00:24:07 +0000479- Console Baudrate:
480 CONFIG_BAUDRATE - in bps
481 Select one of the baudrates listed in
482 CFG_BAUDRATE_TABLE, see below.
wdenk3bbc8992003-12-07 22:27:15 +0000483 CFG_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000484
485- Interrupt driven serial port input:
486 CONFIG_SERIAL_SOFTWARE_FIFO
487
488 PPC405GP only.
489 Use an interrupt handler for receiving data on the
490 serial port. It also enables using hardware handshake
491 (RTS/CTS) and UART's built-in FIFO. Set the number of
492 bytes the interrupt driven input buffer should have.
493
wdenk109c0e32004-03-23 21:43:07 +0000494 Leave undefined to disable this feature, including
495 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000496
stroese1d49b1f2003-05-23 11:39:05 +0000497- Console UART Number:
498 CONFIG_UART1_CONSOLE
499
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200500 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000501 If defined internal UART1 (and not UART0) is used
502 as default U-Boot console.
503
wdenkc6097192002-11-03 00:24:07 +0000504- Boot Delay: CONFIG_BOOTDELAY - in seconds
505 Delay before automatically booting the default image;
506 set to -1 to disable autoboot.
507
508 See doc/README.autoboot for these options that
509 work with CONFIG_BOOTDELAY. None are required.
510 CONFIG_BOOT_RETRY_TIME
511 CONFIG_BOOT_RETRY_MIN
512 CONFIG_AUTOBOOT_KEYED
513 CONFIG_AUTOBOOT_PROMPT
514 CONFIG_AUTOBOOT_DELAY_STR
515 CONFIG_AUTOBOOT_STOP_STR
516 CONFIG_AUTOBOOT_DELAY_STR2
517 CONFIG_AUTOBOOT_STOP_STR2
518 CONFIG_ZERO_BOOTDELAY_CHECK
519 CONFIG_RESET_TO_RETRY
520
521- Autoboot Command:
522 CONFIG_BOOTCOMMAND
523 Only needed when CONFIG_BOOTDELAY is enabled;
524 define a command string that is automatically executed
525 when no character is read on the console interface
526 within "Boot Delay" after reset.
527
528 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000529 This can be used to pass arguments to the bootm
530 command. The value of CONFIG_BOOTARGS goes into the
531 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000532
533 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000534 The value of these goes into the environment as
535 "ramboot" and "nfsboot" respectively, and can be used
536 as a convenience, when switching between booting from
537 ram and nfs.
wdenkc6097192002-11-03 00:24:07 +0000538
539- Pre-Boot Commands:
540 CONFIG_PREBOOT
541
542 When this option is #defined, the existence of the
543 environment variable "preboot" will be checked
544 immediately before starting the CONFIG_BOOTDELAY
545 countdown and/or running the auto-boot command resp.
546 entering interactive mode.
547
548 This feature is especially useful when "preboot" is
549 automatically generated or modified. For an example
550 see the LWMON board specific code: here "preboot" is
551 modified when the user holds down a certain
552 combination of keys on the (special) keyboard when
553 booting the systems
554
555- Serial Download Echo Mode:
556 CONFIG_LOADS_ECHO
557 If defined to 1, all characters received during a
558 serial download (using the "loads" command) are
559 echoed back. This might be needed by some terminal
560 emulations (like "cu"), but may as well just take
561 time on others. This setting #define's the initial
562 value of the "loads_echo" environment variable.
563
564- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
565 CONFIG_KGDB_BAUDRATE
566 Select one of the baudrates listed in
567 CFG_BAUDRATE_TABLE, see below.
568
569- Monitor Functions:
570 CONFIG_COMMANDS
571 Most monitor functions can be selected (or
572 de-selected) by adjusting the definition of
573 CONFIG_COMMANDS; to select individual functions,
574 #define CONFIG_COMMANDS by "OR"ing any of the
575 following values:
576
577 #define enables commands:
578 -------------------------
579 CFG_CMD_ASKENV * ask for env variable
wdenk78137c32003-09-15 18:00:00 +0000580 CFG_CMD_AUTOSCRIPT Autoscript Support
wdenkc6097192002-11-03 00:24:07 +0000581 CFG_CMD_BDI bdinfo
wdenk6705d812004-08-02 23:22:59 +0000582 CFG_CMD_BEDBUG * Include BedBug Debugger
wdenkba56f622004-02-06 23:19:44 +0000583 CFG_CMD_BMP * BMP support
wdenk6705d812004-08-02 23:22:59 +0000584 CFG_CMD_BSP * Board specific commands
wdenkc6097192002-11-03 00:24:07 +0000585 CFG_CMD_BOOTD bootd
wdenk6705d812004-08-02 23:22:59 +0000586 CFG_CMD_CACHE * icache, dcache
wdenkc6097192002-11-03 00:24:07 +0000587 CFG_CMD_CONSOLE coninfo
588 CFG_CMD_DATE * support for RTC, date/time...
wdenk6705d812004-08-02 23:22:59 +0000589 CFG_CMD_DHCP * DHCP support
wdenkba56f622004-02-06 23:19:44 +0000590 CFG_CMD_DIAG * Diagnostics
591 CFG_CMD_DOC * Disk-On-Chip Support
wdenk6705d812004-08-02 23:22:59 +0000592 CFG_CMD_DTT * Digital Therm and Thermostat
wdenkc6097192002-11-03 00:24:07 +0000593 CFG_CMD_ECHO * echo arguments
594 CFG_CMD_EEPROM * EEPROM read/write support
wdenk6705d812004-08-02 23:22:59 +0000595 CFG_CMD_ELF * bootelf, bootvx
wdenkc6097192002-11-03 00:24:07 +0000596 CFG_CMD_ENV saveenv
597 CFG_CMD_FDC * Floppy Disk Support
wdenk6705d812004-08-02 23:22:59 +0000598 CFG_CMD_FAT * FAT partition support
wdenk2262cfe2002-11-18 00:14:45 +0000599 CFG_CMD_FDOS * Dos diskette Support
wdenkc6097192002-11-03 00:24:07 +0000600 CFG_CMD_FLASH flinfo, erase, protect
601 CFG_CMD_FPGA FPGA device initialization support
wdenkba56f622004-02-06 23:19:44 +0000602 CFG_CMD_HWFLOW * RTS/CTS hw flow control
wdenkc6097192002-11-03 00:24:07 +0000603 CFG_CMD_I2C * I2C serial bus support
604 CFG_CMD_IDE * IDE harddisk support
605 CFG_CMD_IMI iminfo
wdenkba56f622004-02-06 23:19:44 +0000606 CFG_CMD_IMLS List all found images
wdenkc6097192002-11-03 00:24:07 +0000607 CFG_CMD_IMMAP * IMMR dump support
608 CFG_CMD_IRQ * irqinfo
wdenk6705d812004-08-02 23:22:59 +0000609 CFG_CMD_ITEST Integer/string test of 2 values
wdenkba56f622004-02-06 23:19:44 +0000610 CFG_CMD_JFFS2 * JFFS2 Support
wdenkc6097192002-11-03 00:24:07 +0000611 CFG_CMD_KGDB * kgdb
612 CFG_CMD_LOADB loadb
613 CFG_CMD_LOADS loads
614 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
wdenk56523f12004-07-11 17:40:54 +0000615 loop, loopw, mtest
wdenkba56f622004-02-06 23:19:44 +0000616 CFG_CMD_MISC Misc functions like sleep etc
wdenk6705d812004-08-02 23:22:59 +0000617 CFG_CMD_MMC * MMC memory mapped support
618 CFG_CMD_MII * MII utility commands
wdenkba56f622004-02-06 23:19:44 +0000619 CFG_CMD_NAND * NAND support
wdenkc6097192002-11-03 00:24:07 +0000620 CFG_CMD_NET bootp, tftpboot, rarpboot
621 CFG_CMD_PCI * pciinfo
622 CFG_CMD_PCMCIA * PCMCIA support
wdenkba56f622004-02-06 23:19:44 +0000623 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
624 CFG_CMD_PORTIO * Port I/O
wdenkc6097192002-11-03 00:24:07 +0000625 CFG_CMD_REGINFO * Register dump
626 CFG_CMD_RUN run command in env variable
wdenk6705d812004-08-02 23:22:59 +0000627 CFG_CMD_SAVES * save S record dump
wdenkc6097192002-11-03 00:24:07 +0000628 CFG_CMD_SCSI * SCSI Support
wdenkba56f622004-02-06 23:19:44 +0000629 CFG_CMD_SDRAM * print SDRAM configuration information
wdenkb1bf6f22005-04-03 14:52:59 +0000630 (requires CFG_CMD_I2C)
wdenkc6097192002-11-03 00:24:07 +0000631 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
632 CFG_CMD_SPI * SPI serial bus support
633 CFG_CMD_USB * USB support
wdenkba56f622004-02-06 23:19:44 +0000634 CFG_CMD_VFD * VFD support (TRAB)
wdenkc6097192002-11-03 00:24:07 +0000635 CFG_CMD_BSP * Board SPecific functions
wdenka3d991b2004-04-15 21:48:45 +0000636 CFG_CMD_CDP * Cisco Discover Protocol support
wdenkc6097192002-11-03 00:24:07 +0000637 -----------------------------------------------
638 CFG_CMD_ALL all
639
wdenk81050922004-07-11 20:04:51 +0000640 CONFIG_CMD_DFL Default configuration; at the moment
wdenkc6097192002-11-03 00:24:07 +0000641 this is includes all commands, except
642 the ones marked with "*" in the list
643 above.
644
645 If you don't define CONFIG_COMMANDS it defaults to
wdenk81050922004-07-11 20:04:51 +0000646 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
wdenkc6097192002-11-03 00:24:07 +0000647 override the default settings in the respective
648 include file.
649
650 EXAMPLE: If you want all functions except of network
651 support you can write:
652
653 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
654
655
656 Note: Don't enable the "icache" and "dcache" commands
wdenk43d96162003-03-06 00:02:04 +0000657 (configuration option CFG_CMD_CACHE) unless you know
658 what you (and your U-Boot users) are doing. Data
659 cache cannot be enabled on systems like the 8xx or
660 8260 (where accesses to the IMMR region must be
661 uncached), and it cannot be disabled on all other
662 systems where we (mis-) use the data cache to hold an
663 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000664
665
666 XXX - this list needs to get updated!
667
668- Watchdog:
669 CONFIG_WATCHDOG
670 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000671 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000672 code for a watchdog. For the 8xx and 8260 CPUs, the
673 SIU Watchdog feature is enabled in the SYPCR
674 register.
675
stroesec1551ea2003-04-04 15:53:41 +0000676- U-Boot Version:
677 CONFIG_VERSION_VARIABLE
678 If this variable is defined, an environment variable
679 named "ver" is created by U-Boot showing the U-Boot
680 version as printed by the "version" command.
681 This variable is readonly.
682
wdenkc6097192002-11-03 00:24:07 +0000683- Real-Time Clock:
684
685 When CFG_CMD_DATE is selected, the type of the RTC
686 has to be selected, too. Define exactly one of the
687 following options:
688
689 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
690 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
691 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000692 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000693 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000694 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000695 CONFIG_RTC_DS164x - use Dallas DS164x RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000696 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
wdenkc6097192002-11-03 00:24:07 +0000697
wdenkb37c7e52003-06-30 16:24:52 +0000698 Note that if the RTC uses I2C, then the I2C interface
699 must also be configured. See I2C Support, below.
700
wdenkc6097192002-11-03 00:24:07 +0000701- Timestamp Support:
702
wdenk43d96162003-03-06 00:02:04 +0000703 When CONFIG_TIMESTAMP is selected, the timestamp
704 (date and time) of an image is printed by image
705 commands like bootm or iminfo. This option is
706 automatically enabled when you select CFG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000707
708- Partition Support:
709 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
710 and/or CONFIG_ISO_PARTITION
711
712 If IDE or SCSI support is enabled (CFG_CMD_IDE or
713 CFG_CMD_SCSI) you must configure support for at least
714 one partition type as well.
715
716- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000717 CONFIG_IDE_RESET_ROUTINE - this is defined in several
718 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000719
wdenk4d13cba2004-03-14 14:09:05 +0000720 CONFIG_IDE_RESET - is this is defined, IDE Reset will
721 be performed by calling the function
722 ide_set_reset(int reset)
723 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000724
725- ATAPI Support:
726 CONFIG_ATAPI
727
728 Set this to enable ATAPI support.
729
wdenkc40b2952004-03-13 23:29:43 +0000730- LBA48 Support
731 CONFIG_LBA48
732
733 Set this to enable support for disks larger than 137GB
734 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
735 Whithout these , LBA48 support uses 32bit variables and will 'only'
736 support disks up to 2.1TB.
737
738 CFG_64BIT_LBA:
739 When enabled, makes the IDE subsystem use 64bit sector addresses.
740 Default is 32bit.
741
wdenkc6097192002-11-03 00:24:07 +0000742- SCSI Support:
743 At the moment only there is only support for the
744 SYM53C8XX SCSI controller; define
745 CONFIG_SCSI_SYM53C8XX to enable it.
746
747 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
748 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
749 CFG_SCSI_MAX_LUN] can be adjusted to define the
750 maximum numbers of LUNs, SCSI ID's and target
751 devices.
752 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
753
754- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000755 CONFIG_E1000
756 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000757
wdenkc6097192002-11-03 00:24:07 +0000758 CONFIG_EEPRO100
759 Support for Intel 82557/82559/82559ER chips.
760 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
761 write routine for first time initialisation.
762
763 CONFIG_TULIP
764 Support for Digital 2114x chips.
765 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
766 modem chip initialisation (KS8761/QS6611).
767
768 CONFIG_NATSEMI
769 Support for National dp83815 chips.
770
771 CONFIG_NS8382X
772 Support for National dp8382[01] gigabit chips.
773
wdenk45219c42003-05-12 21:50:16 +0000774- NETWORK Support (other):
775
776 CONFIG_DRIVER_LAN91C96
777 Support for SMSC's LAN91C96 chips.
778
779 CONFIG_LAN91C96_BASE
780 Define this to hold the physical address
781 of the LAN91C96's I/O space
782
783 CONFIG_LAN91C96_USE_32_BIT
784 Define this to enable 32 bit addressing
785
wdenkf39748a2004-06-09 13:37:52 +0000786 CONFIG_DRIVER_SMC91111
787 Support for SMSC's LAN91C111 chip
788
789 CONFIG_SMC91111_BASE
790 Define this to hold the physical address
791 of the device (I/O space)
792
793 CONFIG_SMC_USE_32_BIT
794 Define this if data bus is 32 bits
795
796 CONFIG_SMC_USE_IOFUNCS
797 Define this to use i/o functions instead of macros
798 (some hardware wont work with macros)
799
wdenkc6097192002-11-03 00:24:07 +0000800- USB Support:
801 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000802 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000803 CONFIG_USB_UHCI to enable it.
804 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000805 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000806 storage devices.
807 Note:
808 Supported are USB Keyboards and USB Floppy drives
809 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000810 MPC5200 USB requires additional defines:
811 CONFIG_USB_CLOCK
812 for 528 MHz Clock: 0x0001bbbb
813 CONFIG_USB_CONFIG
814 for differential drivers: 0x00001000
815 for single ended drivers: 0x00005000
816
wdenkc6097192002-11-03 00:24:07 +0000817
wdenk71f95112003-06-15 22:40:42 +0000818- MMC Support:
wdenk8bde7f72003-06-27 21:31:46 +0000819 The MMC controller on the Intel PXA is supported. To
820 enable this define CONFIG_MMC. The MMC can be
821 accessed from the boot prompt by mapping the device
wdenk71f95112003-06-15 22:40:42 +0000822 to physical memory similar to flash. Command line is
823 enabled with CFG_CMD_MMC. The MMC driver also works with
wdenk8bde7f72003-06-27 21:31:46 +0000824 the FAT fs. This is enabled with CFG_CMD_FAT.
wdenk71f95112003-06-15 22:40:42 +0000825
wdenk6705d812004-08-02 23:22:59 +0000826- Journaling Flash filesystem support:
827 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
828 CONFIG_JFFS2_NAND_DEV
829 Define these for a default partition on a NAND device
830
831 CFG_JFFS2_FIRST_SECTOR,
832 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
833 Define these for a default partition on a NOR device
834
835 CFG_JFFS_CUSTOM_PART
836 Define this to create an own partition. You have to provide a
837 function struct part_info* jffs2_part_info(int part_num)
838
839 If you define only one JFFS2 partition you may also want to
wdenkefe2a4d2004-12-16 21:44:03 +0000840 #define CFG_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +0000841 to disable the command chpart. This is the default when you
842 have not defined a custom partition
843
wdenkc6097192002-11-03 00:24:07 +0000844- Keyboard Support:
845 CONFIG_ISA_KEYBOARD
846
847 Define this to enable standard (PC-Style) keyboard
848 support
849
850 CONFIG_I8042_KBD
851 Standard PC keyboard driver with US (is default) and
852 GERMAN key layout (switch via environment 'keymap=de') support.
853 Export function i8042_kbd_init, i8042_tstc and i8042_getc
854 for cfb_console. Supports cursor blinking.
855
856- Video support:
857 CONFIG_VIDEO
858
859 Define this to enable video support (for output to
860 video).
861
862 CONFIG_VIDEO_CT69000
863
864 Enable Chips & Technologies 69000 Video chip
865
866 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000867 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000868 video output is selected via environment 'videoout'
869 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
870 assumed.
wdenkc6097192002-11-03 00:24:07 +0000871
wdenkb79a11c2004-03-25 15:14:43 +0000872 For the CT69000 and SMI_LYNXEM drivers, videomode is
873 selected via environment 'videomode'. Two diferent ways
wdenkeeb1b772004-03-23 22:53:55 +0000874 are possible:
875 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000876 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000877
878 Colors 640x480 800x600 1024x768 1152x864 1280x1024
879 -------------+---------------------------------------------
880 8 bits | 0x301* 0x303 0x305 0x161 0x307
881 15 bits | 0x310 0x313 0x316 0x162 0x319
882 16 bits | 0x311 0x314 0x317 0x163 0x31A
883 24 bits | 0x312 0x315 0x318 ? 0x31B
884 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000885 (i.e. setenv videomode 317; saveenv; reset;)
886
wdenkb79a11c2004-03-25 15:14:43 +0000887 - "videomode=bootargs" all the video parameters are parsed
wdenkeeb1b772004-03-23 22:53:55 +0000888 from the bootargs. (See drivers/videomodes.c)
889
890
stroesec1551ea2003-04-04 15:53:41 +0000891 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +0000892 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +0000893 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
894 or CONFIG_VIDEO_SED13806_16BPP
895
wdenk682011f2003-06-03 23:54:09 +0000896- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +0000897 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +0000898
wdenk8bde7f72003-06-27 21:31:46 +0000899 Define this to enable a custom keyboard support.
900 This simply calls drv_keyboard_init() which must be
901 defined in your board-specific files.
902 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +0000903
wdenkc6097192002-11-03 00:24:07 +0000904- LCD Support: CONFIG_LCD
905
906 Define this to enable LCD support (for output to LCD
907 display); also select one of the supported displays
908 by defining one of these:
909
wdenkfd3103b2003-11-25 16:55:19 +0000910 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000911
wdenkfd3103b2003-11-25 16:55:19 +0000912 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000913
wdenkfd3103b2003-11-25 16:55:19 +0000914 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +0000915
wdenkfd3103b2003-11-25 16:55:19 +0000916 NEC NL6448BC20-08. 6.5", 640x480.
917 Active, color, single scan.
918
919 CONFIG_NEC_NL6448BC33_54
920
921 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000922 Active, color, single scan.
923
924 CONFIG_SHARP_16x9
925
926 Sharp 320x240. Active, color, single scan.
927 It isn't 16x9, and I am not sure what it is.
928
929 CONFIG_SHARP_LQ64D341
930
931 Sharp LQ64D341 display, 640x480.
932 Active, color, single scan.
933
934 CONFIG_HLD1045
935
936 HLD1045 display, 640x480.
937 Active, color, single scan.
938
939 CONFIG_OPTREX_BW
940
941 Optrex CBL50840-2 NF-FW 99 22 M5
942 or
943 Hitachi LMG6912RPFC-00T
944 or
945 Hitachi SP14Q002
946
947 320x240. Black & white.
948
949 Normally display is black on white background; define
950 CFG_WHITE_ON_BLACK to get it inverted.
951
wdenk7152b1d2003-09-05 23:19:14 +0000952- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +0000953
wdenk8bde7f72003-06-27 21:31:46 +0000954 If this option is set, the environment is checked for
955 a variable "splashimage". If found, the usual display
956 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +0000957 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +0000958 specified in "splashimage" is loaded instead. The
959 console is redirected to the "nulldev", too. This
960 allows for a "silent" boot where a splash screen is
961 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +0000962
Stefan Roese98f4a3d2005-09-22 09:04:17 +0200963- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
964
965 If this option is set, additionally to standard BMP
966 images, gzipped BMP images can be displayed via the
967 splashscreen support or the bmp command.
968
wdenkc29fdfc2003-08-29 20:57:53 +0000969- Compression support:
970 CONFIG_BZIP2
971
972 If this option is set, support for bzip2 compressed
973 images is included. If not, only uncompressed and gzip
974 compressed images are supported.
975
wdenk42d1f032003-10-15 23:53:47 +0000976 NOTE: the bzip2 algorithm requires a lot of RAM, so
977 the malloc area (as defined by CFG_MALLOC_LEN) should
978 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +0000979
wdenk17ea1172004-06-06 21:51:03 +0000980- MII/PHY support:
981 CONFIG_PHY_ADDR
982
983 The address of PHY on MII bus.
984
985 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
986
987 The clock frequency of the MII bus
988
989 CONFIG_PHY_GIGE
990
991 If this option is set, support for speed/duplex
992 detection of Gigabit PHY is included.
993
994 CONFIG_PHY_RESET_DELAY
995
996 Some PHY like Intel LXT971A need extra delay after
997 reset before any MII register access is possible.
998 For such PHY, set this option to the usec delay
999 required. (minimum 300usec for LXT971A)
1000
1001 CONFIG_PHY_CMD_DELAY (ppc4xx)
1002
1003 Some PHY like Intel LXT971A need extra delay after
1004 command issued before MII status register can be read
1005
wdenkc6097192002-11-03 00:24:07 +00001006- Ethernet address:
1007 CONFIG_ETHADDR
1008 CONFIG_ETH2ADDR
1009 CONFIG_ETH3ADDR
1010
1011 Define a default value for ethernet address to use
1012 for the respective ethernet interface, in case this
1013 is not determined automatically.
1014
1015- IP address:
1016 CONFIG_IPADDR
1017
1018 Define a default value for the IP address to use for
1019 the default ethernet interface, in case this is not
1020 determined through e.g. bootp.
1021
1022- Server IP address:
1023 CONFIG_SERVERIP
1024
1025 Defines a default value for theIP address of a TFTP
1026 server to contact when using the "tftboot" command.
1027
1028- BOOTP Recovery Mode:
1029 CONFIG_BOOTP_RANDOM_DELAY
1030
1031 If you have many targets in a network that try to
1032 boot using BOOTP, you may want to avoid that all
1033 systems send out BOOTP requests at precisely the same
1034 moment (which would happen for instance at recovery
1035 from a power failure, when all systems will try to
1036 boot, thus flooding the BOOTP server. Defining
1037 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1038 inserted before sending out BOOTP requests. The
1039 following delays are insterted then:
1040
1041 1st BOOTP request: delay 0 ... 1 sec
1042 2nd BOOTP request: delay 0 ... 2 sec
1043 3rd BOOTP request: delay 0 ... 4 sec
1044 4th and following
1045 BOOTP requests: delay 0 ... 8 sec
1046
stroesefe389a82003-08-28 14:17:32 +00001047- DHCP Advanced Options:
1048 CONFIG_BOOTP_MASK
1049
1050 You can fine tune the DHCP functionality by adding
1051 these flags to the CONFIG_BOOTP_MASK define:
1052
1053 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1054 serverip from a DHCP server, it is possible that more
1055 than one DNS serverip is offered to the client.
1056 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1057 serverip will be stored in the additional environment
1058 variable "dnsip2". The first DNS serverip is always
1059 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1060 is added to the CONFIG_BOOTP_MASK.
1061
1062 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1063 to do a dynamic update of a DNS server. To do this, they
1064 need the hostname of the DHCP requester.
1065 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1066 CONFIG_BOOTP_MASK, the content of the "hostname"
1067 environment variable is passed as option 12 to
1068 the DHCP server.
1069
wdenka3d991b2004-04-15 21:48:45 +00001070 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001071 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001072
1073 The device id used in CDP trigger frames.
1074
1075 CONFIG_CDP_DEVICE_ID_PREFIX
1076
1077 A two character string which is prefixed to the MAC address
1078 of the device.
1079
1080 CONFIG_CDP_PORT_ID
1081
1082 A printf format string which contains the ascii name of
1083 the port. Normally is set to "eth%d" which sets
1084 eth0 for the first ethernet, eth1 for the second etc.
1085
1086 CONFIG_CDP_CAPABILITIES
1087
1088 A 32bit integer which indicates the device capabilities;
1089 0x00000010 for a normal host which does not forwards.
1090
1091 CONFIG_CDP_VERSION
1092
1093 An ascii string containing the version of the software.
1094
1095 CONFIG_CDP_PLATFORM
1096
1097 An ascii string containing the name of the platform.
1098
1099 CONFIG_CDP_TRIGGER
1100
1101 A 32bit integer sent on the trigger.
1102
1103 CONFIG_CDP_POWER_CONSUMPTION
1104
1105 A 16bit integer containing the power consumption of the
1106 device in .1 of milliwatts.
1107
1108 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1109
1110 A byte containing the id of the VLAN.
1111
wdenkc6097192002-11-03 00:24:07 +00001112- Status LED: CONFIG_STATUS_LED
1113
1114 Several configurations allow to display the current
1115 status using a LED. For instance, the LED will blink
1116 fast while running U-Boot code, stop blinking as
1117 soon as a reply to a BOOTP request was received, and
1118 start blinking slow once the Linux kernel is running
1119 (supported by a status LED driver in the Linux
1120 kernel). Defining CONFIG_STATUS_LED enables this
1121 feature in U-Boot.
1122
1123- CAN Support: CONFIG_CAN_DRIVER
1124
1125 Defining CONFIG_CAN_DRIVER enables CAN driver support
1126 on those systems that support this (optional)
1127 feature, like the TQM8xxL modules.
1128
1129- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1130
wdenkb37c7e52003-06-30 16:24:52 +00001131 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001132 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1133 include the appropriate I2C driver for the selected cpu.
wdenkc6097192002-11-03 00:24:07 +00001134
wdenk945af8d2003-07-16 21:53:01 +00001135 This will allow you to use i2c commands at the u-boot
1136 command line (as long as you set CFG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001137 CONFIG_COMMANDS) and communicate with i2c based realtime
1138 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001139 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001140
wdenkba56f622004-02-06 23:19:44 +00001141 CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
wdenkc6097192002-11-03 00:24:07 +00001142
wdenk945af8d2003-07-16 21:53:01 +00001143 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001144 bit-banging) driver instead of CPM or similar hardware
1145 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001146
wdenk945af8d2003-07-16 21:53:01 +00001147 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001148 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001149
wdenkb37c7e52003-06-30 16:24:52 +00001150 In both cases you will need to define CFG_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001151 to be the frequency (in Hz) at which you wish your i2c bus
1152 to run and CFG_I2C_SLAVE to be the address of this node (ie
1153 the cpu's i2c node address).
1154
wdenkb37c7e52003-06-30 16:24:52 +00001155 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1156 sets the cpu up as a master node and so its address should
1157 therefore be cleared to 0 (See, eg, MPC823e User's Manual
wdenk945af8d2003-07-16 21:53:01 +00001158 p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001159
wdenk945af8d2003-07-16 21:53:01 +00001160 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001161
1162 If you use the software i2c interface (CONFIG_SOFT_I2C)
1163 then the following macros need to be defined (examples are
1164 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001165
1166 I2C_INIT
1167
wdenkb37c7e52003-06-30 16:24:52 +00001168 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001169 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001170
wdenkba56f622004-02-06 23:19:44 +00001171 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001172
wdenkc6097192002-11-03 00:24:07 +00001173 I2C_PORT
1174
wdenk43d96162003-03-06 00:02:04 +00001175 (Only for MPC8260 CPU). The I/O port to use (the code
1176 assumes both bits are on the same port). Valid values
1177 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001178
1179 I2C_ACTIVE
1180
1181 The code necessary to make the I2C data line active
1182 (driven). If the data line is open collector, this
1183 define can be null.
1184
wdenkb37c7e52003-06-30 16:24:52 +00001185 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1186
wdenkc6097192002-11-03 00:24:07 +00001187 I2C_TRISTATE
1188
1189 The code necessary to make the I2C data line tri-stated
1190 (inactive). If the data line is open collector, this
1191 define can be null.
1192
wdenkb37c7e52003-06-30 16:24:52 +00001193 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1194
wdenkc6097192002-11-03 00:24:07 +00001195 I2C_READ
1196
1197 Code that returns TRUE if the I2C data line is high,
1198 FALSE if it is low.
1199
wdenkb37c7e52003-06-30 16:24:52 +00001200 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1201
wdenkc6097192002-11-03 00:24:07 +00001202 I2C_SDA(bit)
1203
1204 If <bit> is TRUE, sets the I2C data line high. If it
1205 is FALSE, it clears it (low).
1206
wdenkb37c7e52003-06-30 16:24:52 +00001207 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001208 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001209 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001210
wdenkc6097192002-11-03 00:24:07 +00001211 I2C_SCL(bit)
1212
1213 If <bit> is TRUE, sets the I2C clock line high. If it
1214 is FALSE, it clears it (low).
1215
wdenkb37c7e52003-06-30 16:24:52 +00001216 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001217 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001218 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001219
wdenkc6097192002-11-03 00:24:07 +00001220 I2C_DELAY
1221
1222 This delay is invoked four times per clock cycle so this
1223 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001224 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001225 like:
1226
wdenkb37c7e52003-06-30 16:24:52 +00001227 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001228
wdenk47cd00f2003-03-06 13:39:27 +00001229 CFG_I2C_INIT_BOARD
1230
wdenk8bde7f72003-06-27 21:31:46 +00001231 When a board is reset during an i2c bus transfer
1232 chips might think that the current transfer is still
1233 in progress. On some boards it is possible to access
1234 the i2c SCLK line directly, either by using the
1235 processor pin as a GPIO or by having a second pin
1236 connected to the bus. If this option is defined a
1237 custom i2c_init_board() routine in boards/xxx/board.c
1238 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001239
wdenk17ea1172004-06-06 21:51:03 +00001240 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1241
1242 This option enables configuration of bi_iic_fast[] flags
1243 in u-boot bd_info structure based on u-boot environment
1244 variable "i2cfast". (see also i2cfast)
1245
wdenkc6097192002-11-03 00:24:07 +00001246- SPI Support: CONFIG_SPI
1247
1248 Enables SPI driver (so far only tested with
1249 SPI EEPROM, also an instance works with Crystal A/D and
1250 D/As on the SACSng board)
1251
1252 CONFIG_SPI_X
1253
1254 Enables extended (16-bit) SPI EEPROM addressing.
1255 (symmetrical to CONFIG_I2C_X)
1256
1257 CONFIG_SOFT_SPI
1258
wdenk43d96162003-03-06 00:02:04 +00001259 Enables a software (bit-bang) SPI driver rather than
1260 using hardware support. This is a general purpose
1261 driver that only requires three general I/O port pins
1262 (two outputs, one input) to function. If this is
1263 defined, the board configuration must define several
1264 SPI configuration items (port pins to use, etc). For
1265 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001266
1267- FPGA Support: CONFIG_FPGA_COUNT
1268
wdenk43d96162003-03-06 00:02:04 +00001269 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001270
wdenk43d96162003-03-06 00:02:04 +00001271 CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001272
wdenk8bde7f72003-06-27 21:31:46 +00001273 Used to specify the types of FPGA devices. For example,
1274 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
wdenkc6097192002-11-03 00:24:07 +00001275
wdenk8bde7f72003-06-27 21:31:46 +00001276 CFG_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001277
wdenk8bde7f72003-06-27 21:31:46 +00001278 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001279
1280 CFG_FPGA_CHECK_BUSY
1281
wdenk43d96162003-03-06 00:02:04 +00001282 Enable checks on FPGA configuration interface busy
1283 status by the configuration function. This option
1284 will require a board or device specific function to
1285 be written.
wdenkc6097192002-11-03 00:24:07 +00001286
1287 CONFIG_FPGA_DELAY
1288
1289 If defined, a function that provides delays in the FPGA
1290 configuration driver.
1291
1292 CFG_FPGA_CHECK_CTRLC
1293 Allow Control-C to interrupt FPGA configuration
1294
1295 CFG_FPGA_CHECK_ERROR
1296
wdenk43d96162003-03-06 00:02:04 +00001297 Check for configuration errors during FPGA bitfile
1298 loading. For example, abort during Virtex II
1299 configuration if the INIT_B line goes low (which
1300 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001301
1302 CFG_FPGA_WAIT_INIT
1303
wdenk43d96162003-03-06 00:02:04 +00001304 Maximum time to wait for the INIT_B line to deassert
1305 after PROB_B has been deasserted during a Virtex II
1306 FPGA configuration sequence. The default time is 500
1307 mS.
wdenkc6097192002-11-03 00:24:07 +00001308
1309 CFG_FPGA_WAIT_BUSY
1310
wdenk43d96162003-03-06 00:02:04 +00001311 Maximum time to wait for BUSY to deassert during
1312 Virtex II FPGA configuration. The default is 5 mS.
wdenkc6097192002-11-03 00:24:07 +00001313
1314 CFG_FPGA_WAIT_CONFIG
1315
wdenk43d96162003-03-06 00:02:04 +00001316 Time to wait after FPGA configuration. The default is
1317 200 mS.
wdenkc6097192002-11-03 00:24:07 +00001318
1319- Configuration Management:
1320 CONFIG_IDENT_STRING
1321
wdenk43d96162003-03-06 00:02:04 +00001322 If defined, this string will be added to the U-Boot
1323 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001324
1325- Vendor Parameter Protection:
1326
wdenk43d96162003-03-06 00:02:04 +00001327 U-Boot considers the values of the environment
1328 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001329 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001330 are set once by the board vendor / manufacturer, and
1331 protects these variables from casual modification by
1332 the user. Once set, these variables are read-only,
1333 and write or delete attempts are rejected. You can
1334 change this behviour:
wdenkc6097192002-11-03 00:24:07 +00001335
1336 If CONFIG_ENV_OVERWRITE is #defined in your config
1337 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001338 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001339 these parameters.
1340
1341 Alternatively, if you #define _both_ CONFIG_ETHADDR
1342 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1343 ethernet address is installed in the environment,
1344 which can be changed exactly ONCE by the user. [The
1345 serial# is unaffected by this, i. e. it remains
1346 read-only.]
1347
1348- Protected RAM:
1349 CONFIG_PRAM
1350
1351 Define this variable to enable the reservation of
1352 "protected RAM", i. e. RAM which is not overwritten
1353 by U-Boot. Define CONFIG_PRAM to hold the number of
1354 kB you want to reserve for pRAM. You can overwrite
1355 this default value by defining an environment
1356 variable "pram" to the number of kB you want to
1357 reserve. Note that the board info structure will
1358 still show the full amount of RAM. If pRAM is
1359 reserved, a new environment variable "mem" will
1360 automatically be defined to hold the amount of
1361 remaining RAM in a form that can be passed as boot
1362 argument to Linux, for instance like that:
1363
1364 setenv bootargs ... mem=\$(mem)
1365 saveenv
1366
1367 This way you can tell Linux not to use this memory,
1368 either, which results in a memory region that will
1369 not be affected by reboots.
1370
1371 *WARNING* If your board configuration uses automatic
1372 detection of the RAM size, you must make sure that
1373 this memory test is non-destructive. So far, the
1374 following board configurations are known to be
1375 "pRAM-clean":
1376
1377 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1378 HERMES, IP860, RPXlite, LWMON, LANTEC,
1379 PCU_E, FLAGADM, TQM8260
1380
1381- Error Recovery:
1382 CONFIG_PANIC_HANG
1383
1384 Define this variable to stop the system in case of a
1385 fatal error, so that you have to reset it manually.
1386 This is probably NOT a good idea for an embedded
1387 system where you want to system to reboot
1388 automatically as fast as possible, but it may be
1389 useful during development since you can try to debug
1390 the conditions that lead to the situation.
1391
1392 CONFIG_NET_RETRY_COUNT
1393
wdenk43d96162003-03-06 00:02:04 +00001394 This variable defines the number of retries for
1395 network operations like ARP, RARP, TFTP, or BOOTP
1396 before giving up the operation. If not defined, a
1397 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001398
1399- Command Interpreter:
wdenk04a85b32004-04-15 18:22:41 +00001400 CFG_AUTO_COMPLETE
1401
1402 Enable auto completion of commands using TAB.
1403
wdenkc6097192002-11-03 00:24:07 +00001404 CFG_HUSH_PARSER
1405
1406 Define this variable to enable the "hush" shell (from
1407 Busybox) as command line interpreter, thus enabling
1408 powerful command line syntax like
1409 if...then...else...fi conditionals or `&&' and '||'
1410 constructs ("shell scripts").
1411
1412 If undefined, you get the old, much simpler behaviour
1413 with a somewhat smaller memory footprint.
1414
1415
1416 CFG_PROMPT_HUSH_PS2
1417
1418 This defines the secondary prompt string, which is
1419 printed when the command interpreter needs more input
1420 to complete a command. Usually "> ".
1421
1422 Note:
1423
wdenk8bde7f72003-06-27 21:31:46 +00001424 In the current implementation, the local variables
1425 space and global environment variables space are
1426 separated. Local variables are those you define by
1427 simply typing `name=value'. To access a local
1428 variable later on, you have write `$name' or
1429 `${name}'; to execute the contents of a variable
1430 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001431
wdenk43d96162003-03-06 00:02:04 +00001432 Global environment variables are those you use
1433 setenv/printenv to work with. To run a command stored
1434 in such a variable, you need to use the run command,
1435 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001436
1437 To store commands and special characters in a
1438 variable, please use double quotation marks
1439 surrounding the whole text of the variable, instead
1440 of the backslashes before semicolons and special
1441 symbols.
1442
wdenka8c7c702003-12-06 19:49:23 +00001443- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001444 CONFIG_EXTRA_ENV_SETTINGS
1445
wdenk43d96162003-03-06 00:02:04 +00001446 Define this to contain any number of null terminated
1447 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001448 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001449
wdenk43d96162003-03-06 00:02:04 +00001450 For example, place something like this in your
1451 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001452
1453 #define CONFIG_EXTRA_ENV_SETTINGS \
1454 "myvar1=value1\0" \
1455 "myvar2=value2\0"
1456
wdenk43d96162003-03-06 00:02:04 +00001457 Warning: This method is based on knowledge about the
1458 internal format how the environment is stored by the
1459 U-Boot code. This is NOT an official, exported
1460 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001461 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001462 You better know what you are doing here.
1463
wdenk43d96162003-03-06 00:02:04 +00001464 Note: overly (ab)use of the default environment is
1465 discouraged. Make sure to check other ways to preset
1466 the environment like the autoscript function or the
1467 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001468
wdenka8c7c702003-12-06 19:49:23 +00001469- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001470 CONFIG_HAS_DATAFLASH
1471
wdenk8bde7f72003-06-27 21:31:46 +00001472 Defining this option enables DataFlash features and
1473 allows to read/write in Dataflash via the standard
1474 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001475
wdenk3f85ce22004-02-23 16:11:30 +00001476- SystemACE Support:
1477 CONFIG_SYSTEMACE
1478
1479 Adding this option adds support for Xilinx SystemACE
1480 chips attached via some sort of local bus. The address
1481 of the chip must alsh be defined in the
1482 CFG_SYSTEMACE_BASE macro. For example:
1483
1484 #define CONFIG_SYSTEMACE
1485 #define CFG_SYSTEMACE_BASE 0xf0000000
1486
1487 When SystemACE support is added, the "ace" device type
1488 becomes available to the fat commands, i.e. fatls.
1489
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001490- TFTP Fixed UDP Port:
1491 CONFIG_TFTP_PORT
1492
1493 If this is defined, the environment variable tftpport
1494 is used to supply the TFTP UDP source port value.
1495 If tftpport isn't defined, the normal pseudo-random port
1496 number generator is used.
1497
1498 The purpose for this is to allow a TFTP server to
1499 blindly start the TFTP transfer using the pre-configured
1500 target IP address and UDP port. This has the effect of
1501 "punching through" the (Windows XP) firewall, allowing
1502 the remainder of the TFTP transfer to proceed normally.
1503 A better solution is to properly configure the firewall,
1504 but sometimes that is not allowed.
1505
wdenka8c7c702003-12-06 19:49:23 +00001506- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001507 CONFIG_SHOW_BOOT_PROGRESS
1508
wdenk43d96162003-03-06 00:02:04 +00001509 Defining this option allows to add some board-
1510 specific code (calling a user-provided function
1511 "show_boot_progress(int)") that enables you to show
1512 the system's boot progress on some display (for
1513 example, some LED's) on your board. At the moment,
1514 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001515
1516 Arg Where When
1517 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001518 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001519 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001520 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001521 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001522 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001523 4 common/cmd_bootm.c Image data has correct checksum
1524 -4 common/cmd_bootm.c Image is for unsupported architecture
1525 5 common/cmd_bootm.c Architecture check OK
1526 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1527 6 common/cmd_bootm.c Image Type check OK
1528 -6 common/cmd_bootm.c gunzip uncompression error
1529 -7 common/cmd_bootm.c Unimplemented compression type
1530 7 common/cmd_bootm.c Uncompression OK
1531 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1532 8 common/cmd_bootm.c Image Type check OK
1533 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1534 9 common/cmd_bootm.c Start initial ramdisk verification
wdenkba56f622004-02-06 23:19:44 +00001535 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1536 -11 common/cmd_bootm.c Ramdisk header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001537 10 common/cmd_bootm.c Ramdisk header is OK
wdenkba56f622004-02-06 23:19:44 +00001538 -12 common/cmd_bootm.c Ramdisk data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001539 11 common/cmd_bootm.c Ramdisk data has correct checksum
1540 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1541 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1542 13 common/cmd_bootm.c Start multifile image verification
1543 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1544 15 common/cmd_bootm.c All preparation done, transferring control to OS
1545
wdenk11dadd52004-02-27 00:07:27 +00001546 -30 lib_ppc/board.c Fatal error, hang the system
1547 -31 post/post.c POST test failed, detected by post_output_backlog()
1548 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001549
wdenkc6097192002-11-03 00:24:07 +00001550 -1 common/cmd_doc.c Bad usage of "doc" command
1551 -1 common/cmd_doc.c No boot device
1552 -1 common/cmd_doc.c Unknown Chip ID on boot device
1553 -1 common/cmd_doc.c Read Error on boot device
1554 -1 common/cmd_doc.c Image header has bad magic number
1555
1556 -1 common/cmd_ide.c Bad usage of "ide" command
1557 -1 common/cmd_ide.c No boot device
1558 -1 common/cmd_ide.c Unknown boot device
1559 -1 common/cmd_ide.c Unknown partition table
1560 -1 common/cmd_ide.c Invalid partition type
1561 -1 common/cmd_ide.c Read Error on boot device
1562 -1 common/cmd_ide.c Image header has bad magic number
1563
wdenk206c60c2003-09-18 10:02:25 +00001564 -1 common/cmd_nand.c Bad usage of "nand" command
1565 -1 common/cmd_nand.c No boot device
1566 -1 common/cmd_nand.c Unknown Chip ID on boot device
1567 -1 common/cmd_nand.c Read Error on boot device
1568 -1 common/cmd_nand.c Image header has bad magic number
1569
wdenkba56f622004-02-06 23:19:44 +00001570 -1 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001571
1572
1573Modem Support:
1574--------------
1575
wdenk85ec0bc2003-03-31 16:34:49 +00001576[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001577
1578- Modem support endable:
1579 CONFIG_MODEM_SUPPORT
1580
1581- RTS/CTS Flow control enable:
1582 CONFIG_HWFLOW
1583
1584- Modem debug support:
1585 CONFIG_MODEM_SUPPORT_DEBUG
1586
wdenk43d96162003-03-06 00:02:04 +00001587 Enables debugging stuff (char screen[1024], dbg())
1588 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001589
wdenka8c7c702003-12-06 19:49:23 +00001590- Interrupt support (PPC):
1591
wdenkd4ca31c2004-01-02 14:00:00 +00001592 There are common interrupt_init() and timer_interrupt()
1593 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1594 for cpu specific initialization. interrupt_init_cpu()
1595 should set decrementer_count to appropriate value. If
1596 cpu resets decrementer automatically after interrupt
1597 (ppc4xx) it should set decrementer_count to zero.
1598 timer_interrupt() calls timer_interrupt_cpu() for cpu
1599 specific handling. If board has watchdog / status_led
1600 / other_activity_monitor it works automatically from
1601 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001602
wdenkc6097192002-11-03 00:24:07 +00001603- General:
1604
wdenk43d96162003-03-06 00:02:04 +00001605 In the target system modem support is enabled when a
1606 specific key (key combination) is pressed during
1607 power-on. Otherwise U-Boot will boot normally
1608 (autoboot). The key_pressed() fuction is called from
1609 board_init(). Currently key_pressed() is a dummy
1610 function, returning 1 and thus enabling modem
1611 initialization.
wdenkc6097192002-11-03 00:24:07 +00001612
wdenk43d96162003-03-06 00:02:04 +00001613 If there are no modem init strings in the
1614 environment, U-Boot proceed to autoboot; the
1615 previous output (banner, info printfs) will be
1616 supressed, though.
wdenkc6097192002-11-03 00:24:07 +00001617
1618 See also: doc/README.Modem
1619
1620
wdenkc6097192002-11-03 00:24:07 +00001621Configuration Settings:
1622-----------------------
1623
1624- CFG_LONGHELP: Defined when you want long help messages included;
1625 undefine this when you're short of memory.
1626
1627- CFG_PROMPT: This is what U-Boot prints on the console to
1628 prompt for user input.
1629
1630- CFG_CBSIZE: Buffer size for input from the Console
1631
1632- CFG_PBSIZE: Buffer size for Console output
1633
1634- CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1635
1636- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1637 the application (usually a Linux kernel) when it is
1638 booted
1639
1640- CFG_BAUDRATE_TABLE:
1641 List of legal baudrate settings for this board.
1642
1643- CFG_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00001644 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00001645
1646- CFG_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00001647 If the board specific function
1648 extern int overwrite_console (void);
1649 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00001650 serial port, else the settings in the environment are used.
1651
1652- CFG_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00001653 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00001654
1655- CFG_CONSOLE_ENV_OVERWRITE
1656 Enable overwrite of previous console environment settings.
1657
1658- CFG_MEMTEST_START, CFG_MEMTEST_END:
1659 Begin and End addresses of the area used by the
1660 simple memory test.
1661
1662- CFG_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00001663 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00001664
wdenk5f535fe2003-09-18 09:21:33 +00001665- CFG_MEMTEST_SCRATCH:
1666 Scratch address used by the alternate memory test
1667 You only need to set this if address zero isn't writeable
1668
wdenkc6097192002-11-03 00:24:07 +00001669- CFG_TFTP_LOADADDR:
1670 Default load address for network file downloads
1671
1672- CFG_LOADS_BAUD_CHANGE:
1673 Enable temporary baudrate change while serial download
1674
1675- CFG_SDRAM_BASE:
1676 Physical start address of SDRAM. _Must_ be 0 here.
1677
1678- CFG_MBIO_BASE:
1679 Physical start address of Motherboard I/O (if using a
1680 Cogent motherboard)
1681
1682- CFG_FLASH_BASE:
1683 Physical start address of Flash memory.
1684
1685- CFG_MONITOR_BASE:
1686 Physical start address of boot monitor code (set by
1687 make config files to be same as the text base address
1688 (TEXT_BASE) used when linking) - same as
1689 CFG_FLASH_BASE when booting from flash.
1690
1691- CFG_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00001692 Size of memory reserved for monitor code, used to
1693 determine _at_compile_time_ (!) if the environment is
1694 embedded within the U-Boot image, or in a separate
1695 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001696
1697- CFG_MALLOC_LEN:
1698 Size of DRAM reserved for malloc() use.
1699
1700- CFG_BOOTMAPSZ:
1701 Maximum size of memory mapped by the startup code of
1702 the Linux kernel; all data that must be processed by
1703 the Linux kernel (bd_info, boot arguments, eventually
1704 initrd image) must be put below this limit.
1705
1706- CFG_MAX_FLASH_BANKS:
1707 Max number of Flash memory banks
1708
1709- CFG_MAX_FLASH_SECT:
1710 Max number of sectors on a Flash chip
1711
1712- CFG_FLASH_ERASE_TOUT:
1713 Timeout for Flash erase operations (in ms)
1714
1715- CFG_FLASH_WRITE_TOUT:
1716 Timeout for Flash write operations (in ms)
1717
wdenk8564acf2003-07-14 22:13:32 +00001718- CFG_FLASH_LOCK_TOUT
1719 Timeout for Flash set sector lock bit operation (in ms)
1720
1721- CFG_FLASH_UNLOCK_TOUT
1722 Timeout for Flash clear lock bits operation (in ms)
1723
1724- CFG_FLASH_PROTECTION
1725 If defined, hardware flash sectors protection is used
1726 instead of U-Boot software protection.
1727
wdenkc6097192002-11-03 00:24:07 +00001728- CFG_DIRECT_FLASH_TFTP:
1729
1730 Enable TFTP transfers directly to flash memory;
1731 without this option such a download has to be
1732 performed in two steps: (1) download to RAM, and (2)
1733 copy from RAM to flash.
1734
1735 The two-step approach is usually more reliable, since
1736 you can check if the download worked before you erase
1737 the flash, but in some situations (when sytem RAM is
1738 too limited to allow for a tempory copy of the
1739 downloaded image) this option may be very useful.
1740
1741- CFG_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00001742 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00001743 common flash structure for storing flash geometry.
1744
1745- CFG_FLASH_CFI_DRIVER
1746 This option also enables the building of the cfi_flash driver
1747 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001748
stroese53cf9432003-06-05 15:39:44 +00001749- CFG_RX_ETH_BUFFER:
1750 Defines the number of ethernet receive buffers. On some
1751 ethernet controllers it is recommended to set this value
1752 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1753 buffers can be full shortly after enabling the interface
1754 on high ethernet traffic.
1755 Defaults to 4 if not defined.
1756
wdenkc6097192002-11-03 00:24:07 +00001757The following definitions that deal with the placement and management
1758of environment data (variable area); in general, we support the
1759following configurations:
1760
1761- CFG_ENV_IS_IN_FLASH:
1762
1763 Define this if the environment is in flash memory.
1764
1765 a) The environment occupies one whole flash sector, which is
1766 "embedded" in the text segment with the U-Boot code. This
1767 happens usually with "bottom boot sector" or "top boot
1768 sector" type flash chips, which have several smaller
1769 sectors at the start or the end. For instance, such a
1770 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1771 such a case you would place the environment in one of the
1772 4 kB sectors - with U-Boot code before and after it. With
1773 "top boot sector" type flash chips, you would put the
1774 environment in one of the last sectors, leaving a gap
1775 between U-Boot and the environment.
1776
1777 - CFG_ENV_OFFSET:
1778
1779 Offset of environment data (variable area) to the
1780 beginning of flash memory; for instance, with bottom boot
1781 type flash chips the second sector can be used: the offset
1782 for this sector is given here.
1783
1784 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1785
1786 - CFG_ENV_ADDR:
1787
1788 This is just another way to specify the start address of
1789 the flash sector containing the environment (instead of
1790 CFG_ENV_OFFSET).
1791
1792 - CFG_ENV_SECT_SIZE:
1793
1794 Size of the sector containing the environment.
1795
1796
1797 b) Sometimes flash chips have few, equal sized, BIG sectors.
1798 In such a case you don't want to spend a whole sector for
1799 the environment.
1800
1801 - CFG_ENV_SIZE:
1802
1803 If you use this in combination with CFG_ENV_IS_IN_FLASH
1804 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1805 of this flash sector for the environment. This saves
1806 memory for the RAM copy of the environment.
1807
1808 It may also save flash memory if you decide to use this
1809 when your environment is "embedded" within U-Boot code,
1810 since then the remainder of the flash sector could be used
1811 for U-Boot code. It should be pointed out that this is
1812 STRONGLY DISCOURAGED from a robustness point of view:
1813 updating the environment in flash makes it always
1814 necessary to erase the WHOLE sector. If something goes
1815 wrong before the contents has been restored from a copy in
1816 RAM, your target system will be dead.
1817
1818 - CFG_ENV_ADDR_REDUND
1819 CFG_ENV_SIZE_REDUND
1820
wdenk43d96162003-03-06 00:02:04 +00001821 These settings describe a second storage area used to hold
1822 a redundand copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00001823 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00001824 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00001825
1826BE CAREFUL! Any changes to the flash layout, and some changes to the
1827source code will make it necessary to adapt <board>/u-boot.lds*
1828accordingly!
1829
1830
1831- CFG_ENV_IS_IN_NVRAM:
1832
1833 Define this if you have some non-volatile memory device
1834 (NVRAM, battery buffered SRAM) which you want to use for the
1835 environment.
1836
1837 - CFG_ENV_ADDR:
1838 - CFG_ENV_SIZE:
1839
1840 These two #defines are used to determin the memory area you
1841 want to use for environment. It is assumed that this memory
1842 can just be read and written to, without any special
1843 provision.
1844
1845BE CAREFUL! The first access to the environment happens quite early
1846in U-Boot initalization (when we try to get the setting of for the
1847console baudrate). You *MUST* have mappend your NVRAM area then, or
1848U-Boot will hang.
1849
1850Please note that even with NVRAM we still use a copy of the
1851environment in RAM: we could work on NVRAM directly, but we want to
1852keep settings there always unmodified except somebody uses "saveenv"
1853to save the current settings.
1854
1855
1856- CFG_ENV_IS_IN_EEPROM:
1857
1858 Use this if you have an EEPROM or similar serial access
1859 device and a driver for it.
1860
1861 - CFG_ENV_OFFSET:
1862 - CFG_ENV_SIZE:
1863
1864 These two #defines specify the offset and size of the
1865 environment area within the total memory of your EEPROM.
1866
1867 - CFG_I2C_EEPROM_ADDR:
1868 If defined, specified the chip address of the EEPROM device.
1869 The default address is zero.
1870
1871 - CFG_EEPROM_PAGE_WRITE_BITS:
1872 If defined, the number of bits used to address bytes in a
1873 single page in the EEPROM device. A 64 byte page, for example
1874 would require six bits.
1875
1876 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1877 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00001878 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00001879
1880 - CFG_I2C_EEPROM_ADDR_LEN:
1881 The length in bytes of the EEPROM memory array address. Note
1882 that this is NOT the chip address length!
1883
wdenk5cf91d62004-04-23 20:32:05 +00001884 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
1885 EEPROM chips that implement "address overflow" are ones
1886 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
1887 address and the extra bits end up in the "chip address" bit
1888 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
1889 byte chips.
1890
1891 Note that we consider the length of the address field to
1892 still be one byte because the extra address bits are hidden
1893 in the chip address.
1894
wdenkc6097192002-11-03 00:24:07 +00001895 - CFG_EEPROM_SIZE:
1896 The size in bytes of the EEPROM device.
1897
wdenkc6097192002-11-03 00:24:07 +00001898
wdenk5779d8d2003-12-06 23:55:10 +00001899- CFG_ENV_IS_IN_DATAFLASH:
1900
wdenkd4ca31c2004-01-02 14:00:00 +00001901 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00001902 want to use for the environment.
1903
1904 - CFG_ENV_OFFSET:
1905 - CFG_ENV_ADDR:
1906 - CFG_ENV_SIZE:
1907
1908 These three #defines specify the offset and size of the
1909 environment area within the total memory of your DataFlash placed
1910 at the specified address.
1911
wdenk13a56952004-06-09 14:58:14 +00001912- CFG_ENV_IS_IN_NAND:
1913
1914 Define this if you have a NAND device which you want to use
1915 for the environment.
1916
1917 - CFG_ENV_OFFSET:
1918 - CFG_ENV_SIZE:
1919
1920 These two #defines specify the offset and size of the environment
1921 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00001922
wdenkc6097192002-11-03 00:24:07 +00001923- CFG_SPI_INIT_OFFSET
1924
1925 Defines offset to the initial SPI buffer area in DPRAM. The
1926 area is used at an early stage (ROM part) if the environment
1927 is configured to reside in the SPI EEPROM: We need a 520 byte
1928 scratch DPRAM area. It is used between the two initialization
1929 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1930 to be a good choice since it makes it far enough from the
1931 start of the data area as well as from the stack pointer.
1932
1933Please note that the environment is read-only as long as the monitor
1934has been relocated to RAM and a RAM copy of the environment has been
1935created; also, when using EEPROM you will have to use getenv_r()
1936until then to read environment variables.
1937
wdenk85ec0bc2003-03-31 16:34:49 +00001938The environment is protected by a CRC32 checksum. Before the monitor
1939is relocated into RAM, as a result of a bad CRC you will be working
1940with the compiled-in default environment - *silently*!!! [This is
1941necessary, because the first environment variable we need is the
1942"baudrate" setting for the console - if we have a bad CRC, we don't
1943have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00001944
1945Note: once the monitor has been relocated, then it will complain if
1946the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00001947use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00001948
wdenkfc3e2162003-10-08 22:33:00 +00001949- CFG_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00001950 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00001951
1952 Note: If this option is active, then CFG_FAULT_MII_ADDR
1953 also needs to be defined.
1954
1955- CFG_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00001956 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00001957
wdenkc40b2952004-03-13 23:29:43 +00001958- CFG_64BIT_VSPRINTF:
1959 Makes vsprintf (and all *printf functions) support printing
1960 of 64bit values by using the L quantifier
1961
1962- CFG_64BIT_STRTOUL:
1963 Adds simple_strtoull that returns a 64bit value
1964
wdenkc6097192002-11-03 00:24:07 +00001965Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00001966---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001967
1968- CFG_CACHELINE_SIZE:
1969 Cache Line Size of the CPU.
1970
1971- CFG_DEFAULT_IMMR:
1972 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00001973
wdenk42d1f032003-10-15 23:53:47 +00001974 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
1975 and RPXsuper) to be able to adjust the position of
1976 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00001977
wdenk7f6c2cb2002-11-10 22:06:23 +00001978- Floppy Disk Support:
1979 CFG_FDC_DRIVE_NUMBER
1980
1981 the default drive number (default value 0)
1982
1983 CFG_ISA_IO_STRIDE
1984
1985 defines the spacing between fdc chipset registers
1986 (default value 1)
1987
1988 CFG_ISA_IO_OFFSET
1989
wdenk43d96162003-03-06 00:02:04 +00001990 defines the offset of register from address. It
1991 depends on which part of the data bus is connected to
1992 the fdc chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00001993
wdenk43d96162003-03-06 00:02:04 +00001994 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
1995 CFG_FDC_DRIVE_NUMBER are undefined, they take their
1996 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00001997
wdenk43d96162003-03-06 00:02:04 +00001998 if CFG_FDC_HW_INIT is defined, then the function
1999 fdc_hw_init() is called at the beginning of the FDC
2000 setup. fdc_hw_init() must be provided by the board
2001 source code. It is used to make hardware dependant
2002 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002003
wdenk25d67122004-12-10 11:40:40 +00002004- CFG_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002005 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002006 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002007
2008- CFG_INIT_RAM_ADDR:
2009
wdenk7152b1d2003-09-05 23:19:14 +00002010 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002011 initial data and stack; please note that this must be
2012 writable memory that is working WITHOUT special
2013 initialization, i. e. you CANNOT use normal RAM which
2014 will become available only after programming the
2015 memory controller and running certain initialization
2016 sequences.
2017
2018 U-Boot uses the following memory types:
2019 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2020 - MPC824X: data cache
2021 - PPC4xx: data cache
2022
wdenk85ec0bc2003-03-31 16:34:49 +00002023- CFG_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002024
2025 Offset of the initial data structure in the memory
2026 area defined by CFG_INIT_RAM_ADDR. Usually
wdenk85ec0bc2003-03-31 16:34:49 +00002027 CFG_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002028 data is located at the end of the available space
2029 (sometimes written as (CFG_INIT_RAM_END -
2030 CFG_INIT_DATA_SIZE), and the initial stack is just
2031 below that area (growing from (CFG_INIT_RAM_ADDR +
wdenk85ec0bc2003-03-31 16:34:49 +00002032 CFG_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002033
2034 Note:
2035 On the MPC824X (or other systems that use the data
2036 cache for initial memory) the address chosen for
2037 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2038 point to an otherwise UNUSED address space between
2039 the top of RAM and the start of the PCI space.
2040
2041- CFG_SIUMCR: SIU Module Configuration (11-6)
2042
2043- CFG_SYPCR: System Protection Control (11-9)
2044
2045- CFG_TBSCR: Time Base Status and Control (11-26)
2046
2047- CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2048
2049- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2050
2051- CFG_SCCR: System Clock and reset Control Register (15-27)
2052
2053- CFG_OR_TIMING_SDRAM:
2054 SDRAM timing
2055
2056- CFG_MAMR_PTA:
2057 periodic timer for refresh
2058
2059- CFG_DER: Debug Event Register (37-47)
2060
2061- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2062 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2063 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2064 CFG_BR1_PRELIM:
2065 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2066
2067- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2068 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2069 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2070 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2071
2072- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2073 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2074 Machine Mode Register and Memory Periodic Timer
2075 Prescaler definitions (SDRAM timing)
2076
2077- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2078 enable I2C microcode relocation patch (MPC8xx);
2079 define relocation offset in DPRAM [DSP2]
2080
2081- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2082 enable SPI microcode relocation patch (MPC8xx);
2083 define relocation offset in DPRAM [SCC4]
2084
2085- CFG_USE_OSCCLK:
2086 Use OSCM clock mode on MBX8xx board. Be careful,
2087 wrong setting might damage your board. Read
2088 doc/README.MBX before setting this variable!
2089
wdenkea909b72002-11-21 23:11:29 +00002090- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002091 Offset of the bootmode word in DPRAM used by post
2092 (Power On Self Tests). This definition overrides
2093 #define'd default value in commproc.h resp.
2094 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002095
stroese1d49b1f2003-05-23 11:39:05 +00002096- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2097 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2098 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2099 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2100 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2101 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2102 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
wdenk5d232d02003-05-22 22:52:13 +00002103 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2104 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2105
wdenkc26e4542004-04-18 10:13:26 +00002106- CONFIG_ETHER_ON_FEC[12]
2107 Define to enable FEC[12] on a 8xx series processor.
2108
2109- CONFIG_FEC[12]_PHY
2110 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002111 to the given FEC; i. e.
2112 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002113 means that the PHY with address 4 is connected to FEC1
2114
2115 When set to -1, means to probe for first available.
2116
2117- CONFIG_FEC[12]_PHY_NORXERR
2118 The PHY does not have a RXERR line (RMII only).
2119 (so program the FEC to ignore it).
2120
2121- CONFIG_RMII
2122 Enable RMII mode for all FECs.
2123 Note that this is a global option, we can't
2124 have one FEC in standard MII mode and another in RMII mode.
2125
wdenk5cf91d62004-04-23 20:32:05 +00002126- CONFIG_CRC32_VERIFY
2127 Add a verify option to the crc32 command.
2128 The syntax is:
2129
2130 => crc32 -v <address> <count> <crc32>
2131
2132 Where address/count indicate a memory area
2133 and crc32 is the correct crc32 which the
2134 area should have.
2135
wdenk56523f12004-07-11 17:40:54 +00002136- CONFIG_LOOPW
2137 Add the "loopw" memory command. This only takes effect if
2138 the memory commands are activated globally (CFG_CMD_MEM).
2139
stroese7b466642004-12-16 18:46:55 +00002140- CONFIG_MX_CYCLIC
2141 Add the "mdc" and "mwc" memory commands. These are cyclic
2142 "md/mw" commands.
2143 Examples:
2144
wdenkefe2a4d2004-12-16 21:44:03 +00002145 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002146 This command will print 4 bytes (10,11,12,13) each 500 ms.
2147
wdenkefe2a4d2004-12-16 21:44:03 +00002148 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002149 This command will write 12345678 to address 100 all 10 ms.
2150
wdenkefe2a4d2004-12-16 21:44:03 +00002151 This only takes effect if the memory commands are activated
stroese7b466642004-12-16 18:46:55 +00002152 globally (CFG_CMD_MEM).
2153
wdenk8aa1a2d2005-04-04 12:44:11 +00002154- CONFIG_SKIP_LOWLEVEL_INIT
2155- CONFIG_SKIP_RELOCATE_UBOOT
2156
wdenk3c2b3d42005-04-05 23:32:21 +00002157 [ARM only] If these variables are defined, then
2158 certain low level initializations (like setting up
2159 the memory controller) are omitted and/or U-Boot does
2160 not relocate itself into RAM.
2161 Normally these variables MUST NOT be defined. The
2162 only exception is when U-Boot is loaded (to RAM) by
2163 some other boot loader or by a debugger which
2164 performs these intializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002165
wdenk400558b2005-04-02 23:52:25 +00002166
wdenkc6097192002-11-03 00:24:07 +00002167Building the Software:
2168======================
2169
2170Building U-Boot has been tested in native PPC environments (on a
2171PowerBook G3 running LinuxPPC 2000) and in cross environments
2172(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2173NetBSD 1.5 on x86).
2174
2175If you are not using a native PPC environment, it is assumed that you
2176have the GNU cross compiling tools available in your path and named
2177with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2178you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2179the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2180change it to:
2181
2182 CROSS_COMPILE = ppc_4xx-
2183
2184
wdenkba56f622004-02-06 23:19:44 +00002185U-Boot is intended to be simple to build. After installing the
wdenkc6097192002-11-03 00:24:07 +00002186sources you must configure U-Boot for one specific board type. This
2187is done by typing:
2188
2189 make NAME_config
2190
2191where "NAME_config" is the name of one of the existing
2192configurations; the following names are supported:
2193
wdenk1eaeb582004-06-08 00:22:43 +00002194 ADCIOP_config FPS860L_config omap730p2_config
2195 ADS860_config GEN860T_config pcu_e_config
wdenk983fda82004-10-28 00:09:35 +00002196 Alaska8220_config
wdenk1eaeb582004-06-08 00:22:43 +00002197 AR405_config GENIETV_config PIP405_config
2198 at91rm9200dk_config GTH_config QS823_config
2199 CANBT_config hermes_config QS850_config
2200 cmi_mpc5xx_config hymod_config QS860T_config
2201 cogent_common_config IP860_config RPXlite_config
wdenke63c8ee2004-06-09 21:04:48 +00002202 cogent_mpc8260_config IVML24_config RPXlite_DW_config
2203 cogent_mpc8xx_config IVMS8_config RPXsuper_config
2204 CPCI405_config JSE_config rsdproto_config
2205 CPCIISER4_config LANTEC_config Sandpoint8240_config
2206 csb272_config lwmon_config sbc8260_config
wdenk466b7412004-07-10 22:35:59 +00002207 CU824_config MBX860T_config sbc8560_33_config
2208 DUET_ADS_config MBX_config sbc8560_66_config
wdenk8b07a112004-07-10 21:45:47 +00002209 EBONY_config MPC8260ADS_config SM850_config
2210 ELPT860_config MPC8540ADS_config SPD823TS_config
Lunsheng Wangb0e32942005-07-29 10:20:29 -05002211 ESTEEM192E_config MPC8540EVAL_config stxgp3_config
2212 ETX094_config MPC8560ADS_config SXNI855T_config
2213 FADS823_config NETVIA_config TQM823L_config
2214 FADS850SAR_config omap1510inn_config TQM850L_config
2215 FADS860T_config omap1610h2_config TQM855L_config
2216 FPS850L_config omap1610inn_config TQM860L_config
Jon Loeliger4b1d95d2005-08-02 13:53:07 -05002217 omap5912osk_config walnut_config
Lunsheng Wangb0e32942005-07-29 10:20:29 -05002218 omap2420h4_config Yukon8220_config
wdenk8b07a112004-07-10 21:45:47 +00002219 ZPC1900_config
wdenk54387ac2003-10-08 22:45:44 +00002220
wdenk2729af92004-05-03 20:45:30 +00002221Note: for some board special configuration names may exist; check if
2222 additional information is available from the board vendor; for
2223 instance, the TQM823L systems are available without (standard)
2224 or with LCD support. You can select such additional "features"
2225 when chosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002226
wdenk2729af92004-05-03 20:45:30 +00002227 make TQM823L_config
2228 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002229
wdenk2729af92004-05-03 20:45:30 +00002230 make TQM823L_LCD_config
2231 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002232
wdenk2729af92004-05-03 20:45:30 +00002233 etc.
wdenkc6097192002-11-03 00:24:07 +00002234
wdenkc6097192002-11-03 00:24:07 +00002235
wdenk2729af92004-05-03 20:45:30 +00002236Finally, type "make all", and you should get some working U-Boot
2237images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002238
wdenk2729af92004-05-03 20:45:30 +00002239- "u-boot.bin" is a raw binary image
2240- "u-boot" is an image in ELF binary format
2241- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002242
wdenkc6097192002-11-03 00:24:07 +00002243
wdenk2729af92004-05-03 20:45:30 +00002244Please be aware that the Makefiles assume you are using GNU make, so
2245for instance on NetBSD you might need to use "gmake" instead of
2246native "make".
wdenkc6097192002-11-03 00:24:07 +00002247
wdenkc6097192002-11-03 00:24:07 +00002248
wdenk2729af92004-05-03 20:45:30 +00002249If the system board that you have is not listed, then you will need
2250to port U-Boot to your hardware platform. To do this, follow these
2251steps:
wdenkc6097192002-11-03 00:24:07 +00002252
wdenk2729af92004-05-03 20:45:30 +000022531. Add a new configuration option for your board to the toplevel
2254 "Makefile" and to the "MAKEALL" script, using the existing
2255 entries as examples. Note that here and at many other places
2256 boards and other names are listed in alphabetical sort order. Please
2257 keep this order.
22582. Create a new directory to hold your board specific code. Add any
2259 files you need. In your board directory, you will need at least
2260 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
22613. Create a new configuration file "include/configs/<board>.h" for
2262 your board
22633. If you're porting U-Boot to a new CPU, then also create a new
2264 directory to hold your CPU specific code. Add any files you need.
22654. Run "make <board>_config" with your new name.
22665. Type "make", and you should get a working "u-boot.srec" file
2267 to be installed on your target system.
22686. Debug and solve any problems that might arise.
2269 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002270
wdenkc6097192002-11-03 00:24:07 +00002271
wdenk2729af92004-05-03 20:45:30 +00002272Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2273==============================================================
wdenkc6097192002-11-03 00:24:07 +00002274
wdenk2729af92004-05-03 20:45:30 +00002275If you have modified U-Boot sources (for instance added a new board
2276or support for new devices, a new CPU, etc.) you are expected to
2277provide feedback to the other developers. The feedback normally takes
2278the form of a "patch", i. e. a context diff against a certain (latest
2279official or latest in CVS) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002280
wdenk2729af92004-05-03 20:45:30 +00002281But before you submit such a patch, please verify that your modifi-
2282cation did not break existing code. At least make sure that *ALL* of
2283the supported boards compile WITHOUT ANY compiler warnings. To do so,
2284just run the "MAKEALL" script, which will configure and build U-Boot
2285for ALL supported system. Be warned, this will take a while. You can
2286select which (cross) compiler to use by passing a `CROSS_COMPILE'
2287environment variable to the script, i. e. to use the cross tools from
2288MontaVista's Hard Hat Linux you can type
wdenkc6097192002-11-03 00:24:07 +00002289
wdenk2729af92004-05-03 20:45:30 +00002290 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002291
wdenk2729af92004-05-03 20:45:30 +00002292or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002293
wdenk2729af92004-05-03 20:45:30 +00002294 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002295
wdenk2729af92004-05-03 20:45:30 +00002296See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002297
wdenkc6097192002-11-03 00:24:07 +00002298
wdenk2729af92004-05-03 20:45:30 +00002299Monitor Commands - Overview:
2300============================
wdenkc6097192002-11-03 00:24:07 +00002301
wdenk2729af92004-05-03 20:45:30 +00002302go - start application at address 'addr'
2303run - run commands in an environment variable
2304bootm - boot application image from memory
2305bootp - boot image via network using BootP/TFTP protocol
2306tftpboot- boot image via network using TFTP protocol
2307 and env variables "ipaddr" and "serverip"
2308 (and eventually "gatewayip")
2309rarpboot- boot image via network using RARP/TFTP protocol
2310diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2311loads - load S-Record file over serial line
2312loadb - load binary file over serial line (kermit mode)
2313md - memory display
2314mm - memory modify (auto-incrementing)
2315nm - memory modify (constant address)
2316mw - memory write (fill)
2317cp - memory copy
2318cmp - memory compare
2319crc32 - checksum calculation
2320imd - i2c memory display
2321imm - i2c memory modify (auto-incrementing)
2322inm - i2c memory modify (constant address)
2323imw - i2c memory write (fill)
2324icrc32 - i2c checksum calculation
2325iprobe - probe to discover valid I2C chip addresses
2326iloop - infinite loop on address range
2327isdram - print SDRAM configuration information
2328sspi - SPI utility commands
2329base - print or set address offset
2330printenv- print environment variables
2331setenv - set environment variables
2332saveenv - save environment variables to persistent storage
2333protect - enable or disable FLASH write protection
2334erase - erase FLASH memory
2335flinfo - print FLASH memory information
2336bdinfo - print Board Info structure
2337iminfo - print header information for application image
2338coninfo - print console devices and informations
2339ide - IDE sub-system
2340loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002341loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002342mtest - simple RAM test
2343icache - enable or disable instruction cache
2344dcache - enable or disable data cache
2345reset - Perform RESET of the CPU
2346echo - echo args to console
2347version - print monitor version
2348help - print online help
2349? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002350
wdenkc6097192002-11-03 00:24:07 +00002351
wdenk2729af92004-05-03 20:45:30 +00002352Monitor Commands - Detailed Description:
2353========================================
wdenkc6097192002-11-03 00:24:07 +00002354
wdenk2729af92004-05-03 20:45:30 +00002355TODO.
wdenkc6097192002-11-03 00:24:07 +00002356
wdenk2729af92004-05-03 20:45:30 +00002357For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002358
2359
wdenk2729af92004-05-03 20:45:30 +00002360Environment Variables:
2361======================
wdenkc6097192002-11-03 00:24:07 +00002362
wdenk2729af92004-05-03 20:45:30 +00002363U-Boot supports user configuration using Environment Variables which
2364can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002365
wdenk2729af92004-05-03 20:45:30 +00002366Environment Variables are set using "setenv", printed using
2367"printenv", and saved to Flash using "saveenv". Using "setenv"
2368without a value can be used to delete a variable from the
2369environment. As long as you don't save the environment you are
2370working with an in-memory copy. In case the Flash area containing the
2371environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002372
wdenk2729af92004-05-03 20:45:30 +00002373Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002374
wdenk2729af92004-05-03 20:45:30 +00002375 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002376
wdenk2729af92004-05-03 20:45:30 +00002377 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002378
wdenk2729af92004-05-03 20:45:30 +00002379 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002380
wdenk2729af92004-05-03 20:45:30 +00002381 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002382
wdenk2729af92004-05-03 20:45:30 +00002383 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002384
wdenk2729af92004-05-03 20:45:30 +00002385 autoload - if set to "no" (any string beginning with 'n'),
2386 "bootp" will just load perform a lookup of the
2387 configuration from the BOOTP server, but not try to
2388 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002389
wdenk2729af92004-05-03 20:45:30 +00002390 autostart - if set to "yes", an image loaded using the "bootp",
2391 "rarpboot", "tftpboot" or "diskboot" commands will
2392 be automatically started (by internally calling
2393 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002394
wdenk2729af92004-05-03 20:45:30 +00002395 If set to "no", a standalone image passed to the
2396 "bootm" command will be copied to the load address
2397 (and eventually uncompressed), but NOT be started.
2398 This can be used to load and uncompress arbitrary
2399 data.
wdenkc6097192002-11-03 00:24:07 +00002400
wdenk17ea1172004-06-06 21:51:03 +00002401 i2cfast - (PPC405GP|PPC405EP only)
2402 if set to 'y' configures Linux I2C driver for fast
2403 mode (400kHZ). This environment variable is used in
2404 initialization code. So, for changes to be effective
2405 it must be saved and board must be reset.
2406
wdenk2729af92004-05-03 20:45:30 +00002407 initrd_high - restrict positioning of initrd images:
2408 If this variable is not set, initrd images will be
2409 copied to the highest possible address in RAM; this
2410 is usually what you want since it allows for
2411 maximum initrd size. If for some reason you want to
2412 make sure that the initrd image is loaded below the
2413 CFG_BOOTMAPSZ limit, you can set this environment
2414 variable to a value of "no" or "off" or "0".
2415 Alternatively, you can set it to a maximum upper
2416 address to use (U-Boot will still check that it
2417 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002418
wdenk2729af92004-05-03 20:45:30 +00002419 For instance, when you have a system with 16 MB
2420 RAM, and want to reserve 4 MB from use by Linux,
2421 you can do this by adding "mem=12M" to the value of
2422 the "bootargs" variable. However, now you must make
2423 sure that the initrd image is placed in the first
2424 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002425
wdenk2729af92004-05-03 20:45:30 +00002426 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002427
wdenk2729af92004-05-03 20:45:30 +00002428 If you set initrd_high to 0xFFFFFFFF, this is an
2429 indication to U-Boot that all addresses are legal
2430 for the Linux kernel, including addresses in flash
2431 memory. In this case U-Boot will NOT COPY the
2432 ramdisk at all. This may be useful to reduce the
2433 boot time on your system, but requires that this
2434 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00002435
wdenk2729af92004-05-03 20:45:30 +00002436 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002437
wdenk2729af92004-05-03 20:45:30 +00002438 loadaddr - Default load address for commands like "bootp",
2439 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002440
wdenk2729af92004-05-03 20:45:30 +00002441 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002442
wdenk2729af92004-05-03 20:45:30 +00002443 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00002444
wdenk2729af92004-05-03 20:45:30 +00002445 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002446
wdenk2729af92004-05-03 20:45:30 +00002447 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002448
wdenk2729af92004-05-03 20:45:30 +00002449 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002450
wdenk2729af92004-05-03 20:45:30 +00002451 ethprime - When CONFIG_NET_MULTI is enabled controls which
2452 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002453
wdenk2729af92004-05-03 20:45:30 +00002454 ethact - When CONFIG_NET_MULTI is enabled controls which
2455 interface is currently active. For example you
2456 can do the following
wdenkc6097192002-11-03 00:24:07 +00002457
wdenk2729af92004-05-03 20:45:30 +00002458 => setenv ethact FEC ETHERNET
2459 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2460 => setenv ethact SCC ETHERNET
2461 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002462
wdenk2729af92004-05-03 20:45:30 +00002463 netretry - When set to "no" each network operation will
2464 either succeed or fail without retrying.
2465 When set to "once" the network operation will
2466 fail when all the available network interfaces
2467 are tried once without success.
2468 Useful on scripts which control the retry operation
2469 themselves.
wdenkc6097192002-11-03 00:24:07 +00002470
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002471 tftpport - If this is set, the value is used for TFTP's
2472 UDP source port.
2473
wdenk2729af92004-05-03 20:45:30 +00002474 vlan - When set to a value < 4095 the traffic over
2475 ethernet is encapsulated/received over 802.1q
2476 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00002477
wdenk2729af92004-05-03 20:45:30 +00002478The following environment variables may be used and automatically
2479updated by the network boot commands ("bootp" and "rarpboot"),
2480depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00002481
wdenk2729af92004-05-03 20:45:30 +00002482 bootfile - see above
2483 dnsip - IP address of your Domain Name Server
2484 dnsip2 - IP address of your secondary Domain Name Server
2485 gatewayip - IP address of the Gateway (Router) to use
2486 hostname - Target hostname
2487 ipaddr - see above
2488 netmask - Subnet Mask
2489 rootpath - Pathname of the root filesystem on the NFS server
2490 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00002491
wdenka3d991b2004-04-15 21:48:45 +00002492
wdenk2729af92004-05-03 20:45:30 +00002493There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002494
wdenk2729af92004-05-03 20:45:30 +00002495 serial# - contains hardware identification information such
2496 as type string and/or serial number
2497 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00002498
wdenk2729af92004-05-03 20:45:30 +00002499These variables can be set only once (usually during manufacturing of
2500the board). U-Boot refuses to delete or overwrite these variables
2501once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00002502
2503
wdenk2729af92004-05-03 20:45:30 +00002504Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002505
wdenk2729af92004-05-03 20:45:30 +00002506 ver - Contains the U-Boot version string as printed
2507 with the "version" command. This variable is
2508 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00002509
wdenkc6097192002-11-03 00:24:07 +00002510
wdenk2729af92004-05-03 20:45:30 +00002511Please note that changes to some configuration parameters may take
2512only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00002513
stroesec1551ea2003-04-04 15:53:41 +00002514
wdenk2729af92004-05-03 20:45:30 +00002515Command Line Parsing:
2516=====================
stroesec1551ea2003-04-04 15:53:41 +00002517
wdenk2729af92004-05-03 20:45:30 +00002518There are two different command line parsers available with U-Boot:
2519the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00002520
wdenk2729af92004-05-03 20:45:30 +00002521Old, simple command line parser:
2522--------------------------------
wdenkc6097192002-11-03 00:24:07 +00002523
wdenk2729af92004-05-03 20:45:30 +00002524- supports environment variables (through setenv / saveenv commands)
2525- several commands on one line, separated by ';'
2526- variable substitution using "... $(name) ..." syntax
2527- special characters ('$', ';') can be escaped by prefixing with '\',
2528 for example:
2529 setenv bootcmd bootm \$(address)
2530- You can also escape text by enclosing in single apostrophes, for example:
2531 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00002532
wdenk2729af92004-05-03 20:45:30 +00002533Hush shell:
2534-----------
wdenkf07771c2003-05-28 08:06:31 +00002535
wdenk2729af92004-05-03 20:45:30 +00002536- similar to Bourne shell, with control structures like
2537 if...then...else...fi, for...do...done; while...do...done,
2538 until...do...done, ...
2539- supports environment ("global") variables (through setenv / saveenv
2540 commands) and local shell variables (through standard shell syntax
2541 "name=value"); only environment variables can be used with "run"
2542 command
wdenkf07771c2003-05-28 08:06:31 +00002543
wdenk2729af92004-05-03 20:45:30 +00002544General rules:
2545--------------
wdenkf07771c2003-05-28 08:06:31 +00002546
wdenk2729af92004-05-03 20:45:30 +00002547(1) If a command line (or an environment variable executed by a "run"
2548 command) contains several commands separated by semicolon, and
2549 one of these commands fails, then the remaining commands will be
2550 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00002551
wdenk2729af92004-05-03 20:45:30 +00002552(2) If you execute several variables with one call to run (i. e.
2553 calling run with a list af variables as arguments), any failing
2554 command will cause "run" to terminate, i. e. the remaining
2555 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00002556
wdenk2729af92004-05-03 20:45:30 +00002557Note for Redundant Ethernet Interfaces:
2558=======================================
wdenkf07771c2003-05-28 08:06:31 +00002559
wdenk2729af92004-05-03 20:45:30 +00002560Some boards come with redundant ethernet interfaces; U-Boot supports
2561such configurations and is capable of automatic selection of a
2562"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00002563
wdenk2729af92004-05-03 20:45:30 +00002564Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2565MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2566"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00002567
wdenk2729af92004-05-03 20:45:30 +00002568If the network interface stores some valid MAC address (for instance
2569in SROM), this is used as default address if there is NO correspon-
2570ding setting in the environment; if the corresponding environment
2571variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00002572
wdenk2729af92004-05-03 20:45:30 +00002573o If the SROM has a valid MAC address, and there is no address in the
2574 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002575
wdenk2729af92004-05-03 20:45:30 +00002576o If there is no valid address in the SROM, and a definition in the
2577 environment exists, then the value from the environment variable is
2578 used.
wdenkc6097192002-11-03 00:24:07 +00002579
wdenk2729af92004-05-03 20:45:30 +00002580o If both the SROM and the environment contain a MAC address, and
2581 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002582
wdenk2729af92004-05-03 20:45:30 +00002583o If both the SROM and the environment contain a MAC address, and the
2584 addresses differ, the value from the environment is used and a
2585 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002586
wdenk2729af92004-05-03 20:45:30 +00002587o If neither SROM nor the environment contain a MAC address, an error
2588 is raised.
wdenkc6097192002-11-03 00:24:07 +00002589
wdenkc6097192002-11-03 00:24:07 +00002590
wdenk2729af92004-05-03 20:45:30 +00002591Image Formats:
2592==============
wdenkc6097192002-11-03 00:24:07 +00002593
wdenk2729af92004-05-03 20:45:30 +00002594The "boot" commands of this monitor operate on "image" files which
2595can be basicly anything, preceeded by a special header; see the
2596definitions in include/image.h for details; basicly, the header
2597defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002598
wdenk2729af92004-05-03 20:45:30 +00002599* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2600 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2601 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2602 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2603* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2604 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2605 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2606* Compression Type (uncompressed, gzip, bzip2)
2607* Load Address
2608* Entry Point
2609* Image Name
2610* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002611
wdenk2729af92004-05-03 20:45:30 +00002612The header is marked by a special Magic Number, and both the header
2613and the data portions of the image are secured against corruption by
2614CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002615
wdenkc6097192002-11-03 00:24:07 +00002616
wdenk2729af92004-05-03 20:45:30 +00002617Linux Support:
2618==============
wdenkc6097192002-11-03 00:24:07 +00002619
wdenk2729af92004-05-03 20:45:30 +00002620Although U-Boot should support any OS or standalone application
2621easily, the main focus has always been on Linux during the design of
2622U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002623
wdenk2729af92004-05-03 20:45:30 +00002624U-Boot includes many features that so far have been part of some
2625special "boot loader" code within the Linux kernel. Also, any
2626"initrd" images to be used are no longer part of one big Linux image;
2627instead, kernel and "initrd" are separate images. This implementation
2628serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002629
wdenk2729af92004-05-03 20:45:30 +00002630- the same features can be used for other OS or standalone
2631 applications (for instance: using compressed images to reduce the
2632 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002633
wdenk2729af92004-05-03 20:45:30 +00002634- it becomes much easier to port new Linux kernel versions because
2635 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002636
wdenk2729af92004-05-03 20:45:30 +00002637- the same Linux kernel image can now be used with different "initrd"
2638 images; of course this also means that different kernel images can
2639 be run with the same "initrd". This makes testing easier (you don't
2640 have to build a new "zImage.initrd" Linux image when you just
2641 change a file in your "initrd"). Also, a field-upgrade of the
2642 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002643
wdenkc6097192002-11-03 00:24:07 +00002644
wdenk2729af92004-05-03 20:45:30 +00002645Linux HOWTO:
2646============
wdenkc6097192002-11-03 00:24:07 +00002647
wdenk2729af92004-05-03 20:45:30 +00002648Porting Linux to U-Boot based systems:
2649---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002650
wdenk2729af92004-05-03 20:45:30 +00002651U-Boot cannot save you from doing all the necessary modifications to
2652configure the Linux device drivers for use with your target hardware
2653(no, we don't intend to provide a full virtual machine interface to
2654Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002655
wdenk2729af92004-05-03 20:45:30 +00002656But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002657
wdenk2729af92004-05-03 20:45:30 +00002658Just make sure your machine specific header file (for instance
2659include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2660Information structure as we define in include/u-boot.h, and make
2661sure that your definition of IMAP_ADDR uses the same value as your
2662U-Boot configuration in CFG_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002663
wdenkc6097192002-11-03 00:24:07 +00002664
wdenk2729af92004-05-03 20:45:30 +00002665Configuring the Linux kernel:
2666-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002667
wdenk2729af92004-05-03 20:45:30 +00002668No specific requirements for U-Boot. Make sure you have some root
2669device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002670
wdenkc6097192002-11-03 00:24:07 +00002671
wdenk2729af92004-05-03 20:45:30 +00002672Building a Linux Image:
2673-----------------------
wdenkc6097192002-11-03 00:24:07 +00002674
wdenk2729af92004-05-03 20:45:30 +00002675With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2676not used. If you use recent kernel source, a new build target
2677"uImage" will exist which automatically builds an image usable by
2678U-Boot. Most older kernels also have support for a "pImage" target,
2679which was introduced for our predecessor project PPCBoot and uses a
2680100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002681
wdenk2729af92004-05-03 20:45:30 +00002682Example:
wdenkc6097192002-11-03 00:24:07 +00002683
wdenk2729af92004-05-03 20:45:30 +00002684 make TQM850L_config
2685 make oldconfig
2686 make dep
2687 make uImage
wdenkc6097192002-11-03 00:24:07 +00002688
wdenk2729af92004-05-03 20:45:30 +00002689The "uImage" build target uses a special tool (in 'tools/mkimage') to
2690encapsulate a compressed Linux kernel image with header information,
2691CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002692
wdenk2729af92004-05-03 20:45:30 +00002693* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002694
wdenk2729af92004-05-03 20:45:30 +00002695* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002696
wdenk2729af92004-05-03 20:45:30 +00002697 ${CROSS_COMPILE}-objcopy -O binary \
2698 -R .note -R .comment \
2699 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00002700
wdenk2729af92004-05-03 20:45:30 +00002701* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00002702
wdenk2729af92004-05-03 20:45:30 +00002703 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00002704
wdenk2729af92004-05-03 20:45:30 +00002705* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002706
wdenk2729af92004-05-03 20:45:30 +00002707 mkimage -A ppc -O linux -T kernel -C gzip \
2708 -a 0 -e 0 -n "Linux Kernel Image" \
2709 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00002710
wdenk24ee89b2002-11-03 17:56:27 +00002711
wdenk2729af92004-05-03 20:45:30 +00002712The "mkimage" tool can also be used to create ramdisk images for use
2713with U-Boot, either separated from the Linux kernel image, or
2714combined into one file. "mkimage" encapsulates the images with a 64
2715byte header containing information about target architecture,
2716operating system, image type, compression method, entry points, time
2717stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00002718
wdenk2729af92004-05-03 20:45:30 +00002719"mkimage" can be called in two ways: to verify existing images and
2720print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002721
wdenk2729af92004-05-03 20:45:30 +00002722In the first form (with "-l" option) mkimage lists the information
2723contained in the header of an existing U-Boot image; this includes
2724checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002725
wdenk2729af92004-05-03 20:45:30 +00002726 tools/mkimage -l image
2727 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002728
wdenk2729af92004-05-03 20:45:30 +00002729The second form (with "-d" option) is used to build a U-Boot image
2730from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002731
wdenk2729af92004-05-03 20:45:30 +00002732 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2733 -n name -d data_file image
2734 -A ==> set architecture to 'arch'
2735 -O ==> set operating system to 'os'
2736 -T ==> set image type to 'type'
2737 -C ==> set compression type 'comp'
2738 -a ==> set load address to 'addr' (hex)
2739 -e ==> set entry point to 'ep' (hex)
2740 -n ==> set image name to 'name'
2741 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002742
wdenk69459792004-05-29 16:53:29 +00002743Right now, all Linux kernels for PowerPC systems use the same load
2744address (0x00000000), but the entry point address depends on the
2745kernel version:
wdenkc6097192002-11-03 00:24:07 +00002746
wdenk2729af92004-05-03 20:45:30 +00002747- 2.2.x kernels have the entry point at 0x0000000C,
2748- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002749
wdenk2729af92004-05-03 20:45:30 +00002750So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002751
wdenk2729af92004-05-03 20:45:30 +00002752 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2753 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2754 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2755 > examples/uImage.TQM850L
2756 Image Name: 2.4.4 kernel for TQM850L
2757 Created: Wed Jul 19 02:34:59 2000
2758 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2759 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2760 Load Address: 0x00000000
2761 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002762
wdenk2729af92004-05-03 20:45:30 +00002763To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002764
wdenk2729af92004-05-03 20:45:30 +00002765 -> tools/mkimage -l examples/uImage.TQM850L
2766 Image Name: 2.4.4 kernel for TQM850L
2767 Created: Wed Jul 19 02:34:59 2000
2768 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2769 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2770 Load Address: 0x00000000
2771 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002772
wdenk2729af92004-05-03 20:45:30 +00002773NOTE: for embedded systems where boot time is critical you can trade
2774speed for memory and install an UNCOMPRESSED image instead: this
2775needs more space in Flash, but boots much faster since it does not
2776need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002777
wdenk2729af92004-05-03 20:45:30 +00002778 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2779 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2780 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2781 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2782 > examples/uImage.TQM850L-uncompressed
2783 Image Name: 2.4.4 kernel for TQM850L
2784 Created: Wed Jul 19 02:34:59 2000
2785 Image Type: PowerPC Linux Kernel Image (uncompressed)
2786 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2787 Load Address: 0x00000000
2788 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002789
wdenkc6097192002-11-03 00:24:07 +00002790
wdenk2729af92004-05-03 20:45:30 +00002791Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2792when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00002793
wdenk2729af92004-05-03 20:45:30 +00002794 -> tools/mkimage -n 'Simple Ramdisk Image' \
2795 > -A ppc -O linux -T ramdisk -C gzip \
2796 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2797 Image Name: Simple Ramdisk Image
2798 Created: Wed Jan 12 14:01:50 2000
2799 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2800 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2801 Load Address: 0x00000000
2802 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00002803
wdenkdb01a2e2004-04-15 23:14:49 +00002804
wdenk2729af92004-05-03 20:45:30 +00002805Installing a Linux Image:
2806-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00002807
wdenk2729af92004-05-03 20:45:30 +00002808To downloading a U-Boot image over the serial (console) interface,
2809you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00002810
wdenk2729af92004-05-03 20:45:30 +00002811 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00002812
wdenk2729af92004-05-03 20:45:30 +00002813The 'objcopy' does not understand the information in the U-Boot
2814image header, so the resulting S-Record file will be relative to
2815address 0x00000000. To load it to a given address, you need to
2816specify the target address as 'offset' parameter with the 'loads'
2817command.
wdenkc6097192002-11-03 00:24:07 +00002818
wdenk2729af92004-05-03 20:45:30 +00002819Example: install the image to address 0x40100000 (which on the
2820TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00002821
wdenk2729af92004-05-03 20:45:30 +00002822 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00002823
wdenk2729af92004-05-03 20:45:30 +00002824 .......... done
2825 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00002826
wdenk2729af92004-05-03 20:45:30 +00002827 => loads 40100000
2828 ## Ready for S-Record download ...
2829 ~>examples/image.srec
2830 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2831 ...
2832 15989 15990 15991 15992
2833 [file transfer complete]
2834 [connected]
2835 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002836
2837
wdenk2729af92004-05-03 20:45:30 +00002838You can check the success of the download using the 'iminfo' command;
2839this includes a checksum verification so you can be sure no data
2840corruption happened:
wdenkc6097192002-11-03 00:24:07 +00002841
wdenk2729af92004-05-03 20:45:30 +00002842 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00002843
wdenk2729af92004-05-03 20:45:30 +00002844 ## Checking Image at 40100000 ...
2845 Image Name: 2.2.13 for initrd on TQM850L
2846 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2847 Data Size: 335725 Bytes = 327 kB = 0 MB
2848 Load Address: 00000000
2849 Entry Point: 0000000c
2850 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002851
2852
wdenk2729af92004-05-03 20:45:30 +00002853Boot Linux:
2854-----------
wdenkc6097192002-11-03 00:24:07 +00002855
wdenk2729af92004-05-03 20:45:30 +00002856The "bootm" command is used to boot an application that is stored in
2857memory (RAM or Flash). In case of a Linux kernel image, the contents
2858of the "bootargs" environment variable is passed to the kernel as
2859parameters. You can check and modify this variable using the
2860"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00002861
2862
wdenk2729af92004-05-03 20:45:30 +00002863 => printenv bootargs
2864 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00002865
wdenk2729af92004-05-03 20:45:30 +00002866 => 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 +00002867
wdenk2729af92004-05-03 20:45:30 +00002868 => printenv bootargs
2869 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 +00002870
wdenk2729af92004-05-03 20:45:30 +00002871 => bootm 40020000
2872 ## Booting Linux kernel at 40020000 ...
2873 Image Name: 2.2.13 for NFS on TQM850L
2874 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2875 Data Size: 381681 Bytes = 372 kB = 0 MB
2876 Load Address: 00000000
2877 Entry Point: 0000000c
2878 Verifying Checksum ... OK
2879 Uncompressing Kernel Image ... OK
2880 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
2881 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2882 time_init: decrementer frequency = 187500000/60
2883 Calibrating delay loop... 49.77 BogoMIPS
2884 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2885 ...
wdenkc6097192002-11-03 00:24:07 +00002886
wdenk2729af92004-05-03 20:45:30 +00002887If you want to boot a Linux kernel with initial ram disk, you pass
2888the memory addresses of both the kernel and the initrd image (PPBCOOT
2889format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00002890
wdenk2729af92004-05-03 20:45:30 +00002891 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00002892
wdenk2729af92004-05-03 20:45:30 +00002893 ## Checking Image at 40100000 ...
2894 Image Name: 2.2.13 for initrd on TQM850L
2895 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2896 Data Size: 335725 Bytes = 327 kB = 0 MB
2897 Load Address: 00000000
2898 Entry Point: 0000000c
2899 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002900
wdenk2729af92004-05-03 20:45:30 +00002901 ## Checking Image at 40200000 ...
2902 Image Name: Simple Ramdisk Image
2903 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2904 Data Size: 566530 Bytes = 553 kB = 0 MB
2905 Load Address: 00000000
2906 Entry Point: 00000000
2907 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002908
wdenk2729af92004-05-03 20:45:30 +00002909 => bootm 40100000 40200000
2910 ## Booting Linux kernel at 40100000 ...
2911 Image Name: 2.2.13 for initrd on TQM850L
2912 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2913 Data Size: 335725 Bytes = 327 kB = 0 MB
2914 Load Address: 00000000
2915 Entry Point: 0000000c
2916 Verifying Checksum ... OK
2917 Uncompressing Kernel Image ... OK
2918 ## Loading RAMDisk Image at 40200000 ...
2919 Image Name: Simple Ramdisk Image
2920 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2921 Data Size: 566530 Bytes = 553 kB = 0 MB
2922 Load Address: 00000000
2923 Entry Point: 00000000
2924 Verifying Checksum ... OK
2925 Loading Ramdisk ... OK
2926 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
2927 Boot arguments: root=/dev/ram
2928 time_init: decrementer frequency = 187500000/60
2929 Calibrating delay loop... 49.77 BogoMIPS
2930 ...
2931 RAMDISK: Compressed image found at block 0
2932 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00002933
wdenk2729af92004-05-03 20:45:30 +00002934 bash#
wdenkc6097192002-11-03 00:24:07 +00002935
wdenk2729af92004-05-03 20:45:30 +00002936More About U-Boot Image Types:
2937------------------------------
wdenk6069ff22003-02-28 00:49:47 +00002938
wdenk2729af92004-05-03 20:45:30 +00002939U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00002940
wdenk2729af92004-05-03 20:45:30 +00002941 "Standalone Programs" are directly runnable in the environment
2942 provided by U-Boot; it is expected that (if they behave
2943 well) you can continue to work in U-Boot after return from
2944 the Standalone Program.
2945 "OS Kernel Images" are usually images of some Embedded OS which
2946 will take over control completely. Usually these programs
2947 will install their own set of exception handlers, device
2948 drivers, set up the MMU, etc. - this means, that you cannot
2949 expect to re-enter U-Boot except by resetting the CPU.
2950 "RAMDisk Images" are more or less just data blocks, and their
2951 parameters (address, size) are passed to an OS kernel that is
2952 being started.
2953 "Multi-File Images" contain several images, typically an OS
2954 (Linux) kernel image and one or more data images like
2955 RAMDisks. This construct is useful for instance when you want
2956 to boot over the network using BOOTP etc., where the boot
2957 server provides just a single image file, but you want to get
2958 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00002959
wdenk2729af92004-05-03 20:45:30 +00002960 "Multi-File Images" start with a list of image sizes, each
2961 image size (in bytes) specified by an "uint32_t" in network
2962 byte order. This list is terminated by an "(uint32_t)0".
2963 Immediately after the terminating 0 follow the images, one by
2964 one, all aligned on "uint32_t" boundaries (size rounded up to
2965 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00002966
wdenk2729af92004-05-03 20:45:30 +00002967 "Firmware Images" are binary images containing firmware (like
2968 U-Boot or FPGA images) which usually will be programmed to
2969 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00002970
wdenk2729af92004-05-03 20:45:30 +00002971 "Script files" are command sequences that will be executed by
2972 U-Boot's command interpreter; this feature is especially
2973 useful when you configure U-Boot to use a real shell (hush)
2974 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00002975
wdenkc6097192002-11-03 00:24:07 +00002976
wdenk2729af92004-05-03 20:45:30 +00002977Standalone HOWTO:
2978=================
wdenkc6097192002-11-03 00:24:07 +00002979
wdenk2729af92004-05-03 20:45:30 +00002980One of the features of U-Boot is that you can dynamically load and
2981run "standalone" applications, which can use some resources of
2982U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00002983
wdenk2729af92004-05-03 20:45:30 +00002984Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00002985
wdenk2729af92004-05-03 20:45:30 +00002986"Hello World" Demo:
2987-------------------
wdenkc6097192002-11-03 00:24:07 +00002988
wdenk2729af92004-05-03 20:45:30 +00002989'examples/hello_world.c' contains a small "Hello World" Demo
2990application; it is automatically compiled when you build U-Boot.
2991It's configured to run at address 0x00040004, so you can play with it
2992like that:
wdenkc6097192002-11-03 00:24:07 +00002993
wdenk2729af92004-05-03 20:45:30 +00002994 => loads
2995 ## Ready for S-Record download ...
2996 ~>examples/hello_world.srec
2997 1 2 3 4 5 6 7 8 9 10 11 ...
2998 [file transfer complete]
2999 [connected]
3000 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003001
wdenk2729af92004-05-03 20:45:30 +00003002 => go 40004 Hello World! This is a test.
3003 ## Starting application at 0x00040004 ...
3004 Hello World
3005 argc = 7
3006 argv[0] = "40004"
3007 argv[1] = "Hello"
3008 argv[2] = "World!"
3009 argv[3] = "This"
3010 argv[4] = "is"
3011 argv[5] = "a"
3012 argv[6] = "test."
3013 argv[7] = "<NULL>"
3014 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003015
wdenk2729af92004-05-03 20:45:30 +00003016 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003017
wdenk2729af92004-05-03 20:45:30 +00003018Another example, which demonstrates how to register a CPM interrupt
3019handler with the U-Boot code, can be found in 'examples/timer.c'.
3020Here, a CPM timer is set up to generate an interrupt every second.
3021The interrupt service routine is trivial, just printing a '.'
3022character, but this is just a demo program. The application can be
3023controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003024
wdenk2729af92004-05-03 20:45:30 +00003025 ? - print current values og the CPM Timer registers
3026 b - enable interrupts and start timer
3027 e - stop timer and disable interrupts
3028 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003029
wdenk2729af92004-05-03 20:45:30 +00003030 => loads
3031 ## Ready for S-Record download ...
3032 ~>examples/timer.srec
3033 1 2 3 4 5 6 7 8 9 10 11 ...
3034 [file transfer complete]
3035 [connected]
3036 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003037
wdenk2729af92004-05-03 20:45:30 +00003038 => go 40004
3039 ## Starting application at 0x00040004 ...
3040 TIMERS=0xfff00980
3041 Using timer 1
3042 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003043
wdenk2729af92004-05-03 20:45:30 +00003044Hit 'b':
3045 [q, b, e, ?] Set interval 1000000 us
3046 Enabling timer
3047Hit '?':
3048 [q, b, e, ?] ........
3049 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3050Hit '?':
3051 [q, b, e, ?] .
3052 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3053Hit '?':
3054 [q, b, e, ?] .
3055 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3056Hit '?':
3057 [q, b, e, ?] .
3058 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3059Hit 'e':
3060 [q, b, e, ?] ...Stopping timer
3061Hit 'q':
3062 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003063
3064
wdenk2729af92004-05-03 20:45:30 +00003065Minicom warning:
3066================
wdenk85ec0bc2003-03-31 16:34:49 +00003067
wdenk2729af92004-05-03 20:45:30 +00003068Over time, many people have reported problems when trying to use the
3069"minicom" terminal emulation program for serial download. I (wd)
3070consider minicom to be broken, and recommend not to use it. Under
3071Unix, I recommend to use C-Kermit for general purpose use (and
3072especially for kermit binary protocol download ("loadb" command), and
3073use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003074
wdenk2729af92004-05-03 20:45:30 +00003075Nevertheless, if you absolutely want to use it try adding this
3076configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003077
wdenk2729af92004-05-03 20:45:30 +00003078 Name Program Name U/D FullScr IO-Red. Multi
3079 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3080 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003081
3082
wdenk2729af92004-05-03 20:45:30 +00003083NetBSD Notes:
3084=============
wdenkc6097192002-11-03 00:24:07 +00003085
wdenk2729af92004-05-03 20:45:30 +00003086Starting at version 0.9.2, U-Boot supports NetBSD both as host
3087(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003088
wdenk2729af92004-05-03 20:45:30 +00003089Building requires a cross environment; it is known to work on
3090NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3091need gmake since the Makefiles are not compatible with BSD make).
3092Note that the cross-powerpc package does not install include files;
3093attempting to build U-Boot will fail because <machine/ansi.h> is
3094missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003095
wdenk2729af92004-05-03 20:45:30 +00003096 # cd /usr/pkg/cross/powerpc-netbsd/include
3097 # mkdir powerpc
3098 # ln -s powerpc machine
3099 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3100 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003101
wdenk2729af92004-05-03 20:45:30 +00003102Native builds *don't* work due to incompatibilities between native
3103and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003104
wdenk2729af92004-05-03 20:45:30 +00003105Booting assumes that (the first part of) the image booted is a
3106stage-2 loader which in turn loads and then invokes the kernel
3107proper. Loader sources will eventually appear in the NetBSD source
3108tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003109meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003110
3111
wdenk2729af92004-05-03 20:45:30 +00003112Implementation Internals:
3113=========================
wdenkc6097192002-11-03 00:24:07 +00003114
wdenk2729af92004-05-03 20:45:30 +00003115The following is not intended to be a complete description of every
3116implementation detail. However, it should help to understand the
3117inner workings of U-Boot and make it easier to port it to custom
3118hardware.
wdenkc6097192002-11-03 00:24:07 +00003119
3120
wdenk2729af92004-05-03 20:45:30 +00003121Initial Stack, Global Data:
3122---------------------------
wdenkc6097192002-11-03 00:24:07 +00003123
wdenk2729af92004-05-03 20:45:30 +00003124The implementation of U-Boot is complicated by the fact that U-Boot
3125starts running out of ROM (flash memory), usually without access to
3126system RAM (because the memory controller is not initialized yet).
3127This means that we don't have writable Data or BSS segments, and BSS
3128is not initialized as zero. To be able to get a C environment working
3129at all, we have to allocate at least a minimal stack. Implementation
3130options for this are defined and restricted by the CPU used: Some CPU
3131models provide on-chip memory (like the IMMR area on MPC8xx and
3132MPC826x processors), on others (parts of) the data cache can be
3133locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003134
wdenk2729af92004-05-03 20:45:30 +00003135 Chris Hallinan posted a good summary of these issues to the
3136 u-boot-users mailing list:
wdenk43d96162003-03-06 00:02:04 +00003137
wdenk2729af92004-05-03 20:45:30 +00003138 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3139 From: "Chris Hallinan" <clh@net1plus.com>
3140 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3141 ...
wdenk43d96162003-03-06 00:02:04 +00003142
wdenk2729af92004-05-03 20:45:30 +00003143 Correct me if I'm wrong, folks, but the way I understand it
3144 is this: Using DCACHE as initial RAM for Stack, etc, does not
3145 require any physical RAM backing up the cache. The cleverness
3146 is that the cache is being used as a temporary supply of
3147 necessary storage before the SDRAM controller is setup. It's
3148 beyond the scope of this list to expain the details, but you
3149 can see how this works by studying the cache architecture and
3150 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003151
wdenk2729af92004-05-03 20:45:30 +00003152 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3153 is another option for the system designer to use as an
3154 initial stack/ram area prior to SDRAM being available. Either
3155 option should work for you. Using CS 4 should be fine if your
3156 board designers haven't used it for something that would
3157 cause you grief during the initial boot! It is frequently not
3158 used.
wdenk43d96162003-03-06 00:02:04 +00003159
wdenk2729af92004-05-03 20:45:30 +00003160 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3161 with your processor/board/system design. The default value
3162 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003163 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003164 than your SDRAM module. If you have a 64MB SDRAM module, set
3165 it above 400_0000. Just make sure your board has no resources
3166 that are supposed to respond to that address! That code in
3167 start.S has been around a while and should work as is when
3168 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003169
wdenk2729af92004-05-03 20:45:30 +00003170 -Chris Hallinan
3171 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003172
wdenk2729af92004-05-03 20:45:30 +00003173It is essential to remember this, since it has some impact on the C
3174code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003175
wdenk2729af92004-05-03 20:45:30 +00003176* Initialized global data (data segment) is read-only. Do not attempt
3177 to write it.
wdenkc6097192002-11-03 00:24:07 +00003178
wdenk2729af92004-05-03 20:45:30 +00003179* Do not use any unitialized global data (or implicitely initialized
3180 as zero data - BSS segment) at all - this is undefined, initiali-
3181 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003182
wdenk2729af92004-05-03 20:45:30 +00003183* Stack space is very limited. Avoid big data buffers or things like
3184 that.
wdenkc6097192002-11-03 00:24:07 +00003185
wdenk2729af92004-05-03 20:45:30 +00003186Having only the stack as writable memory limits means we cannot use
3187normal global data to share information beween the code. But it
3188turned out that the implementation of U-Boot can be greatly
3189simplified by making a global data structure (gd_t) available to all
3190functions. We could pass a pointer to this data as argument to _all_
3191functions, but this would bloat the code. Instead we use a feature of
3192the GCC compiler (Global Register Variables) to share the data: we
3193place a pointer (gd) to the global data into a register which we
3194reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003195
wdenk2729af92004-05-03 20:45:30 +00003196When choosing a register for such a purpose we are restricted by the
3197relevant (E)ABI specifications for the current architecture, and by
3198GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003199
wdenk2729af92004-05-03 20:45:30 +00003200For PowerPC, the following registers have specific use:
3201 R1: stack pointer
3202 R2: TOC pointer
3203 R3-R4: parameter passing and return values
3204 R5-R10: parameter passing
3205 R13: small data area pointer
3206 R30: GOT pointer
3207 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003208
wdenk2729af92004-05-03 20:45:30 +00003209 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003210
wdenk2729af92004-05-03 20:45:30 +00003211 ==> U-Boot will use R29 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003212
wdenk2729af92004-05-03 20:45:30 +00003213 Note: on PPC, we could use a static initializer (since the
3214 address of the global data structure is known at compile time),
3215 but it turned out that reserving a register results in somewhat
3216 smaller code - although the code savings are not that big (on
3217 average for all boards 752 bytes for the whole U-Boot image,
3218 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003219
wdenk2729af92004-05-03 20:45:30 +00003220On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003221
wdenk2729af92004-05-03 20:45:30 +00003222 R0: function argument word/integer result
3223 R1-R3: function argument word
3224 R9: GOT pointer
3225 R10: stack limit (used only if stack checking if enabled)
3226 R11: argument (frame) pointer
3227 R12: temporary workspace
3228 R13: stack pointer
3229 R14: link register
3230 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003231
wdenk2729af92004-05-03 20:45:30 +00003232 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003233
3234
wdenk2729af92004-05-03 20:45:30 +00003235Memory Management:
3236------------------
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk2729af92004-05-03 20:45:30 +00003238U-Boot runs in system state and uses physical addresses, i.e. the
3239MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003240
wdenk2729af92004-05-03 20:45:30 +00003241The available memory is mapped to fixed addresses using the memory
3242controller. In this process, a contiguous block is formed for each
3243memory type (Flash, SDRAM, SRAM), even when it consists of several
3244physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003245
wdenk2729af92004-05-03 20:45:30 +00003246U-Boot is installed in the first 128 kB of the first Flash bank (on
3247TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3248booting and sizing and initializing DRAM, the code relocates itself
3249to the upper end of DRAM. Immediately below the U-Boot code some
3250memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3251configuration setting]. Below that, a structure with global Board
3252Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003253
wdenk2729af92004-05-03 20:45:30 +00003254Additionally, some exception handler code is copied to the low 8 kB
3255of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003256
wdenk2729af92004-05-03 20:45:30 +00003257So a typical memory configuration with 16 MB of DRAM could look like
3258this:
wdenkc6097192002-11-03 00:24:07 +00003259
wdenk2729af92004-05-03 20:45:30 +00003260 0x0000 0000 Exception Vector code
3261 :
3262 0x0000 1FFF
3263 0x0000 2000 Free for Application Use
3264 :
3265 :
wdenkc6097192002-11-03 00:24:07 +00003266
wdenk2729af92004-05-03 20:45:30 +00003267 :
3268 :
3269 0x00FB FF20 Monitor Stack (Growing downward)
3270 0x00FB FFAC Board Info Data and permanent copy of global data
3271 0x00FC 0000 Malloc Arena
3272 :
3273 0x00FD FFFF
3274 0x00FE 0000 RAM Copy of Monitor Code
3275 ... eventually: LCD or video framebuffer
3276 ... eventually: pRAM (Protected RAM - unchanged by reset)
3277 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003278
3279
wdenk2729af92004-05-03 20:45:30 +00003280System Initialization:
3281----------------------
wdenkc6097192002-11-03 00:24:07 +00003282
wdenk2729af92004-05-03 20:45:30 +00003283In the reset configuration, U-Boot starts at the reset entry point
3284(on most PowerPC systens at address 0x00000100). Because of the reset
3285configuration for CS0# this is a mirror of the onboard Flash memory.
3286To be able to re-map memory U-Boot then jumps to its link address.
3287To be able to implement the initialization code in C, a (small!)
3288initial stack is set up in the internal Dual Ported RAM (in case CPUs
3289which provide such a feature like MPC8xx or MPC8260), or in a locked
3290part of the data cache. After that, U-Boot initializes the CPU core,
3291the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003292
wdenk2729af92004-05-03 20:45:30 +00003293Next, all (potentially) available memory banks are mapped using a
3294preliminary mapping. For example, we put them on 512 MB boundaries
3295(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3296on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3297programmed for SDRAM access. Using the temporary configuration, a
3298simple memory test is run that determines the size of the SDRAM
3299banks.
wdenkc6097192002-11-03 00:24:07 +00003300
wdenk2729af92004-05-03 20:45:30 +00003301When there is more than one SDRAM bank, and the banks are of
3302different size, the largest is mapped first. For equal size, the first
3303bank (CS2#) is mapped first. The first mapping is always for address
33040x00000000, with any additional banks following immediately to create
3305contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307Then, the monitor installs itself at the upper end of the SDRAM area
3308and allocates memory for use by malloc() and for the global Board
3309Info data; also, the exception vector code is copied to the low RAM
3310pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003311
wdenk2729af92004-05-03 20:45:30 +00003312Only after this relocation will you have a "normal" C environment;
3313until that you are restricted in several ways, mostly because you are
3314running from ROM, and because the code will have to be relocated to a
3315new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003316
3317
wdenk2729af92004-05-03 20:45:30 +00003318U-Boot Porting Guide:
3319----------------------
wdenkc6097192002-11-03 00:24:07 +00003320
wdenk2729af92004-05-03 20:45:30 +00003321[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3322list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003323
3324
wdenk2729af92004-05-03 20:45:30 +00003325int main (int argc, char *argv[])
3326{
3327 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003328
wdenk2729af92004-05-03 20:45:30 +00003329 signal (SIGALRM, no_more_time);
3330 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003331
wdenk2729af92004-05-03 20:45:30 +00003332 if (available_money > available_manpower) {
3333 pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00003334 return 0;
3335 }
3336
wdenk2729af92004-05-03 20:45:30 +00003337 Download latest U-Boot source;
3338
3339 Subscribe to u-boot-users mailing list;
3340
3341 if (clueless) {
3342 email ("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003343 }
3344
wdenk2729af92004-05-03 20:45:30 +00003345 while (learning) {
3346 Read the README file in the top level directory;
3347 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3348 Read the source, Luke;
3349 }
wdenkc6097192002-11-03 00:24:07 +00003350
wdenk2729af92004-05-03 20:45:30 +00003351 if (available_money > toLocalCurrency ($2500)) {
3352 Buy a BDI2000;
3353 } else {
3354 Add a lot of aggravation and time;
3355 }
wdenkc6097192002-11-03 00:24:07 +00003356
wdenk2729af92004-05-03 20:45:30 +00003357 Create your own board support subdirectory;
wdenkc6097192002-11-03 00:24:07 +00003358
wdenk2729af92004-05-03 20:45:30 +00003359 Create your own board config file;
wdenk6aff3112002-12-17 01:51:00 +00003360
wdenk2729af92004-05-03 20:45:30 +00003361 while (!running) {
3362 do {
3363 Add / modify source code;
3364 } until (compiles);
3365 Debug;
3366 if (clueless)
3367 email ("Hi, I am having problems...");
3368 }
3369 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003370
wdenk2729af92004-05-03 20:45:30 +00003371 return 0;
3372}
3373
3374void no_more_time (int sig)
3375{
3376 hire_a_guru();
3377}
wdenkc6097192002-11-03 00:24:07 +00003378
3379
wdenk2729af92004-05-03 20:45:30 +00003380Coding Standards:
3381-----------------
wdenkc6097192002-11-03 00:24:07 +00003382
wdenk2729af92004-05-03 20:45:30 +00003383All contributions to U-Boot should conform to the Linux kernel
3384coding style; see the file "Documentation/CodingStyle" in your Linux
3385kernel source directory.
3386
3387Please note that U-Boot is implemented in C (and to some small parts
3388in Assembler); no C++ is used, so please do not use C++ style
3389comments (//) in your code.
3390
3391Please also stick to the following formatting rules:
3392- remove any trailing white space
3393- use TAB characters for indentation, not spaces
3394- make sure NOT to use DOS '\r\n' line feeds
3395- do not add more than 2 empty lines to source files
3396- do not add trailing empty lines to source files
3397
3398Submissions which do not conform to the standards may be returned
3399with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003400
3401
wdenk2729af92004-05-03 20:45:30 +00003402Submitting Patches:
3403-------------------
wdenkc6097192002-11-03 00:24:07 +00003404
wdenk2729af92004-05-03 20:45:30 +00003405Since the number of patches for U-Boot is growing, we need to
3406establish some rules. Submissions which do not conform to these rules
3407may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003408
wdenk90dc6702005-05-03 14:12:25 +00003409Patches shall be sent to the u-boot-users mailing list.
wdenkc6097192002-11-03 00:24:07 +00003410
wdenk2729af92004-05-03 20:45:30 +00003411When you send a patch, please include the following information with
3412it:
wdenkc6097192002-11-03 00:24:07 +00003413
wdenk2729af92004-05-03 20:45:30 +00003414* For bug fixes: a description of the bug and how your patch fixes
3415 this bug. Please try to include a way of demonstrating that the
3416 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003417
wdenk2729af92004-05-03 20:45:30 +00003418* For new features: a description of the feature and your
3419 implementation.
wdenkc6097192002-11-03 00:24:07 +00003420
wdenk2729af92004-05-03 20:45:30 +00003421* A CHANGELOG entry as plaintext (separate from the patch)
3422
3423* For major contributions, your entry to the CREDITS file
3424
3425* When you add support for a new board, don't forget to add this
3426 board to the MAKEALL script, too.
3427
3428* If your patch adds new configuration options, don't forget to
3429 document these in the README file.
3430
3431* The patch itself. If you are accessing the CVS repository use "cvs
3432 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3433 version of diff does not support these options, then get the latest
3434 version of GNU diff.
3435
3436 The current directory when running this command shall be the top
3437 level directory of the U-Boot source tree, or it's parent directory
3438 (i. e. please make sure that your patch includes sufficient
3439 directory information for the affected files).
3440
3441 We accept patches as plain text, MIME attachments or as uuencoded
3442 gzipped text.
3443
3444* If one logical set of modifications affects or creates several
3445 files, all these changes shall be submitted in a SINGLE patch file.
3446
3447* Changesets that contain different, unrelated modifications shall be
3448 submitted as SEPARATE patches, one patch per changeset.
3449
3450
3451Notes:
3452
3453* Before sending the patch, run the MAKEALL script on your patched
3454 source tree and make sure that no errors or warnings are reported
3455 for any of the boards.
3456
3457* Keep your modifications to the necessary minimum: A patch
3458 containing several unrelated changes or arbitrary reformats will be
3459 returned with a request to re-formatting / split it.
3460
3461* If you modify existing code, make sure that your new code does not
3462 add to the memory footprint of the code ;-) Small is beautiful!
3463 When adding new features, these should compile conditionally only
3464 (using #ifdef), and the resulting code with the new feature
3465 disabled must not need more memory than the old code without your
3466 modification.
wdenk90dc6702005-05-03 14:12:25 +00003467
3468* Remember that there is a size limit of 40 kB per message on the
3469 u-boot-users mailing list. Compression may help.