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