]> git.ipfire.org Git - people/ms/u-boot.git/blame - README
mtd: nand: use loff_t for offset
[people/ms/u-boot.git] / README
CommitLineData
c609719b 1#
218ca724 2# (C) Copyright 2000 - 2008
c609719b
WD
3# 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
24ee89b9 27This directory contains the source code for U-Boot, a boot loader for
e86e5a07
WD
28Embedded 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.
c609719b
WD
32
33The development of U-Boot is closely related to Linux: some parts of
24ee89b9
WD
34the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
c609719b
WD
36support 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
24ee89b9 50Makefile have been tested to some extent and can be considered
c609719b
WD
51"working". In fact, many of them are used in production systems.
52
24ee89b9 53In case of problems see the CHANGELOG and CREDITS files to find out
218ca724
WD
54who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
c609719b 56
c609719b
WD
57
58Where to get help:
59==================
60
24ee89b9
WD
61In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
0c32565f
PT
63<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
c609719b
WD
67
68
218ca724
WD
69Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
11ccc33f 77any version you might be interested in. Official releases are also
218ca724
WD
78available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
d4ee711d 81Pre-built (and tested) images are available from
218ca724
WD
82ftp://ftp.denx.de/pub/u-boot/images/
83
84
c609719b
WD
85Where we come from:
86===================
87
88- start from 8xxrom sources
24ee89b9 89- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
c609719b
WD
90- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
11ccc33f 97 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
24ee89b9 98- create ARMBoot project (http://sourceforge.net/projects/armboot)
c609719b 99- add other CPU families (starting with ARM)
24ee89b9 100- create U-Boot project (http://sourceforge.net/projects/u-boot)
0d28f34b 101- current project page: see http://www.denx.de/wiki/U-Boot
24ee89b9
WD
102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
c609719b
WD
124
125
93f19cc0
WD
126Versioning:
127===========
128
129U-Boot uses a 3 level version number containing a version, a
130sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
131sub-version "34", and patchlevel "4".
132
133The patchlevel is used to indicate certain stages of development
134between released versions, i. e. officially released versions of
135U-Boot will always have a patchlevel of "0".
136
137
c609719b
WD
138Directory Hierarchy:
139====================
140
7152b1d0
WD
141- board Board dependent files
142- common Misc architecture independent functions
c609719b 143- cpu CPU specific files
983fda83 144 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
11dadd54
WD
145 - arm720t Files specific to ARM 720 CPUs
146 - arm920t Files specific to ARM 920 CPUs
a85f9f21 147 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
983fda83 148 - imx Files specific to Freescale MC9328 i.MX CPUs
1d9f4105 149 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
11dadd54
WD
150 - arm925t Files specific to ARM 925 CPUs
151 - arm926ejs Files specific to ARM 926 CPUs
8ed96046 152 - arm1136 Files specific to ARM 1136 CPUs
72a087e0 153 - at32ap Files specific to Atmel AVR32 AP CPUs
adbfeeb7 154 - blackfin Files specific to Analog Devices Blackfin CPUs
11dadd54
WD
155 - i386 Files specific to i386 CPUs
156 - ixp Files specific to Intel XScale IXP CPUs
b330990c 157 - leon2 Files specific to Gaisler LEON2 SPARC CPU
1e9a164e 158 - leon3 Files specific to Gaisler LEON3 SPARC CPU
983fda83 159 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
1552af70 160 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
8e585f02 161 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
8ae158cd 162 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
57a12720 163 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
11dadd54 164 - mips Files specific to MIPS CPUs
983fda83
WD
165 - mpc5xx Files specific to Freescale MPC5xx CPUs
166 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
167 - mpc8xx Files specific to Freescale MPC8xx CPUs
168 - mpc8220 Files specific to Freescale MPC8220 CPUs
169 - mpc824x Files specific to Freescale MPC824x CPUs
170 - mpc8260 Files specific to Freescale MPC8260 CPUs
171 - mpc85xx Files specific to Freescale MPC85xx CPUs
11dadd54 172 - nios Files specific to Altera NIOS CPUs
5c952cf0 173 - nios2 Files specific to Altera Nios-II CPUs
0c8721a4 174 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
11dadd54
WD
175 - pxa Files specific to Intel XScale PXA CPUs
176 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
177 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
c609719b
WD
178- disk Code for disk drive partition handling
179- doc Documentation (don't expect too much)
7152b1d0 180- drivers Commonly used device drivers
c609719b
WD
181- dtt Digital Thermometer and Thermostat drivers
182- examples Example code for standalone applications, etc.
183- include Header Files
11dadd54 184- lib_arm Files generic to ARM architecture
7b64fef3 185- lib_avr32 Files generic to AVR32 architecture
adbfeeb7 186- lib_blackfin Files generic to Blackfin architecture
11dadd54
WD
187- lib_generic Files generic to all architectures
188- lib_i386 Files generic to i386 architecture
189- lib_m68k Files generic to m68k architecture
190- lib_mips Files generic to MIPS architecture
191- lib_nios Files generic to NIOS architecture
192- lib_ppc Files generic to PowerPC architecture
c2f02da2 193- lib_sparc Files generic to SPARC architecture
218ca724 194- libfdt Library files to support flattened device trees
c609719b 195- net Networking code
c609719b 196- post Power On Self Test
c609719b
WD
197- rtc Real Time Clock drivers
198- tools Tools to build S-Record or U-Boot images, etc.
199
c609719b
WD
200Software Configuration:
201=======================
202
203Configuration is usually done using C preprocessor defines; the
204rationale behind that is to avoid dead code whenever possible.
205
206There are two classes of configuration variables:
207
208* Configuration _OPTIONS_:
209 These are selectable by the user and have names beginning with
210 "CONFIG_".
211
212* Configuration _SETTINGS_:
213 These depend on the hardware etc. and should not be meddled with if
214 you don't know what you're doing; they have names beginning with
6d0f6bcf 215 "CONFIG_SYS_".
c609719b
WD
216
217Later we will add a configuration tool - probably similar to or even
218identical to what's used for the Linux kernel. Right now, we have to
219do the configuration by hand, which means creating some symbolic
220links and editing some configuration files. We use the TQM8xxL boards
221as an example here.
222
223
224Selection of Processor Architecture and Board Type:
225---------------------------------------------------
226
227For all supported boards there are ready-to-use default
228configurations available; just type "make <board_name>_config".
229
230Example: For a TQM823L module type:
231
232 cd u-boot
233 make TQM823L_config
234
11ccc33f 235For the Cogent platform, you need to specify the CPU type as well;
c609719b
WD
236e.g. "make cogent_mpc8xx_config". And also configure the cogent
237directory according to the instructions in cogent/README.
238
239
240Configuration Options:
241----------------------
242
243Configuration depends on the combination of board and CPU type; all
244such information is kept in a configuration file
245"include/configs/<board_name>.h".
246
247Example: For a TQM823L module, all configuration settings are in
248"include/configs/TQM823L.h".
249
250
7f6c2cbc
WD
251Many of the options are named exactly as the corresponding Linux
252kernel configuration options. The intention is to make it easier to
253build a config tool - later.
254
255
c609719b
WD
256The following options need to be configured:
257
2628114e
KP
258- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
259
260- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec449
WD
261
262- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
09ea0de0 263 Define exactly one, e.g. CONFIG_ATSTK1002
c609719b
WD
264
265- CPU Module Type: (if CONFIG_COGENT is defined)
266 Define exactly one of
267 CONFIG_CMA286_60_OLD
268--- FIXME --- not tested yet:
269 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
270 CONFIG_CMA287_23, CONFIG_CMA287_50
271
272- Motherboard Type: (if CONFIG_COGENT is defined)
273 Define exactly one of
274 CONFIG_CMA101, CONFIG_CMA102
275
276- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
277 Define one or more of
278 CONFIG_CMA302
279
280- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
281 Define one or more of
282 CONFIG_LCD_HEARTBEAT - update a character position on
11ccc33f 283 the LCD display every second with
c609719b
WD
284 a "rotator" |\-/|\-/
285
2535d602
WD
286- Board flavour: (if CONFIG_MPC8260ADS is defined)
287 CONFIG_ADSTYPE
288 Possible values are:
6d0f6bcf
JCPV
289 CONFIG_SYS_8260ADS - original MPC8260ADS
290 CONFIG_SYS_8266ADS - MPC8266ADS
291 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
292 CONFIG_SYS_8272ADS - MPC8272ADS
2535d602 293
c609719b 294- MPC824X Family Member (if CONFIG_MPC824X is defined)
5da627a4
WD
295 Define exactly one of
296 CONFIG_MPC8240, CONFIG_MPC8245
c609719b 297
11ccc33f 298- 8xx CPU Options: (if using an MPC8xx CPU)
66ca92a5
WD
299 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
300 get_gclk_freq() cannot work
5da627a4
WD
301 e.g. if there is no 32KHz
302 reference PIT/RTC clock
66ca92a5
WD
303 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
304 or XTAL/EXTAL)
c609719b 305
66ca92a5 306- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
6d0f6bcf
JCPV
307 CONFIG_SYS_8xx_CPUCLK_MIN
308 CONFIG_SYS_8xx_CPUCLK_MAX
66ca92a5 309 CONFIG_8xx_CPUCLK_DEFAULT
75d1ea7f
WD
310 See doc/README.MPC866
311
6d0f6bcf 312 CONFIG_SYS_MEASURE_CPUCLK
75d1ea7f 313
ba56f625
WD
314 Define this to measure the actual CPU clock instead
315 of relying on the correctness of the configured
316 values. Mostly useful for board bringup to make sure
317 the PLL is locked at the intended frequency. Note
318 that this requires a (stable) reference clock (32 kHz
6d0f6bcf 319 RTC clock or CONFIG_SYS_8XX_XIN)
75d1ea7f 320
506f3918
HS
321 CONFIG_SYS_DELAYED_ICACHE
322
323 Define this option if you want to enable the
324 ICache only when Code runs from RAM.
325
0b953ffc 326- Intel Monahans options:
6d0f6bcf 327 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
0b953ffc
MK
328
329 Defines the Monahans run mode to oscillator
330 ratio. Valid values are 8, 16, 24, 31. The core
331 frequency is this value multiplied by 13 MHz.
332
6d0f6bcf 333 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
cf48eb9a 334
0b953ffc
MK
335 Defines the Monahans turbo mode to oscillator
336 ratio. Valid values are 1 (default if undefined) and
cf48eb9a 337 2. The core frequency as calculated above is multiplied
0b953ffc 338 by this value.
cf48eb9a 339
5da627a4 340- Linux Kernel Interface:
c609719b
WD
341 CONFIG_CLOCKS_IN_MHZ
342
343 U-Boot stores all clock information in Hz
344 internally. For binary compatibility with older Linux
345 kernels (which expect the clocks passed in the
346 bd_info data to be in MHz) the environment variable
347 "clocks_in_mhz" can be defined so that U-Boot
348 converts clock data to MHZ before passing it to the
349 Linux kernel.
c609719b 350 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
218ca724 351 "clocks_in_mhz=1" is automatically included in the
c609719b
WD
352 default environment.
353
5da627a4
WD
354 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
355
11ccc33f 356 When transferring memsize parameter to linux, some versions
5da627a4
WD
357 expect it to be in bytes, others in MB.
358 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
359
fec6d9ee 360 CONFIG_OF_LIBFDT
f57f70aa
WD
361
362 New kernel versions are expecting firmware settings to be
213bf8c8
GVB
363 passed using flattened device trees (based on open firmware
364 concepts).
365
366 CONFIG_OF_LIBFDT
367 * New libfdt-based support
368 * Adds the "fdt" command
3bb342fc 369 * The bootm command automatically updates the fdt
213bf8c8 370
f57f70aa 371 OF_CPU - The proper name of the cpus node.
c2871f03 372 OF_SOC - The proper name of the soc node.
f57f70aa 373 OF_TBCLK - The timebase frequency.
c2871f03 374 OF_STDOUT_PATH - The path to the console device
f57f70aa 375
11ccc33f
MZ
376 boards with QUICC Engines require OF_QE to set UCC MAC
377 addresses
3bb342fc 378
4e253137
KG
379 CONFIG_OF_BOARD_SETUP
380
381 Board code has addition modification that it wants to make
382 to the flat device tree before handing it off to the kernel
f57f70aa 383
0267768e
MM
384 CONFIG_OF_BOOT_CPU
385
11ccc33f 386 This define fills in the correct boot CPU in the boot
0267768e
MM
387 param header, the default value is zero if undefined.
388
0b2f4eca
NG
389- vxWorks boot parameters:
390
391 bootvx constructs a valid bootline using the following
392 environments variables: bootfile, ipaddr, serverip, hostname.
393 It loads the vxWorks image pointed bootfile.
394
395 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
396 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
397 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
398 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
399
400 CONFIG_SYS_VXWORKS_ADD_PARAMS
401
402 Add it at the end of the bootline. E.g "u=username pw=secret"
403
404 Note: If a "bootargs" environment is defined, it will overwride
405 the defaults discussed just above.
406
6705d81e 407- Serial Ports:
48d0192f 408 CONFIG_PL010_SERIAL
6705d81e
WD
409
410 Define this if you want support for Amba PrimeCell PL010 UARTs.
411
48d0192f 412 CONFIG_PL011_SERIAL
6705d81e
WD
413
414 Define this if you want support for Amba PrimeCell PL011 UARTs.
415
416 CONFIG_PL011_CLOCK
417
418 If you have Amba PrimeCell PL011 UARTs, set this variable to
419 the clock speed of the UARTs.
420
421 CONFIG_PL01x_PORTS
422
423 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
424 define this to a list of base addresses for each (supported)
425 port. See e.g. include/configs/versatile.h
426
427
c609719b 428- Console Interface:
43d9616c
WD
429 Depending on board, define exactly one serial port
430 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
431 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
432 console by defining CONFIG_8xx_CONS_NONE
c609719b
WD
433
434 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
435 port routines must be defined elsewhere
436 (i.e. serial_init(), serial_getc(), ...)
437
438 CONFIG_CFB_CONSOLE
439 Enables console device for a color framebuffer. Needs following
440 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
441 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
442 (default big endian)
443 VIDEO_HW_RECTFILL graphic chip supports
444 rectangle fill
445 (cf. smiLynxEM)
446 VIDEO_HW_BITBLT graphic chip supports
447 bit-blit (cf. smiLynxEM)
448 VIDEO_VISIBLE_COLS visible pixel columns
449 (cols=pitch)
ba56f625
WD
450 VIDEO_VISIBLE_ROWS visible pixel rows
451 VIDEO_PIXEL_SIZE bytes per pixel
c609719b
WD
452 VIDEO_DATA_FORMAT graphic data format
453 (0-5, cf. cfb_console.c)
ba56f625 454 VIDEO_FB_ADRS framebuffer address
c609719b
WD
455 VIDEO_KBD_INIT_FCT keyboard int fct
456 (i.e. i8042_kbd_init())
457 VIDEO_TSTC_FCT test char fct
458 (i.e. i8042_tstc)
459 VIDEO_GETC_FCT get char fct
460 (i.e. i8042_getc)
461 CONFIG_CONSOLE_CURSOR cursor drawing on/off
462 (requires blink timer
463 cf. i8042.c)
6d0f6bcf 464 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
c609719b
WD
465 CONFIG_CONSOLE_TIME display time/date info in
466 upper right corner
602ad3b3 467 (requires CONFIG_CMD_DATE)
c609719b
WD
468 CONFIG_VIDEO_LOGO display Linux logo in
469 upper left corner
a6c7ad2f
WD
470 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
471 linux_logo.h for logo.
472 Requires CONFIG_VIDEO_LOGO
c609719b 473 CONFIG_CONSOLE_EXTRA_INFO
11ccc33f 474 additional board info beside
c609719b
WD
475 the logo
476
43d9616c
WD
477 When CONFIG_CFB_CONSOLE is defined, video console is
478 default i/o. Serial console can be forced with
479 environment 'console=serial'.
c609719b 480
d4ca31c4
WD
481 When CONFIG_SILENT_CONSOLE is defined, all console
482 messages (by U-Boot and Linux!) can be silenced with
483 the "silent" environment variable. See
484 doc/README.silent for more information.
a3ad8e26 485
c609719b
WD
486- Console Baudrate:
487 CONFIG_BAUDRATE - in bps
488 Select one of the baudrates listed in
6d0f6bcf
JCPV
489 CONFIG_SYS_BAUDRATE_TABLE, see below.
490 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
c609719b 491
c92fac91
HS
492- Console Rx buffer length
493 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
494 the maximum receive buffer length for the SMC.
2b3f12c2 495 This option is actual only for 82xx and 8xx possible.
c92fac91
HS
496 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
497 must be defined, to setup the maximum idle timeout for
498 the SMC.
499
c609719b
WD
500- Interrupt driven serial port input:
501 CONFIG_SERIAL_SOFTWARE_FIFO
502
503 PPC405GP only.
504 Use an interrupt handler for receiving data on the
505 serial port. It also enables using hardware handshake
506 (RTS/CTS) and UART's built-in FIFO. Set the number of
507 bytes the interrupt driven input buffer should have.
508
109c0e3a
WD
509 Leave undefined to disable this feature, including
510 disable the buffer and hardware handshake.
c609719b 511
1d49b1f3
SR
512- Console UART Number:
513 CONFIG_UART1_CONSOLE
514
0c8721a4 515 AMCC PPC4xx only.
1d49b1f3
SR
516 If defined internal UART1 (and not UART0) is used
517 as default U-Boot console.
518
c609719b
WD
519- Boot Delay: CONFIG_BOOTDELAY - in seconds
520 Delay before automatically booting the default image;
521 set to -1 to disable autoboot.
522
523 See doc/README.autoboot for these options that
524 work with CONFIG_BOOTDELAY. None are required.
525 CONFIG_BOOT_RETRY_TIME
526 CONFIG_BOOT_RETRY_MIN
527 CONFIG_AUTOBOOT_KEYED
528 CONFIG_AUTOBOOT_PROMPT
529 CONFIG_AUTOBOOT_DELAY_STR
530 CONFIG_AUTOBOOT_STOP_STR
531 CONFIG_AUTOBOOT_DELAY_STR2
532 CONFIG_AUTOBOOT_STOP_STR2
533 CONFIG_ZERO_BOOTDELAY_CHECK
534 CONFIG_RESET_TO_RETRY
535
536- Autoboot Command:
537 CONFIG_BOOTCOMMAND
538 Only needed when CONFIG_BOOTDELAY is enabled;
539 define a command string that is automatically executed
540 when no character is read on the console interface
541 within "Boot Delay" after reset.
542
543 CONFIG_BOOTARGS
43d9616c
WD
544 This can be used to pass arguments to the bootm
545 command. The value of CONFIG_BOOTARGS goes into the
546 environment value "bootargs".
c609719b
WD
547
548 CONFIG_RAMBOOT and CONFIG_NFSBOOT
43d9616c
WD
549 The value of these goes into the environment as
550 "ramboot" and "nfsboot" respectively, and can be used
551 as a convenience, when switching between booting from
11ccc33f 552 RAM and NFS.
c609719b
WD
553
554- Pre-Boot Commands:
555 CONFIG_PREBOOT
556
557 When this option is #defined, the existence of the
558 environment variable "preboot" will be checked
559 immediately before starting the CONFIG_BOOTDELAY
560 countdown and/or running the auto-boot command resp.
561 entering interactive mode.
562
563 This feature is especially useful when "preboot" is
564 automatically generated or modified. For an example
565 see the LWMON board specific code: here "preboot" is
566 modified when the user holds down a certain
567 combination of keys on the (special) keyboard when
568 booting the systems
569
570- Serial Download Echo Mode:
571 CONFIG_LOADS_ECHO
572 If defined to 1, all characters received during a
573 serial download (using the "loads" command) are
574 echoed back. This might be needed by some terminal
575 emulations (like "cu"), but may as well just take
576 time on others. This setting #define's the initial
577 value of the "loads_echo" environment variable.
578
602ad3b3 579- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
c609719b
WD
580 CONFIG_KGDB_BAUDRATE
581 Select one of the baudrates listed in
6d0f6bcf 582 CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b
WD
583
584- Monitor Functions:
602ad3b3
JL
585 Monitor commands can be included or excluded
586 from the build by using the #include files
587 "config_cmd_all.h" and #undef'ing unwanted
588 commands, or using "config_cmd_default.h"
589 and augmenting with additional #define's
590 for wanted commands.
591
592 The default command configuration includes all commands
593 except those marked below with a "*".
594
595 CONFIG_CMD_ASKENV * ask for env variable
602ad3b3
JL
596 CONFIG_CMD_BDI bdinfo
597 CONFIG_CMD_BEDBUG * Include BedBug Debugger
598 CONFIG_CMD_BMP * BMP support
599 CONFIG_CMD_BSP * Board specific commands
600 CONFIG_CMD_BOOTD bootd
601 CONFIG_CMD_CACHE * icache, dcache
602 CONFIG_CMD_CONSOLE coninfo
603 CONFIG_CMD_DATE * support for RTC, date/time...
604 CONFIG_CMD_DHCP * DHCP support
605 CONFIG_CMD_DIAG * Diagnostics
606 CONFIG_CMD_DOC * Disk-On-Chip Support
a7c93104
PT
607 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
608 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
609 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
610 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
602ad3b3
JL
611 CONFIG_CMD_DTT * Digital Therm and Thermostat
612 CONFIG_CMD_ECHO echo arguments
613 CONFIG_CMD_EEPROM * EEPROM read/write support
614 CONFIG_CMD_ELF * bootelf, bootvx
bdab39d3 615 CONFIG_CMD_SAVEENV saveenv
602ad3b3
JL
616 CONFIG_CMD_FDC * Floppy Disk Support
617 CONFIG_CMD_FAT * FAT partition support
618 CONFIG_CMD_FDOS * Dos diskette Support
619 CONFIG_CMD_FLASH flinfo, erase, protect
620 CONFIG_CMD_FPGA FPGA device initialization support
621 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
622 CONFIG_CMD_I2C * I2C serial bus support
623 CONFIG_CMD_IDE * IDE harddisk support
624 CONFIG_CMD_IMI iminfo
625 CONFIG_CMD_IMLS List all found images
626 CONFIG_CMD_IMMAP * IMMR dump support
627 CONFIG_CMD_IRQ * irqinfo
628 CONFIG_CMD_ITEST Integer/string test of 2 values
629 CONFIG_CMD_JFFS2 * JFFS2 Support
630 CONFIG_CMD_KGDB * kgdb
631 CONFIG_CMD_LOADB loadb
632 CONFIG_CMD_LOADS loads
633 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
634 loop, loopw, mtest
635 CONFIG_CMD_MISC Misc functions like sleep etc
636 CONFIG_CMD_MMC * MMC memory mapped support
637 CONFIG_CMD_MII * MII utility commands
68d7d651 638 CONFIG_CMD_MTDPARTS * MTD partition support
602ad3b3
JL
639 CONFIG_CMD_NAND * NAND support
640 CONFIG_CMD_NET bootp, tftpboot, rarpboot
e92739d3
PT
641 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
642 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
602ad3b3
JL
643 CONFIG_CMD_PCI * pciinfo
644 CONFIG_CMD_PCMCIA * PCMCIA support
645 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
646 host
647 CONFIG_CMD_PORTIO * Port I/O
648 CONFIG_CMD_REGINFO * Register dump
649 CONFIG_CMD_RUN run command in env variable
650 CONFIG_CMD_SAVES * save S record dump
651 CONFIG_CMD_SCSI * SCSI Support
652 CONFIG_CMD_SDRAM * print SDRAM configuration information
653 (requires CONFIG_CMD_I2C)
654 CONFIG_CMD_SETGETDCR Support for DCR Register access
655 (4xx only)
74de7aef 656 CONFIG_CMD_SOURCE "source" command Support
602ad3b3
JL
657 CONFIG_CMD_SPI * SPI serial bus support
658 CONFIG_CMD_USB * USB support
659 CONFIG_CMD_VFD * VFD support (TRAB)
602ad3b3
JL
660 CONFIG_CMD_CDP * Cisco Discover Protocol support
661 CONFIG_CMD_FSL * Microblaze FSL support
662
c609719b
WD
663
664 EXAMPLE: If you want all functions except of network
665 support you can write:
666
602ad3b3
JL
667 #include "config_cmd_all.h"
668 #undef CONFIG_CMD_NET
c609719b 669
213bf8c8
GVB
670 Other Commands:
671 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
c609719b
WD
672
673 Note: Don't enable the "icache" and "dcache" commands
602ad3b3 674 (configuration option CONFIG_CMD_CACHE) unless you know
43d9616c
WD
675 what you (and your U-Boot users) are doing. Data
676 cache cannot be enabled on systems like the 8xx or
677 8260 (where accesses to the IMMR region must be
678 uncached), and it cannot be disabled on all other
679 systems where we (mis-) use the data cache to hold an
680 initial stack and some data.
c609719b
WD
681
682
683 XXX - this list needs to get updated!
684
685- Watchdog:
686 CONFIG_WATCHDOG
687 If this variable is defined, it enables watchdog
7152b1d0 688 support. There must be support in the platform specific
c609719b
WD
689 code for a watchdog. For the 8xx and 8260 CPUs, the
690 SIU Watchdog feature is enabled in the SYPCR
691 register.
692
c1551ea8
SR
693- U-Boot Version:
694 CONFIG_VERSION_VARIABLE
695 If this variable is defined, an environment variable
696 named "ver" is created by U-Boot showing the U-Boot
697 version as printed by the "version" command.
698 This variable is readonly.
699
c609719b
WD
700- Real-Time Clock:
701
602ad3b3 702 When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b
WD
703 has to be selected, too. Define exactly one of the
704 following options:
705
706 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
707 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
7ce63709 708 CONFIG_RTC_MC13783 - use MC13783 RTC
c609719b 709 CONFIG_RTC_MC146818 - use MC146818 RTC
1cb8e980 710 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
c609719b 711 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
7f70e853 712 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
3bac3513 713 CONFIG_RTC_DS164x - use Dallas DS164x RTC
9536dfcc 714 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
4c0d4c3b 715 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
6d0f6bcf 716 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
c609719b 717
b37c7e5e
WD
718 Note that if the RTC uses I2C, then the I2C interface
719 must also be configured. See I2C Support, below.
720
e92739d3
PT
721- GPIO Support:
722 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
723 CONFIG_PCA953X_INFO - enable pca953x info command
724
725 Note that if the GPIO device uses I2C, then the I2C interface
726 must also be configured. See I2C Support, below.
727
c609719b
WD
728- Timestamp Support:
729
43d9616c
WD
730 When CONFIG_TIMESTAMP is selected, the timestamp
731 (date and time) of an image is printed by image
732 commands like bootm or iminfo. This option is
602ad3b3 733 automatically enabled when you select CONFIG_CMD_DATE .
c609719b
WD
734
735- Partition Support:
736 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
07f3d789 737 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
c609719b 738
218ca724
WD
739 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
740 CONFIG_CMD_SCSI) you must configure support for at
741 least one partition type as well.
c609719b
WD
742
743- IDE Reset method:
4d13cbad
WD
744 CONFIG_IDE_RESET_ROUTINE - this is defined in several
745 board configurations files but used nowhere!
c609719b 746
4d13cbad
WD
747 CONFIG_IDE_RESET - is this is defined, IDE Reset will
748 be performed by calling the function
749 ide_set_reset(int reset)
750 which has to be defined in a board specific file
c609719b
WD
751
752- ATAPI Support:
753 CONFIG_ATAPI
754
755 Set this to enable ATAPI support.
756
c40b2956
WD
757- LBA48 Support
758 CONFIG_LBA48
759
760 Set this to enable support for disks larger than 137GB
6d0f6bcf 761 Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
c40b2956
WD
762 Whithout these , LBA48 support uses 32bit variables and will 'only'
763 support disks up to 2.1TB.
764
6d0f6bcf 765 CONFIG_SYS_64BIT_LBA:
c40b2956
WD
766 When enabled, makes the IDE subsystem use 64bit sector addresses.
767 Default is 32bit.
768
c609719b
WD
769- SCSI Support:
770 At the moment only there is only support for the
771 SYM53C8XX SCSI controller; define
772 CONFIG_SCSI_SYM53C8XX to enable it.
773
6d0f6bcf
JCPV
774 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
775 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
776 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
c609719b
WD
777 maximum numbers of LUNs, SCSI ID's and target
778 devices.
6d0f6bcf 779 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
c609719b
WD
780
781- NETWORK Support (PCI):
682011ff
WD
782 CONFIG_E1000
783 Support for Intel 8254x gigabit chips.
53cf9435 784
ac3315c2 785 CONFIG_E1000_FALLBACK_MAC
11ccc33f 786 default MAC for empty EEPROM after production.
ac3315c2 787
c609719b
WD
788 CONFIG_EEPRO100
789 Support for Intel 82557/82559/82559ER chips.
11ccc33f 790 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
c609719b
WD
791 write routine for first time initialisation.
792
793 CONFIG_TULIP
794 Support for Digital 2114x chips.
795 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
796 modem chip initialisation (KS8761/QS6611).
797
798 CONFIG_NATSEMI
799 Support for National dp83815 chips.
800
801 CONFIG_NS8382X
802 Support for National dp8382[01] gigabit chips.
803
45219c46
WD
804- NETWORK Support (other):
805
806 CONFIG_DRIVER_LAN91C96
807 Support for SMSC's LAN91C96 chips.
808
809 CONFIG_LAN91C96_BASE
810 Define this to hold the physical address
811 of the LAN91C96's I/O space
812
813 CONFIG_LAN91C96_USE_32_BIT
814 Define this to enable 32 bit addressing
815
f39748ae
WD
816 CONFIG_DRIVER_SMC91111
817 Support for SMSC's LAN91C111 chip
818
819 CONFIG_SMC91111_BASE
820 Define this to hold the physical address
821 of the device (I/O space)
822
823 CONFIG_SMC_USE_32_BIT
824 Define this if data bus is 32 bits
825
826 CONFIG_SMC_USE_IOFUNCS
827 Define this to use i/o functions instead of macros
828 (some hardware wont work with macros)
829
557b377d
JG
830 CONFIG_DRIVER_SMC911X
831 Support for SMSC's LAN911x and LAN921x chips
832
833 CONFIG_DRIVER_SMC911X_BASE
834 Define this to hold the physical address
835 of the device (I/O space)
836
837 CONFIG_DRIVER_SMC911X_32_BIT
838 Define this if data bus is 32 bits
839
840 CONFIG_DRIVER_SMC911X_16_BIT
841 Define this if data bus is 16 bits. If your processor
842 automatically converts one 32 bit word to two 16 bit
843 words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
844
c609719b
WD
845- USB Support:
846 At the moment only the UHCI host controller is
4d13cbad 847 supported (PIP405, MIP405, MPC5200); define
c609719b
WD
848 CONFIG_USB_UHCI to enable it.
849 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae 850 and define CONFIG_USB_STORAGE to enable the USB
c609719b
WD
851 storage devices.
852 Note:
853 Supported are USB Keyboards and USB Floppy drives
854 (TEAC FD-05PUB).
4d13cbad
WD
855 MPC5200 USB requires additional defines:
856 CONFIG_USB_CLOCK
857 for 528 MHz Clock: 0x0001bbbb
858 CONFIG_USB_CONFIG
859 for differential drivers: 0x00001000
860 for single ended drivers: 0x00005000
6d0f6bcf 861 CONFIG_SYS_USB_EVENT_POLL
fdcfaa1b
ZW
862 May be defined to allow interrupt polling
863 instead of using asynchronous interrupts
4d13cbad 864
16c8d5e7
WD
865- USB Device:
866 Define the below if you wish to use the USB console.
867 Once firmware is rebuilt from a serial console issue the
868 command "setenv stdin usbtty; setenv stdout usbtty" and
11ccc33f 869 attach your USB cable. The Unix command "dmesg" should print
16c8d5e7
WD
870 it has found a new device. The environment variable usbtty
871 can be set to gserial or cdc_acm to enable your device to
386eda02 872 appear to a USB host as a Linux gserial device or a
16c8d5e7
WD
873 Common Device Class Abstract Control Model serial device.
874 If you select usbtty = gserial you should be able to enumerate
875 a Linux host by
876 # modprobe usbserial vendor=0xVendorID product=0xProductID
877 else if using cdc_acm, simply setting the environment
878 variable usbtty to be cdc_acm should suffice. The following
879 might be defined in YourBoardName.h
386eda02 880
16c8d5e7
WD
881 CONFIG_USB_DEVICE
882 Define this to build a UDC device
883
884 CONFIG_USB_TTY
885 Define this to have a tty type of device available to
886 talk to the UDC device
386eda02 887
6d0f6bcf 888 CONFIG_SYS_CONSOLE_IS_IN_ENV
16c8d5e7
WD
889 Define this if you want stdin, stdout &/or stderr to
890 be set to usbtty.
891
892 mpc8xx:
6d0f6bcf 893 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
16c8d5e7 894 Derive USB clock from external clock "blah"
6d0f6bcf 895 - CONFIG_SYS_USB_EXTC_CLK 0x02
386eda02 896
6d0f6bcf 897 CONFIG_SYS_USB_BRG_CLK 0xBLAH
16c8d5e7 898 Derive USB clock from brgclk
6d0f6bcf 899 - CONFIG_SYS_USB_BRG_CLK 0x04
16c8d5e7 900
386eda02 901 If you have a USB-IF assigned VendorID then you may wish to
16c8d5e7 902 define your own vendor specific values either in BoardName.h
386eda02 903 or directly in usbd_vendor_info.h. If you don't define
16c8d5e7
WD
904 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
905 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
906 should pretend to be a Linux device to it's target host.
907
908 CONFIG_USBD_MANUFACTURER
909 Define this string as the name of your company for
910 - CONFIG_USBD_MANUFACTURER "my company"
386eda02 911
16c8d5e7
WD
912 CONFIG_USBD_PRODUCT_NAME
913 Define this string as the name of your product
914 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
915
916 CONFIG_USBD_VENDORID
917 Define this as your assigned Vendor ID from the USB
918 Implementors Forum. This *must* be a genuine Vendor ID
919 to avoid polluting the USB namespace.
920 - CONFIG_USBD_VENDORID 0xFFFF
386eda02 921
16c8d5e7
WD
922 CONFIG_USBD_PRODUCTID
923 Define this as the unique Product ID
924 for your device
925 - CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad 926
c609719b 927
71f95118 928- MMC Support:
8bde7f77
WD
929 The MMC controller on the Intel PXA is supported. To
930 enable this define CONFIG_MMC. The MMC can be
931 accessed from the boot prompt by mapping the device
71f95118 932 to physical memory similar to flash. Command line is
602ad3b3
JL
933 enabled with CONFIG_CMD_MMC. The MMC driver also works with
934 the FAT fs. This is enabled with CONFIG_CMD_FAT.
71f95118 935
6705d81e
WD
936- Journaling Flash filesystem support:
937 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
938 CONFIG_JFFS2_NAND_DEV
939 Define these for a default partition on a NAND device
940
6d0f6bcf
JCPV
941 CONFIG_SYS_JFFS2_FIRST_SECTOR,
942 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e
WD
943 Define these for a default partition on a NOR device
944
6d0f6bcf 945 CONFIG_SYS_JFFS_CUSTOM_PART
6705d81e
WD
946 Define this to create an own partition. You have to provide a
947 function struct part_info* jffs2_part_info(int part_num)
948
949 If you define only one JFFS2 partition you may also want to
6d0f6bcf 950 #define CONFIG_SYS_JFFS_SINGLE_PART 1
6705d81e
WD
951 to disable the command chpart. This is the default when you
952 have not defined a custom partition
953
c609719b
WD
954- Keyboard Support:
955 CONFIG_ISA_KEYBOARD
956
957 Define this to enable standard (PC-Style) keyboard
958 support
959
960 CONFIG_I8042_KBD
961 Standard PC keyboard driver with US (is default) and
962 GERMAN key layout (switch via environment 'keymap=de') support.
963 Export function i8042_kbd_init, i8042_tstc and i8042_getc
964 for cfb_console. Supports cursor blinking.
965
966- Video support:
967 CONFIG_VIDEO
968
969 Define this to enable video support (for output to
970 video).
971
972 CONFIG_VIDEO_CT69000
973
974 Enable Chips & Technologies 69000 Video chip
975
976 CONFIG_VIDEO_SMI_LYNXEM
b79a11cc 977 Enable Silicon Motion SMI 712/710/810 Video chip. The
eeb1b77b
WD
978 video output is selected via environment 'videoout'
979 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
980 assumed.
981
b79a11cc 982 For the CT69000 and SMI_LYNXEM drivers, videomode is
11ccc33f 983 selected via environment 'videomode'. Two different ways
eeb1b77b
WD
984 are possible:
985 - "videomode=num" 'num' is a standard LiLo mode numbers.
6e592385 986 Following standard modes are supported (* is default):
eeb1b77b
WD
987
988 Colors 640x480 800x600 1024x768 1152x864 1280x1024
989 -------------+---------------------------------------------
990 8 bits | 0x301* 0x303 0x305 0x161 0x307
991 15 bits | 0x310 0x313 0x316 0x162 0x319
992 16 bits | 0x311 0x314 0x317 0x163 0x31A
993 24 bits | 0x312 0x315 0x318 ? 0x31B
994 -------------+---------------------------------------------
c609719b
WD
995 (i.e. setenv videomode 317; saveenv; reset;)
996
b79a11cc 997 - "videomode=bootargs" all the video parameters are parsed
7817cb20 998 from the bootargs. (See drivers/video/videomodes.c)
eeb1b77b
WD
999
1000
c1551ea8 1001 CONFIG_VIDEO_SED13806
43d9616c 1002 Enable Epson SED13806 driver. This driver supports 8bpp
a6c7ad2f
WD
1003 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1004 or CONFIG_VIDEO_SED13806_16BPP
1005
682011ff 1006- Keyboard Support:
8bde7f77 1007 CONFIG_KEYBOARD
682011ff 1008
8bde7f77
WD
1009 Define this to enable a custom keyboard support.
1010 This simply calls drv_keyboard_init() which must be
1011 defined in your board-specific files.
1012 The only board using this so far is RBC823.
a6c7ad2f 1013
c609719b
WD
1014- LCD Support: CONFIG_LCD
1015
1016 Define this to enable LCD support (for output to LCD
1017 display); also select one of the supported displays
1018 by defining one of these:
1019
39cf4804
SP
1020 CONFIG_ATMEL_LCD:
1021
1022 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1023
fd3103bb 1024 CONFIG_NEC_NL6448AC33:
c609719b 1025
fd3103bb 1026 NEC NL6448AC33-18. Active, color, single scan.
c609719b 1027
fd3103bb 1028 CONFIG_NEC_NL6448BC20
c609719b 1029
fd3103bb
WD
1030 NEC NL6448BC20-08. 6.5", 640x480.
1031 Active, color, single scan.
1032
1033 CONFIG_NEC_NL6448BC33_54
1034
1035 NEC NL6448BC33-54. 10.4", 640x480.
c609719b
WD
1036 Active, color, single scan.
1037
1038 CONFIG_SHARP_16x9
1039
1040 Sharp 320x240. Active, color, single scan.
1041 It isn't 16x9, and I am not sure what it is.
1042
1043 CONFIG_SHARP_LQ64D341
1044
1045 Sharp LQ64D341 display, 640x480.
1046 Active, color, single scan.
1047
1048 CONFIG_HLD1045
1049
1050 HLD1045 display, 640x480.
1051 Active, color, single scan.
1052
1053 CONFIG_OPTREX_BW
1054
1055 Optrex CBL50840-2 NF-FW 99 22 M5
1056 or
1057 Hitachi LMG6912RPFC-00T
1058 or
1059 Hitachi SP14Q002
1060
1061 320x240. Black & white.
1062
1063 Normally display is black on white background; define
6d0f6bcf 1064 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
c609719b 1065
7152b1d0 1066- Splash Screen Support: CONFIG_SPLASH_SCREEN
d791b1dc 1067
8bde7f77
WD
1068 If this option is set, the environment is checked for
1069 a variable "splashimage". If found, the usual display
1070 of logo, copyright and system information on the LCD
e94d2cd9 1071 is suppressed and the BMP image at the address
8bde7f77
WD
1072 specified in "splashimage" is loaded instead. The
1073 console is redirected to the "nulldev", too. This
1074 allows for a "silent" boot where a splash screen is
1075 loaded very quickly after power-on.
d791b1dc 1076
98f4a3df
SR
1077- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1078
1079 If this option is set, additionally to standard BMP
1080 images, gzipped BMP images can be displayed via the
1081 splashscreen support or the bmp command.
1082
c29fdfc1
WD
1083- Compression support:
1084 CONFIG_BZIP2
1085
1086 If this option is set, support for bzip2 compressed
1087 images is included. If not, only uncompressed and gzip
1088 compressed images are supported.
1089
42d1f039 1090 NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf 1091 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f039 1092 be at least 4MB.
d791b1dc 1093
fc9c1727
LCM
1094 CONFIG_LZMA
1095
1096 If this option is set, support for lzma compressed
1097 images is included.
1098
1099 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1100 requires an amount of dynamic memory that is given by the
1101 formula:
1102
1103 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1104
1105 Where lc and lp stand for, respectively, Literal context bits
1106 and Literal pos bits.
1107
1108 This value is upper-bounded by 14MB in the worst case. Anyway,
1109 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1110 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1111 a very small buffer.
1112
1113 Use the lzmainfo tool to determinate the lc and lp values and
1114 then calculate the amount of needed dynamic memory (ensuring
6d0f6bcf 1115 the appropriate CONFIG_SYS_MALLOC_LEN value).
fc9c1727 1116
17ea1177
WD
1117- MII/PHY support:
1118 CONFIG_PHY_ADDR
1119
1120 The address of PHY on MII bus.
1121
1122 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1123
1124 The clock frequency of the MII bus
1125
1126 CONFIG_PHY_GIGE
1127
1128 If this option is set, support for speed/duplex
11ccc33f 1129 detection of gigabit PHY is included.
17ea1177
WD
1130
1131 CONFIG_PHY_RESET_DELAY
1132
1133 Some PHY like Intel LXT971A need extra delay after
1134 reset before any MII register access is possible.
1135 For such PHY, set this option to the usec delay
1136 required. (minimum 300usec for LXT971A)
1137
1138 CONFIG_PHY_CMD_DELAY (ppc4xx)
1139
1140 Some PHY like Intel LXT971A need extra delay after
1141 command issued before MII status register can be read
1142
c609719b
WD
1143- Ethernet address:
1144 CONFIG_ETHADDR
c68a05fe 1145 CONFIG_ETH1ADDR
c609719b
WD
1146 CONFIG_ETH2ADDR
1147 CONFIG_ETH3ADDR
c68a05fe 1148 CONFIG_ETH4ADDR
1149 CONFIG_ETH5ADDR
c609719b 1150
11ccc33f
MZ
1151 Define a default value for Ethernet address to use
1152 for the respective Ethernet interface, in case this
c609719b
WD
1153 is not determined automatically.
1154
1155- IP address:
1156 CONFIG_IPADDR
1157
1158 Define a default value for the IP address to use for
11ccc33f 1159 the default Ethernet interface, in case this is not
c609719b
WD
1160 determined through e.g. bootp.
1161
1162- Server IP address:
1163 CONFIG_SERVERIP
1164
11ccc33f 1165 Defines a default value for the IP address of a TFTP
c609719b
WD
1166 server to contact when using the "tftboot" command.
1167
53a5c424
DU
1168- Multicast TFTP Mode:
1169 CONFIG_MCAST_TFTP
1170
1171 Defines whether you want to support multicast TFTP as per
1172 rfc-2090; for example to work with atftp. Lets lots of targets
11ccc33f 1173 tftp down the same boot image concurrently. Note: the Ethernet
53a5c424
DU
1174 driver in use must provide a function: mcast() to join/leave a
1175 multicast group.
1176
1177 CONFIG_BOOTP_RANDOM_DELAY
c609719b
WD
1178- BOOTP Recovery Mode:
1179 CONFIG_BOOTP_RANDOM_DELAY
1180
1181 If you have many targets in a network that try to
1182 boot using BOOTP, you may want to avoid that all
1183 systems send out BOOTP requests at precisely the same
1184 moment (which would happen for instance at recovery
1185 from a power failure, when all systems will try to
1186 boot, thus flooding the BOOTP server. Defining
1187 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1188 inserted before sending out BOOTP requests. The
6c33c785 1189 following delays are inserted then:
c609719b
WD
1190
1191 1st BOOTP request: delay 0 ... 1 sec
1192 2nd BOOTP request: delay 0 ... 2 sec
1193 3rd BOOTP request: delay 0 ... 4 sec
1194 4th and following
1195 BOOTP requests: delay 0 ... 8 sec
1196
fe389a82 1197- DHCP Advanced Options:
1fe80d79
JL
1198 You can fine tune the DHCP functionality by defining
1199 CONFIG_BOOTP_* symbols:
1200
1201 CONFIG_BOOTP_SUBNETMASK
1202 CONFIG_BOOTP_GATEWAY
1203 CONFIG_BOOTP_HOSTNAME
1204 CONFIG_BOOTP_NISDOMAIN
1205 CONFIG_BOOTP_BOOTPATH
1206 CONFIG_BOOTP_BOOTFILESIZE
1207 CONFIG_BOOTP_DNS
1208 CONFIG_BOOTP_DNS2
1209 CONFIG_BOOTP_SEND_HOSTNAME
1210 CONFIG_BOOTP_NTPSERVER
1211 CONFIG_BOOTP_TIMEOFFSET
1212 CONFIG_BOOTP_VENDOREX
fe389a82 1213
5d110f0a
WC
1214 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1215 environment variable, not the BOOTP server.
fe389a82
SR
1216
1217 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1218 serverip from a DHCP server, it is possible that more
1219 than one DNS serverip is offered to the client.
1220 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1221 serverip will be stored in the additional environment
1222 variable "dnsip2". The first DNS serverip is always
1223 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1fe80d79 1224 is defined.
fe389a82
SR
1225
1226 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1227 to do a dynamic update of a DNS server. To do this, they
1228 need the hostname of the DHCP requester.
5d110f0a 1229 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79
JL
1230 of the "hostname" environment variable is passed as
1231 option 12 to the DHCP server.
fe389a82 1232
d9a2f416
AV
1233 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1234
1235 A 32bit value in microseconds for a delay between
1236 receiving a "DHCP Offer" and sending the "DHCP Request".
1237 This fixes a problem with certain DHCP servers that don't
1238 respond 100% of the time to a "DHCP request". E.g. On an
1239 AT91RM9200 processor running at 180MHz, this delay needed
1240 to be *at least* 15,000 usec before a Windows Server 2003
1241 DHCP server would reply 100% of the time. I recommend at
1242 least 50,000 usec to be safe. The alternative is to hope
1243 that one of the retries will be successful but note that
1244 the DHCP timeout and retry process takes a longer than
1245 this delay.
1246
a3d991bd 1247 - CDP Options:
6e592385 1248 CONFIG_CDP_DEVICE_ID
a3d991bd
WD
1249
1250 The device id used in CDP trigger frames.
1251
1252 CONFIG_CDP_DEVICE_ID_PREFIX
1253
1254 A two character string which is prefixed to the MAC address
1255 of the device.
1256
1257 CONFIG_CDP_PORT_ID
1258
1259 A printf format string which contains the ascii name of
1260 the port. Normally is set to "eth%d" which sets
11ccc33f 1261 eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd
WD
1262
1263 CONFIG_CDP_CAPABILITIES
1264
1265 A 32bit integer which indicates the device capabilities;
1266 0x00000010 for a normal host which does not forwards.
1267
1268 CONFIG_CDP_VERSION
1269
1270 An ascii string containing the version of the software.
1271
1272 CONFIG_CDP_PLATFORM
1273
1274 An ascii string containing the name of the platform.
1275
1276 CONFIG_CDP_TRIGGER
1277
1278 A 32bit integer sent on the trigger.
1279
1280 CONFIG_CDP_POWER_CONSUMPTION
1281
1282 A 16bit integer containing the power consumption of the
1283 device in .1 of milliwatts.
1284
1285 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1286
1287 A byte containing the id of the VLAN.
1288
c609719b
WD
1289- Status LED: CONFIG_STATUS_LED
1290
1291 Several configurations allow to display the current
1292 status using a LED. For instance, the LED will blink
1293 fast while running U-Boot code, stop blinking as
1294 soon as a reply to a BOOTP request was received, and
1295 start blinking slow once the Linux kernel is running
1296 (supported by a status LED driver in the Linux
1297 kernel). Defining CONFIG_STATUS_LED enables this
1298 feature in U-Boot.
1299
1300- CAN Support: CONFIG_CAN_DRIVER
1301
1302 Defining CONFIG_CAN_DRIVER enables CAN driver support
1303 on those systems that support this (optional)
1304 feature, like the TQM8xxL modules.
1305
1306- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1307
b37c7e5e 1308 These enable I2C serial bus commands. Defining either of
945af8d7 1309 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
11ccc33f 1310 include the appropriate I2C driver for the selected CPU.
c609719b 1311
945af8d7 1312 This will allow you to use i2c commands at the u-boot
602ad3b3 1313 command line (as long as you set CONFIG_CMD_I2C in
b37c7e5e
WD
1314 CONFIG_COMMANDS) and communicate with i2c based realtime
1315 clock chips. See common/cmd_i2c.c for a description of the
43d9616c 1316 command line interface.
c609719b 1317
bb99ad6d 1318 CONFIG_HARD_I2C selects a hardware I2C controller.
b37c7e5e 1319
945af8d7 1320 CONFIG_SOFT_I2C configures u-boot to use a software (aka
b37c7e5e
WD
1321 bit-banging) driver instead of CPM or similar hardware
1322 support for I2C.
c609719b 1323
945af8d7 1324 There are several other quantities that must also be
b37c7e5e 1325 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
c609719b 1326
6d0f6bcf 1327 In both cases you will need to define CONFIG_SYS_I2C_SPEED
945af8d7 1328 to be the frequency (in Hz) at which you wish your i2c bus
6d0f6bcf 1329 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
11ccc33f 1330 the CPU's i2c node address).
945af8d7 1331
b37c7e5e 1332 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
11ccc33f 1333 sets the CPU up as a master node and so its address should
b37c7e5e 1334 therefore be cleared to 0 (See, eg, MPC823e User's Manual
6d0f6bcf 1335 p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
c609719b 1336
945af8d7 1337 That's all that's required for CONFIG_HARD_I2C.
c609719b 1338
b37c7e5e
WD
1339 If you use the software i2c interface (CONFIG_SOFT_I2C)
1340 then the following macros need to be defined (examples are
1341 from include/configs/lwmon.h):
c609719b
WD
1342
1343 I2C_INIT
1344
b37c7e5e 1345 (Optional). Any commands necessary to enable the I2C
43d9616c 1346 controller or configure ports.
c609719b 1347
ba56f625 1348 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
b37c7e5e 1349
c609719b
WD
1350 I2C_PORT
1351
43d9616c
WD
1352 (Only for MPC8260 CPU). The I/O port to use (the code
1353 assumes both bits are on the same port). Valid values
1354 are 0..3 for ports A..D.
c609719b
WD
1355
1356 I2C_ACTIVE
1357
1358 The code necessary to make the I2C data line active
1359 (driven). If the data line is open collector, this
1360 define can be null.
1361
b37c7e5e
WD
1362 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1363
c609719b
WD
1364 I2C_TRISTATE
1365
1366 The code necessary to make the I2C data line tri-stated
1367 (inactive). If the data line is open collector, this
1368 define can be null.
1369
b37c7e5e
WD
1370 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1371
c609719b
WD
1372 I2C_READ
1373
1374 Code that returns TRUE if the I2C data line is high,
1375 FALSE if it is low.
1376
b37c7e5e
WD
1377 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1378
c609719b
WD
1379 I2C_SDA(bit)
1380
1381 If <bit> is TRUE, sets the I2C data line high. If it
1382 is FALSE, it clears it (low).
1383
b37c7e5e 1384 eg: #define I2C_SDA(bit) \
2535d602 1385 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
ba56f625 1386 else immr->im_cpm.cp_pbdat &= ~PB_SDA
b37c7e5e 1387
c609719b
WD
1388 I2C_SCL(bit)
1389
1390 If <bit> is TRUE, sets the I2C clock line high. If it
1391 is FALSE, it clears it (low).
1392
b37c7e5e 1393 eg: #define I2C_SCL(bit) \
2535d602 1394 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
ba56f625 1395 else immr->im_cpm.cp_pbdat &= ~PB_SCL
b37c7e5e 1396
c609719b
WD
1397 I2C_DELAY
1398
1399 This delay is invoked four times per clock cycle so this
1400 controls the rate of data transfer. The data rate thus
b37c7e5e 1401 is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d7
WD
1402 like:
1403
b37c7e5e 1404 #define I2C_DELAY udelay(2)
c609719b 1405
6d0f6bcf 1406 CONFIG_SYS_I2C_INIT_BOARD
47cd00fa 1407
8bde7f77
WD
1408 When a board is reset during an i2c bus transfer
1409 chips might think that the current transfer is still
1410 in progress. On some boards it is possible to access
1411 the i2c SCLK line directly, either by using the
1412 processor pin as a GPIO or by having a second pin
1413 connected to the bus. If this option is defined a
1414 custom i2c_init_board() routine in boards/xxx/board.c
1415 is run early in the boot sequence.
47cd00fa 1416
17ea1177
WD
1417 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1418
1419 This option enables configuration of bi_iic_fast[] flags
1420 in u-boot bd_info structure based on u-boot environment
1421 variable "i2cfast". (see also i2cfast)
1422
bb99ad6d
BW
1423 CONFIG_I2C_MULTI_BUS
1424
1425 This option allows the use of multiple I2C buses, each of which
1426 must have a controller. At any point in time, only one bus is
1427 active. To switch to a different bus, use the 'i2c dev' command.
1428 Note that bus numbering is zero-based.
1429
6d0f6bcf 1430 CONFIG_SYS_I2C_NOPROBES
bb99ad6d
BW
1431
1432 This option specifies a list of I2C devices that will be skipped
0f89c54b
PT
1433 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1434 is set, specify a list of bus-device pairs. Otherwise, specify
1435 a 1D array of device addresses
bb99ad6d
BW
1436
1437 e.g.
1438 #undef CONFIG_I2C_MULTI_BUS
6d0f6bcf 1439 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d
BW
1440
1441 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1442
1443 #define CONFIG_I2C_MULTI_BUS
6d0f6bcf 1444 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d
BW
1445
1446 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1447
6d0f6bcf 1448 CONFIG_SYS_SPD_BUS_NUM
be5e6181
TT
1449
1450 If defined, then this indicates the I2C bus number for DDR SPD.
1451 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1452
6d0f6bcf 1453 CONFIG_SYS_RTC_BUS_NUM
0dc018ec
SR
1454
1455 If defined, then this indicates the I2C bus number for the RTC.
1456 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1457
6d0f6bcf 1458 CONFIG_SYS_DTT_BUS_NUM
0dc018ec
SR
1459
1460 If defined, then this indicates the I2C bus number for the DTT.
1461 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1462
6d0f6bcf 1463 CONFIG_SYS_I2C_DTT_ADDR:
9ebbb54f
VG
1464
1465 If defined, specifies the I2C address of the DTT device.
1466 If not defined, then U-Boot uses predefined value for
1467 specified DTT device.
1468
be5e6181
TT
1469 CONFIG_FSL_I2C
1470
1471 Define this option if you want to use Freescale's I2C driver in
7817cb20 1472 drivers/i2c/fsl_i2c.c.
be5e6181 1473
67b23a32
HS
1474 CONFIG_I2C_MUX
1475
1476 Define this option if you have I2C devices reached over 1 .. n
1477 I2C Muxes like the pca9544a. This option addes a new I2C
1478 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1479 new I2C Bus to the existing I2C Busses. If you select the
1480 new Bus with "i2c dev", u-bbot sends first the commandos for
1481 the muxes to activate this new "bus".
1482
1483 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1484 feature!
1485
1486 Example:
1487 Adding a new I2C Bus reached over 2 pca9544a muxes
1488 The First mux with address 70 and channel 6
1489 The Second mux with address 71 and channel 4
1490
1491 => i2c bus pca9544a:70:6:pca9544a:71:4
1492
1493 Use the "i2c bus" command without parameter, to get a list
1494 of I2C Busses with muxes:
1495
1496 => i2c bus
1497 Busses reached over muxes:
1498 Bus ID: 2
1499 reached over Mux(es):
1500 pca9544a@70 ch: 4
1501 Bus ID: 3
1502 reached over Mux(es):
1503 pca9544a@70 ch: 6
1504 pca9544a@71 ch: 4
1505 =>
1506
1507 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1508 u-boot sends First the Commando to the mux@70 to enable
1509 channel 6, and then the Commando to the mux@71 to enable
1510 the channel 4.
1511
1512 After that, you can use the "normal" i2c commands as
1513 usual, to communicate with your I2C devices behind
1514 the 2 muxes.
1515
1516 This option is actually implemented for the bitbanging
1517 algorithm in common/soft_i2c.c and for the Hardware I2C
1518 Bus on the MPC8260. But it should be not so difficult
1519 to add this option to other architectures.
1520
2ac6985a
AD
1521 CONFIG_SOFT_I2C_READ_REPEATED_START
1522
1523 defining this will force the i2c_read() function in
1524 the soft_i2c driver to perform an I2C repeated start
1525 between writing the address pointer and reading the
1526 data. If this define is omitted the default behaviour
1527 of doing a stop-start sequence will be used. Most I2C
1528 devices can use either method, but some require one or
1529 the other.
be5e6181 1530
c609719b
WD
1531- SPI Support: CONFIG_SPI
1532
1533 Enables SPI driver (so far only tested with
1534 SPI EEPROM, also an instance works with Crystal A/D and
1535 D/As on the SACSng board)
1536
1537 CONFIG_SPI_X
1538
1539 Enables extended (16-bit) SPI EEPROM addressing.
1540 (symmetrical to CONFIG_I2C_X)
1541
1542 CONFIG_SOFT_SPI
1543
43d9616c
WD
1544 Enables a software (bit-bang) SPI driver rather than
1545 using hardware support. This is a general purpose
1546 driver that only requires three general I/O port pins
1547 (two outputs, one input) to function. If this is
1548 defined, the board configuration must define several
1549 SPI configuration items (port pins to use, etc). For
1550 an example, see include/configs/sacsng.h.
c609719b 1551
04a9e118
BW
1552 CONFIG_HARD_SPI
1553
1554 Enables a hardware SPI driver for general-purpose reads
1555 and writes. As with CONFIG_SOFT_SPI, the board configuration
1556 must define a list of chip-select function pointers.
1557 Currently supported on some MPC8xxx processors. For an
1558 example, see include/configs/mpc8349emds.h.
1559
38254f45
GL
1560 CONFIG_MXC_SPI
1561
1562 Enables the driver for the SPI controllers on i.MX and MXC
1563 SoCs. Currently only i.MX31 is supported.
1564
0133502e 1565- FPGA Support: CONFIG_FPGA
c609719b 1566
0133502e
MF
1567 Enables FPGA subsystem.
1568
1569 CONFIG_FPGA_<vendor>
1570
1571 Enables support for specific chip vendors.
1572 (ALTERA, XILINX)
c609719b 1573
0133502e 1574 CONFIG_FPGA_<family>
c609719b 1575
0133502e
MF
1576 Enables support for FPGA family.
1577 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1578
1579 CONFIG_FPGA_COUNT
1580
1581 Specify the number of FPGA devices to support.
c609719b 1582
6d0f6bcf 1583 CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b 1584
8bde7f77 1585 Enable printing of hash marks during FPGA configuration.
c609719b 1586
6d0f6bcf 1587 CONFIG_SYS_FPGA_CHECK_BUSY
c609719b 1588
43d9616c
WD
1589 Enable checks on FPGA configuration interface busy
1590 status by the configuration function. This option
1591 will require a board or device specific function to
1592 be written.
c609719b
WD
1593
1594 CONFIG_FPGA_DELAY
1595
1596 If defined, a function that provides delays in the FPGA
1597 configuration driver.
1598
6d0f6bcf 1599 CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b
WD
1600 Allow Control-C to interrupt FPGA configuration
1601
6d0f6bcf 1602 CONFIG_SYS_FPGA_CHECK_ERROR
c609719b 1603
43d9616c
WD
1604 Check for configuration errors during FPGA bitfile
1605 loading. For example, abort during Virtex II
1606 configuration if the INIT_B line goes low (which
1607 indicated a CRC error).
c609719b 1608
6d0f6bcf 1609 CONFIG_SYS_FPGA_WAIT_INIT
c609719b 1610
43d9616c
WD
1611 Maximum time to wait for the INIT_B line to deassert
1612 after PROB_B has been deasserted during a Virtex II
1613 FPGA configuration sequence. The default time is 500
11ccc33f 1614 ms.
c609719b 1615
6d0f6bcf 1616 CONFIG_SYS_FPGA_WAIT_BUSY
c609719b 1617
43d9616c 1618 Maximum time to wait for BUSY to deassert during
11ccc33f 1619 Virtex II FPGA configuration. The default is 5 ms.
c609719b 1620
6d0f6bcf 1621 CONFIG_SYS_FPGA_WAIT_CONFIG
c609719b 1622
43d9616c 1623 Time to wait after FPGA configuration. The default is
11ccc33f 1624 200 ms.
c609719b
WD
1625
1626- Configuration Management:
1627 CONFIG_IDENT_STRING
1628
43d9616c
WD
1629 If defined, this string will be added to the U-Boot
1630 version information (U_BOOT_VERSION)
c609719b
WD
1631
1632- Vendor Parameter Protection:
1633
43d9616c
WD
1634 U-Boot considers the values of the environment
1635 variables "serial#" (Board Serial Number) and
7152b1d0 1636 "ethaddr" (Ethernet Address) to be parameters that
43d9616c
WD
1637 are set once by the board vendor / manufacturer, and
1638 protects these variables from casual modification by
1639 the user. Once set, these variables are read-only,
1640 and write or delete attempts are rejected. You can
11ccc33f 1641 change this behaviour:
c609719b
WD
1642
1643 If CONFIG_ENV_OVERWRITE is #defined in your config
1644 file, the write protection for vendor parameters is
47cd00fa 1645 completely disabled. Anybody can change or delete
c609719b
WD
1646 these parameters.
1647
1648 Alternatively, if you #define _both_ CONFIG_ETHADDR
1649 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33f 1650 Ethernet address is installed in the environment,
c609719b
WD
1651 which can be changed exactly ONCE by the user. [The
1652 serial# is unaffected by this, i. e. it remains
1653 read-only.]
1654
1655- Protected RAM:
1656 CONFIG_PRAM
1657
1658 Define this variable to enable the reservation of
1659 "protected RAM", i. e. RAM which is not overwritten
1660 by U-Boot. Define CONFIG_PRAM to hold the number of
1661 kB you want to reserve for pRAM. You can overwrite
1662 this default value by defining an environment
1663 variable "pram" to the number of kB you want to
1664 reserve. Note that the board info structure will
1665 still show the full amount of RAM. If pRAM is
1666 reserved, a new environment variable "mem" will
1667 automatically be defined to hold the amount of
1668 remaining RAM in a form that can be passed as boot
1669 argument to Linux, for instance like that:
1670
fe126d8b 1671 setenv bootargs ... mem=\${mem}
c609719b
WD
1672 saveenv
1673
1674 This way you can tell Linux not to use this memory,
1675 either, which results in a memory region that will
1676 not be affected by reboots.
1677
1678 *WARNING* If your board configuration uses automatic
1679 detection of the RAM size, you must make sure that
1680 this memory test is non-destructive. So far, the
1681 following board configurations are known to be
1682 "pRAM-clean":
1683
1684 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1685 HERMES, IP860, RPXlite, LWMON, LANTEC,
1686 PCU_E, FLAGADM, TQM8260
1687
1688- Error Recovery:
1689 CONFIG_PANIC_HANG
1690
1691 Define this variable to stop the system in case of a
1692 fatal error, so that you have to reset it manually.
1693 This is probably NOT a good idea for an embedded
11ccc33f 1694 system where you want the system to reboot
c609719b
WD
1695 automatically as fast as possible, but it may be
1696 useful during development since you can try to debug
1697 the conditions that lead to the situation.
1698
1699 CONFIG_NET_RETRY_COUNT
1700
43d9616c
WD
1701 This variable defines the number of retries for
1702 network operations like ARP, RARP, TFTP, or BOOTP
1703 before giving up the operation. If not defined, a
1704 default value of 5 is used.
c609719b 1705
40cb90ee
GL
1706 CONFIG_ARP_TIMEOUT
1707
1708 Timeout waiting for an ARP reply in milliseconds.
1709
c609719b 1710- Command Interpreter:
8078f1a5 1711 CONFIG_AUTO_COMPLETE
04a85b3b
WD
1712
1713 Enable auto completion of commands using TAB.
1714
a9398e01
WD
1715 Note that this feature has NOT been implemented yet
1716 for the "hush" shell.
8078f1a5
WD
1717
1718
6d0f6bcf 1719 CONFIG_SYS_HUSH_PARSER
c609719b
WD
1720
1721 Define this variable to enable the "hush" shell (from
1722 Busybox) as command line interpreter, thus enabling
1723 powerful command line syntax like
1724 if...then...else...fi conditionals or `&&' and '||'
1725 constructs ("shell scripts").
1726
1727 If undefined, you get the old, much simpler behaviour
1728 with a somewhat smaller memory footprint.
1729
1730
6d0f6bcf 1731 CONFIG_SYS_PROMPT_HUSH_PS2
c609719b
WD
1732
1733 This defines the secondary prompt string, which is
1734 printed when the command interpreter needs more input
1735 to complete a command. Usually "> ".
1736
1737 Note:
1738
8bde7f77
WD
1739 In the current implementation, the local variables
1740 space and global environment variables space are
1741 separated. Local variables are those you define by
1742 simply typing `name=value'. To access a local
1743 variable later on, you have write `$name' or
1744 `${name}'; to execute the contents of a variable
1745 directly type `$name' at the command prompt.
c609719b 1746
43d9616c
WD
1747 Global environment variables are those you use
1748 setenv/printenv to work with. To run a command stored
1749 in such a variable, you need to use the run command,
1750 and you must not use the '$' sign to access them.
c609719b
WD
1751
1752 To store commands and special characters in a
1753 variable, please use double quotation marks
1754 surrounding the whole text of the variable, instead
1755 of the backslashes before semicolons and special
1756 symbols.
1757
aa0c71ac
WD
1758- Commandline Editing and History:
1759 CONFIG_CMDLINE_EDITING
1760
11ccc33f 1761 Enable editing and History functions for interactive
b9365a26 1762 commandline input operations
aa0c71ac 1763
a8c7c708 1764- Default Environment:
c609719b
WD
1765 CONFIG_EXTRA_ENV_SETTINGS
1766
43d9616c
WD
1767 Define this to contain any number of null terminated
1768 strings (variable = value pairs) that will be part of
7152b1d0 1769 the default environment compiled into the boot image.
2262cfee 1770
43d9616c
WD
1771 For example, place something like this in your
1772 board's config file:
c609719b
WD
1773
1774 #define CONFIG_EXTRA_ENV_SETTINGS \
1775 "myvar1=value1\0" \
1776 "myvar2=value2\0"
1777
43d9616c
WD
1778 Warning: This method is based on knowledge about the
1779 internal format how the environment is stored by the
1780 U-Boot code. This is NOT an official, exported
1781 interface! Although it is unlikely that this format
7152b1d0 1782 will change soon, there is no guarantee either.
c609719b
WD
1783 You better know what you are doing here.
1784
43d9616c
WD
1785 Note: overly (ab)use of the default environment is
1786 discouraged. Make sure to check other ways to preset
74de7aef 1787 the environment like the "source" command or the
43d9616c 1788 boot command first.
c609719b 1789
a8c7c708 1790- DataFlash Support:
2abbe075
WD
1791 CONFIG_HAS_DATAFLASH
1792
8bde7f77
WD
1793 Defining this option enables DataFlash features and
1794 allows to read/write in Dataflash via the standard
1795 commands cp, md...
2abbe075 1796
3f85ce27
WD
1797- SystemACE Support:
1798 CONFIG_SYSTEMACE
1799
1800 Adding this option adds support for Xilinx SystemACE
1801 chips attached via some sort of local bus. The address
11ccc33f 1802 of the chip must also be defined in the
6d0f6bcf 1803 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
3f85ce27
WD
1804
1805 #define CONFIG_SYSTEMACE
6d0f6bcf 1806 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
3f85ce27
WD
1807
1808 When SystemACE support is added, the "ace" device type
1809 becomes available to the fat commands, i.e. fatls.
1810
ecb0ccd9
WD
1811- TFTP Fixed UDP Port:
1812 CONFIG_TFTP_PORT
1813
28cb9375 1814 If this is defined, the environment variable tftpsrcp
ecb0ccd9 1815 is used to supply the TFTP UDP source port value.
28cb9375 1816 If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9
WD
1817 number generator is used.
1818
28cb9375
WD
1819 Also, the environment variable tftpdstp is used to supply
1820 the TFTP UDP destination port value. If tftpdstp isn't
1821 defined, the normal port 69 is used.
1822
1823 The purpose for tftpsrcp is to allow a TFTP server to
ecb0ccd9
WD
1824 blindly start the TFTP transfer using the pre-configured
1825 target IP address and UDP port. This has the effect of
1826 "punching through" the (Windows XP) firewall, allowing
1827 the remainder of the TFTP transfer to proceed normally.
1828 A better solution is to properly configure the firewall,
1829 but sometimes that is not allowed.
1830
a8c7c708 1831- Show boot progress:
c609719b
WD
1832 CONFIG_SHOW_BOOT_PROGRESS
1833
43d9616c
WD
1834 Defining this option allows to add some board-
1835 specific code (calling a user-provided function
1836 "show_boot_progress(int)") that enables you to show
1837 the system's boot progress on some display (for
1838 example, some LED's) on your board. At the moment,
1839 the following checkpoints are implemented:
c609719b 1840
4bae9090
BS
1841- Automatic software updates via TFTP server
1842 CONFIG_UPDATE_TFTP
1843 CONFIG_UPDATE_TFTP_CNT_MAX
1844 CONFIG_UPDATE_TFTP_MSEC_MAX
1845
1846 These options enable and control the auto-update feature;
1847 for a more detailed description refer to doc/README.update.
1848
d558107c
SR
1849- MTD Support (mtdparts command, UBI support)
1850 CONFIG_MTD_DEVICE
1851
1852 Adds the MTD device infrastructure from the Linux kernel.
1853 Needed for mtdparts command support.
1854
1855 CONFIG_MTD_PARTITIONS
1856
1857 Adds the MTD partitioning infrastructure from the Linux
1858 kernel. Needed for UBI support.
1859
1372cce2
MB
1860Legacy uImage format:
1861
c609719b
WD
1862 Arg Where When
1863 1 common/cmd_bootm.c before attempting to boot an image
ba56f625 1864 -1 common/cmd_bootm.c Image header has bad magic number
c609719b 1865 2 common/cmd_bootm.c Image header has correct magic number
ba56f625 1866 -2 common/cmd_bootm.c Image header has bad checksum
c609719b 1867 3 common/cmd_bootm.c Image header has correct checksum
ba56f625 1868 -3 common/cmd_bootm.c Image data has bad checksum
c609719b
WD
1869 4 common/cmd_bootm.c Image data has correct checksum
1870 -4 common/cmd_bootm.c Image is for unsupported architecture
1871 5 common/cmd_bootm.c Architecture check OK
1372cce2 1872 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
c609719b
WD
1873 6 common/cmd_bootm.c Image Type check OK
1874 -6 common/cmd_bootm.c gunzip uncompression error
1875 -7 common/cmd_bootm.c Unimplemented compression type
1876 7 common/cmd_bootm.c Uncompression OK
1372cce2 1877 8 common/cmd_bootm.c No uncompress/copy overwrite error
c609719b 1878 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2
MB
1879
1880 9 common/image.c Start initial ramdisk verification
1881 -10 common/image.c Ramdisk header has bad magic number
1882 -11 common/image.c Ramdisk header has bad checksum
1883 10 common/image.c Ramdisk header is OK
1884 -12 common/image.c Ramdisk data has bad checksum
1885 11 common/image.c Ramdisk data has correct checksum
1886 12 common/image.c Ramdisk verification complete, start loading
11ccc33f 1887 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1372cce2
MB
1888 13 common/image.c Start multifile image verification
1889 14 common/image.c No initial ramdisk, no multifile, continue.
1890
1891 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
c609719b 1892
11dadd54
WD
1893 -30 lib_ppc/board.c Fatal error, hang the system
1894 -31 post/post.c POST test failed, detected by post_output_backlog()
1895 -32 post/post.c POST test failed, detected by post_run_single()
63e73c9a 1896
566a494f
HS
1897 34 common/cmd_doc.c before loading a Image from a DOC device
1898 -35 common/cmd_doc.c Bad usage of "doc" command
1899 35 common/cmd_doc.c correct usage of "doc" command
1900 -36 common/cmd_doc.c No boot device
1901 36 common/cmd_doc.c correct boot device
1902 -37 common/cmd_doc.c Unknown Chip ID on boot device
1903 37 common/cmd_doc.c correct chip ID found, device available
1904 -38 common/cmd_doc.c Read Error on boot device
1905 38 common/cmd_doc.c reading Image header from DOC device OK
1906 -39 common/cmd_doc.c Image header has bad magic number
1907 39 common/cmd_doc.c Image header has correct magic number
1908 -40 common/cmd_doc.c Error reading Image from DOC device
1909 40 common/cmd_doc.c Image header has correct magic number
1910 41 common/cmd_ide.c before loading a Image from a IDE device
1911 -42 common/cmd_ide.c Bad usage of "ide" command
1912 42 common/cmd_ide.c correct usage of "ide" command
1913 -43 common/cmd_ide.c No boot device
1914 43 common/cmd_ide.c boot device found
1915 -44 common/cmd_ide.c Device not available
1916 44 common/cmd_ide.c Device available
1917 -45 common/cmd_ide.c wrong partition selected
1918 45 common/cmd_ide.c partition selected
1919 -46 common/cmd_ide.c Unknown partition table
1920 46 common/cmd_ide.c valid partition table found
1921 -47 common/cmd_ide.c Invalid partition type
1922 47 common/cmd_ide.c correct partition type
1923 -48 common/cmd_ide.c Error reading Image Header on boot device
1924 48 common/cmd_ide.c reading Image Header from IDE device OK
1925 -49 common/cmd_ide.c Image header has bad magic number
1926 49 common/cmd_ide.c Image header has correct magic number
1927 -50 common/cmd_ide.c Image header has bad checksum
1928 50 common/cmd_ide.c Image header has correct checksum
1929 -51 common/cmd_ide.c Error reading Image from IDE device
1930 51 common/cmd_ide.c reading Image from IDE device OK
1931 52 common/cmd_nand.c before loading a Image from a NAND device
1932 -53 common/cmd_nand.c Bad usage of "nand" command
1933 53 common/cmd_nand.c correct usage of "nand" command
1934 -54 common/cmd_nand.c No boot device
1935 54 common/cmd_nand.c boot device found
1936 -55 common/cmd_nand.c Unknown Chip ID on boot device
1937 55 common/cmd_nand.c correct chip ID found, device available
1938 -56 common/cmd_nand.c Error reading Image Header on boot device
1939 56 common/cmd_nand.c reading Image Header from NAND device OK
1940 -57 common/cmd_nand.c Image header has bad magic number
1941 57 common/cmd_nand.c Image header has correct magic number
1942 -58 common/cmd_nand.c Error reading Image from NAND device
1943 58 common/cmd_nand.c reading Image from NAND device OK
1944
1945 -60 common/env_common.c Environment has a bad CRC, using default
1946
11ccc33f 1947 64 net/eth.c starting with Ethernet configuration.
566a494f
HS
1948 -64 net/eth.c no Ethernet found.
1949 65 net/eth.c Ethernet found.
1950
1951 -80 common/cmd_net.c usage wrong
1952 80 common/cmd_net.c before calling NetLoop()
11ccc33f 1953 -81 common/cmd_net.c some error in NetLoop() occurred
566a494f
HS
1954 81 common/cmd_net.c NetLoop() back without error
1955 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1956 82 common/cmd_net.c trying automatic boot
74de7aef
WD
1957 83 common/cmd_net.c running "source" command
1958 -83 common/cmd_net.c some error in automatic boot or "source" command
566a494f 1959 84 common/cmd_net.c end without errors
c609719b 1960
1372cce2
MB
1961FIT uImage format:
1962
1963 Arg Where When
1964 100 common/cmd_bootm.c Kernel FIT Image has correct format
1965 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1966 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1967 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1968 102 common/cmd_bootm.c Kernel unit name specified
1969 -103 common/cmd_bootm.c Can't get kernel subimage node offset
f773bea8 1970 103 common/cmd_bootm.c Found configuration node
1372cce2
MB
1971 104 common/cmd_bootm.c Got kernel subimage node offset
1972 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1973 105 common/cmd_bootm.c Kernel subimage hash verification OK
1974 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1975 106 common/cmd_bootm.c Architecture check OK
11ccc33f
MZ
1976 -106 common/cmd_bootm.c Kernel subimage has wrong type
1977 107 common/cmd_bootm.c Kernel subimage type OK
1372cce2
MB
1978 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1979 108 common/cmd_bootm.c Got kernel subimage data/size
1980 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1981 -109 common/cmd_bootm.c Can't get kernel subimage type
1982 -110 common/cmd_bootm.c Can't get kernel subimage comp
1983 -111 common/cmd_bootm.c Can't get kernel subimage os
1984 -112 common/cmd_bootm.c Can't get kernel subimage load address
1985 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1986
1987 120 common/image.c Start initial ramdisk verification
1988 -120 common/image.c Ramdisk FIT image has incorrect format
1989 121 common/image.c Ramdisk FIT image has correct format
11ccc33f 1990 122 common/image.c No ramdisk subimage unit name, using configuration
1372cce2
MB
1991 -122 common/image.c Can't get configuration for ramdisk subimage
1992 123 common/image.c Ramdisk unit name specified
1993 -124 common/image.c Can't get ramdisk subimage node offset
1994 125 common/image.c Got ramdisk subimage node offset
1995 -125 common/image.c Ramdisk subimage hash verification failed
1996 126 common/image.c Ramdisk subimage hash verification OK
1997 -126 common/image.c Ramdisk subimage for unsupported architecture
1998 127 common/image.c Architecture check OK
1999 -127 common/image.c Can't get ramdisk subimage data/size
2000 128 common/image.c Got ramdisk subimage data/size
2001 129 common/image.c Can't get ramdisk load address
2002 -129 common/image.c Got ramdisk load address
2003
11ccc33f 2004 -130 common/cmd_doc.c Incorrect FIT image format
1372cce2
MB
2005 131 common/cmd_doc.c FIT image format OK
2006
11ccc33f 2007 -140 common/cmd_ide.c Incorrect FIT image format
1372cce2
MB
2008 141 common/cmd_ide.c FIT image format OK
2009
11ccc33f 2010 -150 common/cmd_nand.c Incorrect FIT image format
1372cce2
MB
2011 151 common/cmd_nand.c FIT image format OK
2012
2013
c609719b
WD
2014Modem Support:
2015--------------
2016
85ec0bcc 2017[so far only for SMDK2400 and TRAB boards]
c609719b 2018
11ccc33f 2019- Modem support enable:
c609719b
WD
2020 CONFIG_MODEM_SUPPORT
2021
2022- RTS/CTS Flow control enable:
2023 CONFIG_HWFLOW
2024
2025- Modem debug support:
2026 CONFIG_MODEM_SUPPORT_DEBUG
2027
43d9616c
WD
2028 Enables debugging stuff (char screen[1024], dbg())
2029 for modem support. Useful only with BDI2000.
c609719b 2030
a8c7c708
WD
2031- Interrupt support (PPC):
2032
d4ca31c4
WD
2033 There are common interrupt_init() and timer_interrupt()
2034 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33f 2035 for CPU specific initialization. interrupt_init_cpu()
d4ca31c4 2036 should set decrementer_count to appropriate value. If
11ccc33f 2037 CPU resets decrementer automatically after interrupt
d4ca31c4 2038 (ppc4xx) it should set decrementer_count to zero.
11ccc33f 2039 timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c4
WD
2040 specific handling. If board has watchdog / status_led
2041 / other_activity_monitor it works automatically from
2042 general timer_interrupt().
a8c7c708 2043
c609719b
WD
2044- General:
2045
43d9616c
WD
2046 In the target system modem support is enabled when a
2047 specific key (key combination) is pressed during
2048 power-on. Otherwise U-Boot will boot normally
11ccc33f 2049 (autoboot). The key_pressed() function is called from
43d9616c
WD
2050 board_init(). Currently key_pressed() is a dummy
2051 function, returning 1 and thus enabling modem
2052 initialization.
c609719b 2053
43d9616c
WD
2054 If there are no modem init strings in the
2055 environment, U-Boot proceed to autoboot; the
2056 previous output (banner, info printfs) will be
11ccc33f 2057 suppressed, though.
c609719b
WD
2058
2059 See also: doc/README.Modem
2060
2061
c609719b
WD
2062Configuration Settings:
2063-----------------------
2064
6d0f6bcf 2065- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b
WD
2066 undefine this when you're short of memory.
2067
2fb2604d
PT
2068- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2069 width of the commands listed in the 'help' command output.
2070
6d0f6bcf 2071- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
c609719b
WD
2072 prompt for user input.
2073
6d0f6bcf 2074- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
c609719b 2075
6d0f6bcf 2076- CONFIG_SYS_PBSIZE: Buffer size for Console output
c609719b 2077
6d0f6bcf 2078- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
c609719b 2079
6d0f6bcf 2080- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b
WD
2081 the application (usually a Linux kernel) when it is
2082 booted
2083
6d0f6bcf 2084- CONFIG_SYS_BAUDRATE_TABLE:
c609719b
WD
2085 List of legal baudrate settings for this board.
2086
6d0f6bcf 2087- CONFIG_SYS_CONSOLE_INFO_QUIET
8bde7f77 2088 Suppress display of console information at boot.
c609719b 2089
6d0f6bcf 2090- CONFIG_SYS_CONSOLE_IS_IN_ENV
8bde7f77
WD
2091 If the board specific function
2092 extern int overwrite_console (void);
2093 returns 1, the stdin, stderr and stdout are switched to the
c609719b
WD
2094 serial port, else the settings in the environment are used.
2095
6d0f6bcf 2096- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
8bde7f77 2097 Enable the call to overwrite_console().
c609719b 2098
6d0f6bcf 2099- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
c609719b
WD
2100 Enable overwrite of previous console environment settings.
2101
6d0f6bcf 2102- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b
WD
2103 Begin and End addresses of the area used by the
2104 simple memory test.
2105
6d0f6bcf 2106- CONFIG_SYS_ALT_MEMTEST:
8bde7f77 2107 Enable an alternate, more extensive memory test.
c609719b 2108
6d0f6bcf 2109- CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe1
WD
2110 Scratch address used by the alternate memory test
2111 You only need to set this if address zero isn't writeable
2112
6d0f6bcf
JCPV
2113- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2114 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
14f73ca6 2115 this specified memory area will get subtracted from the top
11ccc33f 2116 (end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca6
SR
2117 fixing up gd->ram_size the Linux kernel should gets passed
2118 the now "corrected" memory size and won't touch it either.
2119 This should work for arch/ppc and arch/powerpc. Only Linux
5e12e75d 2120 board ports in arch/powerpc with bootwrapper support that
14f73ca6 2121 recalculate the memory size from the SDRAM controller setup
5e12e75d 2122 will have to get fixed in Linux additionally.
14f73ca6
SR
2123
2124 This option can be used as a workaround for the 440EPx/GRx
2125 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2126 be touched.
2127
2128 WARNING: Please make sure that this value is a multiple of
2129 the Linux page size (normally 4k). If this is not the case,
2130 then the end address of the Linux memory will be located at a
2131 non page size aligned address and this could cause major
2132 problems.
2133
6d0f6bcf 2134- CONFIG_SYS_TFTP_LOADADDR:
c609719b
WD
2135 Default load address for network file downloads
2136
6d0f6bcf 2137- CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b
WD
2138 Enable temporary baudrate change while serial download
2139
6d0f6bcf 2140- CONFIG_SYS_SDRAM_BASE:
c609719b
WD
2141 Physical start address of SDRAM. _Must_ be 0 here.
2142
6d0f6bcf 2143- CONFIG_SYS_MBIO_BASE:
c609719b
WD
2144 Physical start address of Motherboard I/O (if using a
2145 Cogent motherboard)
2146
6d0f6bcf 2147- CONFIG_SYS_FLASH_BASE:
c609719b
WD
2148 Physical start address of Flash memory.
2149
6d0f6bcf 2150- CONFIG_SYS_MONITOR_BASE:
c609719b
WD
2151 Physical start address of boot monitor code (set by
2152 make config files to be same as the text base address
2153 (TEXT_BASE) used when linking) - same as
6d0f6bcf 2154 CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b 2155
6d0f6bcf 2156- CONFIG_SYS_MONITOR_LEN:
8bde7f77
WD
2157 Size of memory reserved for monitor code, used to
2158 determine _at_compile_time_ (!) if the environment is
2159 embedded within the U-Boot image, or in a separate
2160 flash sector.
c609719b 2161
6d0f6bcf 2162- CONFIG_SYS_MALLOC_LEN:
c609719b
WD
2163 Size of DRAM reserved for malloc() use.
2164
6d0f6bcf 2165- CONFIG_SYS_BOOTM_LEN:
15940c9a
SR
2166 Normally compressed uImages are limited to an
2167 uncompressed size of 8 MBytes. If this is not enough,
6d0f6bcf 2168 you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9a
SR
2169 to adjust this setting to your needs.
2170
6d0f6bcf 2171- CONFIG_SYS_BOOTMAPSZ:
c609719b
WD
2172 Maximum size of memory mapped by the startup code of
2173 the Linux kernel; all data that must be processed by
7d721e34
BS
2174 the Linux kernel (bd_info, boot arguments, FDT blob if
2175 used) must be put below this limit, unless "bootm_low"
2176 enviroment variable is defined and non-zero. In such case
2177 all data for the Linux kernel must be between "bootm_low"
6d0f6bcf 2178 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
c609719b 2179
6d0f6bcf 2180- CONFIG_SYS_MAX_FLASH_BANKS:
c609719b
WD
2181 Max number of Flash memory banks
2182
6d0f6bcf 2183- CONFIG_SYS_MAX_FLASH_SECT:
c609719b
WD
2184 Max number of sectors on a Flash chip
2185
6d0f6bcf 2186- CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b
WD
2187 Timeout for Flash erase operations (in ms)
2188
6d0f6bcf 2189- CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b
WD
2190 Timeout for Flash write operations (in ms)
2191
6d0f6bcf 2192- CONFIG_SYS_FLASH_LOCK_TOUT
8564acf9
WD
2193 Timeout for Flash set sector lock bit operation (in ms)
2194
6d0f6bcf 2195- CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf9
WD
2196 Timeout for Flash clear lock bits operation (in ms)
2197
6d0f6bcf 2198- CONFIG_SYS_FLASH_PROTECTION
8564acf9
WD
2199 If defined, hardware flash sectors protection is used
2200 instead of U-Boot software protection.
2201
6d0f6bcf 2202- CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b
WD
2203
2204 Enable TFTP transfers directly to flash memory;
2205 without this option such a download has to be
2206 performed in two steps: (1) download to RAM, and (2)
2207 copy from RAM to flash.
2208
2209 The two-step approach is usually more reliable, since
2210 you can check if the download worked before you erase
11ccc33f
MZ
2211 the flash, but in some situations (when system RAM is
2212 too limited to allow for a temporary copy of the
c609719b
WD
2213 downloaded image) this option may be very useful.
2214
6d0f6bcf 2215- CONFIG_SYS_FLASH_CFI:
43d9616c 2216 Define if the flash driver uses extra elements in the
5653fc33
WD
2217 common flash structure for storing flash geometry.
2218
00b1883a 2219- CONFIG_FLASH_CFI_DRIVER
5653fc33
WD
2220 This option also enables the building of the cfi_flash driver
2221 in the drivers directory
c609719b 2222
91809ed5
PZ
2223- CONFIG_FLASH_CFI_MTD
2224 This option enables the building of the cfi_mtd driver
2225 in the drivers directory. The driver exports CFI flash
2226 to the MTD layer.
2227
6d0f6bcf 2228- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f
GL
2229 Use buffered writes to flash.
2230
2231- CONFIG_FLASH_SPANSION_S29WS_N
2232 s29ws-n MirrorBit flash has non-standard addresses for buffered
2233 write commands.
2234
6d0f6bcf 2235- CONFIG_SYS_FLASH_QUIET_TEST
5568e613
SR
2236 If this option is defined, the common CFI flash doesn't
2237 print it's warning upon not recognized FLASH banks. This
2238 is useful, if some of the configured banks are only
2239 optionally available.
2240
9a042e9c
JVB
2241- CONFIG_FLASH_SHOW_PROGRESS
2242 If defined (must be an integer), print out countdown
2243 digits and dots. Recommended value: 45 (9..1) for 80
2244 column displays, 15 (3..1) for 40 column displays.
2245
6d0f6bcf 2246- CONFIG_SYS_RX_ETH_BUFFER:
11ccc33f
MZ
2247 Defines the number of Ethernet receive buffers. On some
2248 Ethernet controllers it is recommended to set this value
53cf9435
SR
2249 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2250 buffers can be full shortly after enabling the interface
11ccc33f 2251 on high Ethernet traffic.
53cf9435
SR
2252 Defaults to 4 if not defined.
2253
c609719b
WD
2254The following definitions that deal with the placement and management
2255of environment data (variable area); in general, we support the
2256following configurations:
2257
5a1aceb0 2258- CONFIG_ENV_IS_IN_FLASH:
c609719b
WD
2259
2260 Define this if the environment is in flash memory.
2261
2262 a) The environment occupies one whole flash sector, which is
2263 "embedded" in the text segment with the U-Boot code. This
2264 happens usually with "bottom boot sector" or "top boot
2265 sector" type flash chips, which have several smaller
2266 sectors at the start or the end. For instance, such a
2267 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2268 such a case you would place the environment in one of the
2269 4 kB sectors - with U-Boot code before and after it. With
2270 "top boot sector" type flash chips, you would put the
2271 environment in one of the last sectors, leaving a gap
2272 between U-Boot and the environment.
2273
0e8d1586 2274 - CONFIG_ENV_OFFSET:
c609719b
WD
2275
2276 Offset of environment data (variable area) to the
2277 beginning of flash memory; for instance, with bottom boot
2278 type flash chips the second sector can be used: the offset
2279 for this sector is given here.
2280
6d0f6bcf 2281 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
c609719b 2282
0e8d1586 2283 - CONFIG_ENV_ADDR:
c609719b
WD
2284
2285 This is just another way to specify the start address of
2286 the flash sector containing the environment (instead of
0e8d1586 2287 CONFIG_ENV_OFFSET).
c609719b 2288
0e8d1586 2289 - CONFIG_ENV_SECT_SIZE:
c609719b
WD
2290
2291 Size of the sector containing the environment.
2292
2293
2294 b) Sometimes flash chips have few, equal sized, BIG sectors.
2295 In such a case you don't want to spend a whole sector for
2296 the environment.
2297
0e8d1586 2298 - CONFIG_ENV_SIZE:
c609719b 2299
5a1aceb0 2300 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
0e8d1586 2301 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
c609719b
WD
2302 of this flash sector for the environment. This saves
2303 memory for the RAM copy of the environment.
2304
2305 It may also save flash memory if you decide to use this
2306 when your environment is "embedded" within U-Boot code,
2307 since then the remainder of the flash sector could be used
2308 for U-Boot code. It should be pointed out that this is
2309 STRONGLY DISCOURAGED from a robustness point of view:
2310 updating the environment in flash makes it always
2311 necessary to erase the WHOLE sector. If something goes
2312 wrong before the contents has been restored from a copy in
2313 RAM, your target system will be dead.
2314
0e8d1586
JCPV
2315 - CONFIG_ENV_ADDR_REDUND
2316 CONFIG_ENV_SIZE_REDUND
c609719b 2317
43d9616c 2318 These settings describe a second storage area used to hold
11ccc33f 2319 a redundant copy of the environment data, so that there is
3e38691e 2320 a valid backup copy in case there is a power failure during
43d9616c 2321 a "saveenv" operation.
c609719b
WD
2322
2323BE CAREFUL! Any changes to the flash layout, and some changes to the
2324source code will make it necessary to adapt <board>/u-boot.lds*
2325accordingly!
2326
2327
9314cee6 2328- CONFIG_ENV_IS_IN_NVRAM:
c609719b
WD
2329
2330 Define this if you have some non-volatile memory device
2331 (NVRAM, battery buffered SRAM) which you want to use for the
2332 environment.
2333
0e8d1586
JCPV
2334 - CONFIG_ENV_ADDR:
2335 - CONFIG_ENV_SIZE:
c609719b 2336
11ccc33f 2337 These two #defines are used to determine the memory area you
c609719b
WD
2338 want to use for environment. It is assumed that this memory
2339 can just be read and written to, without any special
2340 provision.
2341
2342BE CAREFUL! The first access to the environment happens quite early
2343in U-Boot initalization (when we try to get the setting of for the
11ccc33f 2344console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b
WD
2345U-Boot will hang.
2346
2347Please note that even with NVRAM we still use a copy of the
2348environment in RAM: we could work on NVRAM directly, but we want to
2349keep settings there always unmodified except somebody uses "saveenv"
2350to save the current settings.
2351
2352
bb1f8b4f 2353- CONFIG_ENV_IS_IN_EEPROM:
c609719b
WD
2354
2355 Use this if you have an EEPROM or similar serial access
2356 device and a driver for it.
2357
0e8d1586
JCPV
2358 - CONFIG_ENV_OFFSET:
2359 - CONFIG_ENV_SIZE:
c609719b
WD
2360
2361 These two #defines specify the offset and size of the
2362 environment area within the total memory of your EEPROM.
2363
6d0f6bcf 2364 - CONFIG_SYS_I2C_EEPROM_ADDR:
c609719b
WD
2365 If defined, specified the chip address of the EEPROM device.
2366 The default address is zero.
2367
6d0f6bcf 2368 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
c609719b
WD
2369 If defined, the number of bits used to address bytes in a
2370 single page in the EEPROM device. A 64 byte page, for example
2371 would require six bits.
2372
6d0f6bcf 2373 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
c609719b 2374 If defined, the number of milliseconds to delay between
ba56f625 2375 page writes. The default is zero milliseconds.
c609719b 2376
6d0f6bcf 2377 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
c609719b
WD
2378 The length in bytes of the EEPROM memory array address. Note
2379 that this is NOT the chip address length!
2380
6d0f6bcf 2381 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
5cf91d6b
WD
2382 EEPROM chips that implement "address overflow" are ones
2383 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2384 address and the extra bits end up in the "chip address" bit
2385 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2386 byte chips.
2387
2388 Note that we consider the length of the address field to
2389 still be one byte because the extra address bits are hidden
2390 in the chip address.
2391
6d0f6bcf 2392 - CONFIG_SYS_EEPROM_SIZE:
c609719b
WD
2393 The size in bytes of the EEPROM device.
2394
c609719b 2395
057c849c 2396- CONFIG_ENV_IS_IN_DATAFLASH:
5779d8d9 2397
d4ca31c4 2398 Define this if you have a DataFlash memory device which you
5779d8d9
WD
2399 want to use for the environment.
2400
0e8d1586
JCPV
2401 - CONFIG_ENV_OFFSET:
2402 - CONFIG_ENV_ADDR:
2403 - CONFIG_ENV_SIZE:
5779d8d9
WD
2404
2405 These three #defines specify the offset and size of the
2406 environment area within the total memory of your DataFlash placed
2407 at the specified address.
2408
51bfee19 2409- CONFIG_ENV_IS_IN_NAND:
13a5695b
WD
2410
2411 Define this if you have a NAND device which you want to use
2412 for the environment.
2413
0e8d1586
JCPV
2414 - CONFIG_ENV_OFFSET:
2415 - CONFIG_ENV_SIZE:
13a5695b
WD
2416
2417 These two #defines specify the offset and size of the environment
2418 area within the first NAND device.
5779d8d9 2419
0e8d1586 2420 - CONFIG_ENV_OFFSET_REDUND
e443c944 2421
0e8d1586 2422 This setting describes a second storage area of CONFIG_ENV_SIZE
e443c944
MK
2423 size used to hold a redundant copy of the environment data,
2424 so that there is a valid backup copy in case there is a
2425 power failure during a "saveenv" operation.
2426
0e8d1586
JCPV
2427 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2428 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
e443c944
MK
2429 the NAND devices block size.
2430
6d0f6bcf 2431- CONFIG_SYS_SPI_INIT_OFFSET
c609719b
WD
2432
2433 Defines offset to the initial SPI buffer area in DPRAM. The
2434 area is used at an early stage (ROM part) if the environment
2435 is configured to reside in the SPI EEPROM: We need a 520 byte
2436 scratch DPRAM area. It is used between the two initialization
2437 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2438 to be a good choice since it makes it far enough from the
2439 start of the data area as well as from the stack pointer.
2440
e881cb56 2441Please note that the environment is read-only until the monitor
c609719b
WD
2442has been relocated to RAM and a RAM copy of the environment has been
2443created; also, when using EEPROM you will have to use getenv_r()
2444until then to read environment variables.
2445
85ec0bcc
WD
2446The environment is protected by a CRC32 checksum. Before the monitor
2447is relocated into RAM, as a result of a bad CRC you will be working
2448with the compiled-in default environment - *silently*!!! [This is
2449necessary, because the first environment variable we need is the
2450"baudrate" setting for the console - if we have a bad CRC, we don't
2451have any device yet where we could complain.]
c609719b
WD
2452
2453Note: once the monitor has been relocated, then it will complain if
2454the default environment is used; a new CRC is computed as soon as you
85ec0bcc 2455use the "saveenv" command to store a valid environment.
c609719b 2456
6d0f6bcf 2457- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
42d1f039 2458 Echo the inverted Ethernet link state to the fault LED.
fc3e2165 2459
6d0f6bcf 2460 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
fc3e2165
WD
2461 also needs to be defined.
2462
6d0f6bcf 2463- CONFIG_SYS_FAULT_MII_ADDR:
42d1f039 2464 MII address of the PHY to check for the Ethernet link state.
c609719b 2465
6d0f6bcf 2466- CONFIG_SYS_64BIT_VSPRINTF:
c40b2956
WD
2467 Makes vsprintf (and all *printf functions) support printing
2468 of 64bit values by using the L quantifier
2469
6d0f6bcf 2470- CONFIG_SYS_64BIT_STRTOUL:
c40b2956
WD
2471 Adds simple_strtoull that returns a 64bit value
2472
f5675aa5
RM
2473- CONFIG_NS16550_MIN_FUNCTIONS:
2474 Define this if you desire to only have use of the NS16550_init
2475 and NS16550_putc functions for the serial driver located at
2476 drivers/serial/ns16550.c. This option is useful for saving
2477 space for already greatly restricted images, including but not
2478 limited to NAND_SPL configurations.
2479
c609719b 2480Low Level (hardware related) configuration options:
dc7c9a1a 2481---------------------------------------------------
c609719b 2482
6d0f6bcf 2483- CONFIG_SYS_CACHELINE_SIZE:
c609719b
WD
2484 Cache Line Size of the CPU.
2485
6d0f6bcf 2486- CONFIG_SYS_DEFAULT_IMMR:
c609719b 2487 Default address of the IMMR after system reset.
2535d602 2488
42d1f039
WD
2489 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2490 and RPXsuper) to be able to adjust the position of
2491 the IMMR register after a reset.
c609719b 2492
7f6c2cbc 2493- Floppy Disk Support:
6d0f6bcf 2494 CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc
WD
2495
2496 the default drive number (default value 0)
2497
6d0f6bcf 2498 CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc 2499
11ccc33f 2500 defines the spacing between FDC chipset registers
7f6c2cbc
WD
2501 (default value 1)
2502
6d0f6bcf 2503 CONFIG_SYS_ISA_IO_OFFSET
7f6c2cbc 2504
43d9616c
WD
2505 defines the offset of register from address. It
2506 depends on which part of the data bus is connected to
11ccc33f 2507 the FDC chipset. (default value 0)
7f6c2cbc 2508
6d0f6bcf
JCPV
2509 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2510 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
43d9616c 2511 default value.
7f6c2cbc 2512
6d0f6bcf 2513 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43d9616c
WD
2514 fdc_hw_init() is called at the beginning of the FDC
2515 setup. fdc_hw_init() must be provided by the board
2516 source code. It is used to make hardware dependant
2517 initializations.
7f6c2cbc 2518
6d0f6bcf 2519- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
efe2a4d5 2520 DO NOT CHANGE unless you know exactly what you're
25d6712a 2521 doing! (11-4) [MPC8xx/82xx systems only]
c609719b 2522
6d0f6bcf 2523- CONFIG_SYS_INIT_RAM_ADDR:
c609719b 2524
7152b1d0 2525 Start address of memory area that can be used for
c609719b
WD
2526 initial data and stack; please note that this must be
2527 writable memory that is working WITHOUT special
2528 initialization, i. e. you CANNOT use normal RAM which
2529 will become available only after programming the
2530 memory controller and running certain initialization
2531 sequences.
2532
2533 U-Boot uses the following memory types:
2534 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2535 - MPC824X: data cache
2536 - PPC4xx: data cache
2537
6d0f6bcf 2538- CONFIG_SYS_GBL_DATA_OFFSET:
c609719b
WD
2539
2540 Offset of the initial data structure in the memory
6d0f6bcf
JCPV
2541 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2542 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b 2543 data is located at the end of the available space
6d0f6bcf
JCPV
2544 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2545 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2546 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2547 CONFIG_SYS_GBL_DATA_OFFSET) downward.
c609719b
WD
2548
2549 Note:
2550 On the MPC824X (or other systems that use the data
2551 cache for initial memory) the address chosen for
6d0f6bcf 2552 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b
WD
2553 point to an otherwise UNUSED address space between
2554 the top of RAM and the start of the PCI space.
2555
6d0f6bcf 2556- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
c609719b 2557
6d0f6bcf 2558- CONFIG_SYS_SYPCR: System Protection Control (11-9)
c609719b 2559
6d0f6bcf 2560- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
c609719b 2561
6d0f6bcf 2562- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
c609719b 2563
6d0f6bcf 2564- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
c609719b 2565
6d0f6bcf 2566- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
c609719b 2567
6d0f6bcf 2568- CONFIG_SYS_OR_TIMING_SDRAM:
c609719b
WD
2569 SDRAM timing
2570
6d0f6bcf 2571- CONFIG_SYS_MAMR_PTA:
c609719b
WD
2572 periodic timer for refresh
2573
6d0f6bcf 2574- CONFIG_SYS_DER: Debug Event Register (37-47)
c609719b 2575
6d0f6bcf
JCPV
2576- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2577 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2578 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2579 CONFIG_SYS_BR1_PRELIM:
c609719b
WD
2580 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2581
2582- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
6d0f6bcf
JCPV
2583 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2584 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
c609719b
WD
2585 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2586
6d0f6bcf
JCPV
2587- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2588 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
c609719b
WD
2589 Machine Mode Register and Memory Periodic Timer
2590 Prescaler definitions (SDRAM timing)
2591
6d0f6bcf 2592- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
c609719b
WD
2593 enable I2C microcode relocation patch (MPC8xx);
2594 define relocation offset in DPRAM [DSP2]
2595
6d0f6bcf 2596- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
b423d055
HS
2597 enable SMC microcode relocation patch (MPC8xx);
2598 define relocation offset in DPRAM [SMC1]
2599
6d0f6bcf 2600- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
c609719b
WD
2601 enable SPI microcode relocation patch (MPC8xx);
2602 define relocation offset in DPRAM [SCC4]
2603
6d0f6bcf 2604- CONFIG_SYS_USE_OSCCLK:
c609719b
WD
2605 Use OSCM clock mode on MBX8xx board. Be careful,
2606 wrong setting might damage your board. Read
2607 doc/README.MBX before setting this variable!
2608
6d0f6bcf 2609- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
43d9616c
WD
2610 Offset of the bootmode word in DPRAM used by post
2611 (Power On Self Tests). This definition overrides
2612 #define'd default value in commproc.h resp.
2613 cpm_8260.h.
ea909b76 2614
6d0f6bcf
JCPV
2615- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2616 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2617 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2618 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2619 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2620 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2621 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2622 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
5d232d0e
WD
2623 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2624
9cacf4fc
DE
2625- CONFIG_PCI_DISABLE_PCIE:
2626 Disable PCI-Express on systems where it is supported but not
2627 required.
2628
bb99ad6d 2629- CONFIG_SPD_EEPROM
218ca724
WD
2630 Get DDR timing information from an I2C EEPROM. Common
2631 with pluggable memory modules such as SODIMMs
2632
bb99ad6d
BW
2633 SPD_EEPROM_ADDRESS
2634 I2C address of the SPD EEPROM
2635
6d0f6bcf 2636- CONFIG_SYS_SPD_BUS_NUM
218ca724
WD
2637 If SPD EEPROM is on an I2C bus other than the first
2638 one, specify here. Note that the value must resolve
2639 to something your driver can deal with.
bb99ad6d 2640
6d0f6bcf 2641- CONFIG_SYS_83XX_DDR_USES_CS0
218ca724
WD
2642 Only for 83xx systems. If specified, then DDR should
2643 be configured using CS0 and CS1 instead of CS2 and CS3.
2ad6b513 2644
c26e454d
WD
2645- CONFIG_ETHER_ON_FEC[12]
2646 Define to enable FEC[12] on a 8xx series processor.
2647
2648- CONFIG_FEC[12]_PHY
2649 Define to the hardcoded PHY address which corresponds
6e592385
WD
2650 to the given FEC; i. e.
2651 #define CONFIG_FEC1_PHY 4
c26e454d
WD
2652 means that the PHY with address 4 is connected to FEC1
2653
2654 When set to -1, means to probe for first available.
2655
2656- CONFIG_FEC[12]_PHY_NORXERR
2657 The PHY does not have a RXERR line (RMII only).
2658 (so program the FEC to ignore it).
2659
2660- CONFIG_RMII
2661 Enable RMII mode for all FECs.
2662 Note that this is a global option, we can't
2663 have one FEC in standard MII mode and another in RMII mode.
2664
5cf91d6b
WD
2665- CONFIG_CRC32_VERIFY
2666 Add a verify option to the crc32 command.
2667 The syntax is:
2668
2669 => crc32 -v <address> <count> <crc32>
2670
2671 Where address/count indicate a memory area
2672 and crc32 is the correct crc32 which the
2673 area should have.
2674
56523f12
WD
2675- CONFIG_LOOPW
2676 Add the "loopw" memory command. This only takes effect if
602ad3b3 2677 the memory commands are activated globally (CONFIG_CMD_MEM).
56523f12 2678
7b466641
SR
2679- CONFIG_MX_CYCLIC
2680 Add the "mdc" and "mwc" memory commands. These are cyclic
2681 "md/mw" commands.
2682 Examples:
2683
efe2a4d5 2684 => mdc.b 10 4 500
7b466641
SR
2685 This command will print 4 bytes (10,11,12,13) each 500 ms.
2686
efe2a4d5 2687 => mwc.l 100 12345678 10
7b466641
SR
2688 This command will write 12345678 to address 100 all 10 ms.
2689
efe2a4d5 2690 This only takes effect if the memory commands are activated
602ad3b3 2691 globally (CONFIG_CMD_MEM).
7b466641 2692
8aa1a2d1
WD
2693- CONFIG_SKIP_LOWLEVEL_INIT
2694- CONFIG_SKIP_RELOCATE_UBOOT
2695
3c2b3d45
WD
2696 [ARM only] If these variables are defined, then
2697 certain low level initializations (like setting up
2698 the memory controller) are omitted and/or U-Boot does
2699 not relocate itself into RAM.
2700 Normally these variables MUST NOT be defined. The
2701 only exception is when U-Boot is loaded (to RAM) by
2702 some other boot loader or by a debugger which
11ccc33f 2703 performs these initializations itself.
8aa1a2d1 2704
df81238b
ML
2705- CONFIG_PRELOADER
2706
2707 Modifies the behaviour of start.S when compiling a loader
2708 that is executed before the actual U-Boot. E.g. when
2709 compiling a NAND SPL.
400558b5 2710
c609719b
WD
2711Building the Software:
2712======================
2713
218ca724
WD
2714Building U-Boot has been tested in several native build environments
2715and in many different cross environments. Of course we cannot support
2716all possibly existing versions of cross development tools in all
2717(potentially obsolete) versions. In case of tool chain problems we
2718recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2719which is extensively used to build and test U-Boot.
c609719b 2720
218ca724
WD
2721If you are not using a native environment, it is assumed that you
2722have GNU cross compiling tools available in your path. In this case,
2723you must set the environment variable CROSS_COMPILE in your shell.
2724Note that no changes to the Makefile or any other source files are
2725necessary. For example using the ELDK on a 4xx CPU, please enter:
c609719b 2726
218ca724
WD
2727 $ CROSS_COMPILE=ppc_4xx-
2728 $ export CROSS_COMPILE
c609719b 2729
2f8d396b
PT
2730Note: If you wish to generate Windows versions of the utilities in
2731 the tools directory you can use the MinGW toolchain
2732 (http://www.mingw.org). Set your HOST tools to the MinGW
2733 toolchain and execute 'make tools'. For example:
2734
2735 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2736
2737 Binaries such as tools/mkimage.exe will be created which can
2738 be executed on computers running Windows.
2739
218ca724
WD
2740U-Boot is intended to be simple to build. After installing the
2741sources you must configure U-Boot for one specific board type. This
c609719b
WD
2742is done by typing:
2743
2744 make NAME_config
2745
218ca724
WD
2746where "NAME_config" is the name of one of the existing configu-
2747rations; see the main Makefile for supported names.
db01a2ea 2748
2729af9d
WD
2749Note: for some board special configuration names may exist; check if
2750 additional information is available from the board vendor; for
2751 instance, the TQM823L systems are available without (standard)
2752 or with LCD support. You can select such additional "features"
11ccc33f 2753 when choosing the configuration, i. e.
2729af9d
WD
2754
2755 make TQM823L_config
2756 - will configure for a plain TQM823L, i. e. no LCD support
2757
2758 make TQM823L_LCD_config
2759 - will configure for a TQM823L with U-Boot console on LCD
2760
2761 etc.
2762
2763
2764Finally, type "make all", and you should get some working U-Boot
2765images ready for download to / installation on your system:
2766
2767- "u-boot.bin" is a raw binary image
2768- "u-boot" is an image in ELF binary format
2769- "u-boot.srec" is in Motorola S-Record format
2770
baf31249
MB
2771By default the build is performed locally and the objects are saved
2772in the source directory. One of the two methods can be used to change
2773this behavior and build U-Boot to some external directory:
2774
27751. Add O= to the make command line invocations:
2776
2777 make O=/tmp/build distclean
2778 make O=/tmp/build NAME_config
2779 make O=/tmp/build all
2780
27812. Set environment variable BUILD_DIR to point to the desired location:
2782
2783 export BUILD_DIR=/tmp/build
2784 make distclean
2785 make NAME_config
2786 make all
2787
2788Note that the command line "O=" setting overrides the BUILD_DIR environment
2789variable.
2790
2729af9d
WD
2791
2792Please be aware that the Makefiles assume you are using GNU make, so
2793for instance on NetBSD you might need to use "gmake" instead of
2794native "make".
2795
2796
2797If the system board that you have is not listed, then you will need
2798to port U-Boot to your hardware platform. To do this, follow these
2799steps:
2800
28011. Add a new configuration option for your board to the toplevel
2802 "Makefile" and to the "MAKEALL" script, using the existing
2803 entries as examples. Note that here and at many other places
2804 boards and other names are listed in alphabetical sort order. Please
2805 keep this order.
28062. Create a new directory to hold your board specific code. Add any
2807 files you need. In your board directory, you will need at least
2808 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
28093. Create a new configuration file "include/configs/<board>.h" for
2810 your board
28113. If you're porting U-Boot to a new CPU, then also create a new
2812 directory to hold your CPU specific code. Add any files you need.
28134. Run "make <board>_config" with your new name.
28145. Type "make", and you should get a working "u-boot.srec" file
2815 to be installed on your target system.
28166. Debug and solve any problems that might arise.
2817 [Of course, this last step is much harder than it sounds.]
2818
2819
2820Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2821==============================================================
2822
218ca724
WD
2823If you have modified U-Boot sources (for instance added a new board
2824or support for new devices, a new CPU, etc.) you are expected to
2729af9d
WD
2825provide feedback to the other developers. The feedback normally takes
2826the form of a "patch", i. e. a context diff against a certain (latest
218ca724 2827official or latest in the git repository) version of U-Boot sources.
2729af9d 2828
218ca724
WD
2829But before you submit such a patch, please verify that your modifi-
2830cation did not break existing code. At least make sure that *ALL* of
2729af9d
WD
2831the supported boards compile WITHOUT ANY compiler warnings. To do so,
2832just run the "MAKEALL" script, which will configure and build U-Boot
218ca724
WD
2833for ALL supported system. Be warned, this will take a while. You can
2834select which (cross) compiler to use by passing a `CROSS_COMPILE'
2835environment variable to the script, i. e. to use the ELDK cross tools
2836you can type
2729af9d
WD
2837
2838 CROSS_COMPILE=ppc_8xx- MAKEALL
2839
2840or to build on a native PowerPC system you can type
2841
2842 CROSS_COMPILE=' ' MAKEALL
2843
218ca724
WD
2844When using the MAKEALL script, the default behaviour is to build
2845U-Boot in the source directory. This location can be changed by
2846setting the BUILD_DIR environment variable. Also, for each target
2847built, the MAKEALL script saves two log files (<target>.ERR and
2848<target>.MAKEALL) in the <source dir>/LOG directory. This default
2849location can be changed by setting the MAKEALL_LOGDIR environment
2850variable. For example:
baf31249
MB
2851
2852 export BUILD_DIR=/tmp/build
2853 export MAKEALL_LOGDIR=/tmp/log
2854 CROSS_COMPILE=ppc_8xx- MAKEALL
2855
218ca724
WD
2856With the above settings build objects are saved in the /tmp/build,
2857log files are saved in the /tmp/log and the source tree remains clean
2858during the whole build process.
baf31249
MB
2859
2860
2729af9d
WD
2861See also "U-Boot Porting Guide" below.
2862
2863
2864Monitor Commands - Overview:
2865============================
2866
2867go - start application at address 'addr'
2868run - run commands in an environment variable
2869bootm - boot application image from memory
2870bootp - boot image via network using BootP/TFTP protocol
2871tftpboot- boot image via network using TFTP protocol
2872 and env variables "ipaddr" and "serverip"
2873 (and eventually "gatewayip")
2874rarpboot- boot image via network using RARP/TFTP protocol
2875diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2876loads - load S-Record file over serial line
2877loadb - load binary file over serial line (kermit mode)
2878md - memory display
2879mm - memory modify (auto-incrementing)
2880nm - memory modify (constant address)
2881mw - memory write (fill)
2882cp - memory copy
2883cmp - memory compare
2884crc32 - checksum calculation
0f89c54b 2885i2c - I2C sub-system
2729af9d
WD
2886sspi - SPI utility commands
2887base - print or set address offset
2888printenv- print environment variables
2889setenv - set environment variables
2890saveenv - save environment variables to persistent storage
2891protect - enable or disable FLASH write protection
2892erase - erase FLASH memory
2893flinfo - print FLASH memory information
2894bdinfo - print Board Info structure
2895iminfo - print header information for application image
2896coninfo - print console devices and informations
2897ide - IDE sub-system
2898loop - infinite loop on address range
56523f12 2899loopw - infinite write loop on address range
2729af9d
WD
2900mtest - simple RAM test
2901icache - enable or disable instruction cache
2902dcache - enable or disable data cache
2903reset - Perform RESET of the CPU
2904echo - echo args to console
2905version - print monitor version
2906help - print online help
2907? - alias for 'help'
2908
2909
2910Monitor Commands - Detailed Description:
2911========================================
2912
2913TODO.
2914
2915For now: just type "help <command>".
2916
2917
2918Environment Variables:
2919======================
2920
2921U-Boot supports user configuration using Environment Variables which
2922can be made persistent by saving to Flash memory.
c609719b 2923
2729af9d
WD
2924Environment Variables are set using "setenv", printed using
2925"printenv", and saved to Flash using "saveenv". Using "setenv"
2926without a value can be used to delete a variable from the
2927environment. As long as you don't save the environment you are
2928working with an in-memory copy. In case the Flash area containing the
2929environment is erased by accident, a default environment is provided.
c609719b 2930
2729af9d 2931Some configuration options can be set using Environment Variables:
c609719b 2932
2729af9d 2933 baudrate - see CONFIG_BAUDRATE
c609719b 2934
2729af9d 2935 bootdelay - see CONFIG_BOOTDELAY
c609719b 2936
2729af9d 2937 bootcmd - see CONFIG_BOOTCOMMAND
4a6fd34b 2938
2729af9d 2939 bootargs - Boot arguments when booting an RTOS image
c609719b 2940
2729af9d 2941 bootfile - Name of the image to load with TFTP
c609719b 2942
7d721e34
BS
2943 bootm_low - Memory range available for image processing in the bootm
2944 command can be restricted. This variable is given as
2945 a hexadecimal number and defines lowest address allowed
2946 for use by the bootm command. See also "bootm_size"
2947 environment variable. Address defined by "bootm_low" is
2948 also the base of the initial memory mapping for the Linux
6d0f6bcf 2949 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
7d721e34
BS
2950
2951 bootm_size - Memory range available for image processing in the bootm
2952 command can be restricted. This variable is given as
2953 a hexadecimal number and defines the size of the region
2954 allowed for use by the bootm command. See also "bootm_low"
2955 environment variable.
2956
4bae9090
BS
2957 updatefile - Location of the software update file on a TFTP server, used
2958 by the automatic software update feature. Please refer to
2959 documentation in doc/README.update for more details.
2960
2729af9d
WD
2961 autoload - if set to "no" (any string beginning with 'n'),
2962 "bootp" will just load perform a lookup of the
2963 configuration from the BOOTP server, but not try to
2964 load any image using TFTP
c609719b 2965
3310c549
MB
2966 autoscript - if set to "yes" commands like "loadb", "loady",
2967 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
2968 to automatically run script images (by internally
74de7aef 2969 calling "source").
3310c549
MB
2970
2971 autoscript_uname - if script image is in a format (FIT) this
2972 variable is used to get script subimage unit name.
2973
2729af9d
WD
2974 autostart - if set to "yes", an image loaded using the "bootp",
2975 "rarpboot", "tftpboot" or "diskboot" commands will
2976 be automatically started (by internally calling
2977 "bootm")
38b99261 2978
2729af9d
WD
2979 If set to "no", a standalone image passed to the
2980 "bootm" command will be copied to the load address
2981 (and eventually uncompressed), but NOT be started.
2982 This can be used to load and uncompress arbitrary
2983 data.
c609719b 2984
17ea1177
WD
2985 i2cfast - (PPC405GP|PPC405EP only)
2986 if set to 'y' configures Linux I2C driver for fast
2987 mode (400kHZ). This environment variable is used in
2988 initialization code. So, for changes to be effective
2989 it must be saved and board must be reset.
2990
2729af9d
WD
2991 initrd_high - restrict positioning of initrd images:
2992 If this variable is not set, initrd images will be
2993 copied to the highest possible address in RAM; this
2994 is usually what you want since it allows for
2995 maximum initrd size. If for some reason you want to
2996 make sure that the initrd image is loaded below the
6d0f6bcf 2997 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d
WD
2998 variable to a value of "no" or "off" or "0".
2999 Alternatively, you can set it to a maximum upper
3000 address to use (U-Boot will still check that it
3001 does not overwrite the U-Boot stack and data).
c609719b 3002
2729af9d
WD
3003 For instance, when you have a system with 16 MB
3004 RAM, and want to reserve 4 MB from use by Linux,
3005 you can do this by adding "mem=12M" to the value of
3006 the "bootargs" variable. However, now you must make
3007 sure that the initrd image is placed in the first
3008 12 MB as well - this can be done with
c609719b 3009
2729af9d 3010 setenv initrd_high 00c00000
c609719b 3011
2729af9d
WD
3012 If you set initrd_high to 0xFFFFFFFF, this is an
3013 indication to U-Boot that all addresses are legal
3014 for the Linux kernel, including addresses in flash
3015 memory. In this case U-Boot will NOT COPY the
3016 ramdisk at all. This may be useful to reduce the
3017 boot time on your system, but requires that this
3018 feature is supported by your Linux kernel.
c609719b 3019
2729af9d 3020 ipaddr - IP address; needed for tftpboot command
c609719b 3021
2729af9d
WD
3022 loadaddr - Default load address for commands like "bootp",
3023 "rarpboot", "tftpboot", "loadb" or "diskboot"
c609719b 3024
2729af9d 3025 loads_echo - see CONFIG_LOADS_ECHO
a3d991bd 3026
2729af9d 3027 serverip - TFTP server IP address; needed for tftpboot command
a3d991bd 3028
2729af9d 3029 bootretry - see CONFIG_BOOT_RETRY_TIME
a3d991bd 3030
2729af9d 3031 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
a3d991bd 3032
2729af9d 3033 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
c609719b 3034
2729af9d
WD
3035 ethprime - When CONFIG_NET_MULTI is enabled controls which
3036 interface is used first.
c609719b 3037
2729af9d
WD
3038 ethact - When CONFIG_NET_MULTI is enabled controls which
3039 interface is currently active. For example you
3040 can do the following
c609719b 3041
2729af9d
WD
3042 => setenv ethact FEC ETHERNET
3043 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3044 => setenv ethact SCC ETHERNET
3045 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
c609719b 3046
e1692577
MF
3047 ethrotate - When set to "no" U-Boot does not go through all
3048 available network interfaces.
3049 It just stays at the currently selected interface.
3050
2729af9d
WD
3051 netretry - When set to "no" each network operation will
3052 either succeed or fail without retrying.
3053 When set to "once" the network operation will
3054 fail when all the available network interfaces
3055 are tried once without success.
3056 Useful on scripts which control the retry operation
3057 themselves.
c609719b 3058
b4e2f89d 3059 npe_ucode - set load address for the NPE microcode
a1cf027a 3060
28cb9375 3061 tftpsrcport - If this is set, the value is used for TFTP's
ecb0ccd9
WD
3062 UDP source port.
3063
28cb9375
WD
3064 tftpdstport - If this is set, the value is used for TFTP's UDP
3065 destination port instead of the Well Know Port 69.
3066
2729af9d 3067 vlan - When set to a value < 4095 the traffic over
11ccc33f 3068 Ethernet is encapsulated/received over 802.1q
2729af9d 3069 VLAN tagged frames.
c609719b 3070
2729af9d
WD
3071The following environment variables may be used and automatically
3072updated by the network boot commands ("bootp" and "rarpboot"),
3073depending the information provided by your boot server:
c609719b 3074
2729af9d
WD
3075 bootfile - see above
3076 dnsip - IP address of your Domain Name Server
3077 dnsip2 - IP address of your secondary Domain Name Server
3078 gatewayip - IP address of the Gateway (Router) to use
3079 hostname - Target hostname
3080 ipaddr - see above
3081 netmask - Subnet Mask
3082 rootpath - Pathname of the root filesystem on the NFS server
3083 serverip - see above
c1551ea8 3084
c1551ea8 3085
2729af9d 3086There are two special Environment Variables:
c1551ea8 3087
2729af9d
WD
3088 serial# - contains hardware identification information such
3089 as type string and/or serial number
3090 ethaddr - Ethernet address
c609719b 3091
2729af9d
WD
3092These variables can be set only once (usually during manufacturing of
3093the board). U-Boot refuses to delete or overwrite these variables
3094once they have been set once.
c609719b 3095
f07771cc 3096
2729af9d 3097Further special Environment Variables:
f07771cc 3098
2729af9d
WD
3099 ver - Contains the U-Boot version string as printed
3100 with the "version" command. This variable is
3101 readonly (see CONFIG_VERSION_VARIABLE).
f07771cc 3102
f07771cc 3103
2729af9d
WD
3104Please note that changes to some configuration parameters may take
3105only effect after the next boot (yes, that's just like Windoze :-).
f07771cc 3106
f07771cc 3107
2729af9d
WD
3108Command Line Parsing:
3109=====================
f07771cc 3110
2729af9d
WD
3111There are two different command line parsers available with U-Boot:
3112the old "simple" one, and the much more powerful "hush" shell:
c609719b 3113
2729af9d
WD
3114Old, simple command line parser:
3115--------------------------------
c609719b 3116
2729af9d
WD
3117- supports environment variables (through setenv / saveenv commands)
3118- several commands on one line, separated by ';'
fe126d8b 3119- variable substitution using "... ${name} ..." syntax
2729af9d
WD
3120- special characters ('$', ';') can be escaped by prefixing with '\',
3121 for example:
fe126d8b 3122 setenv bootcmd bootm \${address}
2729af9d
WD
3123- You can also escape text by enclosing in single apostrophes, for example:
3124 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
c609719b 3125
2729af9d
WD
3126Hush shell:
3127-----------
c609719b 3128
2729af9d
WD
3129- similar to Bourne shell, with control structures like
3130 if...then...else...fi, for...do...done; while...do...done,
3131 until...do...done, ...
3132- supports environment ("global") variables (through setenv / saveenv
3133 commands) and local shell variables (through standard shell syntax
3134 "name=value"); only environment variables can be used with "run"
3135 command
3136
3137General rules:
3138--------------
c609719b 3139
2729af9d
WD
3140(1) If a command line (or an environment variable executed by a "run"
3141 command) contains several commands separated by semicolon, and
3142 one of these commands fails, then the remaining commands will be
3143 executed anyway.
c609719b 3144
2729af9d 3145(2) If you execute several variables with one call to run (i. e.
11ccc33f 3146 calling run with a list of variables as arguments), any failing
2729af9d
WD
3147 command will cause "run" to terminate, i. e. the remaining
3148 variables are not executed.
c609719b 3149
2729af9d
WD
3150Note for Redundant Ethernet Interfaces:
3151=======================================
c609719b 3152
11ccc33f 3153Some boards come with redundant Ethernet interfaces; U-Boot supports
2729af9d
WD
3154such configurations and is capable of automatic selection of a
3155"working" interface when needed. MAC assignment works as follows:
c609719b 3156
2729af9d
WD
3157Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3158MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3159"eth1addr" (=>eth1), "eth2addr", ...
c609719b 3160
2729af9d
WD
3161If the network interface stores some valid MAC address (for instance
3162in SROM), this is used as default address if there is NO correspon-
3163ding setting in the environment; if the corresponding environment
3164variable is set, this overrides the settings in the card; that means:
c609719b 3165
2729af9d
WD
3166o If the SROM has a valid MAC address, and there is no address in the
3167 environment, the SROM's address is used.
c609719b 3168
2729af9d
WD
3169o If there is no valid address in the SROM, and a definition in the
3170 environment exists, then the value from the environment variable is
3171 used.
c609719b 3172
2729af9d
WD
3173o If both the SROM and the environment contain a MAC address, and
3174 both addresses are the same, this MAC address is used.
c609719b 3175
2729af9d
WD
3176o If both the SROM and the environment contain a MAC address, and the
3177 addresses differ, the value from the environment is used and a
3178 warning is printed.
c609719b 3179
2729af9d
WD
3180o If neither SROM nor the environment contain a MAC address, an error
3181 is raised.
c609719b 3182
c609719b 3183
2729af9d
WD
3184Image Formats:
3185==============
c609719b 3186
3310c549
MB
3187U-Boot is capable of booting (and performing other auxiliary operations on)
3188images in two formats:
3189
3190New uImage format (FIT)
3191-----------------------
3192
3193Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3194to Flattened Device Tree). It allows the use of images with multiple
3195components (several kernels, ramdisks, etc.), with contents protected by
3196SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3197
3198
3199Old uImage format
3200-----------------
3201
3202Old image format is based on binary files which can be basically anything,
3203preceded by a special header; see the definitions in include/image.h for
3204details; basically, the header defines the following image properties:
c609719b 3205
2729af9d
WD
3206* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3207 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
f5ed9e39
PT
3208 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3209 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3210 INTEGRITY).
7b64fef3 3211* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
2729af9d 3212 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
7b64fef3 3213 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2729af9d
WD
3214* Compression Type (uncompressed, gzip, bzip2)
3215* Load Address
3216* Entry Point
3217* Image Name
3218* Image Timestamp
c609719b 3219
2729af9d
WD
3220The header is marked by a special Magic Number, and both the header
3221and the data portions of the image are secured against corruption by
3222CRC32 checksums.
c609719b
WD
3223
3224
2729af9d
WD
3225Linux Support:
3226==============
c609719b 3227
2729af9d
WD
3228Although U-Boot should support any OS or standalone application
3229easily, the main focus has always been on Linux during the design of
3230U-Boot.
c609719b 3231
2729af9d
WD
3232U-Boot includes many features that so far have been part of some
3233special "boot loader" code within the Linux kernel. Also, any
3234"initrd" images to be used are no longer part of one big Linux image;
3235instead, kernel and "initrd" are separate images. This implementation
3236serves several purposes:
c609719b 3237
2729af9d
WD
3238- the same features can be used for other OS or standalone
3239 applications (for instance: using compressed images to reduce the
3240 Flash memory footprint)
c609719b 3241
2729af9d
WD
3242- it becomes much easier to port new Linux kernel versions because
3243 lots of low-level, hardware dependent stuff are done by U-Boot
c609719b 3244
2729af9d
WD
3245- the same Linux kernel image can now be used with different "initrd"
3246 images; of course this also means that different kernel images can
3247 be run with the same "initrd". This makes testing easier (you don't
3248 have to build a new "zImage.initrd" Linux image when you just
3249 change a file in your "initrd"). Also, a field-upgrade of the
3250 software is easier now.
c609719b 3251
c609719b 3252
2729af9d
WD
3253Linux HOWTO:
3254============
c609719b 3255
2729af9d
WD
3256Porting Linux to U-Boot based systems:
3257---------------------------------------
c609719b 3258
2729af9d
WD
3259U-Boot cannot save you from doing all the necessary modifications to
3260configure the Linux device drivers for use with your target hardware
3261(no, we don't intend to provide a full virtual machine interface to
3262Linux :-).
c609719b 3263
2729af9d 3264But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
24ee89b9 3265
2729af9d
WD
3266Just make sure your machine specific header file (for instance
3267include/asm-ppc/tqm8xx.h) includes the same definition of the Board
1dc30693
MH
3268Information structure as we define in include/asm-<arch>/u-boot.h,
3269and make sure that your definition of IMAP_ADDR uses the same value
6d0f6bcf 3270as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b9 3271
c609719b 3272
2729af9d
WD
3273Configuring the Linux kernel:
3274-----------------------------
c609719b 3275
2729af9d
WD
3276No specific requirements for U-Boot. Make sure you have some root
3277device (initial ramdisk, NFS) for your target system.
3278
3279
3280Building a Linux Image:
3281-----------------------
c609719b 3282
2729af9d
WD
3283With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3284not used. If you use recent kernel source, a new build target
3285"uImage" will exist which automatically builds an image usable by
3286U-Boot. Most older kernels also have support for a "pImage" target,
3287which was introduced for our predecessor project PPCBoot and uses a
3288100% compatible format.
3289
3290Example:
3291
3292 make TQM850L_config
3293 make oldconfig
3294 make dep
3295 make uImage
3296
3297The "uImage" build target uses a special tool (in 'tools/mkimage') to
3298encapsulate a compressed Linux kernel image with header information,
3299CRC32 checksum etc. for use with U-Boot. This is what we are doing:
3300
3301* build a standard "vmlinux" kernel image (in ELF binary format):
3302
3303* convert the kernel into a raw binary image:
3304
3305 ${CROSS_COMPILE}-objcopy -O binary \
3306 -R .note -R .comment \
3307 -S vmlinux linux.bin
3308
3309* compress the binary image:
3310
3311 gzip -9 linux.bin
3312
3313* package compressed binary image for U-Boot:
3314
3315 mkimage -A ppc -O linux -T kernel -C gzip \
3316 -a 0 -e 0 -n "Linux Kernel Image" \
3317 -d linux.bin.gz uImage
c609719b 3318
c609719b 3319
2729af9d
WD
3320The "mkimage" tool can also be used to create ramdisk images for use
3321with U-Boot, either separated from the Linux kernel image, or
3322combined into one file. "mkimage" encapsulates the images with a 64
3323byte header containing information about target architecture,
3324operating system, image type, compression method, entry points, time
3325stamp, CRC32 checksums, etc.
3326
3327"mkimage" can be called in two ways: to verify existing images and
3328print the header information, or to build new images.
3329
3330In the first form (with "-l" option) mkimage lists the information
3331contained in the header of an existing U-Boot image; this includes
3332checksum verification:
c609719b 3333
2729af9d
WD
3334 tools/mkimage -l image
3335 -l ==> list image header information
3336
3337The second form (with "-d" option) is used to build a U-Boot image
3338from a "data file" which is used as image payload:
3339
3340 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3341 -n name -d data_file image
3342 -A ==> set architecture to 'arch'
3343 -O ==> set operating system to 'os'
3344 -T ==> set image type to 'type'
3345 -C ==> set compression type 'comp'
3346 -a ==> set load address to 'addr' (hex)
3347 -e ==> set entry point to 'ep' (hex)
3348 -n ==> set image name to 'name'
3349 -d ==> use image data from 'datafile'
3350
69459791
WD
3351Right now, all Linux kernels for PowerPC systems use the same load
3352address (0x00000000), but the entry point address depends on the
3353kernel version:
2729af9d
WD
3354
3355- 2.2.x kernels have the entry point at 0x0000000C,
3356- 2.3.x and later kernels have the entry point at 0x00000000.
3357
3358So a typical call to build a U-Boot image would read:
3359
3360 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3361 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3362 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3363 > examples/uImage.TQM850L
3364 Image Name: 2.4.4 kernel for TQM850L
3365 Created: Wed Jul 19 02:34:59 2000
3366 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3367 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3368 Load Address: 0x00000000
3369 Entry Point: 0x00000000
3370
3371To verify the contents of the image (or check for corruption):
3372
3373 -> tools/mkimage -l examples/uImage.TQM850L
3374 Image Name: 2.4.4 kernel for TQM850L
3375 Created: Wed Jul 19 02:34:59 2000
3376 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3377 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3378 Load Address: 0x00000000
3379 Entry Point: 0x00000000
3380
3381NOTE: for embedded systems where boot time is critical you can trade
3382speed for memory and install an UNCOMPRESSED image instead: this
3383needs more space in Flash, but boots much faster since it does not
3384need to be uncompressed:
3385
3386 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3387 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3388 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3389 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3390 > examples/uImage.TQM850L-uncompressed
3391 Image Name: 2.4.4 kernel for TQM850L
3392 Created: Wed Jul 19 02:34:59 2000
3393 Image Type: PowerPC Linux Kernel Image (uncompressed)
3394 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3395 Load Address: 0x00000000
3396 Entry Point: 0x00000000
3397
3398
3399Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3400when your kernel is intended to use an initial ramdisk:
3401
3402 -> tools/mkimage -n 'Simple Ramdisk Image' \
3403 > -A ppc -O linux -T ramdisk -C gzip \
3404 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3405 Image Name: Simple Ramdisk Image
3406 Created: Wed Jan 12 14:01:50 2000
3407 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3408 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3409 Load Address: 0x00000000
3410 Entry Point: 0x00000000
3411
3412
3413Installing a Linux Image:
3414-------------------------
3415
3416To downloading a U-Boot image over the serial (console) interface,
3417you must convert the image to S-Record format:
3418
3419 objcopy -I binary -O srec examples/image examples/image.srec
3420
3421The 'objcopy' does not understand the information in the U-Boot
3422image header, so the resulting S-Record file will be relative to
3423address 0x00000000. To load it to a given address, you need to
3424specify the target address as 'offset' parameter with the 'loads'
3425command.
3426
3427Example: install the image to address 0x40100000 (which on the
3428TQM8xxL is in the first Flash bank):
3429
3430 => erase 40100000 401FFFFF
3431
3432 .......... done
3433 Erased 8 sectors
3434
3435 => loads 40100000
3436 ## Ready for S-Record download ...
3437 ~>examples/image.srec
3438 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3439 ...
3440 15989 15990 15991 15992
3441 [file transfer complete]
3442 [connected]
3443 ## Start Addr = 0x00000000
3444
3445
3446You can check the success of the download using the 'iminfo' command;
218ca724 3447this includes a checksum verification so you can be sure no data
2729af9d
WD
3448corruption happened:
3449
3450 => imi 40100000
3451
3452 ## Checking Image at 40100000 ...
3453 Image Name: 2.2.13 for initrd on TQM850L
3454 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3455 Data Size: 335725 Bytes = 327 kB = 0 MB
3456 Load Address: 00000000
3457 Entry Point: 0000000c
3458 Verifying Checksum ... OK
3459
3460
3461Boot Linux:
3462-----------
3463
3464The "bootm" command is used to boot an application that is stored in
3465memory (RAM or Flash). In case of a Linux kernel image, the contents
3466of the "bootargs" environment variable is passed to the kernel as
3467parameters. You can check and modify this variable using the
3468"printenv" and "setenv" commands:
3469
3470
3471 => printenv bootargs
3472 bootargs=root=/dev/ram
3473
3474 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3475
3476 => printenv bootargs
3477 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3478
3479 => bootm 40020000
3480 ## Booting Linux kernel at 40020000 ...
3481 Image Name: 2.2.13 for NFS on TQM850L
3482 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3483 Data Size: 381681 Bytes = 372 kB = 0 MB
3484 Load Address: 00000000
3485 Entry Point: 0000000c
3486 Verifying Checksum ... OK
3487 Uncompressing Kernel Image ... OK
3488 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
3489 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3490 time_init: decrementer frequency = 187500000/60
3491 Calibrating delay loop... 49.77 BogoMIPS
3492 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3493 ...
3494
11ccc33f 3495If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d
WD
3496the memory addresses of both the kernel and the initrd image (PPBCOOT
3497format!) to the "bootm" command:
3498
3499 => imi 40100000 40200000
3500
3501 ## Checking Image at 40100000 ...
3502 Image Name: 2.2.13 for initrd on TQM850L
3503 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3504 Data Size: 335725 Bytes = 327 kB = 0 MB
3505 Load Address: 00000000
3506 Entry Point: 0000000c
3507 Verifying Checksum ... OK
3508
3509 ## Checking Image at 40200000 ...
3510 Image Name: Simple Ramdisk Image
3511 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3512 Data Size: 566530 Bytes = 553 kB = 0 MB
3513 Load Address: 00000000
3514 Entry Point: 00000000
3515 Verifying Checksum ... OK
3516
3517 => bootm 40100000 40200000
3518 ## Booting Linux kernel at 40100000 ...
3519 Image Name: 2.2.13 for initrd on TQM850L
3520 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3521 Data Size: 335725 Bytes = 327 kB = 0 MB
3522 Load Address: 00000000
3523 Entry Point: 0000000c
3524 Verifying Checksum ... OK
3525 Uncompressing Kernel Image ... OK
3526 ## Loading RAMDisk Image at 40200000 ...
3527 Image Name: Simple Ramdisk Image
3528 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3529 Data Size: 566530 Bytes = 553 kB = 0 MB
3530 Load Address: 00000000
3531 Entry Point: 00000000
3532 Verifying Checksum ... OK
3533 Loading Ramdisk ... OK
3534 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
3535 Boot arguments: root=/dev/ram
3536 time_init: decrementer frequency = 187500000/60
3537 Calibrating delay loop... 49.77 BogoMIPS
3538 ...
3539 RAMDISK: Compressed image found at block 0
3540 VFS: Mounted root (ext2 filesystem).
3541
3542 bash#
3543
0267768e
MM
3544Boot Linux and pass a flat device tree:
3545-----------
3546
3547First, U-Boot must be compiled with the appropriate defines. See the section
3548titled "Linux Kernel Interface" above for a more in depth explanation. The
3549following is an example of how to start a kernel and pass an updated
3550flat device tree:
3551
3552=> print oftaddr
3553oftaddr=0x300000
3554=> print oft
3555oft=oftrees/mpc8540ads.dtb
3556=> tftp $oftaddr $oft
3557Speed: 1000, full duplex
3558Using TSEC0 device
3559TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3560Filename 'oftrees/mpc8540ads.dtb'.
3561Load address: 0x300000
3562Loading: #
3563done
3564Bytes transferred = 4106 (100a hex)
3565=> tftp $loadaddr $bootfile
3566Speed: 1000, full duplex
3567Using TSEC0 device
3568TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3569Filename 'uImage'.
3570Load address: 0x200000
3571Loading:############
3572done
3573Bytes transferred = 1029407 (fb51f hex)
3574=> print loadaddr
3575loadaddr=200000
3576=> print oftaddr
3577oftaddr=0x300000
3578=> bootm $loadaddr - $oftaddr
3579## Booting image at 00200000 ...
a9398e01
WD
3580 Image Name: Linux-2.6.17-dirty
3581 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3582 Data Size: 1029343 Bytes = 1005.2 kB
0267768e 3583 Load Address: 00000000
a9398e01 3584 Entry Point: 00000000
0267768e
MM
3585 Verifying Checksum ... OK
3586 Uncompressing Kernel Image ... OK
3587Booting using flat device tree at 0x300000
3588Using MPC85xx ADS machine description
3589Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3590[snip]
3591
3592
2729af9d
WD
3593More About U-Boot Image Types:
3594------------------------------
3595
3596U-Boot supports the following image types:
3597
3598 "Standalone Programs" are directly runnable in the environment
3599 provided by U-Boot; it is expected that (if they behave
3600 well) you can continue to work in U-Boot after return from
3601 the Standalone Program.
3602 "OS Kernel Images" are usually images of some Embedded OS which
3603 will take over control completely. Usually these programs
3604 will install their own set of exception handlers, device
3605 drivers, set up the MMU, etc. - this means, that you cannot
3606 expect to re-enter U-Boot except by resetting the CPU.
3607 "RAMDisk Images" are more or less just data blocks, and their
3608 parameters (address, size) are passed to an OS kernel that is
3609 being started.
3610 "Multi-File Images" contain several images, typically an OS
3611 (Linux) kernel image and one or more data images like
3612 RAMDisks. This construct is useful for instance when you want
3613 to boot over the network using BOOTP etc., where the boot
3614 server provides just a single image file, but you want to get
3615 for instance an OS kernel and a RAMDisk image.
3616
3617 "Multi-File Images" start with a list of image sizes, each
3618 image size (in bytes) specified by an "uint32_t" in network
3619 byte order. This list is terminated by an "(uint32_t)0".
3620 Immediately after the terminating 0 follow the images, one by
3621 one, all aligned on "uint32_t" boundaries (size rounded up to
3622 a multiple of 4 bytes).
3623
3624 "Firmware Images" are binary images containing firmware (like
3625 U-Boot or FPGA images) which usually will be programmed to
3626 flash memory.
3627
3628 "Script files" are command sequences that will be executed by
3629 U-Boot's command interpreter; this feature is especially
3630 useful when you configure U-Boot to use a real shell (hush)
3631 as command interpreter.
3632
3633
3634Standalone HOWTO:
3635=================
3636
3637One of the features of U-Boot is that you can dynamically load and
3638run "standalone" applications, which can use some resources of
3639U-Boot like console I/O functions or interrupt services.
3640
3641Two simple examples are included with the sources:
3642
3643"Hello World" Demo:
3644-------------------
3645
3646'examples/hello_world.c' contains a small "Hello World" Demo
3647application; it is automatically compiled when you build U-Boot.
3648It's configured to run at address 0x00040004, so you can play with it
3649like that:
3650
3651 => loads
3652 ## Ready for S-Record download ...
3653 ~>examples/hello_world.srec
3654 1 2 3 4 5 6 7 8 9 10 11 ...
3655 [file transfer complete]
3656 [connected]
3657 ## Start Addr = 0x00040004
3658
3659 => go 40004 Hello World! This is a test.
3660 ## Starting application at 0x00040004 ...
3661 Hello World
3662 argc = 7
3663 argv[0] = "40004"
3664 argv[1] = "Hello"
3665 argv[2] = "World!"
3666 argv[3] = "This"
3667 argv[4] = "is"
3668 argv[5] = "a"
3669 argv[6] = "test."
3670 argv[7] = "<NULL>"
3671 Hit any key to exit ...
3672
3673 ## Application terminated, rc = 0x0
3674
3675Another example, which demonstrates how to register a CPM interrupt
3676handler with the U-Boot code, can be found in 'examples/timer.c'.
3677Here, a CPM timer is set up to generate an interrupt every second.
3678The interrupt service routine is trivial, just printing a '.'
3679character, but this is just a demo program. The application can be
3680controlled by the following keys:
3681
3682 ? - print current values og the CPM Timer registers
3683 b - enable interrupts and start timer
3684 e - stop timer and disable interrupts
3685 q - quit application
3686
3687 => loads
3688 ## Ready for S-Record download ...
3689 ~>examples/timer.srec
3690 1 2 3 4 5 6 7 8 9 10 11 ...
3691 [file transfer complete]
3692 [connected]
3693 ## Start Addr = 0x00040004
3694
3695 => go 40004
3696 ## Starting application at 0x00040004 ...
3697 TIMERS=0xfff00980
3698 Using timer 1
3699 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3700
3701Hit 'b':
3702 [q, b, e, ?] Set interval 1000000 us
3703 Enabling timer
3704Hit '?':
3705 [q, b, e, ?] ........
3706 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3707Hit '?':
3708 [q, b, e, ?] .
3709 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3710Hit '?':
3711 [q, b, e, ?] .
3712 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3713Hit '?':
3714 [q, b, e, ?] .
3715 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3716Hit 'e':
3717 [q, b, e, ?] ...Stopping timer
3718Hit 'q':
3719 [q, b, e, ?] ## Application terminated, rc = 0x0
3720
3721
3722Minicom warning:
3723================
3724
3725Over time, many people have reported problems when trying to use the
3726"minicom" terminal emulation program for serial download. I (wd)
3727consider minicom to be broken, and recommend not to use it. Under
3728Unix, I recommend to use C-Kermit for general purpose use (and
3729especially for kermit binary protocol download ("loadb" command), and
3730use "cu" for S-Record download ("loads" command).
3731
3732Nevertheless, if you absolutely want to use it try adding this
3733configuration to your "File transfer protocols" section:
3734
3735 Name Program Name U/D FullScr IO-Red. Multi
3736 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3737 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
3738
3739
3740NetBSD Notes:
3741=============
3742
3743Starting at version 0.9.2, U-Boot supports NetBSD both as host
3744(build U-Boot) and target system (boots NetBSD/mpc8xx).
3745
3746Building requires a cross environment; it is known to work on
3747NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3748need gmake since the Makefiles are not compatible with BSD make).
3749Note that the cross-powerpc package does not install include files;
3750attempting to build U-Boot will fail because <machine/ansi.h> is
3751missing. This file has to be installed and patched manually:
3752
3753 # cd /usr/pkg/cross/powerpc-netbsd/include
3754 # mkdir powerpc
3755 # ln -s powerpc machine
3756 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3757 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
3758
3759Native builds *don't* work due to incompatibilities between native
3760and U-Boot include files.
3761
3762Booting assumes that (the first part of) the image booted is a
3763stage-2 loader which in turn loads and then invokes the kernel
3764proper. Loader sources will eventually appear in the NetBSD source
3765tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2a8af187 3766meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d
WD
3767
3768
3769Implementation Internals:
3770=========================
3771
3772The following is not intended to be a complete description of every
3773implementation detail. However, it should help to understand the
3774inner workings of U-Boot and make it easier to port it to custom
3775hardware.
3776
3777
3778Initial Stack, Global Data:
3779---------------------------
3780
3781The implementation of U-Boot is complicated by the fact that U-Boot
3782starts running out of ROM (flash memory), usually without access to
3783system RAM (because the memory controller is not initialized yet).
3784This means that we don't have writable Data or BSS segments, and BSS
3785is not initialized as zero. To be able to get a C environment working
3786at all, we have to allocate at least a minimal stack. Implementation
3787options for this are defined and restricted by the CPU used: Some CPU
3788models provide on-chip memory (like the IMMR area on MPC8xx and
3789MPC826x processors), on others (parts of) the data cache can be
3790locked as (mis-) used as memory, etc.
3791
218ca724 3792 Chris Hallinan posted a good summary of these issues to the
0668236b 3793 U-Boot mailing list:
2729af9d
WD
3794
3795 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3796 From: "Chris Hallinan" <clh@net1plus.com>
3797 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3798 ...
3799
3800 Correct me if I'm wrong, folks, but the way I understand it
3801 is this: Using DCACHE as initial RAM for Stack, etc, does not
3802 require any physical RAM backing up the cache. The cleverness
3803 is that the cache is being used as a temporary supply of
3804 necessary storage before the SDRAM controller is setup. It's
11ccc33f 3805 beyond the scope of this list to explain the details, but you
2729af9d
WD
3806 can see how this works by studying the cache architecture and
3807 operation in the architecture and processor-specific manuals.
3808
3809 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3810 is another option for the system designer to use as an
11ccc33f 3811 initial stack/RAM area prior to SDRAM being available. Either
2729af9d
WD
3812 option should work for you. Using CS 4 should be fine if your
3813 board designers haven't used it for something that would
3814 cause you grief during the initial boot! It is frequently not
3815 used.
3816
6d0f6bcf 3817 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d
WD
3818 with your processor/board/system design. The default value
3819 you will find in any recent u-boot distribution in
8a316c9b 3820 walnut.h should work for you. I'd set it to a value larger
2729af9d
WD
3821 than your SDRAM module. If you have a 64MB SDRAM module, set
3822 it above 400_0000. Just make sure your board has no resources
3823 that are supposed to respond to that address! That code in
3824 start.S has been around a while and should work as is when
3825 you get the config right.
3826
3827 -Chris Hallinan
3828 DS4.COM, Inc.
3829
3830It is essential to remember this, since it has some impact on the C
3831code for the initialization procedures:
3832
3833* Initialized global data (data segment) is read-only. Do not attempt
3834 to write it.
3835
11ccc33f 3836* Do not use any uninitialized global data (or implicitely initialized
2729af9d
WD
3837 as zero data - BSS segment) at all - this is undefined, initiali-
3838 zation is performed later (when relocating to RAM).
3839
3840* Stack space is very limited. Avoid big data buffers or things like
3841 that.
3842
3843Having only the stack as writable memory limits means we cannot use
3844normal global data to share information beween the code. But it
3845turned out that the implementation of U-Boot can be greatly
3846simplified by making a global data structure (gd_t) available to all
3847functions. We could pass a pointer to this data as argument to _all_
3848functions, but this would bloat the code. Instead we use a feature of
3849the GCC compiler (Global Register Variables) to share the data: we
3850place a pointer (gd) to the global data into a register which we
3851reserve for this purpose.
3852
3853When choosing a register for such a purpose we are restricted by the
3854relevant (E)ABI specifications for the current architecture, and by
3855GCC's implementation.
3856
3857For PowerPC, the following registers have specific use:
3858 R1: stack pointer
e7670f6c 3859 R2: reserved for system use
2729af9d
WD
3860 R3-R4: parameter passing and return values
3861 R5-R10: parameter passing
3862 R13: small data area pointer
3863 R30: GOT pointer
3864 R31: frame pointer
3865
3866 (U-Boot also uses R14 as internal GOT pointer.)
3867
e7670f6c 3868 ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d
WD
3869
3870 Note: on PPC, we could use a static initializer (since the
3871 address of the global data structure is known at compile time),
3872 but it turned out that reserving a register results in somewhat
3873 smaller code - although the code savings are not that big (on
3874 average for all boards 752 bytes for the whole U-Boot image,
3875 624 text + 127 data).
3876
4c58eb55
MF
3877On Blackfin, the normal C ABI (except for P5) is followed as documented here:
3878 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3879
3880 ==> U-Boot will use P5 to hold a pointer to the global data
3881
2729af9d
WD
3882On ARM, the following registers are used:
3883
3884 R0: function argument word/integer result
3885 R1-R3: function argument word
3886 R9: GOT pointer
3887 R10: stack limit (used only if stack checking if enabled)
3888 R11: argument (frame) pointer
3889 R12: temporary workspace
3890 R13: stack pointer
3891 R14: link register
3892 R15: program counter
3893
3894 ==> U-Boot will use R8 to hold a pointer to the global data
3895
d87080b7
WD
3896NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3897or current versions of GCC may "optimize" the code too much.
2729af9d
WD
3898
3899Memory Management:
3900------------------
3901
3902U-Boot runs in system state and uses physical addresses, i.e. the
3903MMU is not used either for address mapping nor for memory protection.
3904
3905The available memory is mapped to fixed addresses using the memory
3906controller. In this process, a contiguous block is formed for each
3907memory type (Flash, SDRAM, SRAM), even when it consists of several
3908physical memory banks.
3909
3910U-Boot is installed in the first 128 kB of the first Flash bank (on
3911TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3912booting and sizing and initializing DRAM, the code relocates itself
3913to the upper end of DRAM. Immediately below the U-Boot code some
6d0f6bcf 3914memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d
WD
3915configuration setting]. Below that, a structure with global Board
3916Info data is placed, followed by the stack (growing downward).
3917
3918Additionally, some exception handler code is copied to the low 8 kB
3919of DRAM (0x00000000 ... 0x00001FFF).
3920
3921So a typical memory configuration with 16 MB of DRAM could look like
3922this:
3923
3924 0x0000 0000 Exception Vector code
3925 :
3926 0x0000 1FFF
3927 0x0000 2000 Free for Application Use
3928 :
3929 :
3930
3931 :
3932 :
3933 0x00FB FF20 Monitor Stack (Growing downward)
3934 0x00FB FFAC Board Info Data and permanent copy of global data
3935 0x00FC 0000 Malloc Arena
3936 :
3937 0x00FD FFFF
3938 0x00FE 0000 RAM Copy of Monitor Code
3939 ... eventually: LCD or video framebuffer
3940 ... eventually: pRAM (Protected RAM - unchanged by reset)
3941 0x00FF FFFF [End of RAM]
3942
3943
3944System Initialization:
3945----------------------
c609719b 3946
2729af9d 3947In the reset configuration, U-Boot starts at the reset entry point
11ccc33f 3948(on most PowerPC systems at address 0x00000100). Because of the reset
2729af9d
WD
3949configuration for CS0# this is a mirror of the onboard Flash memory.
3950To be able to re-map memory U-Boot then jumps to its link address.
3951To be able to implement the initialization code in C, a (small!)
3952initial stack is set up in the internal Dual Ported RAM (in case CPUs
3953which provide such a feature like MPC8xx or MPC8260), or in a locked
3954part of the data cache. After that, U-Boot initializes the CPU core,
3955the caches and the SIU.
3956
3957Next, all (potentially) available memory banks are mapped using a
3958preliminary mapping. For example, we put them on 512 MB boundaries
3959(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3960on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3961programmed for SDRAM access. Using the temporary configuration, a
3962simple memory test is run that determines the size of the SDRAM
3963banks.
3964
3965When there is more than one SDRAM bank, and the banks are of
3966different size, the largest is mapped first. For equal size, the first
3967bank (CS2#) is mapped first. The first mapping is always for address
39680x00000000, with any additional banks following immediately to create
3969contiguous memory starting from 0.
3970
3971Then, the monitor installs itself at the upper end of the SDRAM area
3972and allocates memory for use by malloc() and for the global Board
3973Info data; also, the exception vector code is copied to the low RAM
3974pages, and the final stack is set up.
3975
3976Only after this relocation will you have a "normal" C environment;
3977until that you are restricted in several ways, mostly because you are
3978running from ROM, and because the code will have to be relocated to a
3979new address in RAM.
3980
3981
3982U-Boot Porting Guide:
3983----------------------
c609719b 3984
2729af9d
WD
3985[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3986list, October 2002]
c609719b
WD
3987
3988
2729af9d
WD
3989int main (int argc, char *argv[])
3990{
3991 sighandler_t no_more_time;
c609719b 3992
2729af9d
WD
3993 signal (SIGALRM, no_more_time);
3994 alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
c609719b 3995
2729af9d
WD
3996 if (available_money > available_manpower) {
3997 pay consultant to port U-Boot;
c609719b
WD
3998 return 0;
3999 }
4000
2729af9d
WD
4001 Download latest U-Boot source;
4002
0668236b 4003 Subscribe to u-boot mailing list;
2729af9d
WD
4004
4005 if (clueless) {
4006 email ("Hi, I am new to U-Boot, how do I get started?");
4007 }
4008
4009 while (learning) {
4010 Read the README file in the top level directory;
4011 Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
4012 Read the source, Luke;
4013 }
4014
4015 if (available_money > toLocalCurrency ($2500)) {
4016 Buy a BDI2000;
4017 } else {
4018 Add a lot of aggravation and time;
c609719b
WD
4019 }
4020
2729af9d
WD
4021 Create your own board support subdirectory;
4022
4023 Create your own board config file;
4024
4025 while (!running) {
4026 do {
4027 Add / modify source code;
4028 } until (compiles);
4029 Debug;
4030 if (clueless)
4031 email ("Hi, I am having problems...");
4032 }
4033 Send patch file to Wolfgang;
4034
4035 return 0;
4036}
4037
4038void no_more_time (int sig)
4039{
4040 hire_a_guru();
4041}
4042
c609719b 4043
2729af9d
WD
4044Coding Standards:
4045-----------------
c609719b 4046
2729af9d 4047All contributions to U-Boot should conform to the Linux kernel
2c051651
DZ
4048coding style; see the file "Documentation/CodingStyle" and the script
4049"scripts/Lindent" in your Linux kernel source directory. In sources
4050originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4051spaces before parameters to function calls) is actually used.
4052
4053Source files originating from a different project (for example the
4054MTD subsystem) are generally exempt from these guidelines and are not
4055reformated to ease subsequent migration to newer versions of those
4056sources.
4057
4058Please note that U-Boot is implemented in C (and to some small parts in
4059Assembler); no C++ is used, so please do not use C++ style comments (//)
4060in your code.
c609719b 4061
2729af9d
WD
4062Please also stick to the following formatting rules:
4063- remove any trailing white space
4064- use TAB characters for indentation, not spaces
4065- make sure NOT to use DOS '\r\n' line feeds
4066- do not add more than 2 empty lines to source files
4067- do not add trailing empty lines to source files
180d3f74 4068
2729af9d
WD
4069Submissions which do not conform to the standards may be returned
4070with a request to reformat the changes.
c609719b
WD
4071
4072
2729af9d
WD
4073Submitting Patches:
4074-------------------
c609719b 4075
2729af9d
WD
4076Since the number of patches for U-Boot is growing, we need to
4077establish some rules. Submissions which do not conform to these rules
4078may be rejected, even when they contain important and valuable stuff.
c609719b 4079
0d28f34b 4080Please see http://www.denx.de/wiki/U-Boot/Patches for details.
218ca724 4081
0668236b
WD
4082Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4083see http://lists.denx.de/mailman/listinfo/u-boot
4084
2729af9d
WD
4085When you send a patch, please include the following information with
4086it:
c609719b 4087
2729af9d
WD
4088* For bug fixes: a description of the bug and how your patch fixes
4089 this bug. Please try to include a way of demonstrating that the
4090 patch actually fixes something.
c609719b 4091
2729af9d
WD
4092* For new features: a description of the feature and your
4093 implementation.
c609719b 4094
2729af9d 4095* A CHANGELOG entry as plaintext (separate from the patch)
c609719b 4096
2729af9d 4097* For major contributions, your entry to the CREDITS file
c609719b 4098
2729af9d
WD
4099* When you add support for a new board, don't forget to add this
4100 board to the MAKEALL script, too.
c609719b 4101
2729af9d
WD
4102* If your patch adds new configuration options, don't forget to
4103 document these in the README file.
c609719b 4104
218ca724
WD
4105* The patch itself. If you are using git (which is *strongly*
4106 recommended) you can easily generate the patch using the
4107 "git-format-patch". If you then use "git-send-email" to send it to
4108 the U-Boot mailing list, you will avoid most of the common problems
4109 with some other mail clients.
4110
4111 If you cannot use git, use "diff -purN OLD NEW". If your version of
4112 diff does not support these options, then get the latest version of
4113 GNU diff.
c609719b 4114
218ca724
WD
4115 The current directory when running this command shall be the parent
4116 directory of the U-Boot source tree (i. e. please make sure that
4117 your patch includes sufficient directory information for the
4118 affected files).
6dff5529 4119
218ca724
WD
4120 We prefer patches as plain text. MIME attachments are discouraged,
4121 and compressed attachments must not be used.
c609719b 4122
2729af9d
WD
4123* If one logical set of modifications affects or creates several
4124 files, all these changes shall be submitted in a SINGLE patch file.
52f52c14 4125
2729af9d
WD
4126* Changesets that contain different, unrelated modifications shall be
4127 submitted as SEPARATE patches, one patch per changeset.
8bde7f77 4128
52f52c14 4129
2729af9d 4130Notes:
c609719b 4131
2729af9d
WD
4132* Before sending the patch, run the MAKEALL script on your patched
4133 source tree and make sure that no errors or warnings are reported
4134 for any of the boards.
c609719b 4135
2729af9d
WD
4136* Keep your modifications to the necessary minimum: A patch
4137 containing several unrelated changes or arbitrary reformats will be
4138 returned with a request to re-formatting / split it.
c609719b 4139
2729af9d
WD
4140* If you modify existing code, make sure that your new code does not
4141 add to the memory footprint of the code ;-) Small is beautiful!
4142 When adding new features, these should compile conditionally only
4143 (using #ifdef), and the resulting code with the new feature
4144 disabled must not need more memory than the old code without your
4145 modification.
90dc6704 4146
0668236b
WD
4147* Remember that there is a size limit of 100 kB per message on the
4148 u-boot mailing list. Bigger patches will be moderated. If they are
4149 reasonable and not too big, they will be acknowledged. But patches
4150 bigger than the size limit should be avoided.