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