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