blob: 71e9dc91aea0547df33418a255732f26c27b84fc [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
Wolfgang Denk7521af12005-10-09 01:04:33 +0200264 CONFIG_ADCIOP CONFIG_GEN860T CONFIG_PCIPPC2
265 CONFIG_ADS860 CONFIG_GENIETV CONFIG_PCIPPC6
266 CONFIG_AMX860 CONFIG_GTH CONFIG_pcu_e
267 CONFIG_AP1000 CONFIG_gw8260 CONFIG_PIP405
268 CONFIG_AR405 CONFIG_hermes CONFIG_PM826
269 CONFIG_BAB7xx CONFIG_hymod CONFIG_ppmc8260
270 CONFIG_c2mon CONFIG_IAD210 CONFIG_QS823
271 CONFIG_CANBT CONFIG_ICU862 CONFIG_QS850
272 CONFIG_CCM CONFIG_IP860 CONFIG_QS860T
273 CONFIG_CMI CONFIG_IPHASE4539 CONFIG_RBC823
274 CONFIG_cogent_mpc8260 CONFIG_IVML24 CONFIG_RPXClassic
275 CONFIG_cogent_mpc8xx CONFIG_IVML24_128 CONFIG_RPXlite
276 CONFIG_CPCI405 CONFIG_IVML24_256 CONFIG_RPXsuper
277 CONFIG_CPCI4052 CONFIG_IVMS8 CONFIG_rsdproto
278 CONFIG_CPCIISER4 CONFIG_IVMS8_128 CONFIG_sacsng
279 CONFIG_CPU86 CONFIG_IVMS8_256 CONFIG_Sandpoint8240
280 CONFIG_CRAYL1 CONFIG_JSE CONFIG_Sandpoint8245
281 CONFIG_CSB272 CONFIG_LANTEC CONFIG_sbc8260
282 CONFIG_CU824 CONFIG_lwmon CONFIG_sbc8560
283 CONFIG_DASA_SIM CONFIG_MBX CONFIG_SM850
284 CONFIG_DB64360 CONFIG_MBX860T CONFIG_SPD823TS
285 CONFIG_DB64460 CONFIG_MHPC CONFIG_STXGP3
286 CONFIG_DU405 CONFIG_MIP405 CONFIG_SXNI855T
287 CONFIG_DUET_ADS CONFIG_MOUSSE CONFIG_TQM823L
288 CONFIG_EBONY CONFIG_MPC8260ADS CONFIG_TQM8260
289 CONFIG_ELPPC CONFIG_MPC8540ADS CONFIG_TQM850L
290 CONFIG_ELPT860 CONFIG_MPC8540EVAL CONFIG_TQM855L
291 CONFIG_ep8260 CONFIG_MPC8560ADS CONFIG_TQM860L
292 CONFIG_ERIC CONFIG_MUSENKI CONFIG_TTTech
293 CONFIG_ESTEEM192E CONFIG_MVS1 CONFIG_UTX8245
294 CONFIG_ETX094 CONFIG_NETPHONE CONFIG_V37
295 CONFIG_EVB64260 CONFIG_NETTA CONFIG_W7OLMC
296 CONFIG_FADS823 CONFIG_NETVIA CONFIG_W7OLMG
297 CONFIG_FADS850SAR CONFIG_NX823 CONFIG_WALNUT
298 CONFIG_FADS860T CONFIG_OCRTC CONFIG_ZPC1900
299 CONFIG_FLAGADM CONFIG_ORSG CONFIG_ZUMA
300 CONFIG_FPS850L CONFIG_OXC
301 CONFIG_FPS860L CONFIG_PCI405
302
wdenkc6097192002-11-03 00:24:07 +0000303 ARM based boards:
304 -----------------
305
Wolfgang Denkc570b2f2005-09-26 01:06:33 +0200306 CONFIG_ARMADILLO, CONFIG_AT91RM9200DK, CONFIG_CERF250,
Wolfgang Denkf5c254d2005-10-06 01:26:16 +0200307 CONFIG_CSB637, CONFIG_DNP1110, CONFIG_EP7312,
308 CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE, CONFIG_IMPA7,
309 CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610, CONFIG_KB9202,
310 CONFIG_LART, CONFIG_LPD7A400, CONFIG_LUBBOCK,
311 CONFIG_OSK_OMAP5912, CONFIG_OMAP2420H4, CONFIG_SHANNON,
312 CONFIG_P2_OMAP730, CONFIG_SMDK2400, CONFIG_SMDK2410,
313 CONFIG_TRAB, CONFIG_VCMA9
wdenkc6097192002-11-03 00:24:07 +0000314
wdenk507bbe32004-04-18 21:13:41 +0000315 MicroBlaze based boards:
316 ------------------------
317
318 CONFIG_SUZAKU
319
wdenk5c952cf2004-10-10 21:27:30 +0000320 Nios-2 based boards:
321 ------------------------
322
323 CONFIG_PCI5441 CONFIG_PK1C20
324
wdenkc6097192002-11-03 00:24:07 +0000325
326- CPU Module Type: (if CONFIG_COGENT is defined)
327 Define exactly one of
328 CONFIG_CMA286_60_OLD
329--- FIXME --- not tested yet:
330 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
331 CONFIG_CMA287_23, CONFIG_CMA287_50
332
333- Motherboard Type: (if CONFIG_COGENT is defined)
334 Define exactly one of
335 CONFIG_CMA101, CONFIG_CMA102
336
337- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
338 Define one or more of
339 CONFIG_CMA302
340
341- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
342 Define one or more of
343 CONFIG_LCD_HEARTBEAT - update a character position on
344 the lcd display every second with
345 a "rotator" |\-/|\-/
346
wdenk2535d602003-07-17 23:16:40 +0000347- Board flavour: (if CONFIG_MPC8260ADS is defined)
348 CONFIG_ADSTYPE
349 Possible values are:
350 CFG_8260ADS - original MPC8260ADS
wdenk180d3f72004-01-04 16:28:35 +0000351 CFG_8266ADS - MPC8266ADS
wdenk54387ac2003-10-08 22:45:44 +0000352 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
wdenk04a85b32004-04-15 18:22:41 +0000353 CFG_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000354
wdenkc6097192002-11-03 00:24:07 +0000355- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000356 Define exactly one of
357 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000358
wdenk75d1ea72004-01-31 20:06:54 +0000359- 8xx CPU Options: (if using an MPC8xx cpu)
wdenk66ca92a2004-09-28 17:59:53 +0000360 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
361 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000362 e.g. if there is no 32KHz
363 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000364 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
365 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000366
wdenk66ca92a2004-09-28 17:59:53 +0000367- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
368 CFG_8xx_CPUCLK_MIN
369 CFG_8xx_CPUCLK_MAX
370 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000371 See doc/README.MPC866
372
373 CFG_MEASURE_CPUCLK
374
wdenkba56f622004-02-06 23:19:44 +0000375 Define this to measure the actual CPU clock instead
376 of relying on the correctness of the configured
377 values. Mostly useful for board bringup to make sure
378 the PLL is locked at the intended frequency. Note
379 that this requires a (stable) reference clock (32 kHz
wdenk66ca92a2004-09-28 17:59:53 +0000380 RTC clock or CFG_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000381
wdenk5da627a2003-10-09 20:09:04 +0000382- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000383 CONFIG_CLOCKS_IN_MHZ
384
385 U-Boot stores all clock information in Hz
386 internally. For binary compatibility with older Linux
387 kernels (which expect the clocks passed in the
388 bd_info data to be in MHz) the environment variable
389 "clocks_in_mhz" can be defined so that U-Boot
390 converts clock data to MHZ before passing it to the
391 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000392 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
393 "clocks_in_mhz=1" is automatically included in the
394 default environment.
395
wdenk5da627a2003-10-09 20:09:04 +0000396 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
397
398 When transfering memsize parameter to linux, some versions
399 expect it to be in bytes, others in MB.
400 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
401
wdenk6705d812004-08-02 23:22:59 +0000402- Serial Ports:
403 CFG_PL010_SERIAL
404
405 Define this if you want support for Amba PrimeCell PL010 UARTs.
406
407 CFG_PL011_SERIAL
408
409 Define this if you want support for Amba PrimeCell PL011 UARTs.
410
411 CONFIG_PL011_CLOCK
412
413 If you have Amba PrimeCell PL011 UARTs, set this variable to
414 the clock speed of the UARTs.
415
416 CONFIG_PL01x_PORTS
417
418 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
419 define this to a list of base addresses for each (supported)
420 port. See e.g. include/configs/versatile.h
421
422
wdenkc6097192002-11-03 00:24:07 +0000423- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000424 Depending on board, define exactly one serial port
425 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
426 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
427 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000428
429 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
430 port routines must be defined elsewhere
431 (i.e. serial_init(), serial_getc(), ...)
432
433 CONFIG_CFB_CONSOLE
434 Enables console device for a color framebuffer. Needs following
435 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
436 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
437 (default big endian)
438 VIDEO_HW_RECTFILL graphic chip supports
439 rectangle fill
440 (cf. smiLynxEM)
441 VIDEO_HW_BITBLT graphic chip supports
442 bit-blit (cf. smiLynxEM)
443 VIDEO_VISIBLE_COLS visible pixel columns
444 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000445 VIDEO_VISIBLE_ROWS visible pixel rows
446 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000447 VIDEO_DATA_FORMAT graphic data format
448 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000449 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000450 VIDEO_KBD_INIT_FCT keyboard int fct
451 (i.e. i8042_kbd_init())
452 VIDEO_TSTC_FCT test char fct
453 (i.e. i8042_tstc)
454 VIDEO_GETC_FCT get char fct
455 (i.e. i8042_getc)
456 CONFIG_CONSOLE_CURSOR cursor drawing on/off
457 (requires blink timer
458 cf. i8042.c)
459 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
460 CONFIG_CONSOLE_TIME display time/date info in
461 upper right corner
462 (requires CFG_CMD_DATE)
463 CONFIG_VIDEO_LOGO display Linux logo in
464 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000465 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
466 linux_logo.h for logo.
467 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000468 CONFIG_CONSOLE_EXTRA_INFO
469 addional board info beside
470 the logo
471
wdenk43d96162003-03-06 00:02:04 +0000472 When CONFIG_CFB_CONSOLE is defined, video console is
473 default i/o. Serial console can be forced with
474 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000475
wdenkd4ca31c2004-01-02 14:00:00 +0000476 When CONFIG_SILENT_CONSOLE is defined, all console
477 messages (by U-Boot and Linux!) can be silenced with
478 the "silent" environment variable. See
479 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000480
wdenkc6097192002-11-03 00:24:07 +0000481- Console Baudrate:
482 CONFIG_BAUDRATE - in bps
483 Select one of the baudrates listed in
484 CFG_BAUDRATE_TABLE, see below.
wdenk3bbc8992003-12-07 22:27:15 +0000485 CFG_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000486
487- Interrupt driven serial port input:
488 CONFIG_SERIAL_SOFTWARE_FIFO
489
490 PPC405GP only.
491 Use an interrupt handler for receiving data on the
492 serial port. It also enables using hardware handshake
493 (RTS/CTS) and UART's built-in FIFO. Set the number of
494 bytes the interrupt driven input buffer should have.
495
wdenk109c0e32004-03-23 21:43:07 +0000496 Leave undefined to disable this feature, including
497 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000498
stroese1d49b1f2003-05-23 11:39:05 +0000499- Console UART Number:
500 CONFIG_UART1_CONSOLE
501
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200502 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000503 If defined internal UART1 (and not UART0) is used
504 as default U-Boot console.
505
wdenkc6097192002-11-03 00:24:07 +0000506- Boot Delay: CONFIG_BOOTDELAY - in seconds
507 Delay before automatically booting the default image;
508 set to -1 to disable autoboot.
509
510 See doc/README.autoboot for these options that
511 work with CONFIG_BOOTDELAY. None are required.
512 CONFIG_BOOT_RETRY_TIME
513 CONFIG_BOOT_RETRY_MIN
514 CONFIG_AUTOBOOT_KEYED
515 CONFIG_AUTOBOOT_PROMPT
516 CONFIG_AUTOBOOT_DELAY_STR
517 CONFIG_AUTOBOOT_STOP_STR
518 CONFIG_AUTOBOOT_DELAY_STR2
519 CONFIG_AUTOBOOT_STOP_STR2
520 CONFIG_ZERO_BOOTDELAY_CHECK
521 CONFIG_RESET_TO_RETRY
522
523- Autoboot Command:
524 CONFIG_BOOTCOMMAND
525 Only needed when CONFIG_BOOTDELAY is enabled;
526 define a command string that is automatically executed
527 when no character is read on the console interface
528 within "Boot Delay" after reset.
529
530 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000531 This can be used to pass arguments to the bootm
532 command. The value of CONFIG_BOOTARGS goes into the
533 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000534
535 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000536 The value of these goes into the environment as
537 "ramboot" and "nfsboot" respectively, and can be used
538 as a convenience, when switching between booting from
539 ram and nfs.
wdenkc6097192002-11-03 00:24:07 +0000540
541- Pre-Boot Commands:
542 CONFIG_PREBOOT
543
544 When this option is #defined, the existence of the
545 environment variable "preboot" will be checked
546 immediately before starting the CONFIG_BOOTDELAY
547 countdown and/or running the auto-boot command resp.
548 entering interactive mode.
549
550 This feature is especially useful when "preboot" is
551 automatically generated or modified. For an example
552 see the LWMON board specific code: here "preboot" is
553 modified when the user holds down a certain
554 combination of keys on the (special) keyboard when
555 booting the systems
556
557- Serial Download Echo Mode:
558 CONFIG_LOADS_ECHO
559 If defined to 1, all characters received during a
560 serial download (using the "loads" command) are
561 echoed back. This might be needed by some terminal
562 emulations (like "cu"), but may as well just take
563 time on others. This setting #define's the initial
564 value of the "loads_echo" environment variable.
565
566- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
567 CONFIG_KGDB_BAUDRATE
568 Select one of the baudrates listed in
569 CFG_BAUDRATE_TABLE, see below.
570
571- Monitor Functions:
572 CONFIG_COMMANDS
573 Most monitor functions can be selected (or
574 de-selected) by adjusting the definition of
575 CONFIG_COMMANDS; to select individual functions,
576 #define CONFIG_COMMANDS by "OR"ing any of the
577 following values:
578
579 #define enables commands:
580 -------------------------
581 CFG_CMD_ASKENV * ask for env variable
wdenk78137c32003-09-15 18:00:00 +0000582 CFG_CMD_AUTOSCRIPT Autoscript Support
wdenkc6097192002-11-03 00:24:07 +0000583 CFG_CMD_BDI bdinfo
wdenk6705d812004-08-02 23:22:59 +0000584 CFG_CMD_BEDBUG * Include BedBug Debugger
wdenkba56f622004-02-06 23:19:44 +0000585 CFG_CMD_BMP * BMP support
wdenk6705d812004-08-02 23:22:59 +0000586 CFG_CMD_BSP * Board specific commands
wdenkc6097192002-11-03 00:24:07 +0000587 CFG_CMD_BOOTD bootd
wdenk6705d812004-08-02 23:22:59 +0000588 CFG_CMD_CACHE * icache, dcache
wdenkc6097192002-11-03 00:24:07 +0000589 CFG_CMD_CONSOLE coninfo
590 CFG_CMD_DATE * support for RTC, date/time...
wdenk6705d812004-08-02 23:22:59 +0000591 CFG_CMD_DHCP * DHCP support
wdenkba56f622004-02-06 23:19:44 +0000592 CFG_CMD_DIAG * Diagnostics
593 CFG_CMD_DOC * Disk-On-Chip Support
wdenk6705d812004-08-02 23:22:59 +0000594 CFG_CMD_DTT * Digital Therm and Thermostat
wdenkc6097192002-11-03 00:24:07 +0000595 CFG_CMD_ECHO * echo arguments
596 CFG_CMD_EEPROM * EEPROM read/write support
wdenk6705d812004-08-02 23:22:59 +0000597 CFG_CMD_ELF * bootelf, bootvx
wdenkc6097192002-11-03 00:24:07 +0000598 CFG_CMD_ENV saveenv
599 CFG_CMD_FDC * Floppy Disk Support
wdenk6705d812004-08-02 23:22:59 +0000600 CFG_CMD_FAT * FAT partition support
wdenk2262cfe2002-11-18 00:14:45 +0000601 CFG_CMD_FDOS * Dos diskette Support
wdenkc6097192002-11-03 00:24:07 +0000602 CFG_CMD_FLASH flinfo, erase, protect
603 CFG_CMD_FPGA FPGA device initialization support
wdenkba56f622004-02-06 23:19:44 +0000604 CFG_CMD_HWFLOW * RTS/CTS hw flow control
wdenkc6097192002-11-03 00:24:07 +0000605 CFG_CMD_I2C * I2C serial bus support
606 CFG_CMD_IDE * IDE harddisk support
607 CFG_CMD_IMI iminfo
wdenkba56f622004-02-06 23:19:44 +0000608 CFG_CMD_IMLS List all found images
wdenkc6097192002-11-03 00:24:07 +0000609 CFG_CMD_IMMAP * IMMR dump support
610 CFG_CMD_IRQ * irqinfo
wdenk6705d812004-08-02 23:22:59 +0000611 CFG_CMD_ITEST Integer/string test of 2 values
wdenkba56f622004-02-06 23:19:44 +0000612 CFG_CMD_JFFS2 * JFFS2 Support
wdenkc6097192002-11-03 00:24:07 +0000613 CFG_CMD_KGDB * kgdb
614 CFG_CMD_LOADB loadb
615 CFG_CMD_LOADS loads
616 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
wdenk56523f12004-07-11 17:40:54 +0000617 loop, loopw, mtest
wdenkba56f622004-02-06 23:19:44 +0000618 CFG_CMD_MISC Misc functions like sleep etc
wdenk6705d812004-08-02 23:22:59 +0000619 CFG_CMD_MMC * MMC memory mapped support
620 CFG_CMD_MII * MII utility commands
wdenkba56f622004-02-06 23:19:44 +0000621 CFG_CMD_NAND * NAND support
wdenkc6097192002-11-03 00:24:07 +0000622 CFG_CMD_NET bootp, tftpboot, rarpboot
623 CFG_CMD_PCI * pciinfo
624 CFG_CMD_PCMCIA * PCMCIA support
wdenkba56f622004-02-06 23:19:44 +0000625 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host
626 CFG_CMD_PORTIO * Port I/O
wdenkc6097192002-11-03 00:24:07 +0000627 CFG_CMD_REGINFO * Register dump
628 CFG_CMD_RUN run command in env variable
wdenk6705d812004-08-02 23:22:59 +0000629 CFG_CMD_SAVES * save S record dump
wdenkc6097192002-11-03 00:24:07 +0000630 CFG_CMD_SCSI * SCSI Support
wdenkba56f622004-02-06 23:19:44 +0000631 CFG_CMD_SDRAM * print SDRAM configuration information
wdenkb1bf6f22005-04-03 14:52:59 +0000632 (requires CFG_CMD_I2C)
wdenkc6097192002-11-03 00:24:07 +0000633 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
634 CFG_CMD_SPI * SPI serial bus support
635 CFG_CMD_USB * USB support
wdenkba56f622004-02-06 23:19:44 +0000636 CFG_CMD_VFD * VFD support (TRAB)
wdenkc6097192002-11-03 00:24:07 +0000637 CFG_CMD_BSP * Board SPecific functions
wdenka3d991b2004-04-15 21:48:45 +0000638 CFG_CMD_CDP * Cisco Discover Protocol support
wdenkc6097192002-11-03 00:24:07 +0000639 -----------------------------------------------
640 CFG_CMD_ALL all
641
wdenk81050922004-07-11 20:04:51 +0000642 CONFIG_CMD_DFL Default configuration; at the moment
wdenkc6097192002-11-03 00:24:07 +0000643 this is includes all commands, except
644 the ones marked with "*" in the list
645 above.
646
647 If you don't define CONFIG_COMMANDS it defaults to
wdenk81050922004-07-11 20:04:51 +0000648 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
wdenkc6097192002-11-03 00:24:07 +0000649 override the default settings in the respective
650 include file.
651
652 EXAMPLE: If you want all functions except of network
653 support you can write:
654
655 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
656
657
658 Note: Don't enable the "icache" and "dcache" commands
wdenk43d96162003-03-06 00:02:04 +0000659 (configuration option CFG_CMD_CACHE) unless you know
660 what you (and your U-Boot users) are doing. Data
661 cache cannot be enabled on systems like the 8xx or
662 8260 (where accesses to the IMMR region must be
663 uncached), and it cannot be disabled on all other
664 systems where we (mis-) use the data cache to hold an
665 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000666
667
668 XXX - this list needs to get updated!
669
670- Watchdog:
671 CONFIG_WATCHDOG
672 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000673 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000674 code for a watchdog. For the 8xx and 8260 CPUs, the
675 SIU Watchdog feature is enabled in the SYPCR
676 register.
677
stroesec1551ea2003-04-04 15:53:41 +0000678- U-Boot Version:
679 CONFIG_VERSION_VARIABLE
680 If this variable is defined, an environment variable
681 named "ver" is created by U-Boot showing the U-Boot
682 version as printed by the "version" command.
683 This variable is readonly.
684
wdenkc6097192002-11-03 00:24:07 +0000685- Real-Time Clock:
686
687 When CFG_CMD_DATE is selected, the type of the RTC
688 has to be selected, too. Define exactly one of the
689 following options:
690
691 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
692 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
693 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000694 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000695 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000696 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000697 CONFIG_RTC_DS164x - use Dallas DS164x RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000698 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
wdenkc6097192002-11-03 00:24:07 +0000699
wdenkb37c7e52003-06-30 16:24:52 +0000700 Note that if the RTC uses I2C, then the I2C interface
701 must also be configured. See I2C Support, below.
702
wdenkc6097192002-11-03 00:24:07 +0000703- Timestamp Support:
704
wdenk43d96162003-03-06 00:02:04 +0000705 When CONFIG_TIMESTAMP is selected, the timestamp
706 (date and time) of an image is printed by image
707 commands like bootm or iminfo. This option is
708 automatically enabled when you select CFG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000709
710- Partition Support:
711 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
712 and/or CONFIG_ISO_PARTITION
713
714 If IDE or SCSI support is enabled (CFG_CMD_IDE or
715 CFG_CMD_SCSI) you must configure support for at least
716 one partition type as well.
717
718- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000719 CONFIG_IDE_RESET_ROUTINE - this is defined in several
720 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000721
wdenk4d13cba2004-03-14 14:09:05 +0000722 CONFIG_IDE_RESET - is this is defined, IDE Reset will
723 be performed by calling the function
724 ide_set_reset(int reset)
725 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000726
727- ATAPI Support:
728 CONFIG_ATAPI
729
730 Set this to enable ATAPI support.
731
wdenkc40b2952004-03-13 23:29:43 +0000732- LBA48 Support
733 CONFIG_LBA48
734
735 Set this to enable support for disks larger than 137GB
736 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
737 Whithout these , LBA48 support uses 32bit variables and will 'only'
738 support disks up to 2.1TB.
739
740 CFG_64BIT_LBA:
741 When enabled, makes the IDE subsystem use 64bit sector addresses.
742 Default is 32bit.
743
wdenkc6097192002-11-03 00:24:07 +0000744- SCSI Support:
745 At the moment only there is only support for the
746 SYM53C8XX SCSI controller; define
747 CONFIG_SCSI_SYM53C8XX to enable it.
748
749 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
750 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
751 CFG_SCSI_MAX_LUN] can be adjusted to define the
752 maximum numbers of LUNs, SCSI ID's and target
753 devices.
754 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
755
756- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000757 CONFIG_E1000
758 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000759
wdenkc6097192002-11-03 00:24:07 +0000760 CONFIG_EEPRO100
761 Support for Intel 82557/82559/82559ER chips.
762 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
763 write routine for first time initialisation.
764
765 CONFIG_TULIP
766 Support for Digital 2114x chips.
767 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
768 modem chip initialisation (KS8761/QS6611).
769
770 CONFIG_NATSEMI
771 Support for National dp83815 chips.
772
773 CONFIG_NS8382X
774 Support for National dp8382[01] gigabit chips.
775
wdenk45219c42003-05-12 21:50:16 +0000776- NETWORK Support (other):
777
778 CONFIG_DRIVER_LAN91C96
779 Support for SMSC's LAN91C96 chips.
780
781 CONFIG_LAN91C96_BASE
782 Define this to hold the physical address
783 of the LAN91C96's I/O space
784
785 CONFIG_LAN91C96_USE_32_BIT
786 Define this to enable 32 bit addressing
787
wdenkf39748a2004-06-09 13:37:52 +0000788 CONFIG_DRIVER_SMC91111
789 Support for SMSC's LAN91C111 chip
790
791 CONFIG_SMC91111_BASE
792 Define this to hold the physical address
793 of the device (I/O space)
794
795 CONFIG_SMC_USE_32_BIT
796 Define this if data bus is 32 bits
797
798 CONFIG_SMC_USE_IOFUNCS
799 Define this to use i/o functions instead of macros
800 (some hardware wont work with macros)
801
wdenkc6097192002-11-03 00:24:07 +0000802- USB Support:
803 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000804 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000805 CONFIG_USB_UHCI to enable it.
806 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000807 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000808 storage devices.
809 Note:
810 Supported are USB Keyboards and USB Floppy drives
811 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000812 MPC5200 USB requires additional defines:
813 CONFIG_USB_CLOCK
814 for 528 MHz Clock: 0x0001bbbb
815 CONFIG_USB_CONFIG
816 for differential drivers: 0x00001000
817 for single ended drivers: 0x00005000
818
wdenkc6097192002-11-03 00:24:07 +0000819
wdenk71f95112003-06-15 22:40:42 +0000820- MMC Support:
wdenk8bde7f72003-06-27 21:31:46 +0000821 The MMC controller on the Intel PXA is supported. To
822 enable this define CONFIG_MMC. The MMC can be
823 accessed from the boot prompt by mapping the device
wdenk71f95112003-06-15 22:40:42 +0000824 to physical memory similar to flash. Command line is
825 enabled with CFG_CMD_MMC. The MMC driver also works with
wdenk8bde7f72003-06-27 21:31:46 +0000826 the FAT fs. This is enabled with CFG_CMD_FAT.
wdenk71f95112003-06-15 22:40:42 +0000827
wdenk6705d812004-08-02 23:22:59 +0000828- Journaling Flash filesystem support:
829 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
830 CONFIG_JFFS2_NAND_DEV
831 Define these for a default partition on a NAND device
832
833 CFG_JFFS2_FIRST_SECTOR,
834 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
835 Define these for a default partition on a NOR device
836
837 CFG_JFFS_CUSTOM_PART
838 Define this to create an own partition. You have to provide a
839 function struct part_info* jffs2_part_info(int part_num)
840
841 If you define only one JFFS2 partition you may also want to
wdenkefe2a4d2004-12-16 21:44:03 +0000842 #define CFG_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +0000843 to disable the command chpart. This is the default when you
844 have not defined a custom partition
845
wdenkc6097192002-11-03 00:24:07 +0000846- Keyboard Support:
847 CONFIG_ISA_KEYBOARD
848
849 Define this to enable standard (PC-Style) keyboard
850 support
851
852 CONFIG_I8042_KBD
853 Standard PC keyboard driver with US (is default) and
854 GERMAN key layout (switch via environment 'keymap=de') support.
855 Export function i8042_kbd_init, i8042_tstc and i8042_getc
856 for cfb_console. Supports cursor blinking.
857
858- Video support:
859 CONFIG_VIDEO
860
861 Define this to enable video support (for output to
862 video).
863
864 CONFIG_VIDEO_CT69000
865
866 Enable Chips & Technologies 69000 Video chip
867
868 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +0000869 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +0000870 video output is selected via environment 'videoout'
871 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
872 assumed.
wdenkc6097192002-11-03 00:24:07 +0000873
wdenkb79a11c2004-03-25 15:14:43 +0000874 For the CT69000 and SMI_LYNXEM drivers, videomode is
875 selected via environment 'videomode'. Two diferent ways
wdenkeeb1b772004-03-23 22:53:55 +0000876 are possible:
877 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +0000878 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +0000879
880 Colors 640x480 800x600 1024x768 1152x864 1280x1024
881 -------------+---------------------------------------------
882 8 bits | 0x301* 0x303 0x305 0x161 0x307
883 15 bits | 0x310 0x313 0x316 0x162 0x319
884 16 bits | 0x311 0x314 0x317 0x163 0x31A
885 24 bits | 0x312 0x315 0x318 ? 0x31B
886 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +0000887 (i.e. setenv videomode 317; saveenv; reset;)
888
wdenkb79a11c2004-03-25 15:14:43 +0000889 - "videomode=bootargs" all the video parameters are parsed
wdenkeeb1b772004-03-23 22:53:55 +0000890 from the bootargs. (See drivers/videomodes.c)
891
892
stroesec1551ea2003-04-04 15:53:41 +0000893 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +0000894 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +0000895 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
896 or CONFIG_VIDEO_SED13806_16BPP
897
wdenk682011f2003-06-03 23:54:09 +0000898- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +0000899 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +0000900
wdenk8bde7f72003-06-27 21:31:46 +0000901 Define this to enable a custom keyboard support.
902 This simply calls drv_keyboard_init() which must be
903 defined in your board-specific files.
904 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +0000905
wdenkc6097192002-11-03 00:24:07 +0000906- LCD Support: CONFIG_LCD
907
908 Define this to enable LCD support (for output to LCD
909 display); also select one of the supported displays
910 by defining one of these:
911
wdenkfd3103b2003-11-25 16:55:19 +0000912 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +0000913
wdenkfd3103b2003-11-25 16:55:19 +0000914 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +0000915
wdenkfd3103b2003-11-25 16:55:19 +0000916 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +0000917
wdenkfd3103b2003-11-25 16:55:19 +0000918 NEC NL6448BC20-08. 6.5", 640x480.
919 Active, color, single scan.
920
921 CONFIG_NEC_NL6448BC33_54
922
923 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +0000924 Active, color, single scan.
925
926 CONFIG_SHARP_16x9
927
928 Sharp 320x240. Active, color, single scan.
929 It isn't 16x9, and I am not sure what it is.
930
931 CONFIG_SHARP_LQ64D341
932
933 Sharp LQ64D341 display, 640x480.
934 Active, color, single scan.
935
936 CONFIG_HLD1045
937
938 HLD1045 display, 640x480.
939 Active, color, single scan.
940
941 CONFIG_OPTREX_BW
942
943 Optrex CBL50840-2 NF-FW 99 22 M5
944 or
945 Hitachi LMG6912RPFC-00T
946 or
947 Hitachi SP14Q002
948
949 320x240. Black & white.
950
951 Normally display is black on white background; define
952 CFG_WHITE_ON_BLACK to get it inverted.
953
wdenk7152b1d2003-09-05 23:19:14 +0000954- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +0000955
wdenk8bde7f72003-06-27 21:31:46 +0000956 If this option is set, the environment is checked for
957 a variable "splashimage". If found, the usual display
958 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +0000959 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +0000960 specified in "splashimage" is loaded instead. The
961 console is redirected to the "nulldev", too. This
962 allows for a "silent" boot where a splash screen is
963 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +0000964
Stefan Roese98f4a3d2005-09-22 09:04:17 +0200965- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
966
967 If this option is set, additionally to standard BMP
968 images, gzipped BMP images can be displayed via the
969 splashscreen support or the bmp command.
970
wdenkc29fdfc2003-08-29 20:57:53 +0000971- Compression support:
972 CONFIG_BZIP2
973
974 If this option is set, support for bzip2 compressed
975 images is included. If not, only uncompressed and gzip
976 compressed images are supported.
977
wdenk42d1f032003-10-15 23:53:47 +0000978 NOTE: the bzip2 algorithm requires a lot of RAM, so
979 the malloc area (as defined by CFG_MALLOC_LEN) should
980 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +0000981
wdenk17ea1172004-06-06 21:51:03 +0000982- MII/PHY support:
983 CONFIG_PHY_ADDR
984
985 The address of PHY on MII bus.
986
987 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
988
989 The clock frequency of the MII bus
990
991 CONFIG_PHY_GIGE
992
993 If this option is set, support for speed/duplex
994 detection of Gigabit PHY is included.
995
996 CONFIG_PHY_RESET_DELAY
997
998 Some PHY like Intel LXT971A need extra delay after
999 reset before any MII register access is possible.
1000 For such PHY, set this option to the usec delay
1001 required. (minimum 300usec for LXT971A)
1002
1003 CONFIG_PHY_CMD_DELAY (ppc4xx)
1004
1005 Some PHY like Intel LXT971A need extra delay after
1006 command issued before MII status register can be read
1007
wdenkc6097192002-11-03 00:24:07 +00001008- Ethernet address:
1009 CONFIG_ETHADDR
1010 CONFIG_ETH2ADDR
1011 CONFIG_ETH3ADDR
1012
1013 Define a default value for ethernet address to use
1014 for the respective ethernet interface, in case this
1015 is not determined automatically.
1016
1017- IP address:
1018 CONFIG_IPADDR
1019
1020 Define a default value for the IP address to use for
1021 the default ethernet interface, in case this is not
1022 determined through e.g. bootp.
1023
1024- Server IP address:
1025 CONFIG_SERVERIP
1026
1027 Defines a default value for theIP address of a TFTP
1028 server to contact when using the "tftboot" command.
1029
1030- BOOTP Recovery Mode:
1031 CONFIG_BOOTP_RANDOM_DELAY
1032
1033 If you have many targets in a network that try to
1034 boot using BOOTP, you may want to avoid that all
1035 systems send out BOOTP requests at precisely the same
1036 moment (which would happen for instance at recovery
1037 from a power failure, when all systems will try to
1038 boot, thus flooding the BOOTP server. Defining
1039 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1040 inserted before sending out BOOTP requests. The
1041 following delays are insterted then:
1042
1043 1st BOOTP request: delay 0 ... 1 sec
1044 2nd BOOTP request: delay 0 ... 2 sec
1045 3rd BOOTP request: delay 0 ... 4 sec
1046 4th and following
1047 BOOTP requests: delay 0 ... 8 sec
1048
stroesefe389a82003-08-28 14:17:32 +00001049- DHCP Advanced Options:
1050 CONFIG_BOOTP_MASK
1051
1052 You can fine tune the DHCP functionality by adding
1053 these flags to the CONFIG_BOOTP_MASK define:
1054
1055 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1056 serverip from a DHCP server, it is possible that more
1057 than one DNS serverip is offered to the client.
1058 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1059 serverip will be stored in the additional environment
1060 variable "dnsip2". The first DNS serverip is always
1061 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1062 is added to the CONFIG_BOOTP_MASK.
1063
1064 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1065 to do a dynamic update of a DNS server. To do this, they
1066 need the hostname of the DHCP requester.
1067 If CONFIG_BOOP_SEND_HOSTNAME is added to the
1068 CONFIG_BOOTP_MASK, the content of the "hostname"
1069 environment variable is passed as option 12 to
1070 the DHCP server.
1071
wdenka3d991b2004-04-15 21:48:45 +00001072 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001073 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001074
1075 The device id used in CDP trigger frames.
1076
1077 CONFIG_CDP_DEVICE_ID_PREFIX
1078
1079 A two character string which is prefixed to the MAC address
1080 of the device.
1081
1082 CONFIG_CDP_PORT_ID
1083
1084 A printf format string which contains the ascii name of
1085 the port. Normally is set to "eth%d" which sets
1086 eth0 for the first ethernet, eth1 for the second etc.
1087
1088 CONFIG_CDP_CAPABILITIES
1089
1090 A 32bit integer which indicates the device capabilities;
1091 0x00000010 for a normal host which does not forwards.
1092
1093 CONFIG_CDP_VERSION
1094
1095 An ascii string containing the version of the software.
1096
1097 CONFIG_CDP_PLATFORM
1098
1099 An ascii string containing the name of the platform.
1100
1101 CONFIG_CDP_TRIGGER
1102
1103 A 32bit integer sent on the trigger.
1104
1105 CONFIG_CDP_POWER_CONSUMPTION
1106
1107 A 16bit integer containing the power consumption of the
1108 device in .1 of milliwatts.
1109
1110 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1111
1112 A byte containing the id of the VLAN.
1113
wdenkc6097192002-11-03 00:24:07 +00001114- Status LED: CONFIG_STATUS_LED
1115
1116 Several configurations allow to display the current
1117 status using a LED. For instance, the LED will blink
1118 fast while running U-Boot code, stop blinking as
1119 soon as a reply to a BOOTP request was received, and
1120 start blinking slow once the Linux kernel is running
1121 (supported by a status LED driver in the Linux
1122 kernel). Defining CONFIG_STATUS_LED enables this
1123 feature in U-Boot.
1124
1125- CAN Support: CONFIG_CAN_DRIVER
1126
1127 Defining CONFIG_CAN_DRIVER enables CAN driver support
1128 on those systems that support this (optional)
1129 feature, like the TQM8xxL modules.
1130
1131- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1132
wdenkb37c7e52003-06-30 16:24:52 +00001133 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001134 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1135 include the appropriate I2C driver for the selected cpu.
wdenkc6097192002-11-03 00:24:07 +00001136
wdenk945af8d2003-07-16 21:53:01 +00001137 This will allow you to use i2c commands at the u-boot
1138 command line (as long as you set CFG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001139 CONFIG_COMMANDS) and communicate with i2c based realtime
1140 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001141 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001142
wdenkba56f622004-02-06 23:19:44 +00001143 CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
wdenkc6097192002-11-03 00:24:07 +00001144
wdenk945af8d2003-07-16 21:53:01 +00001145 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001146 bit-banging) driver instead of CPM or similar hardware
1147 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001148
wdenk945af8d2003-07-16 21:53:01 +00001149 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001150 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001151
wdenkb37c7e52003-06-30 16:24:52 +00001152 In both cases you will need to define CFG_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001153 to be the frequency (in Hz) at which you wish your i2c bus
1154 to run and CFG_I2C_SLAVE to be the address of this node (ie
1155 the cpu's i2c node address).
1156
wdenkb37c7e52003-06-30 16:24:52 +00001157 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1158 sets the cpu up as a master node and so its address should
1159 therefore be cleared to 0 (See, eg, MPC823e User's Manual
wdenk945af8d2003-07-16 21:53:01 +00001160 p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001161
wdenk945af8d2003-07-16 21:53:01 +00001162 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001163
1164 If you use the software i2c interface (CONFIG_SOFT_I2C)
1165 then the following macros need to be defined (examples are
1166 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001167
1168 I2C_INIT
1169
wdenkb37c7e52003-06-30 16:24:52 +00001170 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001171 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001172
wdenkba56f622004-02-06 23:19:44 +00001173 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001174
wdenkc6097192002-11-03 00:24:07 +00001175 I2C_PORT
1176
wdenk43d96162003-03-06 00:02:04 +00001177 (Only for MPC8260 CPU). The I/O port to use (the code
1178 assumes both bits are on the same port). Valid values
1179 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001180
1181 I2C_ACTIVE
1182
1183 The code necessary to make the I2C data line active
1184 (driven). If the data line is open collector, this
1185 define can be null.
1186
wdenkb37c7e52003-06-30 16:24:52 +00001187 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1188
wdenkc6097192002-11-03 00:24:07 +00001189 I2C_TRISTATE
1190
1191 The code necessary to make the I2C data line tri-stated
1192 (inactive). If the data line is open collector, this
1193 define can be null.
1194
wdenkb37c7e52003-06-30 16:24:52 +00001195 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1196
wdenkc6097192002-11-03 00:24:07 +00001197 I2C_READ
1198
1199 Code that returns TRUE if the I2C data line is high,
1200 FALSE if it is low.
1201
wdenkb37c7e52003-06-30 16:24:52 +00001202 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1203
wdenkc6097192002-11-03 00:24:07 +00001204 I2C_SDA(bit)
1205
1206 If <bit> is TRUE, sets the I2C data line high. If it
1207 is FALSE, it clears it (low).
1208
wdenkb37c7e52003-06-30 16:24:52 +00001209 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001210 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001211 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001212
wdenkc6097192002-11-03 00:24:07 +00001213 I2C_SCL(bit)
1214
1215 If <bit> is TRUE, sets the I2C clock line high. If it
1216 is FALSE, it clears it (low).
1217
wdenkb37c7e52003-06-30 16:24:52 +00001218 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001219 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001220 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001221
wdenkc6097192002-11-03 00:24:07 +00001222 I2C_DELAY
1223
1224 This delay is invoked four times per clock cycle so this
1225 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001226 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001227 like:
1228
wdenkb37c7e52003-06-30 16:24:52 +00001229 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001230
wdenk47cd00f2003-03-06 13:39:27 +00001231 CFG_I2C_INIT_BOARD
1232
wdenk8bde7f72003-06-27 21:31:46 +00001233 When a board is reset during an i2c bus transfer
1234 chips might think that the current transfer is still
1235 in progress. On some boards it is possible to access
1236 the i2c SCLK line directly, either by using the
1237 processor pin as a GPIO or by having a second pin
1238 connected to the bus. If this option is defined a
1239 custom i2c_init_board() routine in boards/xxx/board.c
1240 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001241
wdenk17ea1172004-06-06 21:51:03 +00001242 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1243
1244 This option enables configuration of bi_iic_fast[] flags
1245 in u-boot bd_info structure based on u-boot environment
1246 variable "i2cfast". (see also i2cfast)
1247
wdenkc6097192002-11-03 00:24:07 +00001248- SPI Support: CONFIG_SPI
1249
1250 Enables SPI driver (so far only tested with
1251 SPI EEPROM, also an instance works with Crystal A/D and
1252 D/As on the SACSng board)
1253
1254 CONFIG_SPI_X
1255
1256 Enables extended (16-bit) SPI EEPROM addressing.
1257 (symmetrical to CONFIG_I2C_X)
1258
1259 CONFIG_SOFT_SPI
1260
wdenk43d96162003-03-06 00:02:04 +00001261 Enables a software (bit-bang) SPI driver rather than
1262 using hardware support. This is a general purpose
1263 driver that only requires three general I/O port pins
1264 (two outputs, one input) to function. If this is
1265 defined, the board configuration must define several
1266 SPI configuration items (port pins to use, etc). For
1267 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001268
1269- FPGA Support: CONFIG_FPGA_COUNT
1270
wdenk43d96162003-03-06 00:02:04 +00001271 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001272
wdenk43d96162003-03-06 00:02:04 +00001273 CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00001274
wdenk8bde7f72003-06-27 21:31:46 +00001275 Used to specify the types of FPGA devices. For example,
1276 #define CONFIG_FPGA CFG_XILINX_VIRTEX2
wdenkc6097192002-11-03 00:24:07 +00001277
wdenk8bde7f72003-06-27 21:31:46 +00001278 CFG_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001279
wdenk8bde7f72003-06-27 21:31:46 +00001280 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001281
1282 CFG_FPGA_CHECK_BUSY
1283
wdenk43d96162003-03-06 00:02:04 +00001284 Enable checks on FPGA configuration interface busy
1285 status by the configuration function. This option
1286 will require a board or device specific function to
1287 be written.
wdenkc6097192002-11-03 00:24:07 +00001288
1289 CONFIG_FPGA_DELAY
1290
1291 If defined, a function that provides delays in the FPGA
1292 configuration driver.
1293
1294 CFG_FPGA_CHECK_CTRLC
1295 Allow Control-C to interrupt FPGA configuration
1296
1297 CFG_FPGA_CHECK_ERROR
1298
wdenk43d96162003-03-06 00:02:04 +00001299 Check for configuration errors during FPGA bitfile
1300 loading. For example, abort during Virtex II
1301 configuration if the INIT_B line goes low (which
1302 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001303
1304 CFG_FPGA_WAIT_INIT
1305
wdenk43d96162003-03-06 00:02:04 +00001306 Maximum time to wait for the INIT_B line to deassert
1307 after PROB_B has been deasserted during a Virtex II
1308 FPGA configuration sequence. The default time is 500
1309 mS.
wdenkc6097192002-11-03 00:24:07 +00001310
1311 CFG_FPGA_WAIT_BUSY
1312
wdenk43d96162003-03-06 00:02:04 +00001313 Maximum time to wait for BUSY to deassert during
1314 Virtex II FPGA configuration. The default is 5 mS.
wdenkc6097192002-11-03 00:24:07 +00001315
1316 CFG_FPGA_WAIT_CONFIG
1317
wdenk43d96162003-03-06 00:02:04 +00001318 Time to wait after FPGA configuration. The default is
1319 200 mS.
wdenkc6097192002-11-03 00:24:07 +00001320
1321- Configuration Management:
1322 CONFIG_IDENT_STRING
1323
wdenk43d96162003-03-06 00:02:04 +00001324 If defined, this string will be added to the U-Boot
1325 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001326
1327- Vendor Parameter Protection:
1328
wdenk43d96162003-03-06 00:02:04 +00001329 U-Boot considers the values of the environment
1330 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001331 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001332 are set once by the board vendor / manufacturer, and
1333 protects these variables from casual modification by
1334 the user. Once set, these variables are read-only,
1335 and write or delete attempts are rejected. You can
1336 change this behviour:
wdenkc6097192002-11-03 00:24:07 +00001337
1338 If CONFIG_ENV_OVERWRITE is #defined in your config
1339 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001340 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001341 these parameters.
1342
1343 Alternatively, if you #define _both_ CONFIG_ETHADDR
1344 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1345 ethernet address is installed in the environment,
1346 which can be changed exactly ONCE by the user. [The
1347 serial# is unaffected by this, i. e. it remains
1348 read-only.]
1349
1350- Protected RAM:
1351 CONFIG_PRAM
1352
1353 Define this variable to enable the reservation of
1354 "protected RAM", i. e. RAM which is not overwritten
1355 by U-Boot. Define CONFIG_PRAM to hold the number of
1356 kB you want to reserve for pRAM. You can overwrite
1357 this default value by defining an environment
1358 variable "pram" to the number of kB you want to
1359 reserve. Note that the board info structure will
1360 still show the full amount of RAM. If pRAM is
1361 reserved, a new environment variable "mem" will
1362 automatically be defined to hold the amount of
1363 remaining RAM in a form that can be passed as boot
1364 argument to Linux, for instance like that:
1365
1366 setenv bootargs ... mem=\$(mem)
1367 saveenv
1368
1369 This way you can tell Linux not to use this memory,
1370 either, which results in a memory region that will
1371 not be affected by reboots.
1372
1373 *WARNING* If your board configuration uses automatic
1374 detection of the RAM size, you must make sure that
1375 this memory test is non-destructive. So far, the
1376 following board configurations are known to be
1377 "pRAM-clean":
1378
1379 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1380 HERMES, IP860, RPXlite, LWMON, LANTEC,
1381 PCU_E, FLAGADM, TQM8260
1382
1383- Error Recovery:
1384 CONFIG_PANIC_HANG
1385
1386 Define this variable to stop the system in case of a
1387 fatal error, so that you have to reset it manually.
1388 This is probably NOT a good idea for an embedded
1389 system where you want to system to reboot
1390 automatically as fast as possible, but it may be
1391 useful during development since you can try to debug
1392 the conditions that lead to the situation.
1393
1394 CONFIG_NET_RETRY_COUNT
1395
wdenk43d96162003-03-06 00:02:04 +00001396 This variable defines the number of retries for
1397 network operations like ARP, RARP, TFTP, or BOOTP
1398 before giving up the operation. If not defined, a
1399 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001400
1401- Command Interpreter:
wdenk04a85b32004-04-15 18:22:41 +00001402 CFG_AUTO_COMPLETE
1403
1404 Enable auto completion of commands using TAB.
1405
wdenkc6097192002-11-03 00:24:07 +00001406 CFG_HUSH_PARSER
1407
1408 Define this variable to enable the "hush" shell (from
1409 Busybox) as command line interpreter, thus enabling
1410 powerful command line syntax like
1411 if...then...else...fi conditionals or `&&' and '||'
1412 constructs ("shell scripts").
1413
1414 If undefined, you get the old, much simpler behaviour
1415 with a somewhat smaller memory footprint.
1416
1417
1418 CFG_PROMPT_HUSH_PS2
1419
1420 This defines the secondary prompt string, which is
1421 printed when the command interpreter needs more input
1422 to complete a command. Usually "> ".
1423
1424 Note:
1425
wdenk8bde7f72003-06-27 21:31:46 +00001426 In the current implementation, the local variables
1427 space and global environment variables space are
1428 separated. Local variables are those you define by
1429 simply typing `name=value'. To access a local
1430 variable later on, you have write `$name' or
1431 `${name}'; to execute the contents of a variable
1432 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001433
wdenk43d96162003-03-06 00:02:04 +00001434 Global environment variables are those you use
1435 setenv/printenv to work with. To run a command stored
1436 in such a variable, you need to use the run command,
1437 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001438
1439 To store commands and special characters in a
1440 variable, please use double quotation marks
1441 surrounding the whole text of the variable, instead
1442 of the backslashes before semicolons and special
1443 symbols.
1444
wdenka8c7c702003-12-06 19:49:23 +00001445- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001446 CONFIG_EXTRA_ENV_SETTINGS
1447
wdenk43d96162003-03-06 00:02:04 +00001448 Define this to contain any number of null terminated
1449 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001450 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001451
wdenk43d96162003-03-06 00:02:04 +00001452 For example, place something like this in your
1453 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001454
1455 #define CONFIG_EXTRA_ENV_SETTINGS \
1456 "myvar1=value1\0" \
1457 "myvar2=value2\0"
1458
wdenk43d96162003-03-06 00:02:04 +00001459 Warning: This method is based on knowledge about the
1460 internal format how the environment is stored by the
1461 U-Boot code. This is NOT an official, exported
1462 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001463 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001464 You better know what you are doing here.
1465
wdenk43d96162003-03-06 00:02:04 +00001466 Note: overly (ab)use of the default environment is
1467 discouraged. Make sure to check other ways to preset
1468 the environment like the autoscript function or the
1469 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001470
wdenka8c7c702003-12-06 19:49:23 +00001471- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001472 CONFIG_HAS_DATAFLASH
1473
wdenk8bde7f72003-06-27 21:31:46 +00001474 Defining this option enables DataFlash features and
1475 allows to read/write in Dataflash via the standard
1476 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001477
wdenk3f85ce22004-02-23 16:11:30 +00001478- SystemACE Support:
1479 CONFIG_SYSTEMACE
1480
1481 Adding this option adds support for Xilinx SystemACE
1482 chips attached via some sort of local bus. The address
1483 of the chip must alsh be defined in the
1484 CFG_SYSTEMACE_BASE macro. For example:
1485
1486 #define CONFIG_SYSTEMACE
1487 #define CFG_SYSTEMACE_BASE 0xf0000000
1488
1489 When SystemACE support is added, the "ace" device type
1490 becomes available to the fat commands, i.e. fatls.
1491
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001492- TFTP Fixed UDP Port:
1493 CONFIG_TFTP_PORT
1494
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001495 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001496 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001497 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001498 number generator is used.
1499
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001500 Also, the environment variable tftpdstp is used to supply
1501 the TFTP UDP destination port value. If tftpdstp isn't
1502 defined, the normal port 69 is used.
1503
1504 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001505 blindly start the TFTP transfer using the pre-configured
1506 target IP address and UDP port. This has the effect of
1507 "punching through" the (Windows XP) firewall, allowing
1508 the remainder of the TFTP transfer to proceed normally.
1509 A better solution is to properly configure the firewall,
1510 but sometimes that is not allowed.
1511
wdenka8c7c702003-12-06 19:49:23 +00001512- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001513 CONFIG_SHOW_BOOT_PROGRESS
1514
wdenk43d96162003-03-06 00:02:04 +00001515 Defining this option allows to add some board-
1516 specific code (calling a user-provided function
1517 "show_boot_progress(int)") that enables you to show
1518 the system's boot progress on some display (for
1519 example, some LED's) on your board. At the moment,
1520 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001521
1522 Arg Where When
1523 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001524 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001525 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001526 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001527 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001528 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001529 4 common/cmd_bootm.c Image data has correct checksum
1530 -4 common/cmd_bootm.c Image is for unsupported architecture
1531 5 common/cmd_bootm.c Architecture check OK
1532 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1533 6 common/cmd_bootm.c Image Type check OK
1534 -6 common/cmd_bootm.c gunzip uncompression error
1535 -7 common/cmd_bootm.c Unimplemented compression type
1536 7 common/cmd_bootm.c Uncompression OK
1537 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone)
1538 8 common/cmd_bootm.c Image Type check OK
1539 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1540 9 common/cmd_bootm.c Start initial ramdisk verification
wdenkba56f622004-02-06 23:19:44 +00001541 -10 common/cmd_bootm.c Ramdisk header has bad magic number
1542 -11 common/cmd_bootm.c Ramdisk header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001543 10 common/cmd_bootm.c Ramdisk header is OK
wdenkba56f622004-02-06 23:19:44 +00001544 -12 common/cmd_bootm.c Ramdisk data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001545 11 common/cmd_bootm.c Ramdisk data has correct checksum
1546 12 common/cmd_bootm.c Ramdisk verification complete, start loading
1547 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk)
1548 13 common/cmd_bootm.c Start multifile image verification
1549 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue.
1550 15 common/cmd_bootm.c All preparation done, transferring control to OS
1551
wdenk11dadd52004-02-27 00:07:27 +00001552 -30 lib_ppc/board.c Fatal error, hang the system
1553 -31 post/post.c POST test failed, detected by post_output_backlog()
1554 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001555
wdenkc6097192002-11-03 00:24:07 +00001556 -1 common/cmd_doc.c Bad usage of "doc" command
1557 -1 common/cmd_doc.c No boot device
1558 -1 common/cmd_doc.c Unknown Chip ID on boot device
1559 -1 common/cmd_doc.c Read Error on boot device
1560 -1 common/cmd_doc.c Image header has bad magic number
1561
1562 -1 common/cmd_ide.c Bad usage of "ide" command
1563 -1 common/cmd_ide.c No boot device
1564 -1 common/cmd_ide.c Unknown boot device
1565 -1 common/cmd_ide.c Unknown partition table
1566 -1 common/cmd_ide.c Invalid partition type
1567 -1 common/cmd_ide.c Read Error on boot device
1568 -1 common/cmd_ide.c Image header has bad magic number
1569
wdenk206c60c2003-09-18 10:02:25 +00001570 -1 common/cmd_nand.c Bad usage of "nand" command
1571 -1 common/cmd_nand.c No boot device
1572 -1 common/cmd_nand.c Unknown Chip ID on boot device
1573 -1 common/cmd_nand.c Read Error on boot device
1574 -1 common/cmd_nand.c Image header has bad magic number
1575
wdenkba56f622004-02-06 23:19:44 +00001576 -1 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001577
1578
1579Modem Support:
1580--------------
1581
wdenk85ec0bc2003-03-31 16:34:49 +00001582[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00001583
1584- Modem support endable:
1585 CONFIG_MODEM_SUPPORT
1586
1587- RTS/CTS Flow control enable:
1588 CONFIG_HWFLOW
1589
1590- Modem debug support:
1591 CONFIG_MODEM_SUPPORT_DEBUG
1592
wdenk43d96162003-03-06 00:02:04 +00001593 Enables debugging stuff (char screen[1024], dbg())
1594 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00001595
wdenka8c7c702003-12-06 19:49:23 +00001596- Interrupt support (PPC):
1597
wdenkd4ca31c2004-01-02 14:00:00 +00001598 There are common interrupt_init() and timer_interrupt()
1599 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1600 for cpu specific initialization. interrupt_init_cpu()
1601 should set decrementer_count to appropriate value. If
1602 cpu resets decrementer automatically after interrupt
1603 (ppc4xx) it should set decrementer_count to zero.
1604 timer_interrupt() calls timer_interrupt_cpu() for cpu
1605 specific handling. If board has watchdog / status_led
1606 / other_activity_monitor it works automatically from
1607 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00001608
wdenkc6097192002-11-03 00:24:07 +00001609- General:
1610
wdenk43d96162003-03-06 00:02:04 +00001611 In the target system modem support is enabled when a
1612 specific key (key combination) is pressed during
1613 power-on. Otherwise U-Boot will boot normally
1614 (autoboot). The key_pressed() fuction is called from
1615 board_init(). Currently key_pressed() is a dummy
1616 function, returning 1 and thus enabling modem
1617 initialization.
wdenkc6097192002-11-03 00:24:07 +00001618
wdenk43d96162003-03-06 00:02:04 +00001619 If there are no modem init strings in the
1620 environment, U-Boot proceed to autoboot; the
1621 previous output (banner, info printfs) will be
1622 supressed, though.
wdenkc6097192002-11-03 00:24:07 +00001623
1624 See also: doc/README.Modem
1625
1626
wdenkc6097192002-11-03 00:24:07 +00001627Configuration Settings:
1628-----------------------
1629
1630- CFG_LONGHELP: Defined when you want long help messages included;
1631 undefine this when you're short of memory.
1632
1633- CFG_PROMPT: This is what U-Boot prints on the console to
1634 prompt for user input.
1635
1636- CFG_CBSIZE: Buffer size for input from the Console
1637
1638- CFG_PBSIZE: Buffer size for Console output
1639
1640- CFG_MAXARGS: max. Number of arguments accepted for monitor commands
1641
1642- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1643 the application (usually a Linux kernel) when it is
1644 booted
1645
1646- CFG_BAUDRATE_TABLE:
1647 List of legal baudrate settings for this board.
1648
1649- CFG_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00001650 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00001651
1652- CFG_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00001653 If the board specific function
1654 extern int overwrite_console (void);
1655 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00001656 serial port, else the settings in the environment are used.
1657
1658- CFG_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00001659 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00001660
1661- CFG_CONSOLE_ENV_OVERWRITE
1662 Enable overwrite of previous console environment settings.
1663
1664- CFG_MEMTEST_START, CFG_MEMTEST_END:
1665 Begin and End addresses of the area used by the
1666 simple memory test.
1667
1668- CFG_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00001669 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00001670
wdenk5f535fe2003-09-18 09:21:33 +00001671- CFG_MEMTEST_SCRATCH:
1672 Scratch address used by the alternate memory test
1673 You only need to set this if address zero isn't writeable
1674
wdenkc6097192002-11-03 00:24:07 +00001675- CFG_TFTP_LOADADDR:
1676 Default load address for network file downloads
1677
1678- CFG_LOADS_BAUD_CHANGE:
1679 Enable temporary baudrate change while serial download
1680
1681- CFG_SDRAM_BASE:
1682 Physical start address of SDRAM. _Must_ be 0 here.
1683
1684- CFG_MBIO_BASE:
1685 Physical start address of Motherboard I/O (if using a
1686 Cogent motherboard)
1687
1688- CFG_FLASH_BASE:
1689 Physical start address of Flash memory.
1690
1691- CFG_MONITOR_BASE:
1692 Physical start address of boot monitor code (set by
1693 make config files to be same as the text base address
1694 (TEXT_BASE) used when linking) - same as
1695 CFG_FLASH_BASE when booting from flash.
1696
1697- CFG_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00001698 Size of memory reserved for monitor code, used to
1699 determine _at_compile_time_ (!) if the environment is
1700 embedded within the U-Boot image, or in a separate
1701 flash sector.
wdenkc6097192002-11-03 00:24:07 +00001702
1703- CFG_MALLOC_LEN:
1704 Size of DRAM reserved for malloc() use.
1705
1706- CFG_BOOTMAPSZ:
1707 Maximum size of memory mapped by the startup code of
1708 the Linux kernel; all data that must be processed by
1709 the Linux kernel (bd_info, boot arguments, eventually
1710 initrd image) must be put below this limit.
1711
1712- CFG_MAX_FLASH_BANKS:
1713 Max number of Flash memory banks
1714
1715- CFG_MAX_FLASH_SECT:
1716 Max number of sectors on a Flash chip
1717
1718- CFG_FLASH_ERASE_TOUT:
1719 Timeout for Flash erase operations (in ms)
1720
1721- CFG_FLASH_WRITE_TOUT:
1722 Timeout for Flash write operations (in ms)
1723
wdenk8564acf2003-07-14 22:13:32 +00001724- CFG_FLASH_LOCK_TOUT
1725 Timeout for Flash set sector lock bit operation (in ms)
1726
1727- CFG_FLASH_UNLOCK_TOUT
1728 Timeout for Flash clear lock bits operation (in ms)
1729
1730- CFG_FLASH_PROTECTION
1731 If defined, hardware flash sectors protection is used
1732 instead of U-Boot software protection.
1733
wdenkc6097192002-11-03 00:24:07 +00001734- CFG_DIRECT_FLASH_TFTP:
1735
1736 Enable TFTP transfers directly to flash memory;
1737 without this option such a download has to be
1738 performed in two steps: (1) download to RAM, and (2)
1739 copy from RAM to flash.
1740
1741 The two-step approach is usually more reliable, since
1742 you can check if the download worked before you erase
1743 the flash, but in some situations (when sytem RAM is
1744 too limited to allow for a tempory copy of the
1745 downloaded image) this option may be very useful.
1746
1747- CFG_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00001748 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00001749 common flash structure for storing flash geometry.
1750
1751- CFG_FLASH_CFI_DRIVER
1752 This option also enables the building of the cfi_flash driver
1753 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00001754
stroese53cf9432003-06-05 15:39:44 +00001755- CFG_RX_ETH_BUFFER:
1756 Defines the number of ethernet receive buffers. On some
1757 ethernet controllers it is recommended to set this value
1758 to 8 or even higher (EEPRO100 or 405 EMAC), since all
1759 buffers can be full shortly after enabling the interface
1760 on high ethernet traffic.
1761 Defaults to 4 if not defined.
1762
wdenkc6097192002-11-03 00:24:07 +00001763The following definitions that deal with the placement and management
1764of environment data (variable area); in general, we support the
1765following configurations:
1766
1767- CFG_ENV_IS_IN_FLASH:
1768
1769 Define this if the environment is in flash memory.
1770
1771 a) The environment occupies one whole flash sector, which is
1772 "embedded" in the text segment with the U-Boot code. This
1773 happens usually with "bottom boot sector" or "top boot
1774 sector" type flash chips, which have several smaller
1775 sectors at the start or the end. For instance, such a
1776 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1777 such a case you would place the environment in one of the
1778 4 kB sectors - with U-Boot code before and after it. With
1779 "top boot sector" type flash chips, you would put the
1780 environment in one of the last sectors, leaving a gap
1781 between U-Boot and the environment.
1782
1783 - CFG_ENV_OFFSET:
1784
1785 Offset of environment data (variable area) to the
1786 beginning of flash memory; for instance, with bottom boot
1787 type flash chips the second sector can be used: the offset
1788 for this sector is given here.
1789
1790 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1791
1792 - CFG_ENV_ADDR:
1793
1794 This is just another way to specify the start address of
1795 the flash sector containing the environment (instead of
1796 CFG_ENV_OFFSET).
1797
1798 - CFG_ENV_SECT_SIZE:
1799
1800 Size of the sector containing the environment.
1801
1802
1803 b) Sometimes flash chips have few, equal sized, BIG sectors.
1804 In such a case you don't want to spend a whole sector for
1805 the environment.
1806
1807 - CFG_ENV_SIZE:
1808
1809 If you use this in combination with CFG_ENV_IS_IN_FLASH
1810 and CFG_ENV_SECT_SIZE, you can specify to use only a part
1811 of this flash sector for the environment. This saves
1812 memory for the RAM copy of the environment.
1813
1814 It may also save flash memory if you decide to use this
1815 when your environment is "embedded" within U-Boot code,
1816 since then the remainder of the flash sector could be used
1817 for U-Boot code. It should be pointed out that this is
1818 STRONGLY DISCOURAGED from a robustness point of view:
1819 updating the environment in flash makes it always
1820 necessary to erase the WHOLE sector. If something goes
1821 wrong before the contents has been restored from a copy in
1822 RAM, your target system will be dead.
1823
1824 - CFG_ENV_ADDR_REDUND
1825 CFG_ENV_SIZE_REDUND
1826
wdenk43d96162003-03-06 00:02:04 +00001827 These settings describe a second storage area used to hold
1828 a redundand copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00001829 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00001830 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00001831
1832BE CAREFUL! Any changes to the flash layout, and some changes to the
1833source code will make it necessary to adapt <board>/u-boot.lds*
1834accordingly!
1835
1836
1837- CFG_ENV_IS_IN_NVRAM:
1838
1839 Define this if you have some non-volatile memory device
1840 (NVRAM, battery buffered SRAM) which you want to use for the
1841 environment.
1842
1843 - CFG_ENV_ADDR:
1844 - CFG_ENV_SIZE:
1845
1846 These two #defines are used to determin the memory area you
1847 want to use for environment. It is assumed that this memory
1848 can just be read and written to, without any special
1849 provision.
1850
1851BE CAREFUL! The first access to the environment happens quite early
1852in U-Boot initalization (when we try to get the setting of for the
1853console baudrate). You *MUST* have mappend your NVRAM area then, or
1854U-Boot will hang.
1855
1856Please note that even with NVRAM we still use a copy of the
1857environment in RAM: we could work on NVRAM directly, but we want to
1858keep settings there always unmodified except somebody uses "saveenv"
1859to save the current settings.
1860
1861
1862- CFG_ENV_IS_IN_EEPROM:
1863
1864 Use this if you have an EEPROM or similar serial access
1865 device and a driver for it.
1866
1867 - CFG_ENV_OFFSET:
1868 - CFG_ENV_SIZE:
1869
1870 These two #defines specify the offset and size of the
1871 environment area within the total memory of your EEPROM.
1872
1873 - CFG_I2C_EEPROM_ADDR:
1874 If defined, specified the chip address of the EEPROM device.
1875 The default address is zero.
1876
1877 - CFG_EEPROM_PAGE_WRITE_BITS:
1878 If defined, the number of bits used to address bytes in a
1879 single page in the EEPROM device. A 64 byte page, for example
1880 would require six bits.
1881
1882 - CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1883 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00001884 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00001885
1886 - CFG_I2C_EEPROM_ADDR_LEN:
1887 The length in bytes of the EEPROM memory array address. Note
1888 that this is NOT the chip address length!
1889
wdenk5cf91d62004-04-23 20:32:05 +00001890 - CFG_I2C_EEPROM_ADDR_OVERFLOW:
1891 EEPROM chips that implement "address overflow" are ones
1892 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
1893 address and the extra bits end up in the "chip address" bit
1894 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
1895 byte chips.
1896
1897 Note that we consider the length of the address field to
1898 still be one byte because the extra address bits are hidden
1899 in the chip address.
1900
wdenkc6097192002-11-03 00:24:07 +00001901 - CFG_EEPROM_SIZE:
1902 The size in bytes of the EEPROM device.
1903
wdenkc6097192002-11-03 00:24:07 +00001904
wdenk5779d8d2003-12-06 23:55:10 +00001905- CFG_ENV_IS_IN_DATAFLASH:
1906
wdenkd4ca31c2004-01-02 14:00:00 +00001907 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00001908 want to use for the environment.
1909
1910 - CFG_ENV_OFFSET:
1911 - CFG_ENV_ADDR:
1912 - CFG_ENV_SIZE:
1913
1914 These three #defines specify the offset and size of the
1915 environment area within the total memory of your DataFlash placed
1916 at the specified address.
1917
wdenk13a56952004-06-09 14:58:14 +00001918- CFG_ENV_IS_IN_NAND:
1919
1920 Define this if you have a NAND device which you want to use
1921 for the environment.
1922
1923 - CFG_ENV_OFFSET:
1924 - CFG_ENV_SIZE:
1925
1926 These two #defines specify the offset and size of the environment
1927 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00001928
wdenkc6097192002-11-03 00:24:07 +00001929- CFG_SPI_INIT_OFFSET
1930
1931 Defines offset to the initial SPI buffer area in DPRAM. The
1932 area is used at an early stage (ROM part) if the environment
1933 is configured to reside in the SPI EEPROM: We need a 520 byte
1934 scratch DPRAM area. It is used between the two initialization
1935 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1936 to be a good choice since it makes it far enough from the
1937 start of the data area as well as from the stack pointer.
1938
1939Please note that the environment is read-only as long as the monitor
1940has been relocated to RAM and a RAM copy of the environment has been
1941created; also, when using EEPROM you will have to use getenv_r()
1942until then to read environment variables.
1943
wdenk85ec0bc2003-03-31 16:34:49 +00001944The environment is protected by a CRC32 checksum. Before the monitor
1945is relocated into RAM, as a result of a bad CRC you will be working
1946with the compiled-in default environment - *silently*!!! [This is
1947necessary, because the first environment variable we need is the
1948"baudrate" setting for the console - if we have a bad CRC, we don't
1949have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00001950
1951Note: once the monitor has been relocated, then it will complain if
1952the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00001953use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00001954
wdenkfc3e2162003-10-08 22:33:00 +00001955- CFG_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00001956 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00001957
1958 Note: If this option is active, then CFG_FAULT_MII_ADDR
1959 also needs to be defined.
1960
1961- CFG_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00001962 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00001963
wdenkc40b2952004-03-13 23:29:43 +00001964- CFG_64BIT_VSPRINTF:
1965 Makes vsprintf (and all *printf functions) support printing
1966 of 64bit values by using the L quantifier
1967
1968- CFG_64BIT_STRTOUL:
1969 Adds simple_strtoull that returns a 64bit value
1970
wdenkc6097192002-11-03 00:24:07 +00001971Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00001972---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001973
1974- CFG_CACHELINE_SIZE:
1975 Cache Line Size of the CPU.
1976
1977- CFG_DEFAULT_IMMR:
1978 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00001979
wdenk42d1f032003-10-15 23:53:47 +00001980 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
1981 and RPXsuper) to be able to adjust the position of
1982 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00001983
wdenk7f6c2cb2002-11-10 22:06:23 +00001984- Floppy Disk Support:
1985 CFG_FDC_DRIVE_NUMBER
1986
1987 the default drive number (default value 0)
1988
1989 CFG_ISA_IO_STRIDE
1990
1991 defines the spacing between fdc chipset registers
1992 (default value 1)
1993
1994 CFG_ISA_IO_OFFSET
1995
wdenk43d96162003-03-06 00:02:04 +00001996 defines the offset of register from address. It
1997 depends on which part of the data bus is connected to
1998 the fdc chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00001999
wdenk43d96162003-03-06 00:02:04 +00002000 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
2001 CFG_FDC_DRIVE_NUMBER are undefined, they take their
2002 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002003
wdenk43d96162003-03-06 00:02:04 +00002004 if CFG_FDC_HW_INIT is defined, then the function
2005 fdc_hw_init() is called at the beginning of the FDC
2006 setup. fdc_hw_init() must be provided by the board
2007 source code. It is used to make hardware dependant
2008 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002009
wdenk25d67122004-12-10 11:40:40 +00002010- CFG_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002011 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002012 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002013
2014- CFG_INIT_RAM_ADDR:
2015
wdenk7152b1d2003-09-05 23:19:14 +00002016 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002017 initial data and stack; please note that this must be
2018 writable memory that is working WITHOUT special
2019 initialization, i. e. you CANNOT use normal RAM which
2020 will become available only after programming the
2021 memory controller and running certain initialization
2022 sequences.
2023
2024 U-Boot uses the following memory types:
2025 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2026 - MPC824X: data cache
2027 - PPC4xx: data cache
2028
wdenk85ec0bc2003-03-31 16:34:49 +00002029- CFG_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002030
2031 Offset of the initial data structure in the memory
2032 area defined by CFG_INIT_RAM_ADDR. Usually
wdenk85ec0bc2003-03-31 16:34:49 +00002033 CFG_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002034 data is located at the end of the available space
2035 (sometimes written as (CFG_INIT_RAM_END -
2036 CFG_INIT_DATA_SIZE), and the initial stack is just
2037 below that area (growing from (CFG_INIT_RAM_ADDR +
wdenk85ec0bc2003-03-31 16:34:49 +00002038 CFG_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002039
2040 Note:
2041 On the MPC824X (or other systems that use the data
2042 cache for initial memory) the address chosen for
2043 CFG_INIT_RAM_ADDR is basically arbitrary - it must
2044 point to an otherwise UNUSED address space between
2045 the top of RAM and the start of the PCI space.
2046
2047- CFG_SIUMCR: SIU Module Configuration (11-6)
2048
2049- CFG_SYPCR: System Protection Control (11-9)
2050
2051- CFG_TBSCR: Time Base Status and Control (11-26)
2052
2053- CFG_PISCR: Periodic Interrupt Status and Control (11-31)
2054
2055- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
2056
2057- CFG_SCCR: System Clock and reset Control Register (15-27)
2058
2059- CFG_OR_TIMING_SDRAM:
2060 SDRAM timing
2061
2062- CFG_MAMR_PTA:
2063 periodic timer for refresh
2064
2065- CFG_DER: Debug Event Register (37-47)
2066
2067- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2068 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2069 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2070 CFG_BR1_PRELIM:
2071 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2072
2073- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2074 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2075 CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2076 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2077
2078- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2079 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2080 Machine Mode Register and Memory Periodic Timer
2081 Prescaler definitions (SDRAM timing)
2082
2083- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2084 enable I2C microcode relocation patch (MPC8xx);
2085 define relocation offset in DPRAM [DSP2]
2086
2087- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2088 enable SPI microcode relocation patch (MPC8xx);
2089 define relocation offset in DPRAM [SCC4]
2090
2091- CFG_USE_OSCCLK:
2092 Use OSCM clock mode on MBX8xx board. Be careful,
2093 wrong setting might damage your board. Read
2094 doc/README.MBX before setting this variable!
2095
wdenkea909b72002-11-21 23:11:29 +00002096- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002097 Offset of the bootmode word in DPRAM used by post
2098 (Power On Self Tests). This definition overrides
2099 #define'd default value in commproc.h resp.
2100 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002101
stroese1d49b1f2003-05-23 11:39:05 +00002102- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
2103 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
2104 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
2105 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
2106 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2107 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
2108 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
wdenk5d232d02003-05-22 22:52:13 +00002109 CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
2110 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2111
wdenkc26e4542004-04-18 10:13:26 +00002112- CONFIG_ETHER_ON_FEC[12]
2113 Define to enable FEC[12] on a 8xx series processor.
2114
2115- CONFIG_FEC[12]_PHY
2116 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002117 to the given FEC; i. e.
2118 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002119 means that the PHY with address 4 is connected to FEC1
2120
2121 When set to -1, means to probe for first available.
2122
2123- CONFIG_FEC[12]_PHY_NORXERR
2124 The PHY does not have a RXERR line (RMII only).
2125 (so program the FEC to ignore it).
2126
2127- CONFIG_RMII
2128 Enable RMII mode for all FECs.
2129 Note that this is a global option, we can't
2130 have one FEC in standard MII mode and another in RMII mode.
2131
wdenk5cf91d62004-04-23 20:32:05 +00002132- CONFIG_CRC32_VERIFY
2133 Add a verify option to the crc32 command.
2134 The syntax is:
2135
2136 => crc32 -v <address> <count> <crc32>
2137
2138 Where address/count indicate a memory area
2139 and crc32 is the correct crc32 which the
2140 area should have.
2141
wdenk56523f12004-07-11 17:40:54 +00002142- CONFIG_LOOPW
2143 Add the "loopw" memory command. This only takes effect if
2144 the memory commands are activated globally (CFG_CMD_MEM).
2145
stroese7b466642004-12-16 18:46:55 +00002146- CONFIG_MX_CYCLIC
2147 Add the "mdc" and "mwc" memory commands. These are cyclic
2148 "md/mw" commands.
2149 Examples:
2150
wdenkefe2a4d2004-12-16 21:44:03 +00002151 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002152 This command will print 4 bytes (10,11,12,13) each 500 ms.
2153
wdenkefe2a4d2004-12-16 21:44:03 +00002154 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002155 This command will write 12345678 to address 100 all 10 ms.
2156
wdenkefe2a4d2004-12-16 21:44:03 +00002157 This only takes effect if the memory commands are activated
stroese7b466642004-12-16 18:46:55 +00002158 globally (CFG_CMD_MEM).
2159
wdenk8aa1a2d2005-04-04 12:44:11 +00002160- CONFIG_SKIP_LOWLEVEL_INIT
2161- CONFIG_SKIP_RELOCATE_UBOOT
2162
wdenk3c2b3d42005-04-05 23:32:21 +00002163 [ARM only] If these variables are defined, then
2164 certain low level initializations (like setting up
2165 the memory controller) are omitted and/or U-Boot does
2166 not relocate itself into RAM.
2167 Normally these variables MUST NOT be defined. The
2168 only exception is when U-Boot is loaded (to RAM) by
2169 some other boot loader or by a debugger which
2170 performs these intializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002171
wdenk400558b2005-04-02 23:52:25 +00002172
wdenkc6097192002-11-03 00:24:07 +00002173Building the Software:
2174======================
2175
2176Building U-Boot has been tested in native PPC environments (on a
2177PowerBook G3 running LinuxPPC 2000) and in cross environments
2178(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2179NetBSD 1.5 on x86).
2180
2181If you are not using a native PPC environment, it is assumed that you
2182have the GNU cross compiling tools available in your path and named
2183with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2184you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2185the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2186change it to:
2187
2188 CROSS_COMPILE = ppc_4xx-
2189
2190
wdenkba56f622004-02-06 23:19:44 +00002191U-Boot is intended to be simple to build. After installing the
wdenkc6097192002-11-03 00:24:07 +00002192sources you must configure U-Boot for one specific board type. This
2193is done by typing:
2194
2195 make NAME_config
2196
2197where "NAME_config" is the name of one of the existing
2198configurations; the following names are supported:
2199
wdenk1eaeb582004-06-08 00:22:43 +00002200 ADCIOP_config FPS860L_config omap730p2_config
2201 ADS860_config GEN860T_config pcu_e_config
wdenk983fda82004-10-28 00:09:35 +00002202 Alaska8220_config
wdenk1eaeb582004-06-08 00:22:43 +00002203 AR405_config GENIETV_config PIP405_config
2204 at91rm9200dk_config GTH_config QS823_config
2205 CANBT_config hermes_config QS850_config
2206 cmi_mpc5xx_config hymod_config QS860T_config
2207 cogent_common_config IP860_config RPXlite_config
wdenke63c8ee2004-06-09 21:04:48 +00002208 cogent_mpc8260_config IVML24_config RPXlite_DW_config
2209 cogent_mpc8xx_config IVMS8_config RPXsuper_config
2210 CPCI405_config JSE_config rsdproto_config
2211 CPCIISER4_config LANTEC_config Sandpoint8240_config
2212 csb272_config lwmon_config sbc8260_config
wdenk466b7412004-07-10 22:35:59 +00002213 CU824_config MBX860T_config sbc8560_33_config
2214 DUET_ADS_config MBX_config sbc8560_66_config
wdenk8b07a112004-07-10 21:45:47 +00002215 EBONY_config MPC8260ADS_config SM850_config
2216 ELPT860_config MPC8540ADS_config SPD823TS_config
Lunsheng Wangb0e32942005-07-29 10:20:29 -05002217 ESTEEM192E_config MPC8540EVAL_config stxgp3_config
2218 ETX094_config MPC8560ADS_config SXNI855T_config
2219 FADS823_config NETVIA_config TQM823L_config
2220 FADS850SAR_config omap1510inn_config TQM850L_config
2221 FADS860T_config omap1610h2_config TQM855L_config
2222 FPS850L_config omap1610inn_config TQM860L_config
Jon Loeliger4b1d95d2005-08-02 13:53:07 -05002223 omap5912osk_config walnut_config
Lunsheng Wangb0e32942005-07-29 10:20:29 -05002224 omap2420h4_config Yukon8220_config
wdenk8b07a112004-07-10 21:45:47 +00002225 ZPC1900_config
wdenk54387ac2003-10-08 22:45:44 +00002226
wdenk2729af92004-05-03 20:45:30 +00002227Note: for some board special configuration names may exist; check if
2228 additional information is available from the board vendor; for
2229 instance, the TQM823L systems are available without (standard)
2230 or with LCD support. You can select such additional "features"
2231 when chosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002232
wdenk2729af92004-05-03 20:45:30 +00002233 make TQM823L_config
2234 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002235
wdenk2729af92004-05-03 20:45:30 +00002236 make TQM823L_LCD_config
2237 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002238
wdenk2729af92004-05-03 20:45:30 +00002239 etc.
wdenkc6097192002-11-03 00:24:07 +00002240
wdenkc6097192002-11-03 00:24:07 +00002241
wdenk2729af92004-05-03 20:45:30 +00002242Finally, type "make all", and you should get some working U-Boot
2243images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002244
wdenk2729af92004-05-03 20:45:30 +00002245- "u-boot.bin" is a raw binary image
2246- "u-boot" is an image in ELF binary format
2247- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002248
wdenkc6097192002-11-03 00:24:07 +00002249
wdenk2729af92004-05-03 20:45:30 +00002250Please be aware that the Makefiles assume you are using GNU make, so
2251for instance on NetBSD you might need to use "gmake" instead of
2252native "make".
wdenkc6097192002-11-03 00:24:07 +00002253
wdenkc6097192002-11-03 00:24:07 +00002254
wdenk2729af92004-05-03 20:45:30 +00002255If the system board that you have is not listed, then you will need
2256to port U-Boot to your hardware platform. To do this, follow these
2257steps:
wdenkc6097192002-11-03 00:24:07 +00002258
wdenk2729af92004-05-03 20:45:30 +000022591. Add a new configuration option for your board to the toplevel
2260 "Makefile" and to the "MAKEALL" script, using the existing
2261 entries as examples. Note that here and at many other places
2262 boards and other names are listed in alphabetical sort order. Please
2263 keep this order.
22642. Create a new directory to hold your board specific code. Add any
2265 files you need. In your board directory, you will need at least
2266 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
22673. Create a new configuration file "include/configs/<board>.h" for
2268 your board
22693. If you're porting U-Boot to a new CPU, then also create a new
2270 directory to hold your CPU specific code. Add any files you need.
22714. Run "make <board>_config" with your new name.
22725. Type "make", and you should get a working "u-boot.srec" file
2273 to be installed on your target system.
22746. Debug and solve any problems that might arise.
2275 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002276
wdenkc6097192002-11-03 00:24:07 +00002277
wdenk2729af92004-05-03 20:45:30 +00002278Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2279==============================================================
wdenkc6097192002-11-03 00:24:07 +00002280
wdenk2729af92004-05-03 20:45:30 +00002281If you have modified U-Boot sources (for instance added a new board
2282or support for new devices, a new CPU, etc.) you are expected to
2283provide feedback to the other developers. The feedback normally takes
2284the form of a "patch", i. e. a context diff against a certain (latest
2285official or latest in CVS) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002286
wdenk2729af92004-05-03 20:45:30 +00002287But before you submit such a patch, please verify that your modifi-
2288cation did not break existing code. At least make sure that *ALL* of
2289the supported boards compile WITHOUT ANY compiler warnings. To do so,
2290just run the "MAKEALL" script, which will configure and build U-Boot
2291for ALL supported system. Be warned, this will take a while. You can
2292select which (cross) compiler to use by passing a `CROSS_COMPILE'
2293environment variable to the script, i. e. to use the cross tools from
2294MontaVista's Hard Hat Linux you can type
wdenkc6097192002-11-03 00:24:07 +00002295
wdenk2729af92004-05-03 20:45:30 +00002296 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002297
wdenk2729af92004-05-03 20:45:30 +00002298or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002299
wdenk2729af92004-05-03 20:45:30 +00002300 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002301
wdenk2729af92004-05-03 20:45:30 +00002302See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002303
wdenkc6097192002-11-03 00:24:07 +00002304
wdenk2729af92004-05-03 20:45:30 +00002305Monitor Commands - Overview:
2306============================
wdenkc6097192002-11-03 00:24:07 +00002307
wdenk2729af92004-05-03 20:45:30 +00002308go - start application at address 'addr'
2309run - run commands in an environment variable
2310bootm - boot application image from memory
2311bootp - boot image via network using BootP/TFTP protocol
2312tftpboot- boot image via network using TFTP protocol
2313 and env variables "ipaddr" and "serverip"
2314 (and eventually "gatewayip")
2315rarpboot- boot image via network using RARP/TFTP protocol
2316diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2317loads - load S-Record file over serial line
2318loadb - load binary file over serial line (kermit mode)
2319md - memory display
2320mm - memory modify (auto-incrementing)
2321nm - memory modify (constant address)
2322mw - memory write (fill)
2323cp - memory copy
2324cmp - memory compare
2325crc32 - checksum calculation
2326imd - i2c memory display
2327imm - i2c memory modify (auto-incrementing)
2328inm - i2c memory modify (constant address)
2329imw - i2c memory write (fill)
2330icrc32 - i2c checksum calculation
2331iprobe - probe to discover valid I2C chip addresses
2332iloop - infinite loop on address range
2333isdram - print SDRAM configuration information
2334sspi - SPI utility commands
2335base - print or set address offset
2336printenv- print environment variables
2337setenv - set environment variables
2338saveenv - save environment variables to persistent storage
2339protect - enable or disable FLASH write protection
2340erase - erase FLASH memory
2341flinfo - print FLASH memory information
2342bdinfo - print Board Info structure
2343iminfo - print header information for application image
2344coninfo - print console devices and informations
2345ide - IDE sub-system
2346loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002347loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002348mtest - simple RAM test
2349icache - enable or disable instruction cache
2350dcache - enable or disable data cache
2351reset - Perform RESET of the CPU
2352echo - echo args to console
2353version - print monitor version
2354help - print online help
2355? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002356
wdenkc6097192002-11-03 00:24:07 +00002357
wdenk2729af92004-05-03 20:45:30 +00002358Monitor Commands - Detailed Description:
2359========================================
wdenkc6097192002-11-03 00:24:07 +00002360
wdenk2729af92004-05-03 20:45:30 +00002361TODO.
wdenkc6097192002-11-03 00:24:07 +00002362
wdenk2729af92004-05-03 20:45:30 +00002363For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002364
2365
wdenk2729af92004-05-03 20:45:30 +00002366Environment Variables:
2367======================
wdenkc6097192002-11-03 00:24:07 +00002368
wdenk2729af92004-05-03 20:45:30 +00002369U-Boot supports user configuration using Environment Variables which
2370can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00002371
wdenk2729af92004-05-03 20:45:30 +00002372Environment Variables are set using "setenv", printed using
2373"printenv", and saved to Flash using "saveenv". Using "setenv"
2374without a value can be used to delete a variable from the
2375environment. As long as you don't save the environment you are
2376working with an in-memory copy. In case the Flash area containing the
2377environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00002378
wdenk2729af92004-05-03 20:45:30 +00002379Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002380
wdenk2729af92004-05-03 20:45:30 +00002381 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00002382
wdenk2729af92004-05-03 20:45:30 +00002383 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00002384
wdenk2729af92004-05-03 20:45:30 +00002385 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00002386
wdenk2729af92004-05-03 20:45:30 +00002387 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00002388
wdenk2729af92004-05-03 20:45:30 +00002389 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00002390
wdenk2729af92004-05-03 20:45:30 +00002391 autoload - if set to "no" (any string beginning with 'n'),
2392 "bootp" will just load perform a lookup of the
2393 configuration from the BOOTP server, but not try to
2394 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00002395
wdenk2729af92004-05-03 20:45:30 +00002396 autostart - if set to "yes", an image loaded using the "bootp",
2397 "rarpboot", "tftpboot" or "diskboot" commands will
2398 be automatically started (by internally calling
2399 "bootm")
wdenkc6097192002-11-03 00:24:07 +00002400
wdenk2729af92004-05-03 20:45:30 +00002401 If set to "no", a standalone image passed to the
2402 "bootm" command will be copied to the load address
2403 (and eventually uncompressed), but NOT be started.
2404 This can be used to load and uncompress arbitrary
2405 data.
wdenkc6097192002-11-03 00:24:07 +00002406
wdenk17ea1172004-06-06 21:51:03 +00002407 i2cfast - (PPC405GP|PPC405EP only)
2408 if set to 'y' configures Linux I2C driver for fast
2409 mode (400kHZ). This environment variable is used in
2410 initialization code. So, for changes to be effective
2411 it must be saved and board must be reset.
2412
wdenk2729af92004-05-03 20:45:30 +00002413 initrd_high - restrict positioning of initrd images:
2414 If this variable is not set, initrd images will be
2415 copied to the highest possible address in RAM; this
2416 is usually what you want since it allows for
2417 maximum initrd size. If for some reason you want to
2418 make sure that the initrd image is loaded below the
2419 CFG_BOOTMAPSZ limit, you can set this environment
2420 variable to a value of "no" or "off" or "0".
2421 Alternatively, you can set it to a maximum upper
2422 address to use (U-Boot will still check that it
2423 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00002424
wdenk2729af92004-05-03 20:45:30 +00002425 For instance, when you have a system with 16 MB
2426 RAM, and want to reserve 4 MB from use by Linux,
2427 you can do this by adding "mem=12M" to the value of
2428 the "bootargs" variable. However, now you must make
2429 sure that the initrd image is placed in the first
2430 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00002431
wdenk2729af92004-05-03 20:45:30 +00002432 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00002433
wdenk2729af92004-05-03 20:45:30 +00002434 If you set initrd_high to 0xFFFFFFFF, this is an
2435 indication to U-Boot that all addresses are legal
2436 for the Linux kernel, including addresses in flash
2437 memory. In this case U-Boot will NOT COPY the
2438 ramdisk at all. This may be useful to reduce the
2439 boot time on your system, but requires that this
2440 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00002441
wdenk2729af92004-05-03 20:45:30 +00002442 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00002443
wdenk2729af92004-05-03 20:45:30 +00002444 loadaddr - Default load address for commands like "bootp",
2445 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00002446
wdenk2729af92004-05-03 20:45:30 +00002447 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00002448
wdenk2729af92004-05-03 20:45:30 +00002449 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00002450
wdenk2729af92004-05-03 20:45:30 +00002451 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00002452
wdenk2729af92004-05-03 20:45:30 +00002453 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00002454
wdenk2729af92004-05-03 20:45:30 +00002455 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00002456
wdenk2729af92004-05-03 20:45:30 +00002457 ethprime - When CONFIG_NET_MULTI is enabled controls which
2458 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00002459
wdenk2729af92004-05-03 20:45:30 +00002460 ethact - When CONFIG_NET_MULTI is enabled controls which
2461 interface is currently active. For example you
2462 can do the following
wdenkc6097192002-11-03 00:24:07 +00002463
wdenk2729af92004-05-03 20:45:30 +00002464 => setenv ethact FEC ETHERNET
2465 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2466 => setenv ethact SCC ETHERNET
2467 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00002468
wdenk2729af92004-05-03 20:45:30 +00002469 netretry - When set to "no" each network operation will
2470 either succeed or fail without retrying.
2471 When set to "once" the network operation will
2472 fail when all the available network interfaces
2473 are tried once without success.
2474 Useful on scripts which control the retry operation
2475 themselves.
wdenkc6097192002-11-03 00:24:07 +00002476
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002477 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002478 UDP source port.
2479
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002480 tftpdstport - If this is set, the value is used for TFTP's UDP
2481 destination port instead of the Well Know Port 69.
2482
wdenk2729af92004-05-03 20:45:30 +00002483 vlan - When set to a value < 4095 the traffic over
2484 ethernet is encapsulated/received over 802.1q
2485 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00002486
wdenk2729af92004-05-03 20:45:30 +00002487The following environment variables may be used and automatically
2488updated by the network boot commands ("bootp" and "rarpboot"),
2489depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00002490
wdenk2729af92004-05-03 20:45:30 +00002491 bootfile - see above
2492 dnsip - IP address of your Domain Name Server
2493 dnsip2 - IP address of your secondary Domain Name Server
2494 gatewayip - IP address of the Gateway (Router) to use
2495 hostname - Target hostname
2496 ipaddr - see above
2497 netmask - Subnet Mask
2498 rootpath - Pathname of the root filesystem on the NFS server
2499 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00002500
wdenka3d991b2004-04-15 21:48:45 +00002501
wdenk2729af92004-05-03 20:45:30 +00002502There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002503
wdenk2729af92004-05-03 20:45:30 +00002504 serial# - contains hardware identification information such
2505 as type string and/or serial number
2506 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00002507
wdenk2729af92004-05-03 20:45:30 +00002508These variables can be set only once (usually during manufacturing of
2509the board). U-Boot refuses to delete or overwrite these variables
2510once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00002511
2512
wdenk2729af92004-05-03 20:45:30 +00002513Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00002514
wdenk2729af92004-05-03 20:45:30 +00002515 ver - Contains the U-Boot version string as printed
2516 with the "version" command. This variable is
2517 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00002518
wdenkc6097192002-11-03 00:24:07 +00002519
wdenk2729af92004-05-03 20:45:30 +00002520Please note that changes to some configuration parameters may take
2521only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00002522
stroesec1551ea2003-04-04 15:53:41 +00002523
wdenk2729af92004-05-03 20:45:30 +00002524Command Line Parsing:
2525=====================
stroesec1551ea2003-04-04 15:53:41 +00002526
wdenk2729af92004-05-03 20:45:30 +00002527There are two different command line parsers available with U-Boot:
2528the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00002529
wdenk2729af92004-05-03 20:45:30 +00002530Old, simple command line parser:
2531--------------------------------
wdenkc6097192002-11-03 00:24:07 +00002532
wdenk2729af92004-05-03 20:45:30 +00002533- supports environment variables (through setenv / saveenv commands)
2534- several commands on one line, separated by ';'
2535- variable substitution using "... $(name) ..." syntax
2536- special characters ('$', ';') can be escaped by prefixing with '\',
2537 for example:
2538 setenv bootcmd bootm \$(address)
2539- You can also escape text by enclosing in single apostrophes, for example:
2540 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00002541
wdenk2729af92004-05-03 20:45:30 +00002542Hush shell:
2543-----------
wdenkf07771c2003-05-28 08:06:31 +00002544
wdenk2729af92004-05-03 20:45:30 +00002545- similar to Bourne shell, with control structures like
2546 if...then...else...fi, for...do...done; while...do...done,
2547 until...do...done, ...
2548- supports environment ("global") variables (through setenv / saveenv
2549 commands) and local shell variables (through standard shell syntax
2550 "name=value"); only environment variables can be used with "run"
2551 command
wdenkf07771c2003-05-28 08:06:31 +00002552
wdenk2729af92004-05-03 20:45:30 +00002553General rules:
2554--------------
wdenkf07771c2003-05-28 08:06:31 +00002555
wdenk2729af92004-05-03 20:45:30 +00002556(1) If a command line (or an environment variable executed by a "run"
2557 command) contains several commands separated by semicolon, and
2558 one of these commands fails, then the remaining commands will be
2559 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00002560
wdenk2729af92004-05-03 20:45:30 +00002561(2) If you execute several variables with one call to run (i. e.
2562 calling run with a list af variables as arguments), any failing
2563 command will cause "run" to terminate, i. e. the remaining
2564 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00002565
wdenk2729af92004-05-03 20:45:30 +00002566Note for Redundant Ethernet Interfaces:
2567=======================================
wdenkf07771c2003-05-28 08:06:31 +00002568
wdenk2729af92004-05-03 20:45:30 +00002569Some boards come with redundant ethernet interfaces; U-Boot supports
2570such configurations and is capable of automatic selection of a
2571"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00002572
wdenk2729af92004-05-03 20:45:30 +00002573Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2574MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2575"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00002576
wdenk2729af92004-05-03 20:45:30 +00002577If the network interface stores some valid MAC address (for instance
2578in SROM), this is used as default address if there is NO correspon-
2579ding setting in the environment; if the corresponding environment
2580variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00002581
wdenk2729af92004-05-03 20:45:30 +00002582o If the SROM has a valid MAC address, and there is no address in the
2583 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00002584
wdenk2729af92004-05-03 20:45:30 +00002585o If there is no valid address in the SROM, and a definition in the
2586 environment exists, then the value from the environment variable is
2587 used.
wdenkc6097192002-11-03 00:24:07 +00002588
wdenk2729af92004-05-03 20:45:30 +00002589o If both the SROM and the environment contain a MAC address, and
2590 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00002591
wdenk2729af92004-05-03 20:45:30 +00002592o If both the SROM and the environment contain a MAC address, and the
2593 addresses differ, the value from the environment is used and a
2594 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00002595
wdenk2729af92004-05-03 20:45:30 +00002596o If neither SROM nor the environment contain a MAC address, an error
2597 is raised.
wdenkc6097192002-11-03 00:24:07 +00002598
wdenkc6097192002-11-03 00:24:07 +00002599
wdenk2729af92004-05-03 20:45:30 +00002600Image Formats:
2601==============
wdenkc6097192002-11-03 00:24:07 +00002602
wdenk2729af92004-05-03 20:45:30 +00002603The "boot" commands of this monitor operate on "image" files which
2604can be basicly anything, preceeded by a special header; see the
2605definitions in include/image.h for details; basicly, the header
2606defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00002607
wdenk2729af92004-05-03 20:45:30 +00002608* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2609 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
2610 LynxOS, pSOS, QNX, RTEMS, ARTOS;
2611 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2612* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
2613 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2614 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2615* Compression Type (uncompressed, gzip, bzip2)
2616* Load Address
2617* Entry Point
2618* Image Name
2619* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00002620
wdenk2729af92004-05-03 20:45:30 +00002621The header is marked by a special Magic Number, and both the header
2622and the data portions of the image are secured against corruption by
2623CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00002624
wdenkc6097192002-11-03 00:24:07 +00002625
wdenk2729af92004-05-03 20:45:30 +00002626Linux Support:
2627==============
wdenkc6097192002-11-03 00:24:07 +00002628
wdenk2729af92004-05-03 20:45:30 +00002629Although U-Boot should support any OS or standalone application
2630easily, the main focus has always been on Linux during the design of
2631U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002632
wdenk2729af92004-05-03 20:45:30 +00002633U-Boot includes many features that so far have been part of some
2634special "boot loader" code within the Linux kernel. Also, any
2635"initrd" images to be used are no longer part of one big Linux image;
2636instead, kernel and "initrd" are separate images. This implementation
2637serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00002638
wdenk2729af92004-05-03 20:45:30 +00002639- the same features can be used for other OS or standalone
2640 applications (for instance: using compressed images to reduce the
2641 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00002642
wdenk2729af92004-05-03 20:45:30 +00002643- it becomes much easier to port new Linux kernel versions because
2644 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00002645
wdenk2729af92004-05-03 20:45:30 +00002646- the same Linux kernel image can now be used with different "initrd"
2647 images; of course this also means that different kernel images can
2648 be run with the same "initrd". This makes testing easier (you don't
2649 have to build a new "zImage.initrd" Linux image when you just
2650 change a file in your "initrd"). Also, a field-upgrade of the
2651 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00002652
wdenkc6097192002-11-03 00:24:07 +00002653
wdenk2729af92004-05-03 20:45:30 +00002654Linux HOWTO:
2655============
wdenkc6097192002-11-03 00:24:07 +00002656
wdenk2729af92004-05-03 20:45:30 +00002657Porting Linux to U-Boot based systems:
2658---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002659
wdenk2729af92004-05-03 20:45:30 +00002660U-Boot cannot save you from doing all the necessary modifications to
2661configure the Linux device drivers for use with your target hardware
2662(no, we don't intend to provide a full virtual machine interface to
2663Linux :-).
wdenkc6097192002-11-03 00:24:07 +00002664
wdenk2729af92004-05-03 20:45:30 +00002665But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00002666
wdenk2729af92004-05-03 20:45:30 +00002667Just make sure your machine specific header file (for instance
2668include/asm-ppc/tqm8xx.h) includes the same definition of the Board
2669Information structure as we define in include/u-boot.h, and make
2670sure that your definition of IMAP_ADDR uses the same value as your
2671U-Boot configuration in CFG_IMMR.
wdenkc6097192002-11-03 00:24:07 +00002672
wdenkc6097192002-11-03 00:24:07 +00002673
wdenk2729af92004-05-03 20:45:30 +00002674Configuring the Linux kernel:
2675-----------------------------
wdenkc6097192002-11-03 00:24:07 +00002676
wdenk2729af92004-05-03 20:45:30 +00002677No specific requirements for U-Boot. Make sure you have some root
2678device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00002679
wdenkc6097192002-11-03 00:24:07 +00002680
wdenk2729af92004-05-03 20:45:30 +00002681Building a Linux Image:
2682-----------------------
wdenkc6097192002-11-03 00:24:07 +00002683
wdenk2729af92004-05-03 20:45:30 +00002684With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2685not used. If you use recent kernel source, a new build target
2686"uImage" will exist which automatically builds an image usable by
2687U-Boot. Most older kernels also have support for a "pImage" target,
2688which was introduced for our predecessor project PPCBoot and uses a
2689100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00002690
wdenk2729af92004-05-03 20:45:30 +00002691Example:
wdenkc6097192002-11-03 00:24:07 +00002692
wdenk2729af92004-05-03 20:45:30 +00002693 make TQM850L_config
2694 make oldconfig
2695 make dep
2696 make uImage
wdenkc6097192002-11-03 00:24:07 +00002697
wdenk2729af92004-05-03 20:45:30 +00002698The "uImage" build target uses a special tool (in 'tools/mkimage') to
2699encapsulate a compressed Linux kernel image with header information,
2700CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00002701
wdenk2729af92004-05-03 20:45:30 +00002702* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00002703
wdenk2729af92004-05-03 20:45:30 +00002704* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00002705
wdenk2729af92004-05-03 20:45:30 +00002706 ${CROSS_COMPILE}-objcopy -O binary \
2707 -R .note -R .comment \
2708 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00002709
wdenk2729af92004-05-03 20:45:30 +00002710* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00002711
wdenk2729af92004-05-03 20:45:30 +00002712 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00002713
wdenk2729af92004-05-03 20:45:30 +00002714* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00002715
wdenk2729af92004-05-03 20:45:30 +00002716 mkimage -A ppc -O linux -T kernel -C gzip \
2717 -a 0 -e 0 -n "Linux Kernel Image" \
2718 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00002719
wdenk24ee89b2002-11-03 17:56:27 +00002720
wdenk2729af92004-05-03 20:45:30 +00002721The "mkimage" tool can also be used to create ramdisk images for use
2722with U-Boot, either separated from the Linux kernel image, or
2723combined into one file. "mkimage" encapsulates the images with a 64
2724byte header containing information about target architecture,
2725operating system, image type, compression method, entry points, time
2726stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00002727
wdenk2729af92004-05-03 20:45:30 +00002728"mkimage" can be called in two ways: to verify existing images and
2729print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00002730
wdenk2729af92004-05-03 20:45:30 +00002731In the first form (with "-l" option) mkimage lists the information
2732contained in the header of an existing U-Boot image; this includes
2733checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00002734
wdenk2729af92004-05-03 20:45:30 +00002735 tools/mkimage -l image
2736 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00002737
wdenk2729af92004-05-03 20:45:30 +00002738The second form (with "-d" option) is used to build a U-Boot image
2739from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00002740
wdenk2729af92004-05-03 20:45:30 +00002741 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2742 -n name -d data_file image
2743 -A ==> set architecture to 'arch'
2744 -O ==> set operating system to 'os'
2745 -T ==> set image type to 'type'
2746 -C ==> set compression type 'comp'
2747 -a ==> set load address to 'addr' (hex)
2748 -e ==> set entry point to 'ep' (hex)
2749 -n ==> set image name to 'name'
2750 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00002751
wdenk69459792004-05-29 16:53:29 +00002752Right now, all Linux kernels for PowerPC systems use the same load
2753address (0x00000000), but the entry point address depends on the
2754kernel version:
wdenkc6097192002-11-03 00:24:07 +00002755
wdenk2729af92004-05-03 20:45:30 +00002756- 2.2.x kernels have the entry point at 0x0000000C,
2757- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00002758
wdenk2729af92004-05-03 20:45:30 +00002759So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00002760
wdenk2729af92004-05-03 20:45:30 +00002761 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2762 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
2763 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
2764 > examples/uImage.TQM850L
2765 Image Name: 2.4.4 kernel for TQM850L
2766 Created: Wed Jul 19 02:34:59 2000
2767 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2768 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2769 Load Address: 0x00000000
2770 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002771
wdenk2729af92004-05-03 20:45:30 +00002772To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00002773
wdenk2729af92004-05-03 20:45:30 +00002774 -> tools/mkimage -l examples/uImage.TQM850L
2775 Image Name: 2.4.4 kernel for TQM850L
2776 Created: Wed Jul 19 02:34:59 2000
2777 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2778 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2779 Load Address: 0x00000000
2780 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002781
wdenk2729af92004-05-03 20:45:30 +00002782NOTE: for embedded systems where boot time is critical you can trade
2783speed for memory and install an UNCOMPRESSED image instead: this
2784needs more space in Flash, but boots much faster since it does not
2785need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00002786
wdenk2729af92004-05-03 20:45:30 +00002787 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
2788 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2789 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
2790 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
2791 > examples/uImage.TQM850L-uncompressed
2792 Image Name: 2.4.4 kernel for TQM850L
2793 Created: Wed Jul 19 02:34:59 2000
2794 Image Type: PowerPC Linux Kernel Image (uncompressed)
2795 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2796 Load Address: 0x00000000
2797 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002798
wdenkc6097192002-11-03 00:24:07 +00002799
wdenk2729af92004-05-03 20:45:30 +00002800Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2801when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00002802
wdenk2729af92004-05-03 20:45:30 +00002803 -> tools/mkimage -n 'Simple Ramdisk Image' \
2804 > -A ppc -O linux -T ramdisk -C gzip \
2805 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2806 Image Name: Simple Ramdisk Image
2807 Created: Wed Jan 12 14:01:50 2000
2808 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2809 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2810 Load Address: 0x00000000
2811 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00002812
wdenkdb01a2e2004-04-15 23:14:49 +00002813
wdenk2729af92004-05-03 20:45:30 +00002814Installing a Linux Image:
2815-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00002816
wdenk2729af92004-05-03 20:45:30 +00002817To downloading a U-Boot image over the serial (console) interface,
2818you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00002819
wdenk2729af92004-05-03 20:45:30 +00002820 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00002821
wdenk2729af92004-05-03 20:45:30 +00002822The 'objcopy' does not understand the information in the U-Boot
2823image header, so the resulting S-Record file will be relative to
2824address 0x00000000. To load it to a given address, you need to
2825specify the target address as 'offset' parameter with the 'loads'
2826command.
wdenkc6097192002-11-03 00:24:07 +00002827
wdenk2729af92004-05-03 20:45:30 +00002828Example: install the image to address 0x40100000 (which on the
2829TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00002830
wdenk2729af92004-05-03 20:45:30 +00002831 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00002832
wdenk2729af92004-05-03 20:45:30 +00002833 .......... done
2834 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00002835
wdenk2729af92004-05-03 20:45:30 +00002836 => loads 40100000
2837 ## Ready for S-Record download ...
2838 ~>examples/image.srec
2839 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2840 ...
2841 15989 15990 15991 15992
2842 [file transfer complete]
2843 [connected]
2844 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00002845
2846
wdenk2729af92004-05-03 20:45:30 +00002847You can check the success of the download using the 'iminfo' command;
2848this includes a checksum verification so you can be sure no data
2849corruption happened:
wdenkc6097192002-11-03 00:24:07 +00002850
wdenk2729af92004-05-03 20:45:30 +00002851 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00002852
wdenk2729af92004-05-03 20:45:30 +00002853 ## Checking Image at 40100000 ...
2854 Image Name: 2.2.13 for initrd on TQM850L
2855 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2856 Data Size: 335725 Bytes = 327 kB = 0 MB
2857 Load Address: 00000000
2858 Entry Point: 0000000c
2859 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002860
2861
wdenk2729af92004-05-03 20:45:30 +00002862Boot Linux:
2863-----------
wdenkc6097192002-11-03 00:24:07 +00002864
wdenk2729af92004-05-03 20:45:30 +00002865The "bootm" command is used to boot an application that is stored in
2866memory (RAM or Flash). In case of a Linux kernel image, the contents
2867of the "bootargs" environment variable is passed to the kernel as
2868parameters. You can check and modify this variable using the
2869"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00002870
2871
wdenk2729af92004-05-03 20:45:30 +00002872 => printenv bootargs
2873 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00002874
wdenk2729af92004-05-03 20:45:30 +00002875 => 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 +00002876
wdenk2729af92004-05-03 20:45:30 +00002877 => printenv bootargs
2878 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 +00002879
wdenk2729af92004-05-03 20:45:30 +00002880 => bootm 40020000
2881 ## Booting Linux kernel at 40020000 ...
2882 Image Name: 2.2.13 for NFS on TQM850L
2883 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2884 Data Size: 381681 Bytes = 372 kB = 0 MB
2885 Load Address: 00000000
2886 Entry Point: 0000000c
2887 Verifying Checksum ... OK
2888 Uncompressing Kernel Image ... OK
2889 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
2890 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2891 time_init: decrementer frequency = 187500000/60
2892 Calibrating delay loop... 49.77 BogoMIPS
2893 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2894 ...
wdenkc6097192002-11-03 00:24:07 +00002895
wdenk2729af92004-05-03 20:45:30 +00002896If you want to boot a Linux kernel with initial ram disk, you pass
2897the memory addresses of both the kernel and the initrd image (PPBCOOT
2898format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00002899
wdenk2729af92004-05-03 20:45:30 +00002900 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00002901
wdenk2729af92004-05-03 20:45:30 +00002902 ## Checking Image at 40100000 ...
2903 Image Name: 2.2.13 for initrd on TQM850L
2904 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2905 Data Size: 335725 Bytes = 327 kB = 0 MB
2906 Load Address: 00000000
2907 Entry Point: 0000000c
2908 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002909
wdenk2729af92004-05-03 20:45:30 +00002910 ## Checking Image at 40200000 ...
2911 Image Name: Simple Ramdisk Image
2912 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2913 Data Size: 566530 Bytes = 553 kB = 0 MB
2914 Load Address: 00000000
2915 Entry Point: 00000000
2916 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00002917
wdenk2729af92004-05-03 20:45:30 +00002918 => bootm 40100000 40200000
2919 ## Booting Linux kernel at 40100000 ...
2920 Image Name: 2.2.13 for initrd on TQM850L
2921 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2922 Data Size: 335725 Bytes = 327 kB = 0 MB
2923 Load Address: 00000000
2924 Entry Point: 0000000c
2925 Verifying Checksum ... OK
2926 Uncompressing Kernel Image ... OK
2927 ## Loading RAMDisk Image at 40200000 ...
2928 Image Name: Simple Ramdisk Image
2929 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2930 Data Size: 566530 Bytes = 553 kB = 0 MB
2931 Load Address: 00000000
2932 Entry Point: 00000000
2933 Verifying Checksum ... OK
2934 Loading Ramdisk ... OK
2935 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
2936 Boot arguments: root=/dev/ram
2937 time_init: decrementer frequency = 187500000/60
2938 Calibrating delay loop... 49.77 BogoMIPS
2939 ...
2940 RAMDISK: Compressed image found at block 0
2941 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00002942
wdenk2729af92004-05-03 20:45:30 +00002943 bash#
wdenkc6097192002-11-03 00:24:07 +00002944
wdenk2729af92004-05-03 20:45:30 +00002945More About U-Boot Image Types:
2946------------------------------
wdenk6069ff22003-02-28 00:49:47 +00002947
wdenk2729af92004-05-03 20:45:30 +00002948U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00002949
wdenk2729af92004-05-03 20:45:30 +00002950 "Standalone Programs" are directly runnable in the environment
2951 provided by U-Boot; it is expected that (if they behave
2952 well) you can continue to work in U-Boot after return from
2953 the Standalone Program.
2954 "OS Kernel Images" are usually images of some Embedded OS which
2955 will take over control completely. Usually these programs
2956 will install their own set of exception handlers, device
2957 drivers, set up the MMU, etc. - this means, that you cannot
2958 expect to re-enter U-Boot except by resetting the CPU.
2959 "RAMDisk Images" are more or less just data blocks, and their
2960 parameters (address, size) are passed to an OS kernel that is
2961 being started.
2962 "Multi-File Images" contain several images, typically an OS
2963 (Linux) kernel image and one or more data images like
2964 RAMDisks. This construct is useful for instance when you want
2965 to boot over the network using BOOTP etc., where the boot
2966 server provides just a single image file, but you want to get
2967 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00002968
wdenk2729af92004-05-03 20:45:30 +00002969 "Multi-File Images" start with a list of image sizes, each
2970 image size (in bytes) specified by an "uint32_t" in network
2971 byte order. This list is terminated by an "(uint32_t)0".
2972 Immediately after the terminating 0 follow the images, one by
2973 one, all aligned on "uint32_t" boundaries (size rounded up to
2974 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00002975
wdenk2729af92004-05-03 20:45:30 +00002976 "Firmware Images" are binary images containing firmware (like
2977 U-Boot or FPGA images) which usually will be programmed to
2978 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00002979
wdenk2729af92004-05-03 20:45:30 +00002980 "Script files" are command sequences that will be executed by
2981 U-Boot's command interpreter; this feature is especially
2982 useful when you configure U-Boot to use a real shell (hush)
2983 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00002984
wdenkc6097192002-11-03 00:24:07 +00002985
wdenk2729af92004-05-03 20:45:30 +00002986Standalone HOWTO:
2987=================
wdenkc6097192002-11-03 00:24:07 +00002988
wdenk2729af92004-05-03 20:45:30 +00002989One of the features of U-Boot is that you can dynamically load and
2990run "standalone" applications, which can use some resources of
2991U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00002992
wdenk2729af92004-05-03 20:45:30 +00002993Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00002994
wdenk2729af92004-05-03 20:45:30 +00002995"Hello World" Demo:
2996-------------------
wdenkc6097192002-11-03 00:24:07 +00002997
wdenk2729af92004-05-03 20:45:30 +00002998'examples/hello_world.c' contains a small "Hello World" Demo
2999application; it is automatically compiled when you build U-Boot.
3000It's configured to run at address 0x00040004, so you can play with it
3001like that:
wdenkc6097192002-11-03 00:24:07 +00003002
wdenk2729af92004-05-03 20:45:30 +00003003 => loads
3004 ## Ready for S-Record download ...
3005 ~>examples/hello_world.srec
3006 1 2 3 4 5 6 7 8 9 10 11 ...
3007 [file transfer complete]
3008 [connected]
3009 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003010
wdenk2729af92004-05-03 20:45:30 +00003011 => go 40004 Hello World! This is a test.
3012 ## Starting application at 0x00040004 ...
3013 Hello World
3014 argc = 7
3015 argv[0] = "40004"
3016 argv[1] = "Hello"
3017 argv[2] = "World!"
3018 argv[3] = "This"
3019 argv[4] = "is"
3020 argv[5] = "a"
3021 argv[6] = "test."
3022 argv[7] = "<NULL>"
3023 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003024
wdenk2729af92004-05-03 20:45:30 +00003025 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003026
wdenk2729af92004-05-03 20:45:30 +00003027Another example, which demonstrates how to register a CPM interrupt
3028handler with the U-Boot code, can be found in 'examples/timer.c'.
3029Here, a CPM timer is set up to generate an interrupt every second.
3030The interrupt service routine is trivial, just printing a '.'
3031character, but this is just a demo program. The application can be
3032controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003033
wdenk2729af92004-05-03 20:45:30 +00003034 ? - print current values og the CPM Timer registers
3035 b - enable interrupts and start timer
3036 e - stop timer and disable interrupts
3037 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003038
wdenk2729af92004-05-03 20:45:30 +00003039 => loads
3040 ## Ready for S-Record download ...
3041 ~>examples/timer.srec
3042 1 2 3 4 5 6 7 8 9 10 11 ...
3043 [file transfer complete]
3044 [connected]
3045 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003046
wdenk2729af92004-05-03 20:45:30 +00003047 => go 40004
3048 ## Starting application at 0x00040004 ...
3049 TIMERS=0xfff00980
3050 Using timer 1
3051 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003052
wdenk2729af92004-05-03 20:45:30 +00003053Hit 'b':
3054 [q, b, e, ?] Set interval 1000000 us
3055 Enabling timer
3056Hit '?':
3057 [q, b, e, ?] ........
3058 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3059Hit '?':
3060 [q, b, e, ?] .
3061 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3062Hit '?':
3063 [q, b, e, ?] .
3064 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3065Hit '?':
3066 [q, b, e, ?] .
3067 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3068Hit 'e':
3069 [q, b, e, ?] ...Stopping timer
3070Hit 'q':
3071 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003072
3073
wdenk2729af92004-05-03 20:45:30 +00003074Minicom warning:
3075================
wdenk85ec0bc2003-03-31 16:34:49 +00003076
wdenk2729af92004-05-03 20:45:30 +00003077Over time, many people have reported problems when trying to use the
3078"minicom" terminal emulation program for serial download. I (wd)
3079consider minicom to be broken, and recommend not to use it. Under
3080Unix, I recommend to use C-Kermit for general purpose use (and
3081especially for kermit binary protocol download ("loadb" command), and
3082use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003083
wdenk2729af92004-05-03 20:45:30 +00003084Nevertheless, if you absolutely want to use it try adding this
3085configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003086
wdenk2729af92004-05-03 20:45:30 +00003087 Name Program Name U/D FullScr IO-Red. Multi
3088 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3089 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003090
3091
wdenk2729af92004-05-03 20:45:30 +00003092NetBSD Notes:
3093=============
wdenkc6097192002-11-03 00:24:07 +00003094
wdenk2729af92004-05-03 20:45:30 +00003095Starting at version 0.9.2, U-Boot supports NetBSD both as host
3096(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003097
wdenk2729af92004-05-03 20:45:30 +00003098Building requires a cross environment; it is known to work on
3099NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3100need gmake since the Makefiles are not compatible with BSD make).
3101Note that the cross-powerpc package does not install include files;
3102attempting to build U-Boot will fail because <machine/ansi.h> is
3103missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003104
wdenk2729af92004-05-03 20:45:30 +00003105 # cd /usr/pkg/cross/powerpc-netbsd/include
3106 # mkdir powerpc
3107 # ln -s powerpc machine
3108 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3109 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003110
wdenk2729af92004-05-03 20:45:30 +00003111Native builds *don't* work due to incompatibilities between native
3112and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003113
wdenk2729af92004-05-03 20:45:30 +00003114Booting assumes that (the first part of) the image booted is a
3115stage-2 loader which in turn loads and then invokes the kernel
3116proper. Loader sources will eventually appear in the NetBSD source
3117tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003118meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003119
3120
wdenk2729af92004-05-03 20:45:30 +00003121Implementation Internals:
3122=========================
wdenkc6097192002-11-03 00:24:07 +00003123
wdenk2729af92004-05-03 20:45:30 +00003124The following is not intended to be a complete description of every
3125implementation detail. However, it should help to understand the
3126inner workings of U-Boot and make it easier to port it to custom
3127hardware.
wdenkc6097192002-11-03 00:24:07 +00003128
3129
wdenk2729af92004-05-03 20:45:30 +00003130Initial Stack, Global Data:
3131---------------------------
wdenkc6097192002-11-03 00:24:07 +00003132
wdenk2729af92004-05-03 20:45:30 +00003133The implementation of U-Boot is complicated by the fact that U-Boot
3134starts running out of ROM (flash memory), usually without access to
3135system RAM (because the memory controller is not initialized yet).
3136This means that we don't have writable Data or BSS segments, and BSS
3137is not initialized as zero. To be able to get a C environment working
3138at all, we have to allocate at least a minimal stack. Implementation
3139options for this are defined and restricted by the CPU used: Some CPU
3140models provide on-chip memory (like the IMMR area on MPC8xx and
3141MPC826x processors), on others (parts of) the data cache can be
3142locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003143
wdenk2729af92004-05-03 20:45:30 +00003144 Chris Hallinan posted a good summary of these issues to the
3145 u-boot-users mailing list:
wdenk43d96162003-03-06 00:02:04 +00003146
wdenk2729af92004-05-03 20:45:30 +00003147 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3148 From: "Chris Hallinan" <clh@net1plus.com>
3149 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3150 ...
wdenk43d96162003-03-06 00:02:04 +00003151
wdenk2729af92004-05-03 20:45:30 +00003152 Correct me if I'm wrong, folks, but the way I understand it
3153 is this: Using DCACHE as initial RAM for Stack, etc, does not
3154 require any physical RAM backing up the cache. The cleverness
3155 is that the cache is being used as a temporary supply of
3156 necessary storage before the SDRAM controller is setup. It's
3157 beyond the scope of this list to expain the details, but you
3158 can see how this works by studying the cache architecture and
3159 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003160
wdenk2729af92004-05-03 20:45:30 +00003161 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3162 is another option for the system designer to use as an
3163 initial stack/ram area prior to SDRAM being available. Either
3164 option should work for you. Using CS 4 should be fine if your
3165 board designers haven't used it for something that would
3166 cause you grief during the initial boot! It is frequently not
3167 used.
wdenk43d96162003-03-06 00:02:04 +00003168
wdenk2729af92004-05-03 20:45:30 +00003169 CFG_INIT_RAM_ADDR should be somewhere that won't interfere
3170 with your processor/board/system design. The default value
3171 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003172 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003173 than your SDRAM module. If you have a 64MB SDRAM module, set
3174 it above 400_0000. Just make sure your board has no resources
3175 that are supposed to respond to that address! That code in
3176 start.S has been around a while and should work as is when
3177 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003178
wdenk2729af92004-05-03 20:45:30 +00003179 -Chris Hallinan
3180 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003181
wdenk2729af92004-05-03 20:45:30 +00003182It is essential to remember this, since it has some impact on the C
3183code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003184
wdenk2729af92004-05-03 20:45:30 +00003185* Initialized global data (data segment) is read-only. Do not attempt
3186 to write it.
wdenkc6097192002-11-03 00:24:07 +00003187
wdenk2729af92004-05-03 20:45:30 +00003188* Do not use any unitialized global data (or implicitely initialized
3189 as zero data - BSS segment) at all - this is undefined, initiali-
3190 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003191
wdenk2729af92004-05-03 20:45:30 +00003192* Stack space is very limited. Avoid big data buffers or things like
3193 that.
wdenkc6097192002-11-03 00:24:07 +00003194
wdenk2729af92004-05-03 20:45:30 +00003195Having only the stack as writable memory limits means we cannot use
3196normal global data to share information beween the code. But it
3197turned out that the implementation of U-Boot can be greatly
3198simplified by making a global data structure (gd_t) available to all
3199functions. We could pass a pointer to this data as argument to _all_
3200functions, but this would bloat the code. Instead we use a feature of
3201the GCC compiler (Global Register Variables) to share the data: we
3202place a pointer (gd) to the global data into a register which we
3203reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003204
wdenk2729af92004-05-03 20:45:30 +00003205When choosing a register for such a purpose we are restricted by the
3206relevant (E)ABI specifications for the current architecture, and by
3207GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003208
wdenk2729af92004-05-03 20:45:30 +00003209For PowerPC, the following registers have specific use:
3210 R1: stack pointer
3211 R2: TOC pointer
3212 R3-R4: parameter passing and return values
3213 R5-R10: parameter passing
3214 R13: small data area pointer
3215 R30: GOT pointer
3216 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003217
wdenk2729af92004-05-03 20:45:30 +00003218 (U-Boot also uses R14 as internal GOT pointer.)
wdenkc6097192002-11-03 00:24:07 +00003219
wdenk2729af92004-05-03 20:45:30 +00003220 ==> U-Boot will use R29 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003221
wdenk2729af92004-05-03 20:45:30 +00003222 Note: on PPC, we could use a static initializer (since the
3223 address of the global data structure is known at compile time),
3224 but it turned out that reserving a register results in somewhat
3225 smaller code - although the code savings are not that big (on
3226 average for all boards 752 bytes for the whole U-Boot image,
3227 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003228
wdenk2729af92004-05-03 20:45:30 +00003229On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003230
wdenk2729af92004-05-03 20:45:30 +00003231 R0: function argument word/integer result
3232 R1-R3: function argument word
3233 R9: GOT pointer
3234 R10: stack limit (used only if stack checking if enabled)
3235 R11: argument (frame) pointer
3236 R12: temporary workspace
3237 R13: stack pointer
3238 R14: link register
3239 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003240
wdenk2729af92004-05-03 20:45:30 +00003241 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003242
3243
wdenk2729af92004-05-03 20:45:30 +00003244Memory Management:
3245------------------
wdenkc6097192002-11-03 00:24:07 +00003246
wdenk2729af92004-05-03 20:45:30 +00003247U-Boot runs in system state and uses physical addresses, i.e. the
3248MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003249
wdenk2729af92004-05-03 20:45:30 +00003250The available memory is mapped to fixed addresses using the memory
3251controller. In this process, a contiguous block is formed for each
3252memory type (Flash, SDRAM, SRAM), even when it consists of several
3253physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003254
wdenk2729af92004-05-03 20:45:30 +00003255U-Boot is installed in the first 128 kB of the first Flash bank (on
3256TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3257booting and sizing and initializing DRAM, the code relocates itself
3258to the upper end of DRAM. Immediately below the U-Boot code some
3259memory is reserved for use by malloc() [see CFG_MALLOC_LEN
3260configuration setting]. Below that, a structure with global Board
3261Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003262
wdenk2729af92004-05-03 20:45:30 +00003263Additionally, some exception handler code is copied to the low 8 kB
3264of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003265
wdenk2729af92004-05-03 20:45:30 +00003266So a typical memory configuration with 16 MB of DRAM could look like
3267this:
wdenkc6097192002-11-03 00:24:07 +00003268
wdenk2729af92004-05-03 20:45:30 +00003269 0x0000 0000 Exception Vector code
3270 :
3271 0x0000 1FFF
3272 0x0000 2000 Free for Application Use
3273 :
3274 :
wdenkc6097192002-11-03 00:24:07 +00003275
wdenk2729af92004-05-03 20:45:30 +00003276 :
3277 :
3278 0x00FB FF20 Monitor Stack (Growing downward)
3279 0x00FB FFAC Board Info Data and permanent copy of global data
3280 0x00FC 0000 Malloc Arena
3281 :
3282 0x00FD FFFF
3283 0x00FE 0000 RAM Copy of Monitor Code
3284 ... eventually: LCD or video framebuffer
3285 ... eventually: pRAM (Protected RAM - unchanged by reset)
3286 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00003287
3288
wdenk2729af92004-05-03 20:45:30 +00003289System Initialization:
3290----------------------
wdenkc6097192002-11-03 00:24:07 +00003291
wdenk2729af92004-05-03 20:45:30 +00003292In the reset configuration, U-Boot starts at the reset entry point
3293(on most PowerPC systens at address 0x00000100). Because of the reset
3294configuration for CS0# this is a mirror of the onboard Flash memory.
3295To be able to re-map memory U-Boot then jumps to its link address.
3296To be able to implement the initialization code in C, a (small!)
3297initial stack is set up in the internal Dual Ported RAM (in case CPUs
3298which provide such a feature like MPC8xx or MPC8260), or in a locked
3299part of the data cache. After that, U-Boot initializes the CPU core,
3300the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00003301
wdenk2729af92004-05-03 20:45:30 +00003302Next, all (potentially) available memory banks are mapped using a
3303preliminary mapping. For example, we put them on 512 MB boundaries
3304(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3305on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3306programmed for SDRAM access. Using the temporary configuration, a
3307simple memory test is run that determines the size of the SDRAM
3308banks.
wdenkc6097192002-11-03 00:24:07 +00003309
wdenk2729af92004-05-03 20:45:30 +00003310When there is more than one SDRAM bank, and the banks are of
3311different size, the largest is mapped first. For equal size, the first
3312bank (CS2#) is mapped first. The first mapping is always for address
33130x00000000, with any additional banks following immediately to create
3314contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00003315
wdenk2729af92004-05-03 20:45:30 +00003316Then, the monitor installs itself at the upper end of the SDRAM area
3317and allocates memory for use by malloc() and for the global Board
3318Info data; also, the exception vector code is copied to the low RAM
3319pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00003320
wdenk2729af92004-05-03 20:45:30 +00003321Only after this relocation will you have a "normal" C environment;
3322until that you are restricted in several ways, mostly because you are
3323running from ROM, and because the code will have to be relocated to a
3324new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00003325
3326
wdenk2729af92004-05-03 20:45:30 +00003327U-Boot Porting Guide:
3328----------------------
wdenkc6097192002-11-03 00:24:07 +00003329
wdenk2729af92004-05-03 20:45:30 +00003330[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3331list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00003332
3333
wdenk2729af92004-05-03 20:45:30 +00003334int main (int argc, char *argv[])
3335{
3336 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00003337
wdenk2729af92004-05-03 20:45:30 +00003338 signal (SIGALRM, no_more_time);
3339 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00003340
wdenk2729af92004-05-03 20:45:30 +00003341 if (available_money > available_manpower) {
3342 pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00003343 return 0;
3344 }
3345
wdenk2729af92004-05-03 20:45:30 +00003346 Download latest U-Boot source;
3347
3348 Subscribe to u-boot-users mailing list;
3349
3350 if (clueless) {
3351 email ("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00003352 }
3353
wdenk2729af92004-05-03 20:45:30 +00003354 while (learning) {
3355 Read the README file in the top level directory;
3356 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3357 Read the source, Luke;
3358 }
wdenkc6097192002-11-03 00:24:07 +00003359
wdenk2729af92004-05-03 20:45:30 +00003360 if (available_money > toLocalCurrency ($2500)) {
3361 Buy a BDI2000;
3362 } else {
3363 Add a lot of aggravation and time;
3364 }
wdenkc6097192002-11-03 00:24:07 +00003365
wdenk2729af92004-05-03 20:45:30 +00003366 Create your own board support subdirectory;
wdenkc6097192002-11-03 00:24:07 +00003367
wdenk2729af92004-05-03 20:45:30 +00003368 Create your own board config file;
wdenk6aff3112002-12-17 01:51:00 +00003369
wdenk2729af92004-05-03 20:45:30 +00003370 while (!running) {
3371 do {
3372 Add / modify source code;
3373 } until (compiles);
3374 Debug;
3375 if (clueless)
3376 email ("Hi, I am having problems...");
3377 }
3378 Send patch file to Wolfgang;
wdenkc6097192002-11-03 00:24:07 +00003379
wdenk2729af92004-05-03 20:45:30 +00003380 return 0;
3381}
3382
3383void no_more_time (int sig)
3384{
3385 hire_a_guru();
3386}
wdenkc6097192002-11-03 00:24:07 +00003387
3388
wdenk2729af92004-05-03 20:45:30 +00003389Coding Standards:
3390-----------------
wdenkc6097192002-11-03 00:24:07 +00003391
wdenk2729af92004-05-03 20:45:30 +00003392All contributions to U-Boot should conform to the Linux kernel
3393coding style; see the file "Documentation/CodingStyle" in your Linux
3394kernel source directory.
3395
3396Please note that U-Boot is implemented in C (and to some small parts
3397in Assembler); no C++ is used, so please do not use C++ style
3398comments (//) in your code.
3399
3400Please also stick to the following formatting rules:
3401- remove any trailing white space
3402- use TAB characters for indentation, not spaces
3403- make sure NOT to use DOS '\r\n' line feeds
3404- do not add more than 2 empty lines to source files
3405- do not add trailing empty lines to source files
3406
3407Submissions which do not conform to the standards may be returned
3408with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00003409
3410
wdenk2729af92004-05-03 20:45:30 +00003411Submitting Patches:
3412-------------------
wdenkc6097192002-11-03 00:24:07 +00003413
wdenk2729af92004-05-03 20:45:30 +00003414Since the number of patches for U-Boot is growing, we need to
3415establish some rules. Submissions which do not conform to these rules
3416may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00003417
wdenk90dc6702005-05-03 14:12:25 +00003418Patches shall be sent to the u-boot-users mailing list.
wdenkc6097192002-11-03 00:24:07 +00003419
wdenk2729af92004-05-03 20:45:30 +00003420When you send a patch, please include the following information with
3421it:
wdenkc6097192002-11-03 00:24:07 +00003422
wdenk2729af92004-05-03 20:45:30 +00003423* For bug fixes: a description of the bug and how your patch fixes
3424 this bug. Please try to include a way of demonstrating that the
3425 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00003426
wdenk2729af92004-05-03 20:45:30 +00003427* For new features: a description of the feature and your
3428 implementation.
wdenkc6097192002-11-03 00:24:07 +00003429
wdenk2729af92004-05-03 20:45:30 +00003430* A CHANGELOG entry as plaintext (separate from the patch)
3431
3432* For major contributions, your entry to the CREDITS file
3433
3434* When you add support for a new board, don't forget to add this
3435 board to the MAKEALL script, too.
3436
3437* If your patch adds new configuration options, don't forget to
3438 document these in the README file.
3439
3440* The patch itself. If you are accessing the CVS repository use "cvs
3441 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3442 version of diff does not support these options, then get the latest
3443 version of GNU diff.
3444
3445 The current directory when running this command shall be the top
3446 level directory of the U-Boot source tree, or it's parent directory
3447 (i. e. please make sure that your patch includes sufficient
3448 directory information for the affected files).
3449
3450 We accept patches as plain text, MIME attachments or as uuencoded
3451 gzipped text.
3452
3453* If one logical set of modifications affects or creates several
3454 files, all these changes shall be submitted in a SINGLE patch file.
3455
3456* Changesets that contain different, unrelated modifications shall be
3457 submitted as SEPARATE patches, one patch per changeset.
3458
3459
3460Notes:
3461
3462* Before sending the patch, run the MAKEALL script on your patched
3463 source tree and make sure that no errors or warnings are reported
3464 for any of the boards.
3465
3466* Keep your modifications to the necessary minimum: A patch
3467 containing several unrelated changes or arbitrary reformats will be
3468 returned with a request to re-formatting / split it.
3469
3470* If you modify existing code, make sure that your new code does not
3471 add to the memory footprint of the code ;-) Small is beautiful!
3472 When adding new features, these should compile conditionally only
3473 (using #ifdef), and the resulting code with the new feature
3474 disabled must not need more memory than the old code without your
3475 modification.
wdenk90dc6702005-05-03 14:12:25 +00003476
3477* Remember that there is a size limit of 40 kB per message on the
3478 u-boot-users mailing list. Compression may help.