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