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