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