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