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