]> git.ipfire.org Git - people/ms/u-boot.git/blame - README
vexpress64: take over maintenance of the semi vexpress64
[people/ms/u-boot.git] / README
CommitLineData
c609719b 1#
eca3aeb3 2# (C) Copyright 2000 - 2013
c609719b
WD
3# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
eca3aeb3 5# SPDX-License-Identifier: GPL-2.0+
c609719b
WD
6#
7
8Summary:
9========
10
24ee89b9 11This directory contains the source code for U-Boot, a boot loader for
e86e5a07
WD
12Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
c609719b
WD
16
17The development of U-Boot is closely related to Linux: some parts of
24ee89b9
WD
18the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
c609719b
WD
20support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
24ee89b9 34Makefile have been tested to some extent and can be considered
c609719b
WD
35"working". In fact, many of them are used in production systems.
36
24ee89b9 37In case of problems see the CHANGELOG and CREDITS files to find out
27af930e 38who contributed the specific port. The boards.cfg file lists board
218ca724 39maintainers.
c609719b 40
adb9d851
RD
41Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
c609719b
WD
46
47Where to get help:
48==================
49
24ee89b9
WD
50In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
0c32565f
PT
52<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
c609719b
WD
56
57
218ca724
WD
58Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
11ccc33f 66any version you might be interested in. Official releases are also
218ca724
WD
67available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
d4ee711d 70Pre-built (and tested) images are available from
218ca724
WD
71ftp://ftp.denx.de/pub/u-boot/images/
72
73
c609719b
WD
74Where we come from:
75===================
76
77- start from 8xxrom sources
24ee89b9 78- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
c609719b
WD
79- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
11ccc33f 86 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
24ee89b9 87- create ARMBoot project (http://sourceforge.net/projects/armboot)
c609719b 88- add other CPU families (starting with ARM)
24ee89b9 89- create U-Boot project (http://sourceforge.net/projects/u-boot)
0d28f34b 90- current project page: see http://www.denx.de/wiki/U-Boot
24ee89b9
WD
91
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
c609719b
WD
113
114
93f19cc0
WD
115Versioning:
116===========
117
360d883a
TW
118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
124
125Examples:
c0f40859 126 U-Boot v2009.11 - Release November 2009
360d883a
TW
127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
93f19cc0
WD
129
130
c609719b
WD
131Directory Hierarchy:
132====================
133
8d321b81 134/arch Architecture specific files
6eae68e4
MY
135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
8d321b81
PT
139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
6eb0921a 143 /at91 Files specific to Atmel AT91RM9200 CPU
a9046b9e
WD
144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
8d321b81
PT
146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
8d321b81 148 /pxa Files specific to Intel XScale PXA CPUs
8d321b81
PT
149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
8d321b81
PT
157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
92bbd64e 170 /mips32 Files specific to MIPS32 CPUs
6eae68e4 171 /mips64 Files specific to MIPS64 CPUs
8d321b81 172 /lib Architecture specific library files
afc1ce82
ML
173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
8d321b81
PT
177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
33c7731b
RD
180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
a47a12be 183 /powerpc Files generic to PowerPC architecture
8d321b81
PT
184 /cpu CPU specific files
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs
8d321b81
PT
189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files
194 /sh Files generic to SH architecture
195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files
33c7731b
RD
205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
8d321b81
PT
208/api Machine/arch independent API for external apps
209/board Board dependent files
210/common Misc architecture independent functions
211/disk Code for disk drive partition handling
212/doc Documentation (don't expect too much)
213/drivers Commonly used device drivers
33c7731b 214/dts Contains Makefile for building internal U-Boot fdt.
8d321b81
PT
215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
33c7731b 224/spl Secondary Program Loader framework
8d321b81 225/tools Tools to build S-Record or U-Boot images, etc.
c609719b 226
c609719b
WD
227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
6d0f6bcf 242 "CONFIG_SYS_".
c609719b
WD
243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
ab584d67 255configurations available; just type "make <board_name>_defconfig".
c609719b
WD
256
257Example: For a TQM823L module type:
258
259 cd u-boot
ab584d67 260 make TQM823L_defconfig
c609719b 261
11ccc33f 262For the Cogent platform, you need to specify the CPU type as well;
ab584d67 263e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
c609719b
WD
264directory according to the instructions in cogent/README.
265
266
75b3c3aa
SG
267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
6b1978f8 275See board/sandbox/README.sandbox for more details.
75b3c3aa
SG
276
277
c609719b
WD
278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
7f6c2cbc
WD
289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
c609719b
WD
294The following options need to be configured:
295
2628114e
KP
296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
297
298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec449
WD
299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
09ea0de0 301 Define exactly one, e.g. CONFIG_ATSTK1002
c609719b
WD
302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
11ccc33f 321 the LCD display every second with
c609719b
WD
322 a "rotator" |\-/|\-/
323
cf946c6d
LW
324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
c609719b 329- MPC824X Family Member (if CONFIG_MPC824X is defined)
5da627a4
WD
330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
c609719b 332
11ccc33f 333- 8xx CPU Options: (if using an MPC8xx CPU)
66ca92a5
WD
334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
5da627a4
WD
336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
66ca92a5
WD
338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
c609719b 340
66ca92a5 341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
6d0f6bcf
JCPV
342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
66ca92a5 344 CONFIG_8xx_CPUCLK_DEFAULT
75d1ea7f
WD
345 See doc/README.MPC866
346
6d0f6bcf 347 CONFIG_SYS_MEASURE_CPUCLK
75d1ea7f 348
ba56f625
WD
349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
6d0f6bcf 354 RTC clock or CONFIG_SYS_8XX_XIN)
75d1ea7f 355
506f3918
HS
356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
66412c63 361- 85xx CPU Options:
ffd06e02
YS
362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
66412c63
KG
368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
8f29084a
KG
374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
afa6b551
PK
379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
33eee330
SW
388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
74fa22ed
PK
408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
9f074e67
PK
412 CONFIG_A008044_WORKAROUND
413 Enables a workaround for T1040/T1042 erratum A008044. It is only
414 requred during NAND boot and valid for Rev 1.0 SoC revision
415
33eee330
SW
416 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418 This is the value to write into CCSR offset 0x18600
419 according to the A004510 workaround.
420
64501c66
PJ
421 CONFIG_SYS_FSL_DSP_DDR_ADDR
422 This value denotes start offset of DDR memory which is
423 connected exclusively to the DSP cores.
424
765b0bdb
PJ
425 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426 This value denotes start offset of M2 memory
427 which is directly connected to the DSP core.
428
64501c66
PJ
429 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
430 This value denotes start offset of M3 memory which is directly
431 connected to the DSP core.
432
765b0bdb
PJ
433 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
434 This value denotes start offset of DSP CCSR space.
435
b135991a
PJ
436 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
437 Single Source Clock is clocking mode present in some of FSL SoC's.
438 In this mode, a single differential clock is used to supply
439 clocks to the sysclock, ddrclock and usbclock.
440
fb4a2409
AB
441 CONFIG_SYS_CPC_REINIT_F
442 This CONFIG is defined when the CPC is configured as SRAM at the
443 time of U-boot entry and is required to be re-initialized.
444
aade2004
TY
445 CONFIG_DEEP_SLEEP
446 Inidcates this SoC supports deep sleep feature. If deep sleep is
447 supported, core will start to execute uboot when wakes up.
448
6cb461b4 449- Generic CPU options:
2a1680e3
YS
450 CONFIG_SYS_GENERIC_GLOBAL_DATA
451 Defines global data is initialized in generic board board_init_f().
452 If this macro is defined, global data is created and cleared in
453 generic board board_init_f(). Without this macro, architecture/board
454 should initialize global data before calling board_init_f().
455
6cb461b4
DS
456 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
457
458 Defines the endianess of the CPU. Implementation of those
459 values is arch specific.
460
5614e71b
YS
461 CONFIG_SYS_FSL_DDR
462 Freescale DDR driver in use. This type of DDR controller is
463 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
464 SoCs.
465
466 CONFIG_SYS_FSL_DDR_ADDR
467 Freescale DDR memory-mapped register base.
468
469 CONFIG_SYS_FSL_DDR_EMU
470 Specify emulator support for DDR. Some DDR features such as
471 deskew training are not available.
472
473 CONFIG_SYS_FSL_DDRC_GEN1
474 Freescale DDR1 controller.
475
476 CONFIG_SYS_FSL_DDRC_GEN2
477 Freescale DDR2 controller.
478
479 CONFIG_SYS_FSL_DDRC_GEN3
480 Freescale DDR3 controller.
481
34e026f9
YS
482 CONFIG_SYS_FSL_DDRC_GEN4
483 Freescale DDR4 controller.
484
9ac4ffbd
YS
485 CONFIG_SYS_FSL_DDRC_ARM_GEN3
486 Freescale DDR3 controller for ARM-based SoCs.
487
5614e71b
YS
488 CONFIG_SYS_FSL_DDR1
489 Board config to use DDR1. It can be enabled for SoCs with
490 Freescale DDR1 or DDR2 controllers, depending on the board
491 implemetation.
492
493 CONFIG_SYS_FSL_DDR2
494 Board config to use DDR2. It can be eanbeld for SoCs with
495 Freescale DDR2 or DDR3 controllers, depending on the board
496 implementation.
497
498 CONFIG_SYS_FSL_DDR3
499 Board config to use DDR3. It can be enabled for SoCs with
34e026f9
YS
500 Freescale DDR3 or DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR3L
503 Board config to use DDR3L. It can be enabled for SoCs with
504 DDR3L controllers.
505
506 CONFIG_SYS_FSL_DDR4
507 Board config to use DDR4. It can be enabled for SoCs with
508 DDR4 controllers.
5614e71b 509
1b4175d6
PK
510 CONFIG_SYS_FSL_IFC_BE
511 Defines the IFC controller register space as Big Endian
512
513 CONFIG_SYS_FSL_IFC_LE
514 Defines the IFC controller register space as Little Endian
515
690e4258
PK
516 CONFIG_SYS_FSL_PBL_PBI
517 It enables addition of RCW (Power on reset configuration) in built image.
518 Please refer doc/README.pblimage for more details
519
520 CONFIG_SYS_FSL_PBL_RCW
521 It adds PBI(pre-boot instructions) commands in u-boot build image.
522 PBI commands can be used to configure SoC before it starts the execution.
523 Please refer doc/README.pblimage for more details
524
89ad7be8
PK
525 CONFIG_SPL_FSL_PBL
526 It adds a target to create boot binary having SPL binary in PBI format
527 concatenated with u-boot binary.
528
4e5b1bd0
YS
529 CONFIG_SYS_FSL_DDR_BE
530 Defines the DDR controller register space as Big Endian
531
532 CONFIG_SYS_FSL_DDR_LE
533 Defines the DDR controller register space as Little Endian
534
6b9e309a
YS
535 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
536 Physical address from the view of DDR controllers. It is the
537 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
538 it could be different for ARM SoCs.
539
6b1e1254
YS
540 CONFIG_SYS_FSL_DDR_INTLV_256B
541 DDR controller interleaving on 256-byte. This is a special
542 interleaving mode, handled by Dickens for Freescale layerscape
543 SoCs with ARM core.
544
1d71efbb
YS
545 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
546 Number of controllers used as main memory.
547
548 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
549 Number of controllers used for other than main memory.
550
028dbb8d
RG
551 CONFIG_SYS_FSL_SEC_BE
552 Defines the SEC controller register space as Big Endian
553
554 CONFIG_SYS_FSL_SEC_LE
555 Defines the SEC controller register space as Little Endian
556
0b953ffc 557- Intel Monahans options:
6d0f6bcf 558 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
0b953ffc
MK
559
560 Defines the Monahans run mode to oscillator
561 ratio. Valid values are 8, 16, 24, 31. The core
562 frequency is this value multiplied by 13 MHz.
563
6d0f6bcf 564 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
cf48eb9a 565
0b953ffc
MK
566 Defines the Monahans turbo mode to oscillator
567 ratio. Valid values are 1 (default if undefined) and
cf48eb9a 568 2. The core frequency as calculated above is multiplied
0b953ffc 569 by this value.
cf48eb9a 570
92bbd64e
DS
571- MIPS CPU options:
572 CONFIG_SYS_INIT_SP_OFFSET
573
574 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
575 pointer. This is needed for the temporary stack before
576 relocation.
577
578 CONFIG_SYS_MIPS_CACHE_MODE
579
580 Cache operation mode for the MIPS CPU.
581 See also arch/mips/include/asm/mipsregs.h.
582 Possible values are:
583 CONF_CM_CACHABLE_NO_WA
584 CONF_CM_CACHABLE_WA
585 CONF_CM_UNCACHED
586 CONF_CM_CACHABLE_NONCOHERENT
587 CONF_CM_CACHABLE_CE
588 CONF_CM_CACHABLE_COW
589 CONF_CM_CACHABLE_CUW
590 CONF_CM_CACHABLE_ACCELERATED
591
592 CONFIG_SYS_XWAY_EBU_BOOTCFG
593
594 Special option for Lantiq XWAY SoCs for booting from NOR flash.
595 See also arch/mips/cpu/mips32/start.S.
596
597 CONFIG_XWAY_SWAP_BYTES
598
599 Enable compilation of tools/xway-swap-bytes needed for Lantiq
600 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
601 be swapped if a flash programmer is used.
602
b67d8816
CR
603- ARM options:
604 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
605
606 Select high exception vectors of the ARM core, e.g., do not
607 clear the V bit of the c1 register of CP15.
608
5356f545
A
609 CONFIG_SYS_THUMB_BUILD
610
611 Use this flag to build U-Boot using the Thumb instruction
612 set for ARM architectures. Thumb instruction set provides
613 better code density. For ARM architectures that support
614 Thumb2 this flag will result in Thumb2 code generated by
615 GCC.
616
c5d4752c 617 CONFIG_ARM_ERRATA_716044
0678587f
SW
618 CONFIG_ARM_ERRATA_742230
619 CONFIG_ARM_ERRATA_743622
620 CONFIG_ARM_ERRATA_751472
f71cbfe3 621 CONFIG_ARM_ERRATA_794072
b7588e3b 622 CONFIG_ARM_ERRATA_761320
0678587f
SW
623
624 If set, the workarounds for these ARM errata are applied early
625 during U-Boot startup. Note that these options force the
626 workarounds to be applied; no CPU-type/version detection
627 exists, unlike the similar options in the Linux kernel. Do not
628 set these options unless they apply!
629
38687ae6
SG
630- Driver Model
631 Driver model is a new framework for devices in U-Boot
632 introduced in early 2014. U-Boot is being progressively
633 moved over to this. It offers a consistent device structure,
634 supports grouping devices into classes and has built-in
635 handling of platform data and device tree.
636
637 To enable transition to driver model in a relatively
638 painful fashion, each subsystem can be independently
639 switched between the legacy/ad-hoc approach and the new
640 driver model using the options below. Also, many uclass
641 interfaces include compatibility features which may be
642 removed once the conversion of that subsystem is complete.
643 As a result, the API provided by the subsystem may in fact
644 not change with driver model.
645
646 See doc/driver-model/README.txt for more information.
647
648 CONFIG_DM
649
650 Enable driver model. This brings in the core support,
651 including scanning of platform data on start-up. If
652 CONFIG_OF_CONTROL is enabled, the device tree will be
653 scanned also when available.
654
655 CONFIG_CMD_DM
656
657 Enable driver model test commands. These allow you to print
658 out the driver model tree and the uclasses.
659
660 CONFIG_DM_DEMO
661
662 Enable some demo devices and the 'demo' command. These are
663 really only useful for playing around while trying to
664 understand driver model in sandbox.
665
666 CONFIG_SPL_DM
667
668 Enable driver model in SPL. You will need to provide a
669 suitable malloc() implementation. If you are not using the
670 full malloc() enabled by CONFIG_SYS_SPL_MALLOC_START,
671 consider using CONFIG_SYS_MALLOC_SIMPLE. In that case you
672 must provide CONFIG_SYS_MALLOC_F_LEN to set the size.
673 In most cases driver model will only allocate a few uclasses
674 and devices in SPL, so 1KB should be enable. See
675 CONFIG_SYS_MALLOC_F_LEN for more details on how to enable
676 it.
677
678 CONFIG_DM_SERIAL
679
680 Enable driver model for serial. This replaces
681 drivers/serial/serial.c with the serial uclass, which
682 implements serial_putc() etc. The uclass interface is
683 defined in include/serial.h.
684
685 CONFIG_DM_GPIO
686
687 Enable driver model for GPIO access. The standard GPIO
688 interface (gpio_get_value(), etc.) is then implemented by
689 the GPIO uclass. Drivers provide methods to query the
690 particular GPIOs that they provide. The uclass interface
691 is defined in include/asm-generic/gpio.h.
692
693 CONFIG_DM_SPI
694
695 Enable driver model for SPI. The SPI slave interface
696 (spi_setup_slave(), spi_xfer(), etc.) is then implemented by
697 the SPI uclass. Drivers provide methods to access the SPI
698 buses that they control. The uclass interface is defined in
699 include/spi.h. The existing spi_slave structure is attached
700 as 'parent data' to every slave on each bus. Slaves
701 typically use driver-private data instead of extending the
702 spi_slave structure.
703
704 CONFIG_DM_SPI_FLASH
705
706 Enable driver model for SPI flash. This SPI flash interface
707 (spi_flash_probe(), spi_flash_write(), etc.) is then
708 implemented by the SPI flash uclass. There is one standard
709 SPI flash driver which knows how to probe most chips
710 supported by U-Boot. The uclass interface is defined in
711 include/spi_flash.h, but is currently fully compatible
712 with the old interface to avoid confusion and duplication
713 during the transition parent. SPI and SPI flash must be
714 enabled together (it is not possible to use driver model
715 for one and not the other).
716
717 CONFIG_DM_CROS_EC
718
719 Enable driver model for the Chrome OS EC interface. This
720 allows the cros_ec SPI driver to operate with CONFIG_DM_SPI
721 but otherwise makes few changes. Since cros_ec also supports
722 I2C and LPC (which don't support driver model yet), a full
723 conversion is not yet possible.
724
725
726 ** Code size options: The following options are enabled by
727 default except in SPL. Enable them explicitly to get these
728 features in SPL.
729
730 CONFIG_DM_WARN
731
732 Enable the dm_warn() function. This can use up quite a bit
733 of space for its strings.
734
735 CONFIG_DM_STDIO
736
737 Enable registering a serial device with the stdio library.
738
739 CONFIG_DM_DEVICE_REMOVE
740
741 Enable removing of devices.
742
743
5da627a4 744- Linux Kernel Interface:
c609719b
WD
745 CONFIG_CLOCKS_IN_MHZ
746
747 U-Boot stores all clock information in Hz
748 internally. For binary compatibility with older Linux
749 kernels (which expect the clocks passed in the
750 bd_info data to be in MHz) the environment variable
751 "clocks_in_mhz" can be defined so that U-Boot
752 converts clock data to MHZ before passing it to the
753 Linux kernel.
c609719b 754 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
218ca724 755 "clocks_in_mhz=1" is automatically included in the
c609719b
WD
756 default environment.
757
5da627a4
WD
758 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
759
11ccc33f 760 When transferring memsize parameter to linux, some versions
5da627a4
WD
761 expect it to be in bytes, others in MB.
762 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
763
fec6d9ee 764 CONFIG_OF_LIBFDT
f57f70aa
WD
765
766 New kernel versions are expecting firmware settings to be
213bf8c8
GVB
767 passed using flattened device trees (based on open firmware
768 concepts).
769
770 CONFIG_OF_LIBFDT
771 * New libfdt-based support
772 * Adds the "fdt" command
3bb342fc 773 * The bootm command automatically updates the fdt
213bf8c8 774
b55ae402
MZ
775 OF_CPU - The proper name of the cpus node (only required for
776 MPC512X and MPC5xxx based boards).
777 OF_SOC - The proper name of the soc node (only required for
778 MPC512X and MPC5xxx based boards).
f57f70aa 779 OF_TBCLK - The timebase frequency.
c2871f03 780 OF_STDOUT_PATH - The path to the console device
f57f70aa 781
11ccc33f
MZ
782 boards with QUICC Engines require OF_QE to set UCC MAC
783 addresses
3bb342fc 784
4e253137
KG
785 CONFIG_OF_BOARD_SETUP
786
787 Board code has addition modification that it wants to make
788 to the flat device tree before handing it off to the kernel
f57f70aa 789
c654b517
SG
790 CONFIG_OF_SYSTEM_SETUP
791
792 Other code has addition modification that it wants to make
793 to the flat device tree before handing it off to the kernel.
794 This causes ft_system_setup() to be called before booting
795 the kernel.
796
0267768e
MM
797 CONFIG_OF_BOOT_CPU
798
11ccc33f 799 This define fills in the correct boot CPU in the boot
0267768e
MM
800 param header, the default value is zero if undefined.
801
3887c3fb
HS
802 CONFIG_OF_IDE_FIXUP
803
804 U-Boot can detect if an IDE device is present or not.
805 If not, and this new config option is activated, U-Boot
806 removes the ATA node from the DTS before booting Linux,
807 so the Linux IDE driver does not probe the device and
808 crash. This is needed for buggy hardware (uc101) where
809 no pull down resistor is connected to the signal IDE5V_DD7.
810
7eb29398
IG
811 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
812
813 This setting is mandatory for all boards that have only one
814 machine type and must be used to specify the machine type
815 number as it appears in the ARM machine registry
816 (see http://www.arm.linux.org.uk/developer/machines/).
817 Only boards that have multiple machine types supported
818 in a single configuration file and the machine type is
819 runtime discoverable, do not have to use this setting.
820
0b2f4eca
NG
821- vxWorks boot parameters:
822
823 bootvx constructs a valid bootline using the following
824 environments variables: bootfile, ipaddr, serverip, hostname.
825 It loads the vxWorks image pointed bootfile.
826
827 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
828 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
829 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
830 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
831
832 CONFIG_SYS_VXWORKS_ADD_PARAMS
833
834 Add it at the end of the bootline. E.g "u=username pw=secret"
835
836 Note: If a "bootargs" environment is defined, it will overwride
837 the defaults discussed just above.
838
2c451f78
A
839- Cache Configuration:
840 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
841 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
842 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
843
93bc2193
A
844- Cache Configuration for ARM:
845 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
846 controller
847 CONFIG_SYS_PL310_BASE - Physical base address of PL310
848 controller register space
849
6705d81e 850- Serial Ports:
48d0192f 851 CONFIG_PL010_SERIAL
6705d81e
WD
852
853 Define this if you want support for Amba PrimeCell PL010 UARTs.
854
48d0192f 855 CONFIG_PL011_SERIAL
6705d81e
WD
856
857 Define this if you want support for Amba PrimeCell PL011 UARTs.
858
859 CONFIG_PL011_CLOCK
860
861 If you have Amba PrimeCell PL011 UARTs, set this variable to
862 the clock speed of the UARTs.
863
864 CONFIG_PL01x_PORTS
865
866 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
867 define this to a list of base addresses for each (supported)
868 port. See e.g. include/configs/versatile.h
869
910f1ae3
JR
870 CONFIG_PL011_SERIAL_RLCR
871
872 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
873 have separate receive and transmit line control registers. Set
874 this variable to initialize the extra register.
875
876 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
877
878 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
879 boot loader that has already initialized the UART. Define this
880 variable to flush the UART at init time.
881
d57dee57
KM
882 CONFIG_SERIAL_HW_FLOW_CONTROL
883
884 Define this variable to enable hw flow control in serial driver.
885 Current user of this option is drivers/serial/nsl16550.c driver
6705d81e 886
c609719b 887- Console Interface:
43d9616c
WD
888 Depending on board, define exactly one serial port
889 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
890 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
891 console by defining CONFIG_8xx_CONS_NONE
c609719b
WD
892
893 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
894 port routines must be defined elsewhere
895 (i.e. serial_init(), serial_getc(), ...)
896
897 CONFIG_CFB_CONSOLE
898 Enables console device for a color framebuffer. Needs following
c53043b7 899 defines (cf. smiLynxEM, i8042)
c609719b
WD
900 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
901 (default big endian)
902 VIDEO_HW_RECTFILL graphic chip supports
903 rectangle fill
904 (cf. smiLynxEM)
905 VIDEO_HW_BITBLT graphic chip supports
906 bit-blit (cf. smiLynxEM)
907 VIDEO_VISIBLE_COLS visible pixel columns
908 (cols=pitch)
ba56f625
WD
909 VIDEO_VISIBLE_ROWS visible pixel rows
910 VIDEO_PIXEL_SIZE bytes per pixel
c609719b
WD
911 VIDEO_DATA_FORMAT graphic data format
912 (0-5, cf. cfb_console.c)
ba56f625 913 VIDEO_FB_ADRS framebuffer address
c609719b
WD
914 VIDEO_KBD_INIT_FCT keyboard int fct
915 (i.e. i8042_kbd_init())
916 VIDEO_TSTC_FCT test char fct
917 (i.e. i8042_tstc)
918 VIDEO_GETC_FCT get char fct
919 (i.e. i8042_getc)
920 CONFIG_CONSOLE_CURSOR cursor drawing on/off
921 (requires blink timer
922 cf. i8042.c)
6d0f6bcf 923 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
c609719b
WD
924 CONFIG_CONSOLE_TIME display time/date info in
925 upper right corner
602ad3b3 926 (requires CONFIG_CMD_DATE)
c609719b
WD
927 CONFIG_VIDEO_LOGO display Linux logo in
928 upper left corner
a6c7ad2f
WD
929 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
930 linux_logo.h for logo.
931 Requires CONFIG_VIDEO_LOGO
c609719b 932 CONFIG_CONSOLE_EXTRA_INFO
11ccc33f 933 additional board info beside
c609719b
WD
934 the logo
935
33a35bbb
PR
936 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
937 a limited number of ANSI escape sequences (cursor control,
938 erase functions and limited graphics rendition control).
939
43d9616c
WD
940 When CONFIG_CFB_CONSOLE is defined, video console is
941 default i/o. Serial console can be forced with
942 environment 'console=serial'.
c609719b 943
d4ca31c4
WD
944 When CONFIG_SILENT_CONSOLE is defined, all console
945 messages (by U-Boot and Linux!) can be silenced with
946 the "silent" environment variable. See
947 doc/README.silent for more information.
a3ad8e26 948
45ae2546
HS
949 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
950 is 0x00.
951 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
952 is 0xa0.
953
c609719b
WD
954- Console Baudrate:
955 CONFIG_BAUDRATE - in bps
956 Select one of the baudrates listed in
6d0f6bcf
JCPV
957 CONFIG_SYS_BAUDRATE_TABLE, see below.
958 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
c609719b 959
c92fac91
HS
960- Console Rx buffer length
961 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
962 the maximum receive buffer length for the SMC.
2b3f12c2 963 This option is actual only for 82xx and 8xx possible.
c92fac91
HS
964 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
965 must be defined, to setup the maximum idle timeout for
966 the SMC.
967
9558b48a 968- Pre-Console Buffer:
4cf2609b
WD
969 Prior to the console being initialised (i.e. serial UART
970 initialised etc) all console output is silently discarded.
971 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
972 buffer any console messages prior to the console being
973 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
974 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
975 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6feff899 976 bytes are output before the console is initialised, the
4cf2609b
WD
977 earlier bytes are discarded.
978
979 'Sane' compilers will generate smaller code if
980 CONFIG_PRE_CON_BUF_SZ is a power of 2
9558b48a 981
046a37bd
SR
982- Safe printf() functions
983 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
984 the printf() functions. These are defined in
985 include/vsprintf.h and include snprintf(), vsnprintf() and
986 so on. Code size increase is approximately 300-500 bytes.
987 If this option is not given then these functions will
988 silently discard their buffer size argument - this means
989 you are not getting any overflow checking in this case.
990
c609719b
WD
991- Boot Delay: CONFIG_BOOTDELAY - in seconds
992 Delay before automatically booting the default image;
993 set to -1 to disable autoboot.
93d7212f
JH
994 set to -2 to autoboot with no delay and not check for abort
995 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
c609719b
WD
996
997 See doc/README.autoboot for these options that
998 work with CONFIG_BOOTDELAY. None are required.
999 CONFIG_BOOT_RETRY_TIME
1000 CONFIG_BOOT_RETRY_MIN
1001 CONFIG_AUTOBOOT_KEYED
1002 CONFIG_AUTOBOOT_PROMPT
1003 CONFIG_AUTOBOOT_DELAY_STR
1004 CONFIG_AUTOBOOT_STOP_STR
1005 CONFIG_AUTOBOOT_DELAY_STR2
1006 CONFIG_AUTOBOOT_STOP_STR2
1007 CONFIG_ZERO_BOOTDELAY_CHECK
1008 CONFIG_RESET_TO_RETRY
1009
1010- Autoboot Command:
1011 CONFIG_BOOTCOMMAND
1012 Only needed when CONFIG_BOOTDELAY is enabled;
1013 define a command string that is automatically executed
1014 when no character is read on the console interface
1015 within "Boot Delay" after reset.
1016
1017 CONFIG_BOOTARGS
43d9616c
WD
1018 This can be used to pass arguments to the bootm
1019 command. The value of CONFIG_BOOTARGS goes into the
1020 environment value "bootargs".
c609719b
WD
1021
1022 CONFIG_RAMBOOT and CONFIG_NFSBOOT
43d9616c
WD
1023 The value of these goes into the environment as
1024 "ramboot" and "nfsboot" respectively, and can be used
1025 as a convenience, when switching between booting from
11ccc33f 1026 RAM and NFS.
c609719b 1027
eda0ba38
HS
1028- Bootcount:
1029 CONFIG_BOOTCOUNT_LIMIT
1030 Implements a mechanism for detecting a repeating reboot
1031 cycle, see:
1032 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
1033
1034 CONFIG_BOOTCOUNT_ENV
1035 If no softreset save registers are found on the hardware
1036 "bootcount" is stored in the environment. To prevent a
1037 saveenv on all reboots, the environment variable
1038 "upgrade_available" is used. If "upgrade_available" is
1039 0, "bootcount" is always 0, if "upgrade_available" is
1040 1 "bootcount" is incremented in the environment.
1041 So the Userspace Applikation must set the "upgrade_available"
1042 and "bootcount" variable to 0, if a boot was successfully.
1043
c609719b
WD
1044- Pre-Boot Commands:
1045 CONFIG_PREBOOT
1046
1047 When this option is #defined, the existence of the
1048 environment variable "preboot" will be checked
1049 immediately before starting the CONFIG_BOOTDELAY
1050 countdown and/or running the auto-boot command resp.
1051 entering interactive mode.
1052
1053 This feature is especially useful when "preboot" is
1054 automatically generated or modified. For an example
1055 see the LWMON board specific code: here "preboot" is
1056 modified when the user holds down a certain
1057 combination of keys on the (special) keyboard when
1058 booting the systems
1059
1060- Serial Download Echo Mode:
1061 CONFIG_LOADS_ECHO
1062 If defined to 1, all characters received during a
1063 serial download (using the "loads" command) are
1064 echoed back. This might be needed by some terminal
1065 emulations (like "cu"), but may as well just take
1066 time on others. This setting #define's the initial
1067 value of the "loads_echo" environment variable.
1068
602ad3b3 1069- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
c609719b
WD
1070 CONFIG_KGDB_BAUDRATE
1071 Select one of the baudrates listed in
6d0f6bcf 1072 CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b
WD
1073
1074- Monitor Functions:
602ad3b3
JL
1075 Monitor commands can be included or excluded
1076 from the build by using the #include files
c6c621bd
SW
1077 <config_cmd_all.h> and #undef'ing unwanted
1078 commands, or using <config_cmd_default.h>
602ad3b3
JL
1079 and augmenting with additional #define's
1080 for wanted commands.
1081
1082 The default command configuration includes all commands
1083 except those marked below with a "*".
1084
b401b73d 1085 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
602ad3b3 1086 CONFIG_CMD_ASKENV * ask for env variable
602ad3b3
JL
1087 CONFIG_CMD_BDI bdinfo
1088 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1089 CONFIG_CMD_BMP * BMP support
1090 CONFIG_CMD_BSP * Board specific commands
1091 CONFIG_CMD_BOOTD bootd
d2b2ffe3 1092 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
602ad3b3 1093 CONFIG_CMD_CACHE * icache, dcache
08d0d6f3 1094 CONFIG_CMD_CLK * clock command support
602ad3b3 1095 CONFIG_CMD_CONSOLE coninfo
710b9938 1096 CONFIG_CMD_CRC32 * crc32
602ad3b3
JL
1097 CONFIG_CMD_DATE * support for RTC, date/time...
1098 CONFIG_CMD_DHCP * DHCP support
1099 CONFIG_CMD_DIAG * Diagnostics
a7c93104
PT
1100 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1101 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1102 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1103 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
602ad3b3
JL
1104 CONFIG_CMD_DTT * Digital Therm and Thermostat
1105 CONFIG_CMD_ECHO echo arguments
246c6922 1106 CONFIG_CMD_EDITENV edit env variable
602ad3b3
JL
1107 CONFIG_CMD_EEPROM * EEPROM read/write support
1108 CONFIG_CMD_ELF * bootelf, bootvx
5e2b3e0c 1109 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
fffad71b 1110 CONFIG_CMD_ENV_FLAGS * display details about env flags
88733e2c 1111 CONFIG_CMD_ENV_EXISTS * check existence of env variable
0c79cda0 1112 CONFIG_CMD_EXPORTENV * export the environment
03e2ecf6
SW
1113 CONFIG_CMD_EXT2 * ext2 command support
1114 CONFIG_CMD_EXT4 * ext4 command support
16f4d933
SW
1115 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1116 that work for multiple fs types
59e890ef 1117 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
bdab39d3 1118 CONFIG_CMD_SAVEENV saveenv
602ad3b3 1119 CONFIG_CMD_FDC * Floppy Disk Support
03e2ecf6 1120 CONFIG_CMD_FAT * FAT command support
602ad3b3
JL
1121 CONFIG_CMD_FLASH flinfo, erase, protect
1122 CONFIG_CMD_FPGA FPGA device initialization support
4d98b5c8 1123 CONFIG_CMD_FUSE * Device fuse support
53fdc7ef 1124 CONFIG_CMD_GETTIME * Get time since boot
a641b979 1125 CONFIG_CMD_GO * the 'go' command (exec code)
a000b795 1126 CONFIG_CMD_GREPENV * search environment
bf36c5d5 1127 CONFIG_CMD_HASH * calculate hash / digest
602ad3b3
JL
1128 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1129 CONFIG_CMD_I2C * I2C serial bus support
1130 CONFIG_CMD_IDE * IDE harddisk support
1131 CONFIG_CMD_IMI iminfo
8fdf1e0f 1132 CONFIG_CMD_IMLS List all images found in NOR flash
4d98b5c8 1133 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
602ad3b3 1134 CONFIG_CMD_IMMAP * IMMR dump support
aa53233a 1135 CONFIG_CMD_IOTRACE * I/O tracing for debugging
0c79cda0 1136 CONFIG_CMD_IMPORTENV * import an environment
c167cc02 1137 CONFIG_CMD_INI * import data from an ini file into the env
602ad3b3
JL
1138 CONFIG_CMD_IRQ * irqinfo
1139 CONFIG_CMD_ITEST Integer/string test of 2 values
1140 CONFIG_CMD_JFFS2 * JFFS2 Support
1141 CONFIG_CMD_KGDB * kgdb
4d98b5c8 1142 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
d22c338e
JH
1143 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1144 (169.254.*.*)
602ad3b3
JL
1145 CONFIG_CMD_LOADB loadb
1146 CONFIG_CMD_LOADS loads
4d98b5c8 1147 CONFIG_CMD_MD5SUM * print md5 message digest
02c9aa1d 1148 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
15a33e49 1149 CONFIG_CMD_MEMINFO * Display detailed memory information
602ad3b3 1150 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
a2681707 1151 loop, loopw
4d98b5c8 1152 CONFIG_CMD_MEMTEST * mtest
602ad3b3
JL
1153 CONFIG_CMD_MISC Misc functions like sleep etc
1154 CONFIG_CMD_MMC * MMC memory mapped support
1155 CONFIG_CMD_MII * MII utility commands
68d7d651 1156 CONFIG_CMD_MTDPARTS * MTD partition support
602ad3b3
JL
1157 CONFIG_CMD_NAND * NAND support
1158 CONFIG_CMD_NET bootp, tftpboot, rarpboot
4d98b5c8 1159 CONFIG_CMD_NFS NFS support
e92739d3 1160 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
c0f40859 1161 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
602ad3b3
JL
1162 CONFIG_CMD_PCI * pciinfo
1163 CONFIG_CMD_PCMCIA * PCMCIA support
1164 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1165 host
1166 CONFIG_CMD_PORTIO * Port I/O
ff048ea9 1167 CONFIG_CMD_READ * Read raw data from partition
602ad3b3
JL
1168 CONFIG_CMD_REGINFO * Register dump
1169 CONFIG_CMD_RUN run command in env variable
d304931f 1170 CONFIG_CMD_SANDBOX * sb command to access sandbox features
602ad3b3
JL
1171 CONFIG_CMD_SAVES * save S record dump
1172 CONFIG_CMD_SCSI * SCSI Support
1173 CONFIG_CMD_SDRAM * print SDRAM configuration information
1174 (requires CONFIG_CMD_I2C)
1175 CONFIG_CMD_SETGETDCR Support for DCR Register access
1176 (4xx only)
f61ec45e 1177 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
4d98b5c8 1178 CONFIG_CMD_SHA1SUM * print sha1 memory digest
02c9aa1d 1179 (requires CONFIG_CMD_MEMORY)
7d861d95 1180 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
74de7aef 1181 CONFIG_CMD_SOURCE "source" command Support
602ad3b3 1182 CONFIG_CMD_SPI * SPI serial bus support
7a83af07 1183 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
1fb7cd49 1184 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
da83bcd7
JH
1185 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1186 CONFIG_CMD_TIMER * access to the system tick timer
602ad3b3 1187 CONFIG_CMD_USB * USB support
602ad3b3 1188 CONFIG_CMD_CDP * Cisco Discover Protocol support
c8339f51 1189 CONFIG_CMD_MFSL * Microblaze FSL support
4d98b5c8 1190 CONFIG_CMD_XIMG Load part of Multi Image
89c8230d 1191 CONFIG_CMD_UUID * Generate random UUID or GUID string
c609719b
WD
1192
1193 EXAMPLE: If you want all functions except of network
1194 support you can write:
1195
602ad3b3
JL
1196 #include "config_cmd_all.h"
1197 #undef CONFIG_CMD_NET
c609719b 1198
213bf8c8
GVB
1199 Other Commands:
1200 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
c609719b
WD
1201
1202 Note: Don't enable the "icache" and "dcache" commands
602ad3b3 1203 (configuration option CONFIG_CMD_CACHE) unless you know
43d9616c
WD
1204 what you (and your U-Boot users) are doing. Data
1205 cache cannot be enabled on systems like the 8xx or
1206 8260 (where accesses to the IMMR region must be
1207 uncached), and it cannot be disabled on all other
1208 systems where we (mis-) use the data cache to hold an
1209 initial stack and some data.
c609719b
WD
1210
1211
1212 XXX - this list needs to get updated!
1213
a5ecbe62
WD
1214- Regular expression support:
1215 CONFIG_REGEX
93e14596
WD
1216 If this variable is defined, U-Boot is linked against
1217 the SLRE (Super Light Regular Expression) library,
1218 which adds regex support to some commands, as for
1219 example "env grep" and "setexpr".
a5ecbe62 1220
45ba8077
SG
1221- Device tree:
1222 CONFIG_OF_CONTROL
1223 If this variable is defined, U-Boot will use a device tree
1224 to configure its devices, instead of relying on statically
1225 compiled #defines in the board file. This option is
1226 experimental and only available on a few boards. The device
1227 tree is available in the global data as gd->fdt_blob.
1228
2c0f79e4
SG
1229 U-Boot needs to get its device tree from somewhere. This can
1230 be done using one of the two options below:
bbb0b128
SG
1231
1232 CONFIG_OF_EMBED
1233 If this variable is defined, U-Boot will embed a device tree
1234 binary in its image. This device tree file should be in the
1235 board directory and called <soc>-<board>.dts. The binary file
1236 is then picked up in board_init_f() and made available through
1237 the global data structure as gd->blob.
45ba8077 1238
2c0f79e4
SG
1239 CONFIG_OF_SEPARATE
1240 If this variable is defined, U-Boot will build a device tree
1241 binary. It will be called u-boot.dtb. Architecture-specific
1242 code will locate it at run-time. Generally this works by:
1243
1244 cat u-boot.bin u-boot.dtb >image.bin
1245
1246 and in fact, U-Boot does this for you, creating a file called
1247 u-boot-dtb.bin which is useful in the common case. You can
1248 still use the individual files if you need something more
1249 exotic.
1250
c609719b
WD
1251- Watchdog:
1252 CONFIG_WATCHDOG
1253 If this variable is defined, it enables watchdog
6abe6fb6
DZ
1254 support for the SoC. There must be support in the SoC
1255 specific code for a watchdog. For the 8xx and 8260
1256 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1257 register. When supported for a specific SoC is
1258 available, then no further board specific code should
1259 be needed to use it.
1260
1261 CONFIG_HW_WATCHDOG
1262 When using a watchdog circuitry external to the used
1263 SoC, then define this variable and provide board
1264 specific code for the "hw_watchdog_reset" function.
c609719b 1265
c1551ea8
SR
1266- U-Boot Version:
1267 CONFIG_VERSION_VARIABLE
1268 If this variable is defined, an environment variable
1269 named "ver" is created by U-Boot showing the U-Boot
1270 version as printed by the "version" command.
a1ea8e51
BT
1271 Any change to this variable will be reverted at the
1272 next reset.
c1551ea8 1273
c609719b
WD
1274- Real-Time Clock:
1275
602ad3b3 1276 When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b
WD
1277 has to be selected, too. Define exactly one of the
1278 following options:
1279
1280 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1281 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
4e8b7544 1282 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
c609719b 1283 CONFIG_RTC_MC146818 - use MC146818 RTC
1cb8e980 1284 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
c609719b 1285 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
7f70e853 1286 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
412921d2 1287 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
3bac3513 1288 CONFIG_RTC_DS164x - use Dallas DS164x RTC
9536dfcc 1289 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
4c0d4c3b 1290 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
6d0f6bcf 1291 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
71d19f30
HS
1292 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1293 RV3029 RTC.
c609719b 1294
b37c7e5e
WD
1295 Note that if the RTC uses I2C, then the I2C interface
1296 must also be configured. See I2C Support, below.
1297
e92739d3
PT
1298- GPIO Support:
1299 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
e92739d3 1300
5dec49ca
CP
1301 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1302 chip-ngpio pairs that tell the PCA953X driver the number of
1303 pins supported by a particular chip.
1304
e92739d3
PT
1305 Note that if the GPIO device uses I2C, then the I2C interface
1306 must also be configured. See I2C Support, below.
1307
aa53233a
SG
1308- I/O tracing:
1309 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1310 accesses and can checksum them or write a list of them out
1311 to memory. See the 'iotrace' command for details. This is
1312 useful for testing device drivers since it can confirm that
1313 the driver behaves the same way before and after a code
1314 change. Currently this is supported on sandbox and arm. To
1315 add support for your architecture, add '#include <iotrace.h>'
1316 to the bottom of arch/<arch>/include/asm/io.h and test.
1317
1318 Example output from the 'iotrace stats' command is below.
1319 Note that if the trace buffer is exhausted, the checksum will
1320 still continue to operate.
1321
1322 iotrace is enabled
1323 Start: 10000000 (buffer start address)
1324 Size: 00010000 (buffer size)
1325 Offset: 00000120 (current buffer offset)
1326 Output: 10000120 (start + offset)
1327 Count: 00000018 (number of trace records)
1328 CRC32: 9526fb66 (CRC32 of all trace records)
1329
c609719b
WD
1330- Timestamp Support:
1331
43d9616c
WD
1332 When CONFIG_TIMESTAMP is selected, the timestamp
1333 (date and time) of an image is printed by image
1334 commands like bootm or iminfo. This option is
602ad3b3 1335 automatically enabled when you select CONFIG_CMD_DATE .
c609719b 1336
923c46f9
KP
1337- Partition Labels (disklabels) Supported:
1338 Zero or more of the following:
1339 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1340 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1341 Intel architecture, USB sticks, etc.
1342 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1343 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1344 bootloader. Note 2TB partition limit; see
1345 disk/part_efi.c
1346 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
c609719b 1347
218ca724
WD
1348 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1349 CONFIG_CMD_SCSI) you must configure support for at
923c46f9 1350 least one non-MTD partition type as well.
c609719b
WD
1351
1352- IDE Reset method:
4d13cbad
WD
1353 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1354 board configurations files but used nowhere!
c609719b 1355
4d13cbad
WD
1356 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1357 be performed by calling the function
1358 ide_set_reset(int reset)
1359 which has to be defined in a board specific file
c609719b
WD
1360
1361- ATAPI Support:
1362 CONFIG_ATAPI
1363
1364 Set this to enable ATAPI support.
1365
c40b2956
WD
1366- LBA48 Support
1367 CONFIG_LBA48
1368
1369 Set this to enable support for disks larger than 137GB
4b142feb 1370 Also look at CONFIG_SYS_64BIT_LBA.
c40b2956
WD
1371 Whithout these , LBA48 support uses 32bit variables and will 'only'
1372 support disks up to 2.1TB.
1373
6d0f6bcf 1374 CONFIG_SYS_64BIT_LBA:
c40b2956
WD
1375 When enabled, makes the IDE subsystem use 64bit sector addresses.
1376 Default is 32bit.
1377
c609719b
WD
1378- SCSI Support:
1379 At the moment only there is only support for the
1380 SYM53C8XX SCSI controller; define
1381 CONFIG_SCSI_SYM53C8XX to enable it.
1382
6d0f6bcf
JCPV
1383 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1384 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1385 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
c609719b
WD
1386 maximum numbers of LUNs, SCSI ID's and target
1387 devices.
6d0f6bcf 1388 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
c609719b 1389
93e14596
WD
1390 The environment variable 'scsidevs' is set to the number of
1391 SCSI devices found during the last scan.
447c031b 1392
c609719b 1393- NETWORK Support (PCI):
682011ff 1394 CONFIG_E1000
ce5207e1
KM
1395 Support for Intel 8254x/8257x gigabit chips.
1396
1397 CONFIG_E1000_SPI
1398 Utility code for direct access to the SPI bus on Intel 8257x.
1399 This does not do anything useful unless you set at least one
1400 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1401
1402 CONFIG_E1000_SPI_GENERIC
1403 Allow generic access to the SPI bus on the Intel 8257x, for
1404 example with the "sspi" command.
1405
1406 CONFIG_CMD_E1000
1407 Management command for E1000 devices. When used on devices
1408 with SPI support you can reprogram the EEPROM from U-Boot.
53cf9435 1409
ac3315c2 1410 CONFIG_E1000_FALLBACK_MAC
11ccc33f 1411 default MAC for empty EEPROM after production.
ac3315c2 1412
c609719b
WD
1413 CONFIG_EEPRO100
1414 Support for Intel 82557/82559/82559ER chips.
11ccc33f 1415 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
c609719b
WD
1416 write routine for first time initialisation.
1417
1418 CONFIG_TULIP
1419 Support for Digital 2114x chips.
1420 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1421 modem chip initialisation (KS8761/QS6611).
1422
1423 CONFIG_NATSEMI
1424 Support for National dp83815 chips.
1425
1426 CONFIG_NS8382X
1427 Support for National dp8382[01] gigabit chips.
1428
45219c46
WD
1429- NETWORK Support (other):
1430
c041e9d2
JS
1431 CONFIG_DRIVER_AT91EMAC
1432 Support for AT91RM9200 EMAC.
1433
1434 CONFIG_RMII
1435 Define this to use reduced MII inteface
1436
1437 CONFIG_DRIVER_AT91EMAC_QUIET
1438 If this defined, the driver is quiet.
1439 The driver doen't show link status messages.
1440
efdd7319
RH
1441 CONFIG_CALXEDA_XGMAC
1442 Support for the Calxeda XGMAC device
1443
3bb46d23 1444 CONFIG_LAN91C96
45219c46
WD
1445 Support for SMSC's LAN91C96 chips.
1446
1447 CONFIG_LAN91C96_BASE
1448 Define this to hold the physical address
1449 of the LAN91C96's I/O space
1450
1451 CONFIG_LAN91C96_USE_32_BIT
1452 Define this to enable 32 bit addressing
1453
3bb46d23 1454 CONFIG_SMC91111
f39748ae
WD
1455 Support for SMSC's LAN91C111 chip
1456
1457 CONFIG_SMC91111_BASE
1458 Define this to hold the physical address
1459 of the device (I/O space)
1460
1461 CONFIG_SMC_USE_32_BIT
1462 Define this if data bus is 32 bits
1463
1464 CONFIG_SMC_USE_IOFUNCS
1465 Define this to use i/o functions instead of macros
1466 (some hardware wont work with macros)
1467
dc02bada
HS
1468 CONFIG_DRIVER_TI_EMAC
1469 Support for davinci emac
1470
1471 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1472 Define this if you have more then 3 PHYs.
1473
b3dbf4a5
ML
1474 CONFIG_FTGMAC100
1475 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1476
1477 CONFIG_FTGMAC100_EGIGA
1478 Define this to use GE link update with gigabit PHY.
1479 Define this if FTGMAC100 is connected to gigabit PHY.
1480 If your system has 10/100 PHY only, it might not occur
1481 wrong behavior. Because PHY usually return timeout or
1482 useless data when polling gigabit status and gigabit
1483 control registers. This behavior won't affect the
1484 correctnessof 10/100 link speed update.
1485
c2fff331 1486 CONFIG_SMC911X
557b377d
JG
1487 Support for SMSC's LAN911x and LAN921x chips
1488
c2fff331 1489 CONFIG_SMC911X_BASE
557b377d
JG
1490 Define this to hold the physical address
1491 of the device (I/O space)
1492
c2fff331 1493 CONFIG_SMC911X_32_BIT
557b377d
JG
1494 Define this if data bus is 32 bits
1495
c2fff331 1496 CONFIG_SMC911X_16_BIT
557b377d
JG
1497 Define this if data bus is 16 bits. If your processor
1498 automatically converts one 32 bit word to two 16 bit
c2fff331 1499 words you may also try CONFIG_SMC911X_32_BIT.
557b377d 1500
3d0075fa
YS
1501 CONFIG_SH_ETHER
1502 Support for Renesas on-chip Ethernet controller
1503
1504 CONFIG_SH_ETHER_USE_PORT
1505 Define the number of ports to be used
1506
1507 CONFIG_SH_ETHER_PHY_ADDR
1508 Define the ETH PHY's address
1509
68260aab
YS
1510 CONFIG_SH_ETHER_CACHE_WRITEBACK
1511 If this option is set, the driver enables cache flush.
1512
b2f97cf2
HS
1513- PWM Support:
1514 CONFIG_PWM_IMX
1515 Support for PWM modul on the imx6.
1516
5e124724 1517- TPM Support:
90899cc0
CC
1518 CONFIG_TPM
1519 Support TPM devices.
1520
1b393db5
TWHT
1521 CONFIG_TPM_TIS_I2C
1522 Support for i2c bus TPM devices. Only one device
1523 per system is supported at this time.
1524
1525 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1526 Define the the i2c bus number for the TPM device
1527
1528 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1529 Define the TPM's address on the i2c bus
1530
1531 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1532 Define the burst count bytes upper limit
1533
c01939c7
DE
1534 CONFIG_TPM_ATMEL_TWI
1535 Support for Atmel TWI TPM device. Requires I2C support.
1536
90899cc0 1537 CONFIG_TPM_TIS_LPC
5e124724
VB
1538 Support for generic parallel port TPM devices. Only one device
1539 per system is supported at this time.
1540
1541 CONFIG_TPM_TIS_BASE_ADDRESS
1542 Base address where the generic TPM device is mapped
1543 to. Contemporary x86 systems usually map it at
1544 0xfed40000.
1545
be6c1529
RP
1546 CONFIG_CMD_TPM
1547 Add tpm monitor functions.
1548 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1549 provides monitor access to authorized functions.
1550
1551 CONFIG_TPM
1552 Define this to enable the TPM support library which provides
1553 functional interfaces to some TPM commands.
1554 Requires support for a TPM device.
1555
1556 CONFIG_TPM_AUTH_SESSIONS
1557 Define this to enable authorized functions in the TPM library.
1558 Requires CONFIG_TPM and CONFIG_SHA1.
1559
c609719b
WD
1560- USB Support:
1561 At the moment only the UHCI host controller is
4d13cbad 1562 supported (PIP405, MIP405, MPC5200); define
c609719b
WD
1563 CONFIG_USB_UHCI to enable it.
1564 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae 1565 and define CONFIG_USB_STORAGE to enable the USB
c609719b
WD
1566 storage devices.
1567 Note:
1568 Supported are USB Keyboards and USB Floppy drives
1569 (TEAC FD-05PUB).
4d13cbad
WD
1570 MPC5200 USB requires additional defines:
1571 CONFIG_USB_CLOCK
1572 for 528 MHz Clock: 0x0001bbbb
307ecb6d
EM
1573 CONFIG_PSC3_USB
1574 for USB on PSC3
4d13cbad
WD
1575 CONFIG_USB_CONFIG
1576 for differential drivers: 0x00001000
1577 for single ended drivers: 0x00005000
307ecb6d
EM
1578 for differential drivers on PSC3: 0x00000100
1579 for single ended drivers on PSC3: 0x00004100
6d0f6bcf 1580 CONFIG_SYS_USB_EVENT_POLL
fdcfaa1b
ZW
1581 May be defined to allow interrupt polling
1582 instead of using asynchronous interrupts
4d13cbad 1583
9ab4ce22
SG
1584 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1585 txfilltuning field in the EHCI controller on reset.
1586
6e9e0626
OT
1587 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1588 HW module registers.
1589
16c8d5e7
WD
1590- USB Device:
1591 Define the below if you wish to use the USB console.
1592 Once firmware is rebuilt from a serial console issue the
1593 command "setenv stdin usbtty; setenv stdout usbtty" and
11ccc33f 1594 attach your USB cable. The Unix command "dmesg" should print
16c8d5e7
WD
1595 it has found a new device. The environment variable usbtty
1596 can be set to gserial or cdc_acm to enable your device to
386eda02 1597 appear to a USB host as a Linux gserial device or a
16c8d5e7
WD
1598 Common Device Class Abstract Control Model serial device.
1599 If you select usbtty = gserial you should be able to enumerate
1600 a Linux host by
1601 # modprobe usbserial vendor=0xVendorID product=0xProductID
1602 else if using cdc_acm, simply setting the environment
1603 variable usbtty to be cdc_acm should suffice. The following
1604 might be defined in YourBoardName.h
386eda02 1605
16c8d5e7
WD
1606 CONFIG_USB_DEVICE
1607 Define this to build a UDC device
1608
1609 CONFIG_USB_TTY
1610 Define this to have a tty type of device available to
1611 talk to the UDC device
386eda02 1612
f9da0f89
VK
1613 CONFIG_USBD_HS
1614 Define this to enable the high speed support for usb
1615 device and usbtty. If this feature is enabled, a routine
1616 int is_usbd_high_speed(void)
1617 also needs to be defined by the driver to dynamically poll
1618 whether the enumeration has succeded at high speed or full
1619 speed.
1620
6d0f6bcf 1621 CONFIG_SYS_CONSOLE_IS_IN_ENV
16c8d5e7
WD
1622 Define this if you want stdin, stdout &/or stderr to
1623 be set to usbtty.
1624
1625 mpc8xx:
6d0f6bcf 1626 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
16c8d5e7 1627 Derive USB clock from external clock "blah"
6d0f6bcf 1628 - CONFIG_SYS_USB_EXTC_CLK 0x02
386eda02 1629
6d0f6bcf 1630 CONFIG_SYS_USB_BRG_CLK 0xBLAH
16c8d5e7 1631 Derive USB clock from brgclk
6d0f6bcf 1632 - CONFIG_SYS_USB_BRG_CLK 0x04
16c8d5e7 1633
386eda02 1634 If you have a USB-IF assigned VendorID then you may wish to
16c8d5e7 1635 define your own vendor specific values either in BoardName.h
386eda02 1636 or directly in usbd_vendor_info.h. If you don't define
16c8d5e7
WD
1637 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1638 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1639 should pretend to be a Linux device to it's target host.
1640
1641 CONFIG_USBD_MANUFACTURER
1642 Define this string as the name of your company for
1643 - CONFIG_USBD_MANUFACTURER "my company"
386eda02 1644
16c8d5e7
WD
1645 CONFIG_USBD_PRODUCT_NAME
1646 Define this string as the name of your product
1647 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1648
1649 CONFIG_USBD_VENDORID
1650 Define this as your assigned Vendor ID from the USB
1651 Implementors Forum. This *must* be a genuine Vendor ID
1652 to avoid polluting the USB namespace.
1653 - CONFIG_USBD_VENDORID 0xFFFF
386eda02 1654
16c8d5e7
WD
1655 CONFIG_USBD_PRODUCTID
1656 Define this as the unique Product ID
1657 for your device
1658 - CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad 1659
d70a560f
IG
1660- ULPI Layer Support:
1661 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1662 the generic ULPI layer. The generic layer accesses the ULPI PHY
1663 via the platform viewport, so you need both the genric layer and
1664 the viewport enabled. Currently only Chipidea/ARC based
1665 viewport is supported.
1666 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1667 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
6d365ea0
LS
1668 If your ULPI phy needs a different reference clock than the
1669 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1670 the appropriate value in Hz.
c609719b 1671
71f95118 1672- MMC Support:
8bde7f77
WD
1673 The MMC controller on the Intel PXA is supported. To
1674 enable this define CONFIG_MMC. The MMC can be
1675 accessed from the boot prompt by mapping the device
71f95118 1676 to physical memory similar to flash. Command line is
602ad3b3
JL
1677 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1678 the FAT fs. This is enabled with CONFIG_CMD_FAT.
71f95118 1679
afb35666
YS
1680 CONFIG_SH_MMCIF
1681 Support for Renesas on-chip MMCIF controller
1682
1683 CONFIG_SH_MMCIF_ADDR
1684 Define the base address of MMCIF registers
1685
1686 CONFIG_SH_MMCIF_CLK
1687 Define the clock frequency for MMCIF
1688
1fd93c6e
PA
1689 CONFIG_GENERIC_MMC
1690 Enable the generic MMC driver
1691
1692 CONFIG_SUPPORT_EMMC_BOOT
1693 Enable some additional features of the eMMC boot partitions.
1694
1695 CONFIG_SUPPORT_EMMC_RPMB
1696 Enable the commands for reading, writing and programming the
1697 key for the Replay Protection Memory Block partition in eMMC.
1698
b3ba6e94
TR
1699- USB Device Firmware Update (DFU) class support:
1700 CONFIG_DFU_FUNCTION
1701 This enables the USB portion of the DFU USB class
1702
1703 CONFIG_CMD_DFU
1704 This enables the command "dfu" which is used to have
1705 U-Boot create a DFU class device via USB. This command
1706 requires that the "dfu_alt_info" environment variable be
1707 set and define the alt settings to expose to the host.
1708
1709 CONFIG_DFU_MMC
1710 This enables support for exposing (e)MMC devices via DFU.
1711
c6631764
PA
1712 CONFIG_DFU_NAND
1713 This enables support for exposing NAND devices via DFU.
1714
a9479f04
AM
1715 CONFIG_DFU_RAM
1716 This enables support for exposing RAM via DFU.
1717 Note: DFU spec refer to non-volatile memory usage, but
1718 allow usages beyond the scope of spec - here RAM usage,
1719 one that would help mostly the developer.
1720
e7e75c70
HS
1721 CONFIG_SYS_DFU_DATA_BUF_SIZE
1722 Dfu transfer uses a buffer before writing data to the
1723 raw storage device. Make the size (in bytes) of this buffer
1724 configurable. The size of this buffer is also configurable
1725 through the "dfu_bufsiz" environment variable.
1726
ea2453d5
PA
1727 CONFIG_SYS_DFU_MAX_FILE_SIZE
1728 When updating files rather than the raw storage device,
1729 we use a static buffer to copy the file into and then write
1730 the buffer once we've been given the whole file. Define
1731 this to the maximum filesize (in bytes) for the buffer.
1732 Default is 4 MiB if undefined.
1733
001a8319
HS
1734 DFU_DEFAULT_POLL_TIMEOUT
1735 Poll timeout [ms], is the timeout a device can send to the
1736 host. The host must wait for this timeout before sending
1737 a subsequent DFU_GET_STATUS request to the device.
1738
1739 DFU_MANIFEST_POLL_TIMEOUT
1740 Poll timeout [ms], which the device sends to the host when
1741 entering dfuMANIFEST state. Host waits this timeout, before
1742 sending again an USB request to the device.
1743
3aab70af
SS
1744- USB Device Android Fastboot support:
1745 CONFIG_CMD_FASTBOOT
1746 This enables the command "fastboot" which enables the Android
1747 fastboot mode for the platform's USB device. Fastboot is a USB
1748 protocol for downloading images, flashing and device control
1749 used on Android devices.
1750 See doc/README.android-fastboot for more information.
1751
1752 CONFIG_ANDROID_BOOT_IMAGE
1753 This enables support for booting images which use the Android
1754 image format header.
1755
1756 CONFIG_USB_FASTBOOT_BUF_ADDR
1757 The fastboot protocol requires a large memory buffer for
1758 downloads. Define this to the starting RAM address to use for
1759 downloaded images.
1760
1761 CONFIG_USB_FASTBOOT_BUF_SIZE
1762 The fastboot protocol requires a large memory buffer for
1763 downloads. This buffer should be as large as possible for a
1764 platform. Define this to the size available RAM for fastboot.
d1b5ed07
SR
1765
1766 CONFIG_FASTBOOT_FLASH
1767 The fastboot protocol includes a "flash" command for writing
1768 the downloaded image to a non-volatile storage device. Define
1769 this to enable the "fastboot flash" command.
1770
1771 CONFIG_FASTBOOT_FLASH_MMC_DEV
1772 The fastboot "flash" command requires additional information
1773 regarding the non-volatile storage device. Define this to
1774 the eMMC device that fastboot should use to store the image.
3aab70af 1775
0ff7e585
SR
1776 CONFIG_FASTBOOT_GPT_NAME
1777 The fastboot "flash" command supports writing the downloaded
1778 image to the Protective MBR and the Primary GUID Partition
1779 Table. (Additionally, this downloaded image is post-processed
1780 to generate and write the Backup GUID Partition Table.)
1781 This occurs when the specified "partition name" on the
1782 "fastboot flash" command line matches this value.
1783 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1784
6705d81e
WD
1785- Journaling Flash filesystem support:
1786 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1787 CONFIG_JFFS2_NAND_DEV
1788 Define these for a default partition on a NAND device
1789
6d0f6bcf
JCPV
1790 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1791 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e
WD
1792 Define these for a default partition on a NOR device
1793
6d0f6bcf 1794 CONFIG_SYS_JFFS_CUSTOM_PART
6705d81e
WD
1795 Define this to create an own partition. You have to provide a
1796 function struct part_info* jffs2_part_info(int part_num)
1797
1798 If you define only one JFFS2 partition you may also want to
6d0f6bcf 1799 #define CONFIG_SYS_JFFS_SINGLE_PART 1
6705d81e
WD
1800 to disable the command chpart. This is the default when you
1801 have not defined a custom partition
1802
c30a15e5
DK
1803- FAT(File Allocation Table) filesystem write function support:
1804 CONFIG_FAT_WRITE
656f4c65
DK
1805
1806 Define this to enable support for saving memory data as a
1807 file in FAT formatted partition.
1808
1809 This will also enable the command "fatwrite" enabling the
1810 user to write files to FAT.
c30a15e5 1811
84cd9327
GB
1812CBFS (Coreboot Filesystem) support
1813 CONFIG_CMD_CBFS
1814
1815 Define this to enable support for reading from a Coreboot
1816 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1817 and cbfsload.
1818
4f0d1a2a
SDPP
1819- FAT(File Allocation Table) filesystem cluster size:
1820 CONFIG_FS_FAT_MAX_CLUSTSIZE
1821
1822 Define the max cluster size for fat operations else
1823 a default value of 65536 will be defined.
1824
c609719b
WD
1825- Keyboard Support:
1826 CONFIG_ISA_KEYBOARD
1827
1828 Define this to enable standard (PC-Style) keyboard
1829 support
1830
1831 CONFIG_I8042_KBD
1832 Standard PC keyboard driver with US (is default) and
1833 GERMAN key layout (switch via environment 'keymap=de') support.
1834 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1835 for cfb_console. Supports cursor blinking.
1836
713cb680
HT
1837 CONFIG_CROS_EC_KEYB
1838 Enables a Chrome OS keyboard using the CROS_EC interface.
1839 This uses CROS_EC to communicate with a second microcontroller
1840 which provides key scans on request.
1841
c609719b
WD
1842- Video support:
1843 CONFIG_VIDEO
1844
1845 Define this to enable video support (for output to
1846 video).
1847
1848 CONFIG_VIDEO_CT69000
1849
1850 Enable Chips & Technologies 69000 Video chip
1851
1852 CONFIG_VIDEO_SMI_LYNXEM
b79a11cc 1853 Enable Silicon Motion SMI 712/710/810 Video chip. The
eeb1b77b
WD
1854 video output is selected via environment 'videoout'
1855 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1856 assumed.
1857
b79a11cc 1858 For the CT69000 and SMI_LYNXEM drivers, videomode is
11ccc33f 1859 selected via environment 'videomode'. Two different ways
eeb1b77b
WD
1860 are possible:
1861 - "videomode=num" 'num' is a standard LiLo mode numbers.
6e592385 1862 Following standard modes are supported (* is default):
eeb1b77b
WD
1863
1864 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1865 -------------+---------------------------------------------
1866 8 bits | 0x301* 0x303 0x305 0x161 0x307
1867 15 bits | 0x310 0x313 0x316 0x162 0x319
1868 16 bits | 0x311 0x314 0x317 0x163 0x31A
1869 24 bits | 0x312 0x315 0x318 ? 0x31B
1870 -------------+---------------------------------------------
c609719b
WD
1871 (i.e. setenv videomode 317; saveenv; reset;)
1872
b79a11cc 1873 - "videomode=bootargs" all the video parameters are parsed
7817cb20 1874 from the bootargs. (See drivers/video/videomodes.c)
eeb1b77b
WD
1875
1876
c1551ea8 1877 CONFIG_VIDEO_SED13806
43d9616c 1878 Enable Epson SED13806 driver. This driver supports 8bpp
a6c7ad2f
WD
1879 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1880 or CONFIG_VIDEO_SED13806_16BPP
1881
7d3053fb 1882 CONFIG_FSL_DIU_FB
04e5ae79 1883 Enable the Freescale DIU video driver. Reference boards for
7d3053fb
TT
1884 SOCs that have a DIU should define this macro to enable DIU
1885 support, and should also define these other macros:
1886
1887 CONFIG_SYS_DIU_ADDR
1888 CONFIG_VIDEO
1889 CONFIG_CMD_BMP
1890 CONFIG_CFB_CONSOLE
1891 CONFIG_VIDEO_SW_CURSOR
1892 CONFIG_VGA_AS_SINGLE_DEVICE
1893 CONFIG_VIDEO_LOGO
1894 CONFIG_VIDEO_BMP_LOGO
1895
ba8e76bd
TT
1896 The DIU driver will look for the 'video-mode' environment
1897 variable, and if defined, enable the DIU as a console during
1898 boot. See the documentation file README.video for a
1899 description of this variable.
7d3053fb 1900
058d59b0
SG
1901 CONFIG_VIDEO_VGA
1902
1903 Enable the VGA video / BIOS for x86. The alternative if you
1904 are using coreboot is to use the coreboot frame buffer
1905 driver.
1906
1907
682011ff 1908- Keyboard Support:
8bde7f77 1909 CONFIG_KEYBOARD
682011ff 1910
8bde7f77
WD
1911 Define this to enable a custom keyboard support.
1912 This simply calls drv_keyboard_init() which must be
1913 defined in your board-specific files.
1914 The only board using this so far is RBC823.
a6c7ad2f 1915
c609719b
WD
1916- LCD Support: CONFIG_LCD
1917
1918 Define this to enable LCD support (for output to LCD
1919 display); also select one of the supported displays
1920 by defining one of these:
1921
39cf4804
SP
1922 CONFIG_ATMEL_LCD:
1923
1924 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1925
fd3103bb 1926 CONFIG_NEC_NL6448AC33:
c609719b 1927
fd3103bb 1928 NEC NL6448AC33-18. Active, color, single scan.
c609719b 1929
fd3103bb 1930 CONFIG_NEC_NL6448BC20
c609719b 1931
fd3103bb
WD
1932 NEC NL6448BC20-08. 6.5", 640x480.
1933 Active, color, single scan.
1934
1935 CONFIG_NEC_NL6448BC33_54
1936
1937 NEC NL6448BC33-54. 10.4", 640x480.
c609719b
WD
1938 Active, color, single scan.
1939
1940 CONFIG_SHARP_16x9
1941
1942 Sharp 320x240. Active, color, single scan.
1943 It isn't 16x9, and I am not sure what it is.
1944
1945 CONFIG_SHARP_LQ64D341
1946
1947 Sharp LQ64D341 display, 640x480.
1948 Active, color, single scan.
1949
1950 CONFIG_HLD1045
1951
1952 HLD1045 display, 640x480.
1953 Active, color, single scan.
1954
1955 CONFIG_OPTREX_BW
1956
1957 Optrex CBL50840-2 NF-FW 99 22 M5
1958 or
1959 Hitachi LMG6912RPFC-00T
1960 or
1961 Hitachi SP14Q002
1962
1963 320x240. Black & white.
1964
1965 Normally display is black on white background; define
6d0f6bcf 1966 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
c609719b 1967
676d319e
SG
1968 CONFIG_LCD_ALIGNMENT
1969
1970 Normally the LCD is page-aligned (tyically 4KB). If this is
1971 defined then the LCD will be aligned to this value instead.
1972 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1973 here, since it is cheaper to change data cache settings on
1974 a per-section basis.
1975
0d89efef
SG
1976 CONFIG_CONSOLE_SCROLL_LINES
1977
1978 When the console need to be scrolled, this is the number of
1979 lines to scroll by. It defaults to 1. Increasing this makes
1980 the console jump but can help speed up operation when scrolling
1981 is slow.
676d319e 1982
45d7f525
TWHT
1983 CONFIG_LCD_BMP_RLE8
1984
1985 Support drawing of RLE8-compressed bitmaps on the LCD.
1986
735987c5
TWHT
1987 CONFIG_I2C_EDID
1988
1989 Enables an 'i2c edid' command which can read EDID
1990 information over I2C from an attached LCD display.
1991
7152b1d0 1992- Splash Screen Support: CONFIG_SPLASH_SCREEN
d791b1dc 1993
8bde7f77
WD
1994 If this option is set, the environment is checked for
1995 a variable "splashimage". If found, the usual display
1996 of logo, copyright and system information on the LCD
e94d2cd9 1997 is suppressed and the BMP image at the address
8bde7f77
WD
1998 specified in "splashimage" is loaded instead. The
1999 console is redirected to the "nulldev", too. This
2000 allows for a "silent" boot where a splash screen is
2001 loaded very quickly after power-on.
d791b1dc 2002
c0880485
NK
2003 CONFIG_SPLASHIMAGE_GUARD
2004
2005 If this option is set, then U-Boot will prevent the environment
2006 variable "splashimage" from being set to a problematic address
1551df35 2007 (see README.displaying-bmps).
c0880485
NK
2008 This option is useful for targets where, due to alignment
2009 restrictions, an improperly aligned BMP image will cause a data
2010 abort. If you think you will not have problems with unaligned
2011 accesses (for example because your toolchain prevents them)
2012 there is no need to set this option.
2013
1ca298ce
MW
2014 CONFIG_SPLASH_SCREEN_ALIGN
2015
2016 If this option is set the splash image can be freely positioned
2017 on the screen. Environment variable "splashpos" specifies the
2018 position as "x,y". If a positive number is given it is used as
2019 number of pixel from left/top. If a negative number is given it
2020 is used as number of pixel from right/bottom. You can also
2021 specify 'm' for centering the image.
2022
2023 Example:
2024 setenv splashpos m,m
2025 => image at center of screen
2026
2027 setenv splashpos 30,20
2028 => image at x = 30 and y = 20
2029
2030 setenv splashpos -10,m
2031 => vertically centered image
2032 at x = dspWidth - bmpWidth - 9
2033
98f4a3df
SR
2034- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2035
2036 If this option is set, additionally to standard BMP
2037 images, gzipped BMP images can be displayed via the
2038 splashscreen support or the bmp command.
2039
d5011762
AG
2040- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2041
2042 If this option is set, 8-bit RLE compressed BMP images
2043 can be displayed via the splashscreen support or the
2044 bmp command.
2045
f2b96dfb
LW
2046- Do compresssing for memory range:
2047 CONFIG_CMD_ZIP
2048
2049 If this option is set, it would use zlib deflate method
2050 to compress the specified memory at its best effort.
2051
c29fdfc1 2052- Compression support:
8ef70478
KC
2053 CONFIG_GZIP
2054
2055 Enabled by default to support gzip compressed images.
2056
c29fdfc1
WD
2057 CONFIG_BZIP2
2058
2059 If this option is set, support for bzip2 compressed
2060 images is included. If not, only uncompressed and gzip
2061 compressed images are supported.
2062
42d1f039 2063 NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf 2064 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f039 2065 be at least 4MB.
d791b1dc 2066
fc9c1727
LCM
2067 CONFIG_LZMA
2068
2069 If this option is set, support for lzma compressed
2070 images is included.
2071
2072 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2073 requires an amount of dynamic memory that is given by the
2074 formula:
2075
2076 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2077
2078 Where lc and lp stand for, respectively, Literal context bits
2079 and Literal pos bits.
2080
2081 This value is upper-bounded by 14MB in the worst case. Anyway,
2082 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2083 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2084 a very small buffer.
2085
2086 Use the lzmainfo tool to determinate the lc and lp values and
2087 then calculate the amount of needed dynamic memory (ensuring
6d0f6bcf 2088 the appropriate CONFIG_SYS_MALLOC_LEN value).
fc9c1727 2089
8ef70478
KC
2090 CONFIG_LZO
2091
2092 If this option is set, support for LZO compressed images
2093 is included.
2094
17ea1177
WD
2095- MII/PHY support:
2096 CONFIG_PHY_ADDR
2097
2098 The address of PHY on MII bus.
2099
2100 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2101
2102 The clock frequency of the MII bus
2103
2104 CONFIG_PHY_GIGE
2105
2106 If this option is set, support for speed/duplex
11ccc33f 2107 detection of gigabit PHY is included.
17ea1177
WD
2108
2109 CONFIG_PHY_RESET_DELAY
2110
2111 Some PHY like Intel LXT971A need extra delay after
2112 reset before any MII register access is possible.
2113 For such PHY, set this option to the usec delay
2114 required. (minimum 300usec for LXT971A)
2115
2116 CONFIG_PHY_CMD_DELAY (ppc4xx)
2117
2118 Some PHY like Intel LXT971A need extra delay after
2119 command issued before MII status register can be read
2120
c609719b
WD
2121- Ethernet address:
2122 CONFIG_ETHADDR
c68a05fe 2123 CONFIG_ETH1ADDR
c609719b
WD
2124 CONFIG_ETH2ADDR
2125 CONFIG_ETH3ADDR
c68a05fe 2126 CONFIG_ETH4ADDR
2127 CONFIG_ETH5ADDR
c609719b 2128
11ccc33f
MZ
2129 Define a default value for Ethernet address to use
2130 for the respective Ethernet interface, in case this
c609719b
WD
2131 is not determined automatically.
2132
2133- IP address:
2134 CONFIG_IPADDR
2135
2136 Define a default value for the IP address to use for
11ccc33f 2137 the default Ethernet interface, in case this is not
c609719b 2138 determined through e.g. bootp.
1ebcd654 2139 (Environment variable "ipaddr")
c609719b
WD
2140
2141- Server IP address:
2142 CONFIG_SERVERIP
2143
11ccc33f 2144 Defines a default value for the IP address of a TFTP
c609719b 2145 server to contact when using the "tftboot" command.
1ebcd654 2146 (Environment variable "serverip")
c609719b 2147
97cfe861
RG
2148 CONFIG_KEEP_SERVERADDR
2149
2150 Keeps the server's MAC address, in the env 'serveraddr'
2151 for passing to bootargs (like Linux's netconsole option)
2152
1ebcd654
WD
2153- Gateway IP address:
2154 CONFIG_GATEWAYIP
2155
2156 Defines a default value for the IP address of the
2157 default router where packets to other networks are
2158 sent to.
2159 (Environment variable "gatewayip")
2160
2161- Subnet mask:
2162 CONFIG_NETMASK
2163
2164 Defines a default value for the subnet mask (or
2165 routing prefix) which is used to determine if an IP
2166 address belongs to the local subnet or needs to be
2167 forwarded through a router.
2168 (Environment variable "netmask")
2169
53a5c424
DU
2170- Multicast TFTP Mode:
2171 CONFIG_MCAST_TFTP
2172
2173 Defines whether you want to support multicast TFTP as per
2174 rfc-2090; for example to work with atftp. Lets lots of targets
11ccc33f 2175 tftp down the same boot image concurrently. Note: the Ethernet
53a5c424
DU
2176 driver in use must provide a function: mcast() to join/leave a
2177 multicast group.
2178
c609719b
WD
2179- BOOTP Recovery Mode:
2180 CONFIG_BOOTP_RANDOM_DELAY
2181
2182 If you have many targets in a network that try to
2183 boot using BOOTP, you may want to avoid that all
2184 systems send out BOOTP requests at precisely the same
2185 moment (which would happen for instance at recovery
2186 from a power failure, when all systems will try to
2187 boot, thus flooding the BOOTP server. Defining
2188 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2189 inserted before sending out BOOTP requests. The
6c33c785 2190 following delays are inserted then:
c609719b
WD
2191
2192 1st BOOTP request: delay 0 ... 1 sec
2193 2nd BOOTP request: delay 0 ... 2 sec
2194 3rd BOOTP request: delay 0 ... 4 sec
2195 4th and following
2196 BOOTP requests: delay 0 ... 8 sec
2197
92ac8acc
TR
2198 CONFIG_BOOTP_ID_CACHE_SIZE
2199
2200 BOOTP packets are uniquely identified using a 32-bit ID. The
2201 server will copy the ID from client requests to responses and
2202 U-Boot will use this to determine if it is the destination of
2203 an incoming response. Some servers will check that addresses
2204 aren't in use before handing them out (usually using an ARP
2205 ping) and therefore take up to a few hundred milliseconds to
2206 respond. Network congestion may also influence the time it
2207 takes for a response to make it back to the client. If that
2208 time is too long, U-Boot will retransmit requests. In order
2209 to allow earlier responses to still be accepted after these
2210 retransmissions, U-Boot's BOOTP client keeps a small cache of
2211 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2212 cache. The default is to keep IDs for up to four outstanding
2213 requests. Increasing this will allow U-Boot to accept offers
2214 from a BOOTP client in networks with unusually high latency.
2215
fe389a82 2216- DHCP Advanced Options:
1fe80d79
JL
2217 You can fine tune the DHCP functionality by defining
2218 CONFIG_BOOTP_* symbols:
2219
2220 CONFIG_BOOTP_SUBNETMASK
2221 CONFIG_BOOTP_GATEWAY
2222 CONFIG_BOOTP_HOSTNAME
2223 CONFIG_BOOTP_NISDOMAIN
2224 CONFIG_BOOTP_BOOTPATH
2225 CONFIG_BOOTP_BOOTFILESIZE
2226 CONFIG_BOOTP_DNS
2227 CONFIG_BOOTP_DNS2
2228 CONFIG_BOOTP_SEND_HOSTNAME
2229 CONFIG_BOOTP_NTPSERVER
2230 CONFIG_BOOTP_TIMEOFFSET
2231 CONFIG_BOOTP_VENDOREX
2c00e099 2232 CONFIG_BOOTP_MAY_FAIL
fe389a82 2233
5d110f0a
WC
2234 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2235 environment variable, not the BOOTP server.
fe389a82 2236
2c00e099
JH
2237 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2238 after the configured retry count, the call will fail
2239 instead of starting over. This can be used to fail over
2240 to Link-local IP address configuration if the DHCP server
2241 is not available.
2242
fe389a82
SR
2243 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2244 serverip from a DHCP server, it is possible that more
2245 than one DNS serverip is offered to the client.
2246 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2247 serverip will be stored in the additional environment
2248 variable "dnsip2". The first DNS serverip is always
2249 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1fe80d79 2250 is defined.
fe389a82
SR
2251
2252 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2253 to do a dynamic update of a DNS server. To do this, they
2254 need the hostname of the DHCP requester.
5d110f0a 2255 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79
JL
2256 of the "hostname" environment variable is passed as
2257 option 12 to the DHCP server.
fe389a82 2258
d9a2f416
AV
2259 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2260
2261 A 32bit value in microseconds for a delay between
2262 receiving a "DHCP Offer" and sending the "DHCP Request".
2263 This fixes a problem with certain DHCP servers that don't
2264 respond 100% of the time to a "DHCP request". E.g. On an
2265 AT91RM9200 processor running at 180MHz, this delay needed
2266 to be *at least* 15,000 usec before a Windows Server 2003
2267 DHCP server would reply 100% of the time. I recommend at
2268 least 50,000 usec to be safe. The alternative is to hope
2269 that one of the retries will be successful but note that
2270 the DHCP timeout and retry process takes a longer than
2271 this delay.
2272
d22c338e
JH
2273 - Link-local IP address negotiation:
2274 Negotiate with other link-local clients on the local network
2275 for an address that doesn't require explicit configuration.
2276 This is especially useful if a DHCP server cannot be guaranteed
2277 to exist in all environments that the device must operate.
2278
2279 See doc/README.link-local for more information.
2280
a3d991bd 2281 - CDP Options:
6e592385 2282 CONFIG_CDP_DEVICE_ID
a3d991bd
WD
2283
2284 The device id used in CDP trigger frames.
2285
2286 CONFIG_CDP_DEVICE_ID_PREFIX
2287
2288 A two character string which is prefixed to the MAC address
2289 of the device.
2290
2291 CONFIG_CDP_PORT_ID
2292
2293 A printf format string which contains the ascii name of
2294 the port. Normally is set to "eth%d" which sets
11ccc33f 2295 eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd
WD
2296
2297 CONFIG_CDP_CAPABILITIES
2298
2299 A 32bit integer which indicates the device capabilities;
2300 0x00000010 for a normal host which does not forwards.
2301
2302 CONFIG_CDP_VERSION
2303
2304 An ascii string containing the version of the software.
2305
2306 CONFIG_CDP_PLATFORM
2307
2308 An ascii string containing the name of the platform.
2309
2310 CONFIG_CDP_TRIGGER
2311
2312 A 32bit integer sent on the trigger.
2313
2314 CONFIG_CDP_POWER_CONSUMPTION
2315
2316 A 16bit integer containing the power consumption of the
2317 device in .1 of milliwatts.
2318
2319 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2320
2321 A byte containing the id of the VLAN.
2322
c609719b
WD
2323- Status LED: CONFIG_STATUS_LED
2324
2325 Several configurations allow to display the current
2326 status using a LED. For instance, the LED will blink
2327 fast while running U-Boot code, stop blinking as
2328 soon as a reply to a BOOTP request was received, and
2329 start blinking slow once the Linux kernel is running
2330 (supported by a status LED driver in the Linux
2331 kernel). Defining CONFIG_STATUS_LED enables this
2332 feature in U-Boot.
2333
1df7bbba
IG
2334 Additional options:
2335
2336 CONFIG_GPIO_LED
2337 The status LED can be connected to a GPIO pin.
2338 In such cases, the gpio_led driver can be used as a
2339 status LED backend implementation. Define CONFIG_GPIO_LED
2340 to include the gpio_led driver in the U-Boot binary.
2341
9dfdcdfe
IG
2342 CONFIG_GPIO_LED_INVERTED_TABLE
2343 Some GPIO connected LEDs may have inverted polarity in which
2344 case the GPIO high value corresponds to LED off state and
2345 GPIO low value corresponds to LED on state.
2346 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2347 with a list of GPIO LEDs that have inverted polarity.
2348
c609719b
WD
2349- CAN Support: CONFIG_CAN_DRIVER
2350
2351 Defining CONFIG_CAN_DRIVER enables CAN driver support
2352 on those systems that support this (optional)
2353 feature, like the TQM8xxL modules.
2354
3f4978c7
HS
2355- I2C Support: CONFIG_SYS_I2C
2356
2357 This enable the NEW i2c subsystem, and will allow you to use
2358 i2c commands at the u-boot command line (as long as you set
2359 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2360 based realtime clock chips or other i2c devices. See
2361 common/cmd_i2c.c for a description of the command line
2362 interface.
2363
2364 ported i2c driver to the new framework:
ea818dbb
HS
2365 - drivers/i2c/soft_i2c.c:
2366 - activate first bus with CONFIG_SYS_I2C_SOFT define
2367 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2368 for defining speed and slave address
2369 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2370 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2371 for defining speed and slave address
2372 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2373 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2374 for defining speed and slave address
2375 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2376 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2377 for defining speed and slave address
3f4978c7 2378
00f792e0
HS
2379 - drivers/i2c/fsl_i2c.c:
2380 - activate i2c driver with CONFIG_SYS_I2C_FSL
2381 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2382 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2383 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2384 bus.
93e14596 2385 - If your board supports a second fsl i2c bus, define
00f792e0
HS
2386 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2387 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2388 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2389 second bus.
2390
1f2ba722 2391 - drivers/i2c/tegra_i2c.c:
10cee516
NI
2392 - activate this driver with CONFIG_SYS_I2C_TEGRA
2393 - This driver adds 4 i2c buses with a fix speed from
2394 100000 and the slave addr 0!
1f2ba722 2395
880540de
DE
2396 - drivers/i2c/ppc4xx_i2c.c
2397 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2398 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2399 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2400
fac96408 2401 - drivers/i2c/i2c_mxc.c
2402 - activate this driver with CONFIG_SYS_I2C_MXC
2403 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2404 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2405 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2406 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2407 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2408 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2409 If thoses defines are not set, default value is 100000
2410 for speed, and 0 for slave.
2411
1086bfa9
NI
2412 - drivers/i2c/rcar_i2c.c:
2413 - activate this driver with CONFIG_SYS_I2C_RCAR
2414 - This driver adds 4 i2c buses
2415
2416 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2417 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2418 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2419 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2420 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2421 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2422 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2423 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2424 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2425
2035d77d
NI
2426 - drivers/i2c/sh_i2c.c:
2427 - activate this driver with CONFIG_SYS_I2C_SH
2428 - This driver adds from 2 to 5 i2c buses
2429
2430 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2431 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2432 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2433 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2434 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2435 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2436 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2437 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2438 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2439 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2440 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2441 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2442 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2443
6789e84e
HS
2444 - drivers/i2c/omap24xx_i2c.c
2445 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2446 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2447 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2448 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2449 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2450 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2451 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2452 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2453 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2454 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2455 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2456
0bdffe71
HS
2457 - drivers/i2c/zynq_i2c.c
2458 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2459 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2460 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2461
e717fc6d
NKC
2462 - drivers/i2c/s3c24x0_i2c.c:
2463 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2464 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2465 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2466 with a fix speed from 100000 and the slave addr 0!
2467
b46226bd
DE
2468 - drivers/i2c/ihs_i2c.c
2469 - activate this driver with CONFIG_SYS_I2C_IHS
2470 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2471 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2472 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2473 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2474 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2475 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2476 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2477 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2478 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2479 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2480 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2481 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2482
3f4978c7
HS
2483 additional defines:
2484
2485 CONFIG_SYS_NUM_I2C_BUSES
2486 Hold the number of i2c busses you want to use. If you
2487 don't use/have i2c muxes on your i2c bus, this
2488 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2489 omit this define.
2490
2491 CONFIG_SYS_I2C_DIRECT_BUS
2492 define this, if you don't use i2c muxes on your hardware.
2493 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2494 omit this define.
2495
2496 CONFIG_SYS_I2C_MAX_HOPS
2497 define how many muxes are maximal consecutively connected
2498 on one i2c bus. If you not use i2c muxes, omit this
2499 define.
2500
2501 CONFIG_SYS_I2C_BUSES
2502 hold a list of busses you want to use, only used if
2503 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2504 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2505 CONFIG_SYS_NUM_I2C_BUSES = 9:
2506
2507 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2508 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2509 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2510 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2511 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2512 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2513 {1, {I2C_NULL_HOP}}, \
2514 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2515 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2516 }
2517
2518 which defines
2519 bus 0 on adapter 0 without a mux
ea818dbb
HS
2520 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2521 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2522 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2523 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2524 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
3f4978c7 2525 bus 6 on adapter 1 without a mux
ea818dbb
HS
2526 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2527 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
3f4978c7
HS
2528
2529 If you do not have i2c muxes on your board, omit this define.
2530
ea818dbb 2531- Legacy I2C Support: CONFIG_HARD_I2C
3f4978c7
HS
2532
2533 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2534 provides the following compelling advantages:
2535
2536 - more than one i2c adapter is usable
2537 - approved multibus support
2538 - better i2c mux support
2539
2540 ** Please consider updating your I2C driver now. **
2541
ea818dbb
HS
2542 These enable legacy I2C serial bus commands. Defining
2543 CONFIG_HARD_I2C will include the appropriate I2C driver
2544 for the selected CPU.
c609719b 2545
945af8d7 2546 This will allow you to use i2c commands at the u-boot
602ad3b3 2547 command line (as long as you set CONFIG_CMD_I2C in
b37c7e5e
WD
2548 CONFIG_COMMANDS) and communicate with i2c based realtime
2549 clock chips. See common/cmd_i2c.c for a description of the
43d9616c 2550 command line interface.
c609719b 2551
bb99ad6d 2552 CONFIG_HARD_I2C selects a hardware I2C controller.
b37c7e5e 2553
945af8d7 2554 There are several other quantities that must also be
ea818dbb 2555 defined when you define CONFIG_HARD_I2C.
c609719b 2556
6d0f6bcf 2557 In both cases you will need to define CONFIG_SYS_I2C_SPEED
945af8d7 2558 to be the frequency (in Hz) at which you wish your i2c bus
6d0f6bcf 2559 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
11ccc33f 2560 the CPU's i2c node address).
945af8d7 2561
8d321b81 2562 Now, the u-boot i2c code for the mpc8xx
a47a12be 2563 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
8d321b81
PT
2564 and so its address should therefore be cleared to 0 (See,
2565 eg, MPC823e User's Manual p.16-473). So, set
2566 CONFIG_SYS_I2C_SLAVE to 0.
c609719b 2567
5da71efa
EM
2568 CONFIG_SYS_I2C_INIT_MPC5XXX
2569
2570 When a board is reset during an i2c bus transfer
2571 chips might think that the current transfer is still
2572 in progress. Reset the slave devices by sending start
2573 commands until the slave device responds.
2574
945af8d7 2575 That's all that's required for CONFIG_HARD_I2C.
c609719b 2576
ea818dbb 2577 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
b37c7e5e
WD
2578 then the following macros need to be defined (examples are
2579 from include/configs/lwmon.h):
c609719b
WD
2580
2581 I2C_INIT
2582
b37c7e5e 2583 (Optional). Any commands necessary to enable the I2C
43d9616c 2584 controller or configure ports.
c609719b 2585
ba56f625 2586 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
b37c7e5e 2587
c609719b
WD
2588 I2C_PORT
2589
43d9616c
WD
2590 (Only for MPC8260 CPU). The I/O port to use (the code
2591 assumes both bits are on the same port). Valid values
2592 are 0..3 for ports A..D.
c609719b
WD
2593
2594 I2C_ACTIVE
2595
2596 The code necessary to make the I2C data line active
2597 (driven). If the data line is open collector, this
2598 define can be null.
2599
b37c7e5e
WD
2600 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2601
c609719b
WD
2602 I2C_TRISTATE
2603
2604 The code necessary to make the I2C data line tri-stated
2605 (inactive). If the data line is open collector, this
2606 define can be null.
2607
b37c7e5e
WD
2608 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2609
c609719b
WD
2610 I2C_READ
2611
472d5460
YS
2612 Code that returns true if the I2C data line is high,
2613 false if it is low.
c609719b 2614
b37c7e5e
WD
2615 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2616
c609719b
WD
2617 I2C_SDA(bit)
2618
472d5460
YS
2619 If <bit> is true, sets the I2C data line high. If it
2620 is false, it clears it (low).
c609719b 2621
b37c7e5e 2622 eg: #define I2C_SDA(bit) \
2535d602 2623 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
ba56f625 2624 else immr->im_cpm.cp_pbdat &= ~PB_SDA
b37c7e5e 2625
c609719b
WD
2626 I2C_SCL(bit)
2627
472d5460
YS
2628 If <bit> is true, sets the I2C clock line high. If it
2629 is false, it clears it (low).
c609719b 2630
b37c7e5e 2631 eg: #define I2C_SCL(bit) \
2535d602 2632 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
ba56f625 2633 else immr->im_cpm.cp_pbdat &= ~PB_SCL
b37c7e5e 2634
c609719b
WD
2635 I2C_DELAY
2636
2637 This delay is invoked four times per clock cycle so this
2638 controls the rate of data transfer. The data rate thus
b37c7e5e 2639 is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d7
WD
2640 like:
2641
b37c7e5e 2642 #define I2C_DELAY udelay(2)
c609719b 2643
793b5726
MF
2644 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2645
2646 If your arch supports the generic GPIO framework (asm/gpio.h),
2647 then you may alternatively define the two GPIOs that are to be
2648 used as SCL / SDA. Any of the previous I2C_xxx macros will
2649 have GPIO-based defaults assigned to them as appropriate.
2650
2651 You should define these to the GPIO value as given directly to
2652 the generic GPIO functions.
2653
6d0f6bcf 2654 CONFIG_SYS_I2C_INIT_BOARD
47cd00fa 2655
8bde7f77
WD
2656 When a board is reset during an i2c bus transfer
2657 chips might think that the current transfer is still
2658 in progress. On some boards it is possible to access
2659 the i2c SCLK line directly, either by using the
2660 processor pin as a GPIO or by having a second pin
2661 connected to the bus. If this option is defined a
2662 custom i2c_init_board() routine in boards/xxx/board.c
2663 is run early in the boot sequence.
47cd00fa 2664
26a33504
RR
2665 CONFIG_SYS_I2C_BOARD_LATE_INIT
2666
2667 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2668 defined a custom i2c_board_late_init() routine in
2669 boards/xxx/board.c is run AFTER the operations in i2c_init()
2670 is completed. This callpoint can be used to unreset i2c bus
2671 using CPU i2c controller register accesses for CPUs whose i2c
2672 controller provide such a method. It is called at the end of
2673 i2c_init() to allow i2c_init operations to setup the i2c bus
2674 controller on the CPU (e.g. setting bus speed & slave address).
2675
17ea1177
WD
2676 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2677
2678 This option enables configuration of bi_iic_fast[] flags
2679 in u-boot bd_info structure based on u-boot environment
2680 variable "i2cfast". (see also i2cfast)
2681
bb99ad6d
BW
2682 CONFIG_I2C_MULTI_BUS
2683
2684 This option allows the use of multiple I2C buses, each of which
c0f40859
WD
2685 must have a controller. At any point in time, only one bus is
2686 active. To switch to a different bus, use the 'i2c dev' command.
bb99ad6d
BW
2687 Note that bus numbering is zero-based.
2688
6d0f6bcf 2689 CONFIG_SYS_I2C_NOPROBES
bb99ad6d
BW
2690
2691 This option specifies a list of I2C devices that will be skipped
c0f40859 2692 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
0f89c54b
PT
2693 is set, specify a list of bus-device pairs. Otherwise, specify
2694 a 1D array of device addresses
bb99ad6d
BW
2695
2696 e.g.
2697 #undef CONFIG_I2C_MULTI_BUS
c0f40859 2698 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d
BW
2699
2700 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2701
c0f40859 2702 #define CONFIG_I2C_MULTI_BUS
6d0f6bcf 2703 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d
BW
2704
2705 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2706
6d0f6bcf 2707 CONFIG_SYS_SPD_BUS_NUM
be5e6181
TT
2708
2709 If defined, then this indicates the I2C bus number for DDR SPD.
2710 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2711
6d0f6bcf 2712 CONFIG_SYS_RTC_BUS_NUM
0dc018ec
SR
2713
2714 If defined, then this indicates the I2C bus number for the RTC.
2715 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2716
6d0f6bcf 2717 CONFIG_SYS_DTT_BUS_NUM
0dc018ec
SR
2718
2719 If defined, then this indicates the I2C bus number for the DTT.
2720 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2721
6d0f6bcf 2722 CONFIG_SYS_I2C_DTT_ADDR:
9ebbb54f
VG
2723
2724 If defined, specifies the I2C address of the DTT device.
2725 If not defined, then U-Boot uses predefined value for
2726 specified DTT device.
2727
2ac6985a
AD
2728 CONFIG_SOFT_I2C_READ_REPEATED_START
2729
2730 defining this will force the i2c_read() function in
2731 the soft_i2c driver to perform an I2C repeated start
2732 between writing the address pointer and reading the
2733 data. If this define is omitted the default behaviour
2734 of doing a stop-start sequence will be used. Most I2C
2735 devices can use either method, but some require one or
2736 the other.
be5e6181 2737
c609719b
WD
2738- SPI Support: CONFIG_SPI
2739
2740 Enables SPI driver (so far only tested with
2741 SPI EEPROM, also an instance works with Crystal A/D and
2742 D/As on the SACSng board)
2743
6639562e
YS
2744 CONFIG_SH_SPI
2745
2746 Enables the driver for SPI controller on SuperH. Currently
2747 only SH7757 is supported.
2748
c609719b
WD
2749 CONFIG_SPI_X
2750
2751 Enables extended (16-bit) SPI EEPROM addressing.
2752 (symmetrical to CONFIG_I2C_X)
2753
2754 CONFIG_SOFT_SPI
2755
43d9616c
WD
2756 Enables a software (bit-bang) SPI driver rather than
2757 using hardware support. This is a general purpose
2758 driver that only requires three general I/O port pins
2759 (two outputs, one input) to function. If this is
2760 defined, the board configuration must define several
2761 SPI configuration items (port pins to use, etc). For
2762 an example, see include/configs/sacsng.h.
c609719b 2763
04a9e118
BW
2764 CONFIG_HARD_SPI
2765
2766 Enables a hardware SPI driver for general-purpose reads
2767 and writes. As with CONFIG_SOFT_SPI, the board configuration
2768 must define a list of chip-select function pointers.
c0f40859 2769 Currently supported on some MPC8xxx processors. For an
04a9e118
BW
2770 example, see include/configs/mpc8349emds.h.
2771
38254f45
GL
2772 CONFIG_MXC_SPI
2773
2774 Enables the driver for the SPI controllers on i.MX and MXC
2e3cd1cd 2775 SoCs. Currently i.MX31/35/51 are supported.
38254f45 2776
f659b573
HS
2777 CONFIG_SYS_SPI_MXC_WAIT
2778 Timeout for waiting until spi transfer completed.
2779 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2780
0133502e 2781- FPGA Support: CONFIG_FPGA
c609719b 2782
0133502e
MF
2783 Enables FPGA subsystem.
2784
2785 CONFIG_FPGA_<vendor>
2786
2787 Enables support for specific chip vendors.
2788 (ALTERA, XILINX)
c609719b 2789
0133502e 2790 CONFIG_FPGA_<family>
c609719b 2791
0133502e
MF
2792 Enables support for FPGA family.
2793 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2794
2795 CONFIG_FPGA_COUNT
2796
2797 Specify the number of FPGA devices to support.
c609719b 2798
64e809af
SDPP
2799 CONFIG_CMD_FPGA_LOADMK
2800
2801 Enable support for fpga loadmk command
2802
67193864
MS
2803 CONFIG_CMD_FPGA_LOADP
2804
2805 Enable support for fpga loadp command - load partial bitstream
2806
2807 CONFIG_CMD_FPGA_LOADBP
2808
2809 Enable support for fpga loadbp command - load partial bitstream
2810 (Xilinx only)
2811
6d0f6bcf 2812 CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b 2813
8bde7f77 2814 Enable printing of hash marks during FPGA configuration.
c609719b 2815
6d0f6bcf 2816 CONFIG_SYS_FPGA_CHECK_BUSY
c609719b 2817
43d9616c
WD
2818 Enable checks on FPGA configuration interface busy
2819 status by the configuration function. This option
2820 will require a board or device specific function to
2821 be written.
c609719b
WD
2822
2823 CONFIG_FPGA_DELAY
2824
2825 If defined, a function that provides delays in the FPGA
2826 configuration driver.
2827
6d0f6bcf 2828 CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b
WD
2829 Allow Control-C to interrupt FPGA configuration
2830
6d0f6bcf 2831 CONFIG_SYS_FPGA_CHECK_ERROR
c609719b 2832
43d9616c
WD
2833 Check for configuration errors during FPGA bitfile
2834 loading. For example, abort during Virtex II
2835 configuration if the INIT_B line goes low (which
2836 indicated a CRC error).
c609719b 2837
6d0f6bcf 2838 CONFIG_SYS_FPGA_WAIT_INIT
c609719b 2839
43d9616c
WD
2840 Maximum time to wait for the INIT_B line to deassert
2841 after PROB_B has been deasserted during a Virtex II
2842 FPGA configuration sequence. The default time is 500
11ccc33f 2843 ms.
c609719b 2844
6d0f6bcf 2845 CONFIG_SYS_FPGA_WAIT_BUSY
c609719b 2846
43d9616c 2847 Maximum time to wait for BUSY to deassert during
11ccc33f 2848 Virtex II FPGA configuration. The default is 5 ms.
c609719b 2849
6d0f6bcf 2850 CONFIG_SYS_FPGA_WAIT_CONFIG
c609719b 2851
43d9616c 2852 Time to wait after FPGA configuration. The default is
11ccc33f 2853 200 ms.
c609719b
WD
2854
2855- Configuration Management:
b2b8a696
SR
2856 CONFIG_BUILD_TARGET
2857
2858 Some SoCs need special image types (e.g. U-Boot binary
2859 with a special header) as build targets. By defining
2860 CONFIG_BUILD_TARGET in the SoC / board header, this
2861 special image will be automatically built upon calling
2862 make / MAKEALL.
2863
c609719b
WD
2864 CONFIG_IDENT_STRING
2865
43d9616c
WD
2866 If defined, this string will be added to the U-Boot
2867 version information (U_BOOT_VERSION)
c609719b
WD
2868
2869- Vendor Parameter Protection:
2870
43d9616c
WD
2871 U-Boot considers the values of the environment
2872 variables "serial#" (Board Serial Number) and
7152b1d0 2873 "ethaddr" (Ethernet Address) to be parameters that
43d9616c
WD
2874 are set once by the board vendor / manufacturer, and
2875 protects these variables from casual modification by
2876 the user. Once set, these variables are read-only,
2877 and write or delete attempts are rejected. You can
11ccc33f 2878 change this behaviour:
c609719b
WD
2879
2880 If CONFIG_ENV_OVERWRITE is #defined in your config
2881 file, the write protection for vendor parameters is
47cd00fa 2882 completely disabled. Anybody can change or delete
c609719b
WD
2883 these parameters.
2884
2885 Alternatively, if you #define _both_ CONFIG_ETHADDR
2886 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33f 2887 Ethernet address is installed in the environment,
c609719b
WD
2888 which can be changed exactly ONCE by the user. [The
2889 serial# is unaffected by this, i. e. it remains
2890 read-only.]
2891
2598090b
JH
2892 The same can be accomplished in a more flexible way
2893 for any variable by configuring the type of access
2894 to allow for those variables in the ".flags" variable
2895 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2896
c609719b
WD
2897- Protected RAM:
2898 CONFIG_PRAM
2899
2900 Define this variable to enable the reservation of
2901 "protected RAM", i. e. RAM which is not overwritten
2902 by U-Boot. Define CONFIG_PRAM to hold the number of
2903 kB you want to reserve for pRAM. You can overwrite
2904 this default value by defining an environment
2905 variable "pram" to the number of kB you want to
2906 reserve. Note that the board info structure will
2907 still show the full amount of RAM. If pRAM is
2908 reserved, a new environment variable "mem" will
2909 automatically be defined to hold the amount of
2910 remaining RAM in a form that can be passed as boot
2911 argument to Linux, for instance like that:
2912
fe126d8b 2913 setenv bootargs ... mem=\${mem}
c609719b
WD
2914 saveenv
2915
2916 This way you can tell Linux not to use this memory,
2917 either, which results in a memory region that will
2918 not be affected by reboots.
2919
2920 *WARNING* If your board configuration uses automatic
2921 detection of the RAM size, you must make sure that
2922 this memory test is non-destructive. So far, the
2923 following board configurations are known to be
2924 "pRAM-clean":
2925
1b0757ec
WD
2926 IVMS8, IVML24, SPD8xx, TQM8xxL,
2927 HERMES, IP860, RPXlite, LWMON,
544d97e9 2928 FLAGADM, TQM8260
c609719b 2929
40fef049
GB
2930- Access to physical memory region (> 4GB)
2931 Some basic support is provided for operations on memory not
2932 normally accessible to U-Boot - e.g. some architectures
2933 support access to more than 4GB of memory on 32-bit
2934 machines using physical address extension or similar.
2935 Define CONFIG_PHYSMEM to access this basic support, which
2936 currently only supports clearing the memory.
2937
c609719b
WD
2938- Error Recovery:
2939 CONFIG_PANIC_HANG
2940
2941 Define this variable to stop the system in case of a
2942 fatal error, so that you have to reset it manually.
2943 This is probably NOT a good idea for an embedded
11ccc33f 2944 system where you want the system to reboot
c609719b
WD
2945 automatically as fast as possible, but it may be
2946 useful during development since you can try to debug
2947 the conditions that lead to the situation.
2948
2949 CONFIG_NET_RETRY_COUNT
2950
43d9616c
WD
2951 This variable defines the number of retries for
2952 network operations like ARP, RARP, TFTP, or BOOTP
2953 before giving up the operation. If not defined, a
2954 default value of 5 is used.
c609719b 2955
40cb90ee
GL
2956 CONFIG_ARP_TIMEOUT
2957
2958 Timeout waiting for an ARP reply in milliseconds.
2959
48a3e999
TK
2960 CONFIG_NFS_TIMEOUT
2961
2962 Timeout in milliseconds used in NFS protocol.
2963 If you encounter "ERROR: Cannot umount" in nfs command,
2964 try longer timeout such as
2965 #define CONFIG_NFS_TIMEOUT 10000UL
2966
c609719b 2967- Command Interpreter:
8078f1a5 2968 CONFIG_AUTO_COMPLETE
04a85b3b
WD
2969
2970 Enable auto completion of commands using TAB.
2971
6d0f6bcf 2972 CONFIG_SYS_PROMPT_HUSH_PS2
c609719b
WD
2973
2974 This defines the secondary prompt string, which is
2975 printed when the command interpreter needs more input
2976 to complete a command. Usually "> ".
2977
2978 Note:
2979
8bde7f77
WD
2980 In the current implementation, the local variables
2981 space and global environment variables space are
2982 separated. Local variables are those you define by
2983 simply typing `name=value'. To access a local
2984 variable later on, you have write `$name' or
2985 `${name}'; to execute the contents of a variable
2986 directly type `$name' at the command prompt.
c609719b 2987
43d9616c
WD
2988 Global environment variables are those you use
2989 setenv/printenv to work with. To run a command stored
2990 in such a variable, you need to use the run command,
2991 and you must not use the '$' sign to access them.
c609719b
WD
2992
2993 To store commands and special characters in a
2994 variable, please use double quotation marks
2995 surrounding the whole text of the variable, instead
2996 of the backslashes before semicolons and special
2997 symbols.
2998
aa0c71ac
WD
2999- Commandline Editing and History:
3000 CONFIG_CMDLINE_EDITING
3001
11ccc33f 3002 Enable editing and History functions for interactive
b9365a26 3003 commandline input operations
aa0c71ac 3004
a8c7c708 3005- Default Environment:
c609719b
WD
3006 CONFIG_EXTRA_ENV_SETTINGS
3007
43d9616c
WD
3008 Define this to contain any number of null terminated
3009 strings (variable = value pairs) that will be part of
7152b1d0 3010 the default environment compiled into the boot image.
2262cfee 3011
43d9616c
WD
3012 For example, place something like this in your
3013 board's config file:
c609719b
WD
3014
3015 #define CONFIG_EXTRA_ENV_SETTINGS \
3016 "myvar1=value1\0" \
3017 "myvar2=value2\0"
3018
43d9616c
WD
3019 Warning: This method is based on knowledge about the
3020 internal format how the environment is stored by the
3021 U-Boot code. This is NOT an official, exported
3022 interface! Although it is unlikely that this format
7152b1d0 3023 will change soon, there is no guarantee either.
c609719b
WD
3024 You better know what you are doing here.
3025
43d9616c
WD
3026 Note: overly (ab)use of the default environment is
3027 discouraged. Make sure to check other ways to preset
74de7aef 3028 the environment like the "source" command or the
43d9616c 3029 boot command first.
c609719b 3030
5e724ca2
SW
3031 CONFIG_ENV_VARS_UBOOT_CONFIG
3032
3033 Define this in order to add variables describing the
3034 U-Boot build configuration to the default environment.
3035 These will be named arch, cpu, board, vendor, and soc.
3036
3037 Enabling this option will cause the following to be defined:
3038
3039 - CONFIG_SYS_ARCH
3040 - CONFIG_SYS_CPU
3041 - CONFIG_SYS_BOARD
3042 - CONFIG_SYS_VENDOR
3043 - CONFIG_SYS_SOC
3044
7e27f89f
TR
3045 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3046
3047 Define this in order to add variables describing certain
3048 run-time determined information about the hardware to the
3049 environment. These will be named board_name, board_rev.
3050
06fd8538
SG
3051 CONFIG_DELAY_ENVIRONMENT
3052
3053 Normally the environment is loaded when the board is
3054 intialised so that it is available to U-Boot. This inhibits
3055 that so that the environment is not available until
3056 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3057 this is instead controlled by the value of
3058 /config/load-environment.
3059
a8c7c708 3060- DataFlash Support:
2abbe075
WD
3061 CONFIG_HAS_DATAFLASH
3062
8bde7f77
WD
3063 Defining this option enables DataFlash features and
3064 allows to read/write in Dataflash via the standard
3065 commands cp, md...
2abbe075 3066
f61ec45e
EN
3067- Serial Flash support
3068 CONFIG_CMD_SF
3069
3070 Defining this option enables SPI flash commands
3071 'sf probe/read/write/erase/update'.
3072
3073 Usage requires an initial 'probe' to define the serial
3074 flash parameters, followed by read/write/erase/update
3075 commands.
3076
3077 The following defaults may be provided by the platform
3078 to handle the common case when only a single serial
3079 flash is present on the system.
3080
3081 CONFIG_SF_DEFAULT_BUS Bus identifier
3082 CONFIG_SF_DEFAULT_CS Chip-select
3083 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3084 CONFIG_SF_DEFAULT_SPEED in Hz
3085
24007273
SG
3086 CONFIG_CMD_SF_TEST
3087
3088 Define this option to include a destructive SPI flash
3089 test ('sf test').
3090
1dcd6d03
JT
3091 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3092
3093 Define this option to use the Bank addr/Extended addr
3094 support on SPI flashes which has size > 16Mbytes.
3095
b902e07c
JT
3096 CONFIG_SF_DUAL_FLASH Dual flash memories
3097
3098 Define this option to use dual flash support where two flash
3099 memories can be connected with a given cs line.
3100 currently Xilinx Zynq qspi support these type of connections.
3101
562f8df1
HS
3102 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3103 enable the W#/Vpp signal to disable writing to the status
3104 register on ST MICRON flashes like the N25Q128.
3105 The status register write enable/disable bit, combined with
3106 the W#/VPP signal provides hardware data protection for the
3107 device as follows: When the enable/disable bit is set to 1,
3108 and the W#/VPP signal is driven LOW, the status register
3109 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3110 operation will not execute. The only way to exit this
3111 hardware-protected mode is to drive W#/VPP HIGH.
3112
3f85ce27
WD
3113- SystemACE Support:
3114 CONFIG_SYSTEMACE
3115
3116 Adding this option adds support for Xilinx SystemACE
3117 chips attached via some sort of local bus. The address
11ccc33f 3118 of the chip must also be defined in the
6d0f6bcf 3119 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
3f85ce27
WD
3120
3121 #define CONFIG_SYSTEMACE
6d0f6bcf 3122 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
3f85ce27
WD
3123
3124 When SystemACE support is added, the "ace" device type
3125 becomes available to the fat commands, i.e. fatls.
3126
ecb0ccd9
WD
3127- TFTP Fixed UDP Port:
3128 CONFIG_TFTP_PORT
3129
28cb9375 3130 If this is defined, the environment variable tftpsrcp
ecb0ccd9 3131 is used to supply the TFTP UDP source port value.
28cb9375 3132 If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9
WD
3133 number generator is used.
3134
28cb9375
WD
3135 Also, the environment variable tftpdstp is used to supply
3136 the TFTP UDP destination port value. If tftpdstp isn't
3137 defined, the normal port 69 is used.
3138
3139 The purpose for tftpsrcp is to allow a TFTP server to
ecb0ccd9
WD
3140 blindly start the TFTP transfer using the pre-configured
3141 target IP address and UDP port. This has the effect of
3142 "punching through" the (Windows XP) firewall, allowing
3143 the remainder of the TFTP transfer to proceed normally.
3144 A better solution is to properly configure the firewall,
3145 but sometimes that is not allowed.
3146
bf36c5d5
SG
3147- Hashing support:
3148 CONFIG_CMD_HASH
3149
3150 This enables a generic 'hash' command which can produce
3151 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3152
3153 CONFIG_HASH_VERIFY
3154
3155 Enable the hash verify command (hash -v). This adds to code
3156 size a little.
3157
3158 CONFIG_SHA1 - support SHA1 hashing
3159 CONFIG_SHA256 - support SHA256 hashing
3160
3161 Note: There is also a sha1sum command, which should perhaps
3162 be deprecated in favour of 'hash sha1'.
3163
a11f1873
RW
3164- Freescale i.MX specific commands:
3165 CONFIG_CMD_HDMIDETECT
3166 This enables 'hdmidet' command which returns true if an
3167 HDMI monitor is detected. This command is i.MX 6 specific.
3168
3169 CONFIG_CMD_BMODE
3170 This enables the 'bmode' (bootmode) command for forcing
3171 a boot from specific media.
3172
3173 This is useful for forcing the ROM's usb downloader to
3174 activate upon a watchdog reset which is nice when iterating
3175 on U-Boot. Using the reset button or running bmode normal
3176 will set it back to normal. This command currently
3177 supports i.MX53 and i.MX6.
3178
19c402af
SG
3179- Signing support:
3180 CONFIG_RSA
3181
3182 This enables the RSA algorithm used for FIT image verification
8bf2aad7 3183 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
19c402af
SG
3184
3185 The signing part is build into mkimage regardless of this
3186 option.
3187
9e50c406
HS
3188- bootcount support:
3189 CONFIG_BOOTCOUNT_LIMIT
3190
3191 This enables the bootcounter support, see:
3192 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3193
3194 CONFIG_AT91SAM9XE
3195 enable special bootcounter support on at91sam9xe based boards.
3196 CONFIG_BLACKFIN
3197 enable special bootcounter support on blackfin based boards.
3198 CONFIG_SOC_DA8XX
3199 enable special bootcounter support on da850 based boards.
3200 CONFIG_BOOTCOUNT_RAM
3201 enable support for the bootcounter in RAM
3202 CONFIG_BOOTCOUNT_I2C
3203 enable support for the bootcounter on an i2c (like RTC) device.
3204 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3205 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3206 the bootcounter.
3207 CONFIG_BOOTCOUNT_ALEN = address len
19c402af 3208
a8c7c708 3209- Show boot progress:
c609719b
WD
3210 CONFIG_SHOW_BOOT_PROGRESS
3211
43d9616c
WD
3212 Defining this option allows to add some board-
3213 specific code (calling a user-provided function
3214 "show_boot_progress(int)") that enables you to show
3215 the system's boot progress on some display (for
3216 example, some LED's) on your board. At the moment,
3217 the following checkpoints are implemented:
c609719b 3218
3a608ca0
SG
3219- Detailed boot stage timing
3220 CONFIG_BOOTSTAGE
3221 Define this option to get detailed timing of each stage
3222 of the boot process.
3223
3224 CONFIG_BOOTSTAGE_USER_COUNT
3225 This is the number of available user bootstage records.
3226 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
3227 a new ID will be allocated from this stash. If you exceed
3228 the limit, recording will stop.
3229
3230 CONFIG_BOOTSTAGE_REPORT
3231 Define this to print a report before boot, similar to this:
3232
3233 Timer summary in microseconds:
3234 Mark Elapsed Stage
3235 0 0 reset
3236 3,575,678 3,575,678 board_init_f start
3237 3,575,695 17 arch_cpu_init A9
3238 3,575,777 82 arch_cpu_init done
3239 3,659,598 83,821 board_init_r start
3240 3,910,375 250,777 main_loop
3241 29,916,167 26,005,792 bootm_start
3242 30,361,327 445,160 start_kernel
3243
2eba38cf
SG
3244 CONFIG_CMD_BOOTSTAGE
3245 Add a 'bootstage' command which supports printing a report
3246 and un/stashing of bootstage data.
3247
94fd1316
SG
3248 CONFIG_BOOTSTAGE_FDT
3249 Stash the bootstage information in the FDT. A root 'bootstage'
3250 node is created with each bootstage id as a child. Each child
3251 has a 'name' property and either 'mark' containing the
3252 mark time in microsecond, or 'accum' containing the
3253 accumulated time for that bootstage id in microseconds.
3254 For example:
3255
3256 bootstage {
3257 154 {
3258 name = "board_init_f";
3259 mark = <3575678>;
3260 };
3261 170 {
3262 name = "lcd";
3263 accum = <33482>;
3264 };
3265 };
3266
3267 Code in the Linux kernel can find this in /proc/devicetree.
3268
1372cce2
MB
3269Legacy uImage format:
3270
c609719b
WD
3271 Arg Where When
3272 1 common/cmd_bootm.c before attempting to boot an image
ba56f625 3273 -1 common/cmd_bootm.c Image header has bad magic number
c609719b 3274 2 common/cmd_bootm.c Image header has correct magic number
ba56f625 3275 -2 common/cmd_bootm.c Image header has bad checksum
c609719b 3276 3 common/cmd_bootm.c Image header has correct checksum
ba56f625 3277 -3 common/cmd_bootm.c Image data has bad checksum
c609719b
WD
3278 4 common/cmd_bootm.c Image data has correct checksum
3279 -4 common/cmd_bootm.c Image is for unsupported architecture
3280 5 common/cmd_bootm.c Architecture check OK
1372cce2 3281 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
c609719b
WD
3282 6 common/cmd_bootm.c Image Type check OK
3283 -6 common/cmd_bootm.c gunzip uncompression error
3284 -7 common/cmd_bootm.c Unimplemented compression type
3285 7 common/cmd_bootm.c Uncompression OK
1372cce2 3286 8 common/cmd_bootm.c No uncompress/copy overwrite error
c609719b 3287 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2
MB
3288
3289 9 common/image.c Start initial ramdisk verification
3290 -10 common/image.c Ramdisk header has bad magic number
3291 -11 common/image.c Ramdisk header has bad checksum
3292 10 common/image.c Ramdisk header is OK
3293 -12 common/image.c Ramdisk data has bad checksum
3294 11 common/image.c Ramdisk data has correct checksum
3295 12 common/image.c Ramdisk verification complete, start loading
11ccc33f 3296 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1372cce2
MB
3297 13 common/image.c Start multifile image verification
3298 14 common/image.c No initial ramdisk, no multifile, continue.
3299
c0f40859 3300 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
c609719b 3301
a47a12be 3302 -30 arch/powerpc/lib/board.c Fatal error, hang the system
11dadd54
WD
3303 -31 post/post.c POST test failed, detected by post_output_backlog()
3304 -32 post/post.c POST test failed, detected by post_run_single()
63e73c9a 3305
566a494f
HS
3306 34 common/cmd_doc.c before loading a Image from a DOC device
3307 -35 common/cmd_doc.c Bad usage of "doc" command
3308 35 common/cmd_doc.c correct usage of "doc" command
3309 -36 common/cmd_doc.c No boot device
3310 36 common/cmd_doc.c correct boot device
3311 -37 common/cmd_doc.c Unknown Chip ID on boot device
3312 37 common/cmd_doc.c correct chip ID found, device available
3313 -38 common/cmd_doc.c Read Error on boot device
3314 38 common/cmd_doc.c reading Image header from DOC device OK
3315 -39 common/cmd_doc.c Image header has bad magic number
3316 39 common/cmd_doc.c Image header has correct magic number
3317 -40 common/cmd_doc.c Error reading Image from DOC device
3318 40 common/cmd_doc.c Image header has correct magic number
3319 41 common/cmd_ide.c before loading a Image from a IDE device
3320 -42 common/cmd_ide.c Bad usage of "ide" command
3321 42 common/cmd_ide.c correct usage of "ide" command
3322 -43 common/cmd_ide.c No boot device
3323 43 common/cmd_ide.c boot device found
3324 -44 common/cmd_ide.c Device not available
3325 44 common/cmd_ide.c Device available
3326 -45 common/cmd_ide.c wrong partition selected
3327 45 common/cmd_ide.c partition selected
3328 -46 common/cmd_ide.c Unknown partition table
3329 46 common/cmd_ide.c valid partition table found
3330 -47 common/cmd_ide.c Invalid partition type
3331 47 common/cmd_ide.c correct partition type
3332 -48 common/cmd_ide.c Error reading Image Header on boot device
3333 48 common/cmd_ide.c reading Image Header from IDE device OK
3334 -49 common/cmd_ide.c Image header has bad magic number
3335 49 common/cmd_ide.c Image header has correct magic number
3336 -50 common/cmd_ide.c Image header has bad checksum
3337 50 common/cmd_ide.c Image header has correct checksum
3338 -51 common/cmd_ide.c Error reading Image from IDE device
3339 51 common/cmd_ide.c reading Image from IDE device OK
3340 52 common/cmd_nand.c before loading a Image from a NAND device
3341 -53 common/cmd_nand.c Bad usage of "nand" command
3342 53 common/cmd_nand.c correct usage of "nand" command
3343 -54 common/cmd_nand.c No boot device
3344 54 common/cmd_nand.c boot device found
3345 -55 common/cmd_nand.c Unknown Chip ID on boot device
3346 55 common/cmd_nand.c correct chip ID found, device available
3347 -56 common/cmd_nand.c Error reading Image Header on boot device
3348 56 common/cmd_nand.c reading Image Header from NAND device OK
3349 -57 common/cmd_nand.c Image header has bad magic number
3350 57 common/cmd_nand.c Image header has correct magic number
3351 -58 common/cmd_nand.c Error reading Image from NAND device
3352 58 common/cmd_nand.c reading Image from NAND device OK
3353
3354 -60 common/env_common.c Environment has a bad CRC, using default
3355
11ccc33f 3356 64 net/eth.c starting with Ethernet configuration.
566a494f
HS
3357 -64 net/eth.c no Ethernet found.
3358 65 net/eth.c Ethernet found.
3359
3360 -80 common/cmd_net.c usage wrong
3361 80 common/cmd_net.c before calling NetLoop()
11ccc33f 3362 -81 common/cmd_net.c some error in NetLoop() occurred
566a494f
HS
3363 81 common/cmd_net.c NetLoop() back without error
3364 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3365 82 common/cmd_net.c trying automatic boot
74de7aef
WD
3366 83 common/cmd_net.c running "source" command
3367 -83 common/cmd_net.c some error in automatic boot or "source" command
566a494f 3368 84 common/cmd_net.c end without errors
c609719b 3369
1372cce2
MB
3370FIT uImage format:
3371
3372 Arg Where When
3373 100 common/cmd_bootm.c Kernel FIT Image has correct format
3374 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3375 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3376 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3377 102 common/cmd_bootm.c Kernel unit name specified
3378 -103 common/cmd_bootm.c Can't get kernel subimage node offset
f773bea8 3379 103 common/cmd_bootm.c Found configuration node
1372cce2
MB
3380 104 common/cmd_bootm.c Got kernel subimage node offset
3381 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3382 105 common/cmd_bootm.c Kernel subimage hash verification OK
3383 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3384 106 common/cmd_bootm.c Architecture check OK
11ccc33f
MZ
3385 -106 common/cmd_bootm.c Kernel subimage has wrong type
3386 107 common/cmd_bootm.c Kernel subimage type OK
1372cce2
MB
3387 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3388 108 common/cmd_bootm.c Got kernel subimage data/size
3389 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3390 -109 common/cmd_bootm.c Can't get kernel subimage type
3391 -110 common/cmd_bootm.c Can't get kernel subimage comp
3392 -111 common/cmd_bootm.c Can't get kernel subimage os
3393 -112 common/cmd_bootm.c Can't get kernel subimage load address
3394 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3395
3396 120 common/image.c Start initial ramdisk verification
3397 -120 common/image.c Ramdisk FIT image has incorrect format
3398 121 common/image.c Ramdisk FIT image has correct format
11ccc33f 3399 122 common/image.c No ramdisk subimage unit name, using configuration
1372cce2
MB
3400 -122 common/image.c Can't get configuration for ramdisk subimage
3401 123 common/image.c Ramdisk unit name specified
3402 -124 common/image.c Can't get ramdisk subimage node offset
3403 125 common/image.c Got ramdisk subimage node offset
3404 -125 common/image.c Ramdisk subimage hash verification failed
3405 126 common/image.c Ramdisk subimage hash verification OK
3406 -126 common/image.c Ramdisk subimage for unsupported architecture
3407 127 common/image.c Architecture check OK
3408 -127 common/image.c Can't get ramdisk subimage data/size
3409 128 common/image.c Got ramdisk subimage data/size
3410 129 common/image.c Can't get ramdisk load address
3411 -129 common/image.c Got ramdisk load address
3412
11ccc33f 3413 -130 common/cmd_doc.c Incorrect FIT image format
1372cce2
MB
3414 131 common/cmd_doc.c FIT image format OK
3415
11ccc33f 3416 -140 common/cmd_ide.c Incorrect FIT image format
1372cce2
MB
3417 141 common/cmd_ide.c FIT image format OK
3418
11ccc33f 3419 -150 common/cmd_nand.c Incorrect FIT image format
1372cce2
MB
3420 151 common/cmd_nand.c FIT image format OK
3421
21d29f7f
HS
3422- legacy image format:
3423 CONFIG_IMAGE_FORMAT_LEGACY
3424 enables the legacy image format support in U-Boot.
3425
3426 Default:
3427 enabled if CONFIG_FIT_SIGNATURE is not defined.
3428
3429 CONFIG_DISABLE_IMAGE_LEGACY
3430 disable the legacy image format
3431
3432 This define is introduced, as the legacy image format is
3433 enabled per default for backward compatibility.
3434
d95f6ec7
GB
3435- FIT image support:
3436 CONFIG_FIT
3437 Enable support for the FIT uImage format.
3438
3439 CONFIG_FIT_BEST_MATCH
3440 When no configuration is explicitly selected, default to the
3441 one whose fdt's compatibility field best matches that of
3442 U-Boot itself. A match is considered "best" if it matches the
3443 most specific compatibility entry of U-Boot's fdt's root node.
3444 The order of entries in the configuration's fdt is ignored.
3445
3e569a6b
SG
3446 CONFIG_FIT_SIGNATURE
3447 This option enables signature verification of FIT uImages,
3448 using a hash signed and verified using RSA. See
3449 doc/uImage.FIT/signature.txt for more details.
3450
21d29f7f
HS
3451 WARNING: When relying on signed FIT images with required
3452 signature check the legacy image format is default
3453 disabled. If a board need legacy image format support
3454 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3455
9a4f479b
DE
3456 CONFIG_FIT_DISABLE_SHA256
3457 Supporting SHA256 hashes has quite an impact on binary size.
3458 For constrained systems sha256 hash support can be disabled
3459 with this option.
3460
4cf2609b
WD
3461- Standalone program support:
3462 CONFIG_STANDALONE_LOAD_ADDR
3463
6feff899
WD
3464 This option defines a board specific value for the
3465 address where standalone program gets loaded, thus
3466 overwriting the architecture dependent default
4cf2609b
WD
3467 settings.
3468
3469- Frame Buffer Address:
3470 CONFIG_FB_ADDR
3471
3472 Define CONFIG_FB_ADDR if you want to use specific
44a53b57
WD
3473 address for frame buffer. This is typically the case
3474 when using a graphics controller has separate video
3475 memory. U-Boot will then place the frame buffer at
3476 the given address instead of dynamically reserving it
3477 in system RAM by calling lcd_setmem(), which grabs
3478 the memory for the frame buffer depending on the
3479 configured panel size.
4cf2609b
WD
3480
3481 Please see board_init_f function.
3482
cccfc2ab
DZ
3483- Automatic software updates via TFTP server
3484 CONFIG_UPDATE_TFTP
3485 CONFIG_UPDATE_TFTP_CNT_MAX
3486 CONFIG_UPDATE_TFTP_MSEC_MAX
3487
3488 These options enable and control the auto-update feature;
3489 for a more detailed description refer to doc/README.update.
3490
3491- MTD Support (mtdparts command, UBI support)
3492 CONFIG_MTD_DEVICE
3493
3494 Adds the MTD device infrastructure from the Linux kernel.
3495 Needed for mtdparts command support.
3496
3497 CONFIG_MTD_PARTITIONS
3498
3499 Adds the MTD partitioning infrastructure from the Linux
3500 kernel. Needed for UBI support.
3501
ff94bc40
HS
3502 CONFIG_MTD_NAND_VERIFY_WRITE
3503 verify if the written data is correct reread.
3504
70c219cd
JH
3505- UBI support
3506 CONFIG_CMD_UBI
3507
3508 Adds commands for interacting with MTD partitions formatted
3509 with the UBI flash translation layer
3510
3511 Requires also defining CONFIG_RBTREE
3512
147162da
JH
3513 CONFIG_UBI_SILENCE_MSG
3514
3515 Make the verbose messages from UBI stop printing. This leaves
3516 warnings and errors enabled.
3517
ff94bc40
HS
3518
3519 CONFIG_MTD_UBI_WL_THRESHOLD
3520 This parameter defines the maximum difference between the highest
3521 erase counter value and the lowest erase counter value of eraseblocks
3522 of UBI devices. When this threshold is exceeded, UBI starts performing
3523 wear leveling by means of moving data from eraseblock with low erase
3524 counter to eraseblocks with high erase counter.
3525
3526 The default value should be OK for SLC NAND flashes, NOR flashes and
3527 other flashes which have eraseblock life-cycle 100000 or more.
3528 However, in case of MLC NAND flashes which typically have eraseblock
3529 life-cycle less than 10000, the threshold should be lessened (e.g.,
3530 to 128 or 256, although it does not have to be power of 2).
3531
3532 default: 4096
c654b517 3533
ff94bc40
HS
3534 CONFIG_MTD_UBI_BEB_LIMIT
3535 This option specifies the maximum bad physical eraseblocks UBI
3536 expects on the MTD device (per 1024 eraseblocks). If the
3537 underlying flash does not admit of bad eraseblocks (e.g. NOR
3538 flash), this value is ignored.
3539
3540 NAND datasheets often specify the minimum and maximum NVM
3541 (Number of Valid Blocks) for the flashes' endurance lifetime.
3542 The maximum expected bad eraseblocks per 1024 eraseblocks
3543 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3544 which gives 20 for most NANDs (MaxNVB is basically the total
3545 count of eraseblocks on the chip).
3546
3547 To put it differently, if this value is 20, UBI will try to
3548 reserve about 1.9% of physical eraseblocks for bad blocks
3549 handling. And that will be 1.9% of eraseblocks on the entire
3550 NAND chip, not just the MTD partition UBI attaches. This means
3551 that if you have, say, a NAND flash chip admits maximum 40 bad
3552 eraseblocks, and it is split on two MTD partitions of the same
3553 size, UBI will reserve 40 eraseblocks when attaching a
3554 partition.
3555
3556 default: 20
3557
3558 CONFIG_MTD_UBI_FASTMAP
3559 Fastmap is a mechanism which allows attaching an UBI device
3560 in nearly constant time. Instead of scanning the whole MTD device it
3561 only has to locate a checkpoint (called fastmap) on the device.
3562 The on-flash fastmap contains all information needed to attach
3563 the device. Using fastmap makes only sense on large devices where
3564 attaching by scanning takes long. UBI will not automatically install
3565 a fastmap on old images, but you can set the UBI parameter
3566 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3567 that fastmap-enabled images are still usable with UBI implementations
3568 without fastmap support. On typical flash devices the whole fastmap
3569 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3570
3571 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3572 Set this parameter to enable fastmap automatically on images
3573 without a fastmap.
3574 default: 0
3575
70c219cd
JH
3576- UBIFS support
3577 CONFIG_CMD_UBIFS
3578
3579 Adds commands for interacting with UBI volumes formatted as
3580 UBIFS. UBIFS is read-only in u-boot.
3581
3582 Requires UBI support as well as CONFIG_LZO
3583
147162da
JH
3584 CONFIG_UBIFS_SILENCE_MSG
3585
3586 Make the verbose messages from UBIFS stop printing. This leaves
3587 warnings and errors enabled.
3588
6a11cf48 3589- SPL framework
04e5ae79
WD
3590 CONFIG_SPL
3591 Enable building of SPL globally.
6a11cf48 3592
95579793
TR
3593 CONFIG_SPL_LDSCRIPT
3594 LDSCRIPT for linking the SPL binary.
3595
6ebc3461
AA
3596 CONFIG_SPL_MAX_FOOTPRINT
3597 Maximum size in memory allocated to the SPL, BSS included.
3598 When defined, the linker checks that the actual memory
3599 used by SPL from _start to __bss_end does not exceed it.
8960af8b 3600 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc3461
AA
3601 must not be both defined at the same time.
3602
95579793 3603 CONFIG_SPL_MAX_SIZE
6ebc3461
AA
3604 Maximum size of the SPL image (text, data, rodata, and
3605 linker lists sections), BSS excluded.
3606 When defined, the linker checks that the actual size does
3607 not exceed it.
95579793 3608
04e5ae79
WD
3609 CONFIG_SPL_TEXT_BASE
3610 TEXT_BASE for linking the SPL binary.
6a11cf48 3611
94a45bb1
SW
3612 CONFIG_SPL_RELOC_TEXT_BASE
3613 Address to relocate to. If unspecified, this is equal to
3614 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3615
95579793
TR
3616 CONFIG_SPL_BSS_START_ADDR
3617 Link address for the BSS within the SPL binary.
3618
3619 CONFIG_SPL_BSS_MAX_SIZE
6ebc3461
AA
3620 Maximum size in memory allocated to the SPL BSS.
3621 When defined, the linker checks that the actual memory used
3622 by SPL from __bss_start to __bss_end does not exceed it.
8960af8b 3623 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc3461 3624 must not be both defined at the same time.
95579793
TR
3625
3626 CONFIG_SPL_STACK
3627 Adress of the start of the stack SPL will use
3628
94a45bb1
SW
3629 CONFIG_SPL_RELOC_STACK
3630 Adress of the start of the stack SPL will use after
3631 relocation. If unspecified, this is equal to
3632 CONFIG_SPL_STACK.
3633
95579793
TR
3634 CONFIG_SYS_SPL_MALLOC_START
3635 Starting address of the malloc pool used in SPL.
3636
3637 CONFIG_SYS_SPL_MALLOC_SIZE
3638 The size of the malloc pool used in SPL.
6a11cf48 3639
47f7bcae
TR
3640 CONFIG_SPL_FRAMEWORK
3641 Enable the SPL framework under common/. This framework
3642 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3643 NAND loading of the Linux Kernel.
3644
9607faf2
TR
3645 CONFIG_SPL_OS_BOOT
3646 Enable booting directly to an OS from SPL.
3647 See also: doc/README.falcon
3648
861a86f4
TR
3649 CONFIG_SPL_DISPLAY_PRINT
3650 For ARM, enable an optional function to print more information
3651 about the running system.
3652
4b919725
SW
3653 CONFIG_SPL_INIT_MINIMAL
3654 Arch init code should be built for a very small image
3655
04e5ae79
WD
3656 CONFIG_SPL_LIBCOMMON_SUPPORT
3657 Support for common/libcommon.o in SPL binary
6a11cf48 3658
04e5ae79
WD
3659 CONFIG_SPL_LIBDISK_SUPPORT
3660 Support for disk/libdisk.o in SPL binary
6a11cf48 3661
04e5ae79
WD
3662 CONFIG_SPL_I2C_SUPPORT
3663 Support for drivers/i2c/libi2c.o in SPL binary
6a11cf48 3664
04e5ae79
WD
3665 CONFIG_SPL_GPIO_SUPPORT
3666 Support for drivers/gpio/libgpio.o in SPL binary
6a11cf48 3667
04e5ae79
WD
3668 CONFIG_SPL_MMC_SUPPORT
3669 Support for drivers/mmc/libmmc.o in SPL binary
6a11cf48 3670
95579793
TR
3671 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3672 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
e2ccdf89 3673 Address and partition on the MMC to load U-Boot from
95579793
TR
3674 when the MMC is being used in raw mode.
3675
b97300b6
PK
3676 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3677 Partition on the MMC to load U-Boot from when the MMC is being
3678 used in raw mode
3679
2b75b0ad
PK
3680 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3681 Sector to load kernel uImage from when MMC is being
3682 used in raw mode (for Falcon mode)
3683
3684 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3685 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3686 Sector and number of sectors to load kernel argument
3687 parameters from when MMC is being used in raw mode
3688 (for falcon mode)
3689
e2ccdf89
PK
3690 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3691 Partition on the MMC to load U-Boot from when the MMC is being
3692 used in fs mode
3693
95579793
TR
3694 CONFIG_SPL_FAT_SUPPORT
3695 Support for fs/fat/libfat.o in SPL binary
3696
fae81c72
GG
3697 CONFIG_SPL_EXT_SUPPORT
3698 Support for EXT filesystem in SPL binary
95579793 3699
fae81c72
GG
3700 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3701 Filename to read to load U-Boot when reading from filesystem
3702
3703 CONFIG_SPL_FS_LOAD_KERNEL_NAME
7ad2cc79 3704 Filename to read to load kernel uImage when reading
fae81c72 3705 from filesystem (for Falcon mode)
7ad2cc79 3706
fae81c72 3707 CONFIG_SPL_FS_LOAD_ARGS_NAME
7ad2cc79 3708 Filename to read to load kernel argument parameters
fae81c72 3709 when reading from filesystem (for Falcon mode)
7ad2cc79 3710
06f60ae3
SW
3711 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3712 Set this for NAND SPL on PPC mpc83xx targets, so that
3713 start.S waits for the rest of the SPL to load before
3714 continuing (the hardware starts execution after just
3715 loading the first page rather than the full 4K).
3716
651fcf60
PK
3717 CONFIG_SPL_SKIP_RELOCATE
3718 Avoid SPL relocation
3719
6f2f01b9
SW
3720 CONFIG_SPL_NAND_BASE
3721 Include nand_base.c in the SPL. Requires
3722 CONFIG_SPL_NAND_DRIVERS.
3723
3724 CONFIG_SPL_NAND_DRIVERS
3725 SPL uses normal NAND drivers, not minimal drivers.
3726
3727 CONFIG_SPL_NAND_ECC
3728 Include standard software ECC in the SPL
3729
95579793 3730 CONFIG_SPL_NAND_SIMPLE
7d4b7955
SW
3731 Support for NAND boot using simple NAND drivers that
3732 expose the cmd_ctrl() interface.
95579793 3733
6dd3b566
TR
3734 CONFIG_SPL_MTD_SUPPORT
3735 Support for the MTD subsystem within SPL. Useful for
3736 environment on NAND support within SPL.
3737
0c3117b1
HS
3738 CONFIG_SPL_NAND_RAW_ONLY
3739 Support to boot only raw u-boot.bin images. Use this only
3740 if you need to save space.
3741
bb0dc108
YZ
3742 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3743 Set for the SPL on PPC mpc8xxx targets, support for
5614e71b 3744 drivers/ddr/fsl/libddr.o in SPL binary.
bb0dc108 3745
7c8eea59
YZ
3746 CONFIG_SPL_COMMON_INIT_DDR
3747 Set for common ddr init with serial presence detect in
3748 SPL binary.
3749
95579793
TR
3750 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3751 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3752 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3753 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3754 CONFIG_SYS_NAND_ECCBYTES
3755 Defines the size and behavior of the NAND that SPL uses
7d4b7955 3756 to read U-Boot
95579793 3757
fbe76ae4
PK
3758 CONFIG_SPL_NAND_BOOT
3759 Add support NAND boot
3760
95579793 3761 CONFIG_SYS_NAND_U_BOOT_OFFS
7d4b7955
SW
3762 Location in NAND to read U-Boot from
3763
3764 CONFIG_SYS_NAND_U_BOOT_DST
3765 Location in memory to load U-Boot to
3766
3767 CONFIG_SYS_NAND_U_BOOT_SIZE
3768 Size of image to load
95579793
TR
3769
3770 CONFIG_SYS_NAND_U_BOOT_START
7d4b7955 3771 Entry point in loaded image to jump to
95579793
TR
3772
3773 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3774 Define this if you need to first read the OOB and then the
3775 data. This is used for example on davinci plattforms.
3776
3777 CONFIG_SPL_OMAP3_ID_NAND
3778 Support for an OMAP3-specific set of functions to return the
3779 ID and MFR of the first attached NAND chip, if present.
3780
04e5ae79
WD
3781 CONFIG_SPL_SERIAL_SUPPORT
3782 Support for drivers/serial/libserial.o in SPL binary
6a11cf48 3783
04e5ae79
WD
3784 CONFIG_SPL_SPI_FLASH_SUPPORT
3785 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
6a11cf48 3786
04e5ae79
WD
3787 CONFIG_SPL_SPI_SUPPORT
3788 Support for drivers/spi/libspi.o in SPL binary
c57b953d
PM
3789
3790 CONFIG_SPL_RAM_DEVICE
3791 Support for running image already present in ram, in SPL binary
6a11cf48 3792
04e5ae79
WD
3793 CONFIG_SPL_LIBGENERIC_SUPPORT
3794 Support for lib/libgeneric.o in SPL binary
1372cce2 3795
ba1bee43
YZ
3796 CONFIG_SPL_ENV_SUPPORT
3797 Support for the environment operating in SPL binary
3798
3799 CONFIG_SPL_NET_SUPPORT
3800 Support for the net/libnet.o in SPL binary.
3801 It conflicts with SPL env from storage medium specified by
3802 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3803
74752baa 3804 CONFIG_SPL_PAD_TO
6113d3f2
BT
3805 Image offset to which the SPL should be padded before appending
3806 the SPL payload. By default, this is defined as
3807 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3808 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3809 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
74752baa 3810
ca2fca22
SW
3811 CONFIG_SPL_TARGET
3812 Final target image containing SPL and payload. Some SPLs
3813 use an arch-specific makefile fragment instead, for
3814 example if more than one image needs to be produced.
3815
87ebee39
SG
3816 CONFIG_FIT_SPL_PRINT
3817 Printing information about a FIT image adds quite a bit of
3818 code to SPL. So this is normally disabled in SPL. Use this
3819 option to re-enable it. This will affect the output of the
3820 bootm command when booting a FIT image.
3821
3aa29de0
YZ
3822- TPL framework
3823 CONFIG_TPL
3824 Enable building of TPL globally.
3825
3826 CONFIG_TPL_PAD_TO
3827 Image offset to which the TPL should be padded before appending
3828 the TPL payload. By default, this is defined as
93e14596
WD
3829 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3830 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3831 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3aa29de0 3832
c609719b
WD
3833Modem Support:
3834--------------
3835
566e5cf4 3836[so far only for SMDK2400 boards]
c609719b 3837
11ccc33f 3838- Modem support enable:
c609719b
WD
3839 CONFIG_MODEM_SUPPORT
3840
3841- RTS/CTS Flow control enable:
3842 CONFIG_HWFLOW
3843
3844- Modem debug support:
3845 CONFIG_MODEM_SUPPORT_DEBUG
3846
43d9616c
WD
3847 Enables debugging stuff (char screen[1024], dbg())
3848 for modem support. Useful only with BDI2000.
c609719b 3849
a8c7c708
WD
3850- Interrupt support (PPC):
3851
d4ca31c4
WD
3852 There are common interrupt_init() and timer_interrupt()
3853 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33f 3854 for CPU specific initialization. interrupt_init_cpu()
d4ca31c4 3855 should set decrementer_count to appropriate value. If
11ccc33f 3856 CPU resets decrementer automatically after interrupt
d4ca31c4 3857 (ppc4xx) it should set decrementer_count to zero.
11ccc33f 3858 timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c4
WD
3859 specific handling. If board has watchdog / status_led
3860 / other_activity_monitor it works automatically from
3861 general timer_interrupt().
a8c7c708 3862
c609719b
WD
3863- General:
3864
43d9616c
WD
3865 In the target system modem support is enabled when a
3866 specific key (key combination) is pressed during
3867 power-on. Otherwise U-Boot will boot normally
11ccc33f 3868 (autoboot). The key_pressed() function is called from
43d9616c
WD
3869 board_init(). Currently key_pressed() is a dummy
3870 function, returning 1 and thus enabling modem
3871 initialization.
c609719b 3872
43d9616c
WD
3873 If there are no modem init strings in the
3874 environment, U-Boot proceed to autoboot; the
3875 previous output (banner, info printfs) will be
11ccc33f 3876 suppressed, though.
c609719b
WD
3877
3878 See also: doc/README.Modem
3879
9660e442
HR
3880Board initialization settings:
3881------------------------------
3882
3883During Initialization u-boot calls a number of board specific functions
3884to allow the preparation of board specific prerequisites, e.g. pin setup
3885before drivers are initialized. To enable these callbacks the
3886following configuration macros have to be defined. Currently this is
3887architecture specific, so please check arch/your_architecture/lib/board.c
3888typically in board_init_f() and board_init_r().
3889
3890- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3891- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3892- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3893- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
c609719b 3894
c609719b
WD
3895Configuration Settings:
3896-----------------------
3897
4d1fd7f1
YS
3898- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3899 Optionally it can be defined to support 64-bit memory commands.
3900
6d0f6bcf 3901- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b
WD
3902 undefine this when you're short of memory.
3903
2fb2604d
PT
3904- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3905 width of the commands listed in the 'help' command output.
3906
6d0f6bcf 3907- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
c609719b
WD
3908 prompt for user input.
3909
6d0f6bcf 3910- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
c609719b 3911
6d0f6bcf 3912- CONFIG_SYS_PBSIZE: Buffer size for Console output
c609719b 3913
6d0f6bcf 3914- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
c609719b 3915
6d0f6bcf 3916- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b
WD
3917 the application (usually a Linux kernel) when it is
3918 booted
3919
6d0f6bcf 3920- CONFIG_SYS_BAUDRATE_TABLE:
c609719b
WD
3921 List of legal baudrate settings for this board.
3922
6d0f6bcf 3923- CONFIG_SYS_CONSOLE_INFO_QUIET
8bde7f77 3924 Suppress display of console information at boot.
c609719b 3925
6d0f6bcf 3926- CONFIG_SYS_CONSOLE_IS_IN_ENV
8bde7f77
WD
3927 If the board specific function
3928 extern int overwrite_console (void);
3929 returns 1, the stdin, stderr and stdout are switched to the
c609719b
WD
3930 serial port, else the settings in the environment are used.
3931
6d0f6bcf 3932- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
8bde7f77 3933 Enable the call to overwrite_console().
c609719b 3934
6d0f6bcf 3935- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
c609719b
WD
3936 Enable overwrite of previous console environment settings.
3937
6d0f6bcf 3938- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b
WD
3939 Begin and End addresses of the area used by the
3940 simple memory test.
3941
6d0f6bcf 3942- CONFIG_SYS_ALT_MEMTEST:
8bde7f77 3943 Enable an alternate, more extensive memory test.
c609719b 3944
6d0f6bcf 3945- CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe1
WD
3946 Scratch address used by the alternate memory test
3947 You only need to set this if address zero isn't writeable
3948
6d0f6bcf
JCPV
3949- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3950 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
14f73ca6 3951 this specified memory area will get subtracted from the top
11ccc33f 3952 (end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca6
SR
3953 fixing up gd->ram_size the Linux kernel should gets passed
3954 the now "corrected" memory size and won't touch it either.
3955 This should work for arch/ppc and arch/powerpc. Only Linux
5e12e75d 3956 board ports in arch/powerpc with bootwrapper support that
14f73ca6 3957 recalculate the memory size from the SDRAM controller setup
5e12e75d 3958 will have to get fixed in Linux additionally.
14f73ca6
SR
3959
3960 This option can be used as a workaround for the 440EPx/GRx
3961 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3962 be touched.
3963
3964 WARNING: Please make sure that this value is a multiple of
3965 the Linux page size (normally 4k). If this is not the case,
3966 then the end address of the Linux memory will be located at a
3967 non page size aligned address and this could cause major
3968 problems.
3969
6d0f6bcf 3970- CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b
WD
3971 Enable temporary baudrate change while serial download
3972
6d0f6bcf 3973- CONFIG_SYS_SDRAM_BASE:
c609719b
WD
3974 Physical start address of SDRAM. _Must_ be 0 here.
3975
6d0f6bcf 3976- CONFIG_SYS_MBIO_BASE:
c609719b
WD
3977 Physical start address of Motherboard I/O (if using a
3978 Cogent motherboard)
3979
6d0f6bcf 3980- CONFIG_SYS_FLASH_BASE:
c609719b
WD
3981 Physical start address of Flash memory.
3982
6d0f6bcf 3983- CONFIG_SYS_MONITOR_BASE:
c609719b
WD
3984 Physical start address of boot monitor code (set by
3985 make config files to be same as the text base address
14d0a02a 3986 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
6d0f6bcf 3987 CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b 3988
6d0f6bcf 3989- CONFIG_SYS_MONITOR_LEN:
8bde7f77
WD
3990 Size of memory reserved for monitor code, used to
3991 determine _at_compile_time_ (!) if the environment is
3992 embedded within the U-Boot image, or in a separate
3993 flash sector.
c609719b 3994
6d0f6bcf 3995- CONFIG_SYS_MALLOC_LEN:
c609719b
WD
3996 Size of DRAM reserved for malloc() use.
3997
d59476b6
SG
3998- CONFIG_SYS_MALLOC_F_LEN
3999 Size of the malloc() pool for use before relocation. If
4000 this is defined, then a very simple malloc() implementation
4001 will become available before relocation. The address is just
4002 below the global data, and the stack is moved down to make
4003 space.
4004
4005 This feature allocates regions with increasing addresses
4006 within the region. calloc() is supported, but realloc()
4007 is not available. free() is supported but does nothing.
4008 The memory will be freed (or in fact just forgotton) when
4009 U-Boot relocates itself.
4010
e7b14e9a 4011 Pre-relocation malloc() is only supported on ARM and sandbox
29afe9e6
SG
4012 at present but is fairly easy to enable for other archs.
4013
38687ae6
SG
4014- CONFIG_SYS_MALLOC_SIMPLE
4015 Provides a simple and small malloc() and calloc() for those
4016 boards which do not use the full malloc in SPL (which is
4017 enabled with CONFIG_SYS_SPL_MALLOC_START).
4018
6d0f6bcf 4019- CONFIG_SYS_BOOTM_LEN:
15940c9a
SR
4020 Normally compressed uImages are limited to an
4021 uncompressed size of 8 MBytes. If this is not enough,
6d0f6bcf 4022 you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9a
SR
4023 to adjust this setting to your needs.
4024
6d0f6bcf 4025- CONFIG_SYS_BOOTMAPSZ:
c609719b
WD
4026 Maximum size of memory mapped by the startup code of
4027 the Linux kernel; all data that must be processed by
7d721e34
BS
4028 the Linux kernel (bd_info, boot arguments, FDT blob if
4029 used) must be put below this limit, unless "bootm_low"
1bce2aeb 4030 environment variable is defined and non-zero. In such case
7d721e34 4031 all data for the Linux kernel must be between "bootm_low"
c0f40859 4032 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
c3624e6e
GL
4033 variable "bootm_mapsize" will override the value of
4034 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4035 then the value in "bootm_size" will be used instead.
c609719b 4036
fca43cc8
JR
4037- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4038 Enable initrd_high functionality. If defined then the
4039 initrd_high feature is enabled and the bootm ramdisk subcommand
4040 is enabled.
4041
4042- CONFIG_SYS_BOOT_GET_CMDLINE:
4043 Enables allocating and saving kernel cmdline in space between
4044 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4045
4046- CONFIG_SYS_BOOT_GET_KBD:
4047 Enables allocating and saving a kernel copy of the bd_info in
4048 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4049
6d0f6bcf 4050- CONFIG_SYS_MAX_FLASH_BANKS:
c609719b
WD
4051 Max number of Flash memory banks
4052
6d0f6bcf 4053- CONFIG_SYS_MAX_FLASH_SECT:
c609719b
WD
4054 Max number of sectors on a Flash chip
4055
6d0f6bcf 4056- CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b
WD
4057 Timeout for Flash erase operations (in ms)
4058
6d0f6bcf 4059- CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b
WD
4060 Timeout for Flash write operations (in ms)
4061
6d0f6bcf 4062- CONFIG_SYS_FLASH_LOCK_TOUT
8564acf9
WD
4063 Timeout for Flash set sector lock bit operation (in ms)
4064
6d0f6bcf 4065- CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf9
WD
4066 Timeout for Flash clear lock bits operation (in ms)
4067
6d0f6bcf 4068- CONFIG_SYS_FLASH_PROTECTION
8564acf9
WD
4069 If defined, hardware flash sectors protection is used
4070 instead of U-Boot software protection.
4071
6d0f6bcf 4072- CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b
WD
4073
4074 Enable TFTP transfers directly to flash memory;
4075 without this option such a download has to be
4076 performed in two steps: (1) download to RAM, and (2)
4077 copy from RAM to flash.
4078
4079 The two-step approach is usually more reliable, since
4080 you can check if the download worked before you erase
11ccc33f
MZ
4081 the flash, but in some situations (when system RAM is
4082 too limited to allow for a temporary copy of the
c609719b
WD
4083 downloaded image) this option may be very useful.
4084
6d0f6bcf 4085- CONFIG_SYS_FLASH_CFI:
43d9616c 4086 Define if the flash driver uses extra elements in the
5653fc33
WD
4087 common flash structure for storing flash geometry.
4088
00b1883a 4089- CONFIG_FLASH_CFI_DRIVER
5653fc33
WD
4090 This option also enables the building of the cfi_flash driver
4091 in the drivers directory
c609719b 4092
91809ed5
PZ
4093- CONFIG_FLASH_CFI_MTD
4094 This option enables the building of the cfi_mtd driver
4095 in the drivers directory. The driver exports CFI flash
4096 to the MTD layer.
4097
6d0f6bcf 4098- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f
GL
4099 Use buffered writes to flash.
4100
4101- CONFIG_FLASH_SPANSION_S29WS_N
4102 s29ws-n MirrorBit flash has non-standard addresses for buffered
4103 write commands.
4104
6d0f6bcf 4105- CONFIG_SYS_FLASH_QUIET_TEST
5568e613
SR
4106 If this option is defined, the common CFI flash doesn't
4107 print it's warning upon not recognized FLASH banks. This
4108 is useful, if some of the configured banks are only
4109 optionally available.
4110
9a042e9c
JVB
4111- CONFIG_FLASH_SHOW_PROGRESS
4112 If defined (must be an integer), print out countdown
4113 digits and dots. Recommended value: 45 (9..1) for 80
4114 column displays, 15 (3..1) for 40 column displays.
4115
352ef3f1
SR
4116- CONFIG_FLASH_VERIFY
4117 If defined, the content of the flash (destination) is compared
4118 against the source after the write operation. An error message
4119 will be printed when the contents are not identical.
4120 Please note that this option is useless in nearly all cases,
4121 since such flash programming errors usually are detected earlier
4122 while unprotecting/erasing/programming. Please only enable
4123 this option if you really know what you are doing.
4124
6d0f6bcf 4125- CONFIG_SYS_RX_ETH_BUFFER:
11ccc33f
MZ
4126 Defines the number of Ethernet receive buffers. On some
4127 Ethernet controllers it is recommended to set this value
53cf9435
SR
4128 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4129 buffers can be full shortly after enabling the interface
11ccc33f 4130 on high Ethernet traffic.
53cf9435
SR
4131 Defaults to 4 if not defined.
4132
ea882baf
WD
4133- CONFIG_ENV_MAX_ENTRIES
4134
071bc923
WD
4135 Maximum number of entries in the hash table that is used
4136 internally to store the environment settings. The default
4137 setting is supposed to be generous and should work in most
4138 cases. This setting can be used to tune behaviour; see
4139 lib/hashtable.c for details.
ea882baf 4140
2598090b
JH
4141- CONFIG_ENV_FLAGS_LIST_DEFAULT
4142- CONFIG_ENV_FLAGS_LIST_STATIC
1bce2aeb 4143 Enable validation of the values given to environment variables when
2598090b
JH
4144 calling env set. Variables can be restricted to only decimal,
4145 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4146 the variables can also be restricted to IP address or MAC address.
4147
4148 The format of the list is:
4149 type_attribute = [s|d|x|b|i|m]
267541f7
JH
4150 access_atribute = [a|r|o|c]
4151 attributes = type_attribute[access_atribute]
2598090b
JH
4152 entry = variable_name[:attributes]
4153 list = entry[,list]
4154
4155 The type attributes are:
4156 s - String (default)
4157 d - Decimal
4158 x - Hexadecimal
4159 b - Boolean ([1yYtT|0nNfF])
4160 i - IP address
4161 m - MAC address
4162
267541f7
JH
4163 The access attributes are:
4164 a - Any (default)
4165 r - Read-only
4166 o - Write-once
4167 c - Change-default
4168
2598090b
JH
4169 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4170 Define this to a list (string) to define the ".flags"
4171 envirnoment variable in the default or embedded environment.
4172
4173 - CONFIG_ENV_FLAGS_LIST_STATIC
4174 Define this to a list (string) to define validation that
4175 should be done if an entry is not found in the ".flags"
4176 environment variable. To override a setting in the static
4177 list, simply add an entry for the same variable name to the
4178 ".flags" variable.
4179
267541f7
JH
4180- CONFIG_ENV_ACCESS_IGNORE_FORCE
4181 If defined, don't allow the -f switch to env set override variable
4182 access flags.
4183
5c1a7ea6
SG
4184- CONFIG_SYS_GENERIC_BOARD
4185 This selects the architecture-generic board system instead of the
4186 architecture-specific board files. It is intended to move boards
4187 to this new framework over time. Defining this will disable the
4188 arch/foo/lib/board.c file and use common/board_f.c and
4189 common/board_r.c instead. To use this option your architecture
4190 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
4191 its config.mk file). If you find problems enabling this option on
4192 your board please report the problem and send patches!
4193
0b1b60c7
LV
4194- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4195 This is set by OMAP boards for the max time that reset should
4196 be asserted. See doc/README.omap-reset-time for details on how
4197 the value can be calulated on a given board.
632efa74 4198
0d296cc2
GB
4199- CONFIG_USE_STDINT
4200 If stdint.h is available with your toolchain you can define this
4201 option to enable it. You can provide option 'USE_STDINT=1' when
4202 building U-Boot to enable this.
4203
c609719b
WD
4204The following definitions that deal with the placement and management
4205of environment data (variable area); in general, we support the
4206following configurations:
4207
c3eb3fe4
MF
4208- CONFIG_BUILD_ENVCRC:
4209
4210 Builds up envcrc with the target environment so that external utils
4211 may easily extract it and embed it in final U-Boot images.
4212
5a1aceb0 4213- CONFIG_ENV_IS_IN_FLASH:
c609719b
WD
4214
4215 Define this if the environment is in flash memory.
4216
4217 a) The environment occupies one whole flash sector, which is
4218 "embedded" in the text segment with the U-Boot code. This
4219 happens usually with "bottom boot sector" or "top boot
4220 sector" type flash chips, which have several smaller
4221 sectors at the start or the end. For instance, such a
4222 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4223 such a case you would place the environment in one of the
4224 4 kB sectors - with U-Boot code before and after it. With
4225 "top boot sector" type flash chips, you would put the
4226 environment in one of the last sectors, leaving a gap
4227 between U-Boot and the environment.
4228
0e8d1586 4229 - CONFIG_ENV_OFFSET:
c609719b
WD
4230
4231 Offset of environment data (variable area) to the
4232 beginning of flash memory; for instance, with bottom boot
4233 type flash chips the second sector can be used: the offset
4234 for this sector is given here.
4235
6d0f6bcf 4236 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
c609719b 4237
0e8d1586 4238 - CONFIG_ENV_ADDR:
c609719b
WD
4239
4240 This is just another way to specify the start address of
4241 the flash sector containing the environment (instead of
0e8d1586 4242 CONFIG_ENV_OFFSET).
c609719b 4243
0e8d1586 4244 - CONFIG_ENV_SECT_SIZE:
c609719b
WD
4245
4246 Size of the sector containing the environment.
4247
4248
4249 b) Sometimes flash chips have few, equal sized, BIG sectors.
4250 In such a case you don't want to spend a whole sector for
4251 the environment.
4252
0e8d1586 4253 - CONFIG_ENV_SIZE:
c609719b 4254
5a1aceb0 4255 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
0e8d1586 4256 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
c609719b
WD
4257 of this flash sector for the environment. This saves
4258 memory for the RAM copy of the environment.
4259
4260 It may also save flash memory if you decide to use this
4261 when your environment is "embedded" within U-Boot code,
4262 since then the remainder of the flash sector could be used
4263 for U-Boot code. It should be pointed out that this is
4264 STRONGLY DISCOURAGED from a robustness point of view:
4265 updating the environment in flash makes it always
4266 necessary to erase the WHOLE sector. If something goes
4267 wrong before the contents has been restored from a copy in
4268 RAM, your target system will be dead.
4269
0e8d1586
JCPV
4270 - CONFIG_ENV_ADDR_REDUND
4271 CONFIG_ENV_SIZE_REDUND
c609719b 4272
43d9616c 4273 These settings describe a second storage area used to hold
11ccc33f 4274 a redundant copy of the environment data, so that there is
3e38691e 4275 a valid backup copy in case there is a power failure during
43d9616c 4276 a "saveenv" operation.
c609719b
WD
4277
4278BE CAREFUL! Any changes to the flash layout, and some changes to the
4279source code will make it necessary to adapt <board>/u-boot.lds*
4280accordingly!
4281
4282
9314cee6 4283- CONFIG_ENV_IS_IN_NVRAM:
c609719b
WD
4284
4285 Define this if you have some non-volatile memory device
4286 (NVRAM, battery buffered SRAM) which you want to use for the
4287 environment.
4288
0e8d1586
JCPV
4289 - CONFIG_ENV_ADDR:
4290 - CONFIG_ENV_SIZE:
c609719b 4291
11ccc33f 4292 These two #defines are used to determine the memory area you
c609719b
WD
4293 want to use for environment. It is assumed that this memory
4294 can just be read and written to, without any special
4295 provision.
4296
4297BE CAREFUL! The first access to the environment happens quite early
4298in U-Boot initalization (when we try to get the setting of for the
11ccc33f 4299console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b
WD
4300U-Boot will hang.
4301
4302Please note that even with NVRAM we still use a copy of the
4303environment in RAM: we could work on NVRAM directly, but we want to
4304keep settings there always unmodified except somebody uses "saveenv"
4305to save the current settings.
4306
4307
bb1f8b4f 4308- CONFIG_ENV_IS_IN_EEPROM:
c609719b
WD
4309
4310 Use this if you have an EEPROM or similar serial access
4311 device and a driver for it.
4312
0e8d1586
JCPV
4313 - CONFIG_ENV_OFFSET:
4314 - CONFIG_ENV_SIZE:
c609719b
WD
4315
4316 These two #defines specify the offset and size of the
4317 environment area within the total memory of your EEPROM.
4318
6d0f6bcf 4319 - CONFIG_SYS_I2C_EEPROM_ADDR:
c609719b
WD
4320 If defined, specified the chip address of the EEPROM device.
4321 The default address is zero.
4322
6d0f6bcf 4323 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
c609719b
WD
4324 If defined, the number of bits used to address bytes in a
4325 single page in the EEPROM device. A 64 byte page, for example
4326 would require six bits.
4327
6d0f6bcf 4328 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
c609719b 4329 If defined, the number of milliseconds to delay between
ba56f625 4330 page writes. The default is zero milliseconds.
c609719b 4331
6d0f6bcf 4332 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
c609719b
WD
4333 The length in bytes of the EEPROM memory array address. Note
4334 that this is NOT the chip address length!
4335
6d0f6bcf 4336 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
5cf91d6b
WD
4337 EEPROM chips that implement "address overflow" are ones
4338 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4339 address and the extra bits end up in the "chip address" bit
4340 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4341 byte chips.
4342
4343 Note that we consider the length of the address field to
4344 still be one byte because the extra address bits are hidden
4345 in the chip address.
4346
6d0f6bcf 4347 - CONFIG_SYS_EEPROM_SIZE:
c609719b
WD
4348 The size in bytes of the EEPROM device.
4349
548738b4
HS
4350 - CONFIG_ENV_EEPROM_IS_ON_I2C
4351 define this, if you have I2C and SPI activated, and your
4352 EEPROM, which holds the environment, is on the I2C bus.
4353
4354 - CONFIG_I2C_ENV_EEPROM_BUS
4355 if you have an Environment on an EEPROM reached over
4356 I2C muxes, you can define here, how to reach this
4357 EEPROM. For example:
4358
ea818dbb 4359 #define CONFIG_I2C_ENV_EEPROM_BUS 1
548738b4
HS
4360
4361 EEPROM which holds the environment, is reached over
4362 a pca9547 i2c mux with address 0x70, channel 3.
c609719b 4363
057c849c 4364- CONFIG_ENV_IS_IN_DATAFLASH:
5779d8d9 4365
d4ca31c4 4366 Define this if you have a DataFlash memory device which you
5779d8d9
WD
4367 want to use for the environment.
4368
0e8d1586
JCPV
4369 - CONFIG_ENV_OFFSET:
4370 - CONFIG_ENV_ADDR:
4371 - CONFIG_ENV_SIZE:
5779d8d9
WD
4372
4373 These three #defines specify the offset and size of the
4374 environment area within the total memory of your DataFlash placed
4375 at the specified address.
4376
bd83b592
WJ
4377- CONFIG_ENV_IS_IN_SPI_FLASH:
4378
4379 Define this if you have a SPI Flash memory device which you
4380 want to use for the environment.
4381
4382 - CONFIG_ENV_OFFSET:
4383 - CONFIG_ENV_SIZE:
4384
4385 These two #defines specify the offset and size of the
4386 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4387 aligned to an erase sector boundary.
4388
4389 - CONFIG_ENV_SECT_SIZE:
4390
4391 Define the SPI flash's sector size.
4392
4393 - CONFIG_ENV_OFFSET_REDUND (optional):
4394
4395 This setting describes a second storage area of CONFIG_ENV_SIZE
4396 size used to hold a redundant copy of the environment data, so
4397 that there is a valid backup copy in case there is a power failure
4398 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4399 aligned to an erase sector boundary.
4400
4401 - CONFIG_ENV_SPI_BUS (optional):
4402 - CONFIG_ENV_SPI_CS (optional):
4403
4404 Define the SPI bus and chip select. If not defined they will be 0.
4405
4406 - CONFIG_ENV_SPI_MAX_HZ (optional):
4407
4408 Define the SPI max work clock. If not defined then use 1MHz.
4409
4410 - CONFIG_ENV_SPI_MODE (optional):
4411
4412 Define the SPI work mode. If not defined then use SPI_MODE_3.
4413
0a85a9e7
LG
4414- CONFIG_ENV_IS_IN_REMOTE:
4415
4416 Define this if you have a remote memory space which you
4417 want to use for the local device's environment.
4418
4419 - CONFIG_ENV_ADDR:
4420 - CONFIG_ENV_SIZE:
4421
4422 These two #defines specify the address and size of the
4423 environment area within the remote memory space. The
4424 local device can get the environment from remote memory
fc54c7fa 4425 space by SRIO or PCIE links.
0a85a9e7
LG
4426
4427BE CAREFUL! For some special cases, the local device can not use
4428"saveenv" command. For example, the local device will get the
fc54c7fa
LG
4429environment stored in a remote NOR flash by SRIO or PCIE link,
4430but it can not erase, write this NOR flash by SRIO or PCIE interface.
0a85a9e7 4431
51bfee19 4432- CONFIG_ENV_IS_IN_NAND:
13a5695b
WD
4433
4434 Define this if you have a NAND device which you want to use
4435 for the environment.
4436
0e8d1586
JCPV
4437 - CONFIG_ENV_OFFSET:
4438 - CONFIG_ENV_SIZE:
13a5695b
WD
4439
4440 These two #defines specify the offset and size of the environment
fdd813de
SW
4441 area within the first NAND device. CONFIG_ENV_OFFSET must be
4442 aligned to an erase block boundary.
5779d8d9 4443
fdd813de 4444 - CONFIG_ENV_OFFSET_REDUND (optional):
e443c944 4445
0e8d1586 4446 This setting describes a second storage area of CONFIG_ENV_SIZE
fdd813de
SW
4447 size used to hold a redundant copy of the environment data, so
4448 that there is a valid backup copy in case there is a power failure
c0f40859 4449 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
fdd813de
SW
4450 aligned to an erase block boundary.
4451
4452 - CONFIG_ENV_RANGE (optional):
4453
4454 Specifies the length of the region in which the environment
4455 can be written. This should be a multiple of the NAND device's
4456 block size. Specifying a range with more erase blocks than
4457 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4458 the range to be avoided.
4459
4460 - CONFIG_ENV_OFFSET_OOB (optional):
4461
4462 Enables support for dynamically retrieving the offset of the
4463 environment from block zero's out-of-band data. The
4464 "nand env.oob" command can be used to record this offset.
4465 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4466 using CONFIG_ENV_OFFSET_OOB.
e443c944 4467
b74ab737
GL
4468- CONFIG_NAND_ENV_DST
4469
4470 Defines address in RAM to which the nand_spl code should copy the
4471 environment. If redundant environment is used, it will be copied to
4472 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4473
2b74433f
JH
4474- CONFIG_ENV_IS_IN_UBI:
4475
4476 Define this if you have an UBI volume that you want to use for the
4477 environment. This has the benefit of wear-leveling the environment
4478 accesses, which is important on NAND.
4479
4480 - CONFIG_ENV_UBI_PART:
4481
4482 Define this to a string that is the mtd partition containing the UBI.
4483
4484 - CONFIG_ENV_UBI_VOLUME:
4485
4486 Define this to the name of the volume that you want to store the
4487 environment in.
4488
785881f7
JH
4489 - CONFIG_ENV_UBI_VOLUME_REDUND:
4490
4491 Define this to the name of another volume to store a second copy of
4492 the environment in. This will enable redundant environments in UBI.
4493 It is assumed that both volumes are in the same MTD partition.
4494
2b74433f
JH
4495 - CONFIG_UBI_SILENCE_MSG
4496 - CONFIG_UBIFS_SILENCE_MSG
4497
4498 You will probably want to define these to avoid a really noisy system
4499 when storing the env in UBI.
4500
d1db76f1
WJ
4501- CONFIG_ENV_IS_IN_FAT:
4502 Define this if you want to use the FAT file system for the environment.
4503
4504 - FAT_ENV_INTERFACE:
4505
4506 Define this to a string that is the name of the block device.
4507
4508 - FAT_ENV_DEV_AND_PART:
4509
4510 Define this to a string to specify the partition of the device. It can
4511 be as following:
4512
4513 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4514 - "D:P": device D partition P. Error occurs if device D has no
4515 partition table.
4516 - "D:0": device D.
4517 - "D" or "D:": device D partition 1 if device D has partition
4518 table, or the whole device D if has no partition
4519 table.
4520 - "D:auto": first partition in device D with bootable flag set.
4521 If none, first valid paratition in device D. If no
4522 partition table then means device D.
4523
4524 - FAT_ENV_FILE:
4525
4526 It's a string of the FAT file name. This file use to store the
4527 envrionment.
4528
4529 - CONFIG_FAT_WRITE:
4530 This should be defined. Otherwise it cannot save the envrionment file.
4531
06e4ae5f
SW
4532- CONFIG_ENV_IS_IN_MMC:
4533
4534 Define this if you have an MMC device which you want to use for the
4535 environment.
4536
4537 - CONFIG_SYS_MMC_ENV_DEV:
4538
4539 Specifies which MMC device the environment is stored in.
4540
4541 - CONFIG_SYS_MMC_ENV_PART (optional):
4542
4543 Specifies which MMC partition the environment is stored in. If not
4544 set, defaults to partition 0, the user area. Common values might be
4545 1 (first MMC boot partition), 2 (second MMC boot partition).
4546
4547 - CONFIG_ENV_OFFSET:
4548 - CONFIG_ENV_SIZE:
4549
4550 These two #defines specify the offset and size of the environment
4551 area within the specified MMC device.
4552
5c088ee8
SW
4553 If offset is positive (the usual case), it is treated as relative to
4554 the start of the MMC partition. If offset is negative, it is treated
4555 as relative to the end of the MMC partition. This can be useful if
4556 your board may be fitted with different MMC devices, which have
4557 different sizes for the MMC partitions, and you always want the
4558 environment placed at the very end of the partition, to leave the
4559 maximum possible space before it, to store other data.
4560
06e4ae5f
SW
4561 These two values are in units of bytes, but must be aligned to an
4562 MMC sector boundary.
4563
4564 - CONFIG_ENV_OFFSET_REDUND (optional):
4565
4566 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4567 hold a redundant copy of the environment data. This provides a
4568 valid backup copy in case the other copy is corrupted, e.g. due
4569 to a power failure during a "saveenv" operation.
4570
5c088ee8
SW
4571 This value may also be positive or negative; this is handled in the
4572 same way as CONFIG_ENV_OFFSET.
4573
06e4ae5f
SW
4574 This value is also in units of bytes, but must also be aligned to
4575 an MMC sector boundary.
4576
4577 - CONFIG_ENV_SIZE_REDUND (optional):
4578
4579 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4580 set. If this value is set, it must be set to the same value as
4581 CONFIG_ENV_SIZE.
4582
6d0f6bcf 4583- CONFIG_SYS_SPI_INIT_OFFSET
c609719b
WD
4584
4585 Defines offset to the initial SPI buffer area in DPRAM. The
4586 area is used at an early stage (ROM part) if the environment
4587 is configured to reside in the SPI EEPROM: We need a 520 byte
4588 scratch DPRAM area. It is used between the two initialization
4589 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4590 to be a good choice since it makes it far enough from the
4591 start of the data area as well as from the stack pointer.
4592
e881cb56 4593Please note that the environment is read-only until the monitor
c609719b 4594has been relocated to RAM and a RAM copy of the environment has been
cdb74977 4595created; also, when using EEPROM you will have to use getenv_f()
c609719b
WD
4596until then to read environment variables.
4597
85ec0bcc
WD
4598The environment is protected by a CRC32 checksum. Before the monitor
4599is relocated into RAM, as a result of a bad CRC you will be working
4600with the compiled-in default environment - *silently*!!! [This is
4601necessary, because the first environment variable we need is the
4602"baudrate" setting for the console - if we have a bad CRC, we don't
4603have any device yet where we could complain.]
c609719b
WD
4604
4605Note: once the monitor has been relocated, then it will complain if
4606the default environment is used; a new CRC is computed as soon as you
85ec0bcc 4607use the "saveenv" command to store a valid environment.
c609719b 4608
6d0f6bcf 4609- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
42d1f039 4610 Echo the inverted Ethernet link state to the fault LED.
fc3e2165 4611
6d0f6bcf 4612 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
fc3e2165
WD
4613 also needs to be defined.
4614
6d0f6bcf 4615- CONFIG_SYS_FAULT_MII_ADDR:
42d1f039 4616 MII address of the PHY to check for the Ethernet link state.
c609719b 4617
f5675aa5
RM
4618- CONFIG_NS16550_MIN_FUNCTIONS:
4619 Define this if you desire to only have use of the NS16550_init
4620 and NS16550_putc functions for the serial driver located at
4621 drivers/serial/ns16550.c. This option is useful for saving
4622 space for already greatly restricted images, including but not
4623 limited to NAND_SPL configurations.
4624
b2b92f53
SG
4625- CONFIG_DISPLAY_BOARDINFO
4626 Display information about the board that U-Boot is running on
4627 when U-Boot starts up. The board function checkboard() is called
4628 to do this.
4629
e2e3e2b1
SG
4630- CONFIG_DISPLAY_BOARDINFO_LATE
4631 Similar to the previous option, but display this information
4632 later, once stdio is running and output goes to the LCD, if
4633 present.
4634
feb85801
SS
4635- CONFIG_BOARD_SIZE_LIMIT:
4636 Maximum size of the U-Boot image. When defined, the
4637 build system checks that the actual size does not
4638 exceed it.
4639
c609719b 4640Low Level (hardware related) configuration options:
dc7c9a1a 4641---------------------------------------------------
c609719b 4642
6d0f6bcf 4643- CONFIG_SYS_CACHELINE_SIZE:
c609719b
WD
4644 Cache Line Size of the CPU.
4645
6d0f6bcf 4646- CONFIG_SYS_DEFAULT_IMMR:
c609719b 4647 Default address of the IMMR after system reset.
2535d602 4648
42d1f039
WD
4649 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4650 and RPXsuper) to be able to adjust the position of
4651 the IMMR register after a reset.
c609719b 4652
e46fedfe
TT
4653- CONFIG_SYS_CCSRBAR_DEFAULT:
4654 Default (power-on reset) physical address of CCSR on Freescale
4655 PowerPC SOCs.
4656
4657- CONFIG_SYS_CCSRBAR:
4658 Virtual address of CCSR. On a 32-bit build, this is typically
4659 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4660
4661 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4662 for cross-platform code that uses that macro instead.
4663
4664- CONFIG_SYS_CCSRBAR_PHYS:
4665 Physical address of CCSR. CCSR can be relocated to a new
4666 physical address, if desired. In this case, this macro should
c0f40859 4667 be set to that address. Otherwise, it should be set to the
e46fedfe
TT
4668 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4669 is typically relocated on 36-bit builds. It is recommended
4670 that this macro be defined via the _HIGH and _LOW macros:
4671
4672 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4673 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4674
4675- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4cf2609b
WD
4676 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4677 either 0 (32-bit build) or 0xF (36-bit build). This macro is
e46fedfe
TT
4678 used in assembly code, so it must not contain typecasts or
4679 integer size suffixes (e.g. "ULL").
4680
4681- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4682 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4683 used in assembly code, so it must not contain typecasts or
4684 integer size suffixes (e.g. "ULL").
4685
4686- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4687 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4688 forced to a value that ensures that CCSR is not relocated.
4689
7f6c2cbc 4690- Floppy Disk Support:
6d0f6bcf 4691 CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc
WD
4692
4693 the default drive number (default value 0)
4694
6d0f6bcf 4695 CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc 4696
11ccc33f 4697 defines the spacing between FDC chipset registers
7f6c2cbc
WD
4698 (default value 1)
4699
6d0f6bcf 4700 CONFIG_SYS_ISA_IO_OFFSET
7f6c2cbc 4701
43d9616c
WD
4702 defines the offset of register from address. It
4703 depends on which part of the data bus is connected to
11ccc33f 4704 the FDC chipset. (default value 0)
7f6c2cbc 4705
6d0f6bcf
JCPV
4706 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4707 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
43d9616c 4708 default value.
7f6c2cbc 4709
6d0f6bcf 4710 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43d9616c
WD
4711 fdc_hw_init() is called at the beginning of the FDC
4712 setup. fdc_hw_init() must be provided by the board
4713 source code. It is used to make hardware dependant
4714 initializations.
7f6c2cbc 4715
0abddf82
ML
4716- CONFIG_IDE_AHB:
4717 Most IDE controllers were designed to be connected with PCI
4718 interface. Only few of them were designed for AHB interface.
4719 When software is doing ATA command and data transfer to
4720 IDE devices through IDE-AHB controller, some additional
4721 registers accessing to these kind of IDE-AHB controller
4722 is requierd.
4723
6d0f6bcf 4724- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
efe2a4d5 4725 DO NOT CHANGE unless you know exactly what you're
25d6712a 4726 doing! (11-4) [MPC8xx/82xx systems only]
c609719b 4727
6d0f6bcf 4728- CONFIG_SYS_INIT_RAM_ADDR:
c609719b 4729
7152b1d0 4730 Start address of memory area that can be used for
c609719b
WD
4731 initial data and stack; please note that this must be
4732 writable memory that is working WITHOUT special
4733 initialization, i. e. you CANNOT use normal RAM which
4734 will become available only after programming the
4735 memory controller and running certain initialization
4736 sequences.
4737
4738 U-Boot uses the following memory types:
4739 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4740 - MPC824X: data cache
4741 - PPC4xx: data cache
4742
6d0f6bcf 4743- CONFIG_SYS_GBL_DATA_OFFSET:
c609719b
WD
4744
4745 Offset of the initial data structure in the memory
6d0f6bcf
JCPV
4746 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4747 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b 4748 data is located at the end of the available space
553f0982 4749 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
6d0f6bcf
JCPV
4750 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4751 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4752 CONFIG_SYS_GBL_DATA_OFFSET) downward.
c609719b
WD
4753
4754 Note:
4755 On the MPC824X (or other systems that use the data
4756 cache for initial memory) the address chosen for
6d0f6bcf 4757 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b
WD
4758 point to an otherwise UNUSED address space between
4759 the top of RAM and the start of the PCI space.
4760
6d0f6bcf 4761- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
c609719b 4762
6d0f6bcf 4763- CONFIG_SYS_SYPCR: System Protection Control (11-9)
c609719b 4764
6d0f6bcf 4765- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
c609719b 4766
6d0f6bcf 4767- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
c609719b 4768
6d0f6bcf 4769- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
c609719b 4770
6d0f6bcf 4771- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
c609719b 4772
6d0f6bcf 4773- CONFIG_SYS_OR_TIMING_SDRAM:
c609719b
WD
4774 SDRAM timing
4775
6d0f6bcf 4776- CONFIG_SYS_MAMR_PTA:
c609719b
WD
4777 periodic timer for refresh
4778
6d0f6bcf 4779- CONFIG_SYS_DER: Debug Event Register (37-47)
c609719b 4780
6d0f6bcf
JCPV
4781- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4782 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4783 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4784 CONFIG_SYS_BR1_PRELIM:
c609719b
WD
4785 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4786
4787- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
6d0f6bcf
JCPV
4788 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4789 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
c609719b
WD
4790 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4791
6d0f6bcf
JCPV
4792- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4793 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
c609719b
WD
4794 Machine Mode Register and Memory Periodic Timer
4795 Prescaler definitions (SDRAM timing)
4796
6d0f6bcf 4797- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
c609719b
WD
4798 enable I2C microcode relocation patch (MPC8xx);
4799 define relocation offset in DPRAM [DSP2]
4800
6d0f6bcf 4801- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
b423d055
HS
4802 enable SMC microcode relocation patch (MPC8xx);
4803 define relocation offset in DPRAM [SMC1]
4804
6d0f6bcf 4805- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
c609719b
WD
4806 enable SPI microcode relocation patch (MPC8xx);
4807 define relocation offset in DPRAM [SCC4]
4808
6d0f6bcf 4809- CONFIG_SYS_USE_OSCCLK:
c609719b
WD
4810 Use OSCM clock mode on MBX8xx board. Be careful,
4811 wrong setting might damage your board. Read
4812 doc/README.MBX before setting this variable!
4813
6d0f6bcf 4814- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
43d9616c
WD
4815 Offset of the bootmode word in DPRAM used by post
4816 (Power On Self Tests). This definition overrides
4817 #define'd default value in commproc.h resp.
4818 cpm_8260.h.
ea909b76 4819
6d0f6bcf
JCPV
4820- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4821 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4822 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4823 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4824 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4825 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4826 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4827 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
a47a12be 4828 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
5d232d0e 4829
9cacf4fc
DE
4830- CONFIG_PCI_DISABLE_PCIE:
4831 Disable PCI-Express on systems where it is supported but not
4832 required.
4833
69fd2d3b
AS
4834- CONFIG_PCI_ENUM_ONLY
4835 Only scan through and get the devices on the busses.
4836 Don't do any setup work, presumably because someone or
4837 something has already done it, and we don't need to do it
4838 a second time. Useful for platforms that are pre-booted
4839 by coreboot or similar.
4840
842033e6
GJ
4841- CONFIG_PCI_INDIRECT_BRIDGE:
4842 Enable support for indirect PCI bridges.
4843
a09b9b68
KG
4844- CONFIG_SYS_SRIO:
4845 Chip has SRIO or not
4846
4847- CONFIG_SRIO1:
4848 Board has SRIO 1 port available
4849
4850- CONFIG_SRIO2:
4851 Board has SRIO 2 port available
4852
c8b28152
LG
4853- CONFIG_SRIO_PCIE_BOOT_MASTER
4854 Board can support master function for Boot from SRIO and PCIE
4855
a09b9b68
KG
4856- CONFIG_SYS_SRIOn_MEM_VIRT:
4857 Virtual Address of SRIO port 'n' memory region
4858
4859- CONFIG_SYS_SRIOn_MEM_PHYS:
4860 Physical Address of SRIO port 'n' memory region
4861
4862- CONFIG_SYS_SRIOn_MEM_SIZE:
4863 Size of SRIO port 'n' memory region
4864
66bd1846
FE
4865- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4866 Defined to tell the NAND controller that the NAND chip is using
4867 a 16 bit bus.
4868 Not all NAND drivers use this symbol.
a430e916 4869 Example of drivers that use it:
66bd1846 4870 - drivers/mtd/nand/ndfc.c
a430e916 4871 - drivers/mtd/nand/mxc_nand.c
eced4626
AW
4872
4873- CONFIG_SYS_NDFC_EBC0_CFG
4874 Sets the EBC0_CFG register for the NDFC. If not defined
4875 a default value will be used.
4876
bb99ad6d 4877- CONFIG_SPD_EEPROM
218ca724
WD
4878 Get DDR timing information from an I2C EEPROM. Common
4879 with pluggable memory modules such as SODIMMs
4880
bb99ad6d
BW
4881 SPD_EEPROM_ADDRESS
4882 I2C address of the SPD EEPROM
4883
6d0f6bcf 4884- CONFIG_SYS_SPD_BUS_NUM
218ca724
WD
4885 If SPD EEPROM is on an I2C bus other than the first
4886 one, specify here. Note that the value must resolve
4887 to something your driver can deal with.
bb99ad6d 4888
1b3e3c4f
YS
4889- CONFIG_SYS_DDR_RAW_TIMING
4890 Get DDR timing information from other than SPD. Common with
4891 soldered DDR chips onboard without SPD. DDR raw timing
4892 parameters are extracted from datasheet and hard-coded into
4893 header files or board specific files.
4894
6f5e1dc5
YS
4895- CONFIG_FSL_DDR_INTERACTIVE
4896 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4897
6d0f6bcf 4898- CONFIG_SYS_83XX_DDR_USES_CS0
218ca724
WD
4899 Only for 83xx systems. If specified, then DDR should
4900 be configured using CS0 and CS1 instead of CS2 and CS3.
2ad6b513 4901
c26e454d
WD
4902- CONFIG_ETHER_ON_FEC[12]
4903 Define to enable FEC[12] on a 8xx series processor.
4904
4905- CONFIG_FEC[12]_PHY
4906 Define to the hardcoded PHY address which corresponds
6e592385
WD
4907 to the given FEC; i. e.
4908 #define CONFIG_FEC1_PHY 4
c26e454d
WD
4909 means that the PHY with address 4 is connected to FEC1
4910
4911 When set to -1, means to probe for first available.
4912
4913- CONFIG_FEC[12]_PHY_NORXERR
4914 The PHY does not have a RXERR line (RMII only).
4915 (so program the FEC to ignore it).
4916
4917- CONFIG_RMII
4918 Enable RMII mode for all FECs.
4919 Note that this is a global option, we can't
4920 have one FEC in standard MII mode and another in RMII mode.
4921
5cf91d6b
WD
4922- CONFIG_CRC32_VERIFY
4923 Add a verify option to the crc32 command.
4924 The syntax is:
4925
4926 => crc32 -v <address> <count> <crc32>
4927
4928 Where address/count indicate a memory area
4929 and crc32 is the correct crc32 which the
4930 area should have.
4931
56523f12
WD
4932- CONFIG_LOOPW
4933 Add the "loopw" memory command. This only takes effect if
602ad3b3 4934 the memory commands are activated globally (CONFIG_CMD_MEM).
56523f12 4935
7b466641
SR
4936- CONFIG_MX_CYCLIC
4937 Add the "mdc" and "mwc" memory commands. These are cyclic
4938 "md/mw" commands.
4939 Examples:
4940
efe2a4d5 4941 => mdc.b 10 4 500
7b466641
SR
4942 This command will print 4 bytes (10,11,12,13) each 500 ms.
4943
efe2a4d5 4944 => mwc.l 100 12345678 10
7b466641
SR
4945 This command will write 12345678 to address 100 all 10 ms.
4946
efe2a4d5 4947 This only takes effect if the memory commands are activated
602ad3b3 4948 globally (CONFIG_CMD_MEM).
7b466641 4949
8aa1a2d1 4950- CONFIG_SKIP_LOWLEVEL_INIT
afc1ce82 4951 [ARM, NDS32, MIPS only] If this variable is defined, then certain
844f07d8
WD
4952 low level initializations (like setting up the memory
4953 controller) are omitted and/or U-Boot does not
4954 relocate itself into RAM.
4955
4956 Normally this variable MUST NOT be defined. The only
4957 exception is when U-Boot is loaded (to RAM) by some
4958 other boot loader or by a debugger which performs
4959 these initializations itself.
8aa1a2d1 4960
401bb30b 4961- CONFIG_SPL_BUILD
df81238b
ML
4962 Modifies the behaviour of start.S when compiling a loader
4963 that is executed before the actual U-Boot. E.g. when
4964 compiling a NAND SPL.
400558b5 4965
3aa29de0
YZ
4966- CONFIG_TPL_BUILD
4967 Modifies the behaviour of start.S when compiling a loader
4968 that is executed after the SPL and before the actual U-Boot.
4969 It is loaded by the SPL.
4970
5df572f0
YZ
4971- CONFIG_SYS_MPC85XX_NO_RESETVEC
4972 Only for 85xx systems. If this variable is specified, the section
4973 .resetvec is not kept and the section .bootpg is placed in the
4974 previous 4k of the .text section.
4975
4213fc29
SG
4976- CONFIG_ARCH_MAP_SYSMEM
4977 Generally U-Boot (and in particular the md command) uses
4978 effective address. It is therefore not necessary to regard
4979 U-Boot address as virtual addresses that need to be translated
4980 to physical addresses. However, sandbox requires this, since
4981 it maintains its own little RAM buffer which contains all
4982 addressable memory. This option causes some memory accesses
4983 to be mapped through map_sysmem() / unmap_sysmem().
4984
d8834a13
MW
4985- CONFIG_USE_ARCH_MEMCPY
4986 CONFIG_USE_ARCH_MEMSET
4987 If these options are used a optimized version of memcpy/memset will
4988 be used if available. These functions may be faster under some
4989 conditions but may increase the binary size.
4990
588a13f7
SG
4991- CONFIG_X86_RESET_VECTOR
4992 If defined, the x86 reset vector code is included. This is not
4993 needed when U-Boot is running from Coreboot.
b16f521a 4994
fc33705e
MJ
4995- CONFIG_SYS_MPUCLK
4996 Defines the MPU clock speed (in MHz).
4997
4998 NOTE : currently only supported on AM335x platforms.
5b5ece9e 4999
16678eb4
HS
5000- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
5001 Enables the RTC32K OSC on AM33xx based plattforms
5002
999d7d32
KM
5003- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
5004 Option to disable subpage write in NAND driver
5005 driver that uses this:
5006 drivers/mtd/nand/davinci_nand.c
5007
f2717b47
TT
5008Freescale QE/FMAN Firmware Support:
5009-----------------------------------
5010
5011The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5012loading of "firmware", which is encoded in the QE firmware binary format.
5013This firmware often needs to be loaded during U-Boot booting, so macros
5014are used to identify the storage device (NOR flash, SPI, etc) and the address
5015within that device.
5016
dcf1d774
ZQ
5017- CONFIG_SYS_FMAN_FW_ADDR
5018 The address in the storage device where the FMAN microcode is located. The
5019 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5020 is also specified.
5021
5022- CONFIG_SYS_QE_FW_ADDR
5023 The address in the storage device where the QE microcode is located. The
f2717b47
TT
5024 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5025 is also specified.
5026
5027- CONFIG_SYS_QE_FMAN_FW_LENGTH
5028 The maximum possible size of the firmware. The firmware binary format
5029 has a field that specifies the actual size of the firmware, but it
5030 might not be possible to read any part of the firmware unless some
5031 local storage is allocated to hold the entire firmware first.
5032
5033- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5034 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5035 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5036 virtual address in NOR flash.
5037
5038- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5039 Specifies that QE/FMAN firmware is located in NAND flash.
5040 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5041
5042- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5043 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5044 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5045
5046- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5047 Specifies that QE/FMAN firmware is located on the primary SPI
5048 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5049
292dc6c5
LG
5050- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5051 Specifies that QE/FMAN firmware is located in the remote (master)
5052 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
fc54c7fa
LG
5053 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5054 window->master inbound window->master LAW->the ucode address in
5055 master's memory space.
f2717b47 5056
b940ca64
GR
5057Freescale Layerscape Management Complex Firmware Support:
5058---------------------------------------------------------
5059The Freescale Layerscape Management Complex (MC) supports the loading of
5060"firmware".
5061This firmware often needs to be loaded during U-Boot booting, so macros
5062are used to identify the storage device (NOR flash, SPI, etc) and the address
5063within that device.
5064
5065- CONFIG_FSL_MC_ENET
5066 Enable the MC driver for Layerscape SoCs.
5067
5068- CONFIG_SYS_LS_MC_FW_ADDR
5069 The address in the storage device where the firmware is located. The
5070 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5071 is also specified.
5072
5073- CONFIG_SYS_LS_MC_FW_LENGTH
5074 The maximum possible size of the firmware. The firmware binary format
5075 has a field that specifies the actual size of the firmware, but it
5076 might not be possible to read any part of the firmware unless some
5077 local storage is allocated to hold the entire firmware first.
5078
5079- CONFIG_SYS_LS_MC_FW_IN_NOR
5080 Specifies that MC firmware is located in NOR flash, mapped as
5081 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5082 virtual address in NOR flash.
5083
c609719b
WD
5084Building the Software:
5085======================
5086
218ca724
WD
5087Building U-Boot has been tested in several native build environments
5088and in many different cross environments. Of course we cannot support
5089all possibly existing versions of cross development tools in all
5090(potentially obsolete) versions. In case of tool chain problems we
5091recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5092which is extensively used to build and test U-Boot.
c609719b 5093
218ca724
WD
5094If you are not using a native environment, it is assumed that you
5095have GNU cross compiling tools available in your path. In this case,
5096you must set the environment variable CROSS_COMPILE in your shell.
5097Note that no changes to the Makefile or any other source files are
5098necessary. For example using the ELDK on a 4xx CPU, please enter:
c609719b 5099
218ca724
WD
5100 $ CROSS_COMPILE=ppc_4xx-
5101 $ export CROSS_COMPILE
c609719b 5102
2f8d396b
PT
5103Note: If you wish to generate Windows versions of the utilities in
5104 the tools directory you can use the MinGW toolchain
5105 (http://www.mingw.org). Set your HOST tools to the MinGW
5106 toolchain and execute 'make tools'. For example:
5107
5108 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5109
5110 Binaries such as tools/mkimage.exe will be created which can
5111 be executed on computers running Windows.
5112
218ca724
WD
5113U-Boot is intended to be simple to build. After installing the
5114sources you must configure U-Boot for one specific board type. This
c609719b
WD
5115is done by typing:
5116
ab584d67 5117 make NAME_defconfig
c609719b 5118
ab584d67 5119where "NAME_defconfig" is the name of one of the existing configu-
4d675ae6 5120rations; see boards.cfg for supported names.
db01a2ea 5121
2729af9d
WD
5122Note: for some board special configuration names may exist; check if
5123 additional information is available from the board vendor; for
5124 instance, the TQM823L systems are available without (standard)
5125 or with LCD support. You can select such additional "features"
11ccc33f 5126 when choosing the configuration, i. e.
2729af9d 5127
ab584d67 5128 make TQM823L_defconfig
2729af9d
WD
5129 - will configure for a plain TQM823L, i. e. no LCD support
5130
ab584d67 5131 make TQM823L_LCD_defconfig
2729af9d
WD
5132 - will configure for a TQM823L with U-Boot console on LCD
5133
5134 etc.
5135
5136
5137Finally, type "make all", and you should get some working U-Boot
5138images ready for download to / installation on your system:
5139
5140- "u-boot.bin" is a raw binary image
5141- "u-boot" is an image in ELF binary format
5142- "u-boot.srec" is in Motorola S-Record format
5143
baf31249
MB
5144By default the build is performed locally and the objects are saved
5145in the source directory. One of the two methods can be used to change
5146this behavior and build U-Boot to some external directory:
5147
51481. Add O= to the make command line invocations:
5149
5150 make O=/tmp/build distclean
ab584d67 5151 make O=/tmp/build NAME_defconfig
baf31249
MB
5152 make O=/tmp/build all
5153
adbba996 51542. Set environment variable KBUILD_OUTPUT to point to the desired location:
baf31249 5155
adbba996 5156 export KBUILD_OUTPUT=/tmp/build
baf31249 5157 make distclean
ab584d67 5158 make NAME_defconfig
baf31249
MB
5159 make all
5160
adbba996 5161Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
baf31249
MB
5162variable.
5163
2729af9d
WD
5164
5165Please be aware that the Makefiles assume you are using GNU make, so
5166for instance on NetBSD you might need to use "gmake" instead of
5167native "make".
5168
5169
5170If the system board that you have is not listed, then you will need
5171to port U-Boot to your hardware platform. To do this, follow these
5172steps:
5173
51741. Add a new configuration option for your board to the toplevel
4d675ae6
MJ
5175 "boards.cfg" file, using the existing entries as examples.
5176 Follow the instructions there to keep the boards in order.
2729af9d
WD
51772. Create a new directory to hold your board specific code. Add any
5178 files you need. In your board directory, you will need at least
5179 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51803. Create a new configuration file "include/configs/<board>.h" for
5181 your board
51823. If you're porting U-Boot to a new CPU, then also create a new
5183 directory to hold your CPU specific code. Add any files you need.
ab584d67 51844. Run "make <board>_defconfig" with your new name.
2729af9d
WD
51855. Type "make", and you should get a working "u-boot.srec" file
5186 to be installed on your target system.
51876. Debug and solve any problems that might arise.
5188 [Of course, this last step is much harder than it sounds.]
5189
5190
5191Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5192==============================================================
5193
218ca724
WD
5194If you have modified U-Boot sources (for instance added a new board
5195or support for new devices, a new CPU, etc.) you are expected to
2729af9d
WD
5196provide feedback to the other developers. The feedback normally takes
5197the form of a "patch", i. e. a context diff against a certain (latest
218ca724 5198official or latest in the git repository) version of U-Boot sources.
2729af9d 5199
218ca724
WD
5200But before you submit such a patch, please verify that your modifi-
5201cation did not break existing code. At least make sure that *ALL* of
2729af9d
WD
5202the supported boards compile WITHOUT ANY compiler warnings. To do so,
5203just run the "MAKEALL" script, which will configure and build U-Boot
218ca724
WD
5204for ALL supported system. Be warned, this will take a while. You can
5205select which (cross) compiler to use by passing a `CROSS_COMPILE'
5206environment variable to the script, i. e. to use the ELDK cross tools
5207you can type
2729af9d
WD
5208
5209 CROSS_COMPILE=ppc_8xx- MAKEALL
5210
5211or to build on a native PowerPC system you can type
5212
5213 CROSS_COMPILE=' ' MAKEALL
5214
218ca724
WD
5215When using the MAKEALL script, the default behaviour is to build
5216U-Boot in the source directory. This location can be changed by
5217setting the BUILD_DIR environment variable. Also, for each target
5218built, the MAKEALL script saves two log files (<target>.ERR and
5219<target>.MAKEALL) in the <source dir>/LOG directory. This default
5220location can be changed by setting the MAKEALL_LOGDIR environment
5221variable. For example:
baf31249
MB
5222
5223 export BUILD_DIR=/tmp/build
5224 export MAKEALL_LOGDIR=/tmp/log
5225 CROSS_COMPILE=ppc_8xx- MAKEALL
5226
218ca724
WD
5227With the above settings build objects are saved in the /tmp/build,
5228log files are saved in the /tmp/log and the source tree remains clean
5229during the whole build process.
baf31249
MB
5230
5231
2729af9d
WD
5232See also "U-Boot Porting Guide" below.
5233
5234
5235Monitor Commands - Overview:
5236============================
5237
5238go - start application at address 'addr'
5239run - run commands in an environment variable
5240bootm - boot application image from memory
5241bootp - boot image via network using BootP/TFTP protocol
44f074c7 5242bootz - boot zImage from memory
2729af9d
WD
5243tftpboot- boot image via network using TFTP protocol
5244 and env variables "ipaddr" and "serverip"
5245 (and eventually "gatewayip")
1fb7cd49 5246tftpput - upload a file via network using TFTP protocol
2729af9d
WD
5247rarpboot- boot image via network using RARP/TFTP protocol
5248diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5249loads - load S-Record file over serial line
5250loadb - load binary file over serial line (kermit mode)
5251md - memory display
5252mm - memory modify (auto-incrementing)
5253nm - memory modify (constant address)
5254mw - memory write (fill)
5255cp - memory copy
5256cmp - memory compare
5257crc32 - checksum calculation
0f89c54b 5258i2c - I2C sub-system
2729af9d
WD
5259sspi - SPI utility commands
5260base - print or set address offset
5261printenv- print environment variables
5262setenv - set environment variables
5263saveenv - save environment variables to persistent storage
5264protect - enable or disable FLASH write protection
5265erase - erase FLASH memory
5266flinfo - print FLASH memory information
10635afa 5267nand - NAND memory operations (see doc/README.nand)
2729af9d
WD
5268bdinfo - print Board Info structure
5269iminfo - print header information for application image
5270coninfo - print console devices and informations
5271ide - IDE sub-system
5272loop - infinite loop on address range
56523f12 5273loopw - infinite write loop on address range
2729af9d
WD
5274mtest - simple RAM test
5275icache - enable or disable instruction cache
5276dcache - enable or disable data cache
5277reset - Perform RESET of the CPU
5278echo - echo args to console
5279version - print monitor version
5280help - print online help
5281? - alias for 'help'
5282
5283
5284Monitor Commands - Detailed Description:
5285========================================
5286
5287TODO.
5288
5289For now: just type "help <command>".
5290
5291
5292Environment Variables:
5293======================
5294
5295U-Boot supports user configuration using Environment Variables which
5296can be made persistent by saving to Flash memory.
c609719b 5297
2729af9d
WD
5298Environment Variables are set using "setenv", printed using
5299"printenv", and saved to Flash using "saveenv". Using "setenv"
5300without a value can be used to delete a variable from the
5301environment. As long as you don't save the environment you are
5302working with an in-memory copy. In case the Flash area containing the
5303environment is erased by accident, a default environment is provided.
c609719b 5304
c96f86ee
WD
5305Some configuration options can be set using Environment Variables.
5306
5307List of environment variables (most likely not complete):
c609719b 5308
2729af9d 5309 baudrate - see CONFIG_BAUDRATE
c609719b 5310
2729af9d 5311 bootdelay - see CONFIG_BOOTDELAY
c609719b 5312
2729af9d 5313 bootcmd - see CONFIG_BOOTCOMMAND
4a6fd34b 5314
2729af9d 5315 bootargs - Boot arguments when booting an RTOS image
c609719b 5316
2729af9d 5317 bootfile - Name of the image to load with TFTP
c609719b 5318
7d721e34
BS
5319 bootm_low - Memory range available for image processing in the bootm
5320 command can be restricted. This variable is given as
5321 a hexadecimal number and defines lowest address allowed
5322 for use by the bootm command. See also "bootm_size"
5323 environment variable. Address defined by "bootm_low" is
5324 also the base of the initial memory mapping for the Linux
c3624e6e
GL
5325 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5326 bootm_mapsize.
5327
c0f40859 5328 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
c3624e6e
GL
5329 This variable is given as a hexadecimal number and it
5330 defines the size of the memory region starting at base
5331 address bootm_low that is accessible by the Linux kernel
5332 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5333 as the default value if it is defined, and bootm_size is
5334 used otherwise.
7d721e34
BS
5335
5336 bootm_size - Memory range available for image processing in the bootm
5337 command can be restricted. This variable is given as
5338 a hexadecimal number and defines the size of the region
5339 allowed for use by the bootm command. See also "bootm_low"
5340 environment variable.
5341
4bae9090
BS
5342 updatefile - Location of the software update file on a TFTP server, used
5343 by the automatic software update feature. Please refer to
5344 documentation in doc/README.update for more details.
5345
2729af9d
WD
5346 autoload - if set to "no" (any string beginning with 'n'),
5347 "bootp" will just load perform a lookup of the
5348 configuration from the BOOTP server, but not try to
5349 load any image using TFTP
c609719b 5350
2729af9d
WD
5351 autostart - if set to "yes", an image loaded using the "bootp",
5352 "rarpboot", "tftpboot" or "diskboot" commands will
5353 be automatically started (by internally calling
5354 "bootm")
38b99261 5355
2729af9d
WD
5356 If set to "no", a standalone image passed to the
5357 "bootm" command will be copied to the load address
5358 (and eventually uncompressed), but NOT be started.
5359 This can be used to load and uncompress arbitrary
5360 data.
c609719b 5361
a28afca5
DL
5362 fdt_high - if set this restricts the maximum address that the
5363 flattened device tree will be copied into upon boot.
fa34f6b2
SG
5364 For example, if you have a system with 1 GB memory
5365 at physical address 0x10000000, while Linux kernel
5366 only recognizes the first 704 MB as low memory, you
5367 may need to set fdt_high as 0x3C000000 to have the
5368 device tree blob be copied to the maximum address
5369 of the 704 MB low memory, so that Linux kernel can
5370 access it during the boot procedure.
5371
a28afca5
DL
5372 If this is set to the special value 0xFFFFFFFF then
5373 the fdt will not be copied at all on boot. For this
5374 to work it must reside in writable memory, have
5375 sufficient padding on the end of it for u-boot to
5376 add the information it needs into it, and the memory
5377 must be accessible by the kernel.
5378
eea63e05
SG
5379 fdtcontroladdr- if set this is the address of the control flattened
5380 device tree used by U-Boot when CONFIG_OF_CONTROL is
5381 defined.
5382
17ea1177
WD
5383 i2cfast - (PPC405GP|PPC405EP only)
5384 if set to 'y' configures Linux I2C driver for fast
5385 mode (400kHZ). This environment variable is used in
5386 initialization code. So, for changes to be effective
5387 it must be saved and board must be reset.
5388
2729af9d
WD
5389 initrd_high - restrict positioning of initrd images:
5390 If this variable is not set, initrd images will be
5391 copied to the highest possible address in RAM; this
5392 is usually what you want since it allows for
5393 maximum initrd size. If for some reason you want to
5394 make sure that the initrd image is loaded below the
6d0f6bcf 5395 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d
WD
5396 variable to a value of "no" or "off" or "0".
5397 Alternatively, you can set it to a maximum upper
5398 address to use (U-Boot will still check that it
5399 does not overwrite the U-Boot stack and data).
c609719b 5400
2729af9d
WD
5401 For instance, when you have a system with 16 MB
5402 RAM, and want to reserve 4 MB from use by Linux,
5403 you can do this by adding "mem=12M" to the value of
5404 the "bootargs" variable. However, now you must make
5405 sure that the initrd image is placed in the first
5406 12 MB as well - this can be done with
c609719b 5407
2729af9d 5408 setenv initrd_high 00c00000
c609719b 5409
2729af9d
WD
5410 If you set initrd_high to 0xFFFFFFFF, this is an
5411 indication to U-Boot that all addresses are legal
5412 for the Linux kernel, including addresses in flash
5413 memory. In this case U-Boot will NOT COPY the
5414 ramdisk at all. This may be useful to reduce the
5415 boot time on your system, but requires that this
5416 feature is supported by your Linux kernel.
c609719b 5417
2729af9d 5418 ipaddr - IP address; needed for tftpboot command
c609719b 5419
2729af9d
WD
5420 loadaddr - Default load address for commands like "bootp",
5421 "rarpboot", "tftpboot", "loadb" or "diskboot"
c609719b 5422
2729af9d 5423 loads_echo - see CONFIG_LOADS_ECHO
a3d991bd 5424
2729af9d 5425 serverip - TFTP server IP address; needed for tftpboot command
a3d991bd 5426
2729af9d 5427 bootretry - see CONFIG_BOOT_RETRY_TIME
a3d991bd 5428
2729af9d 5429 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
a3d991bd 5430
2729af9d 5431 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
c609719b 5432
e2a53458 5433 ethprime - controls which interface is used first.
c609719b 5434
e2a53458
MF
5435 ethact - controls which interface is currently active.
5436 For example you can do the following
c609719b 5437
48690d80
HS
5438 => setenv ethact FEC
5439 => ping 192.168.0.1 # traffic sent on FEC
5440 => setenv ethact SCC
5441 => ping 10.0.0.1 # traffic sent on SCC
c609719b 5442
e1692577
MF
5443 ethrotate - When set to "no" U-Boot does not go through all
5444 available network interfaces.
5445 It just stays at the currently selected interface.
5446
c96f86ee 5447 netretry - When set to "no" each network operation will
2729af9d
WD
5448 either succeed or fail without retrying.
5449 When set to "once" the network operation will
5450 fail when all the available network interfaces
5451 are tried once without success.
5452 Useful on scripts which control the retry operation
5453 themselves.
c609719b 5454
b4e2f89d 5455 npe_ucode - set load address for the NPE microcode
a1cf027a 5456
8d51aacd
SG
5457 silent_linux - If set then linux will be told to boot silently, by
5458 changing the console to be empty. If "yes" it will be
5459 made silent. If "no" it will not be made silent. If
5460 unset, then it will be made silent if the U-Boot console
5461 is silent.
5462
28cb9375 5463 tftpsrcport - If this is set, the value is used for TFTP's
ecb0ccd9
WD
5464 UDP source port.
5465
28cb9375
WD
5466 tftpdstport - If this is set, the value is used for TFTP's UDP
5467 destination port instead of the Well Know Port 69.
5468
c96f86ee
WD
5469 tftpblocksize - Block size to use for TFTP transfers; if not set,
5470 we use the TFTP server's default block size
5471
5472 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5473 seconds, minimum value is 1000 = 1 second). Defines
5474 when a packet is considered to be lost so it has to
5475 be retransmitted. The default is 5000 = 5 seconds.
5476 Lowering this value may make downloads succeed
5477 faster in networks with high packet loss rates or
5478 with unreliable TFTP servers.
5479
5480 vlan - When set to a value < 4095 the traffic over
11ccc33f 5481 Ethernet is encapsulated/received over 802.1q
2729af9d 5482 VLAN tagged frames.
c609719b 5483
dc0b7b0e
JH
5484The following image location variables contain the location of images
5485used in booting. The "Image" column gives the role of the image and is
5486not an environment variable name. The other columns are environment
5487variable names. "File Name" gives the name of the file on a TFTP
5488server, "RAM Address" gives the location in RAM the image will be
5489loaded to, and "Flash Location" gives the image's address in NOR
5490flash or offset in NAND flash.
5491
5492*Note* - these variables don't have to be defined for all boards, some
5493boards currenlty use other variables for these purposes, and some
5494boards use these variables for other purposes.
5495
c0f40859
WD
5496Image File Name RAM Address Flash Location
5497----- --------- ----------- --------------
5498u-boot u-boot u-boot_addr_r u-boot_addr
5499Linux kernel bootfile kernel_addr_r kernel_addr
5500device tree blob fdtfile fdt_addr_r fdt_addr
5501ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
dc0b7b0e 5502
2729af9d
WD
5503The following environment variables may be used and automatically
5504updated by the network boot commands ("bootp" and "rarpboot"),
5505depending the information provided by your boot server:
c609719b 5506
2729af9d
WD
5507 bootfile - see above
5508 dnsip - IP address of your Domain Name Server
5509 dnsip2 - IP address of your secondary Domain Name Server
5510 gatewayip - IP address of the Gateway (Router) to use
5511 hostname - Target hostname
5512 ipaddr - see above
5513 netmask - Subnet Mask
5514 rootpath - Pathname of the root filesystem on the NFS server
5515 serverip - see above
c1551ea8 5516
c1551ea8 5517
2729af9d 5518There are two special Environment Variables:
c1551ea8 5519
2729af9d
WD
5520 serial# - contains hardware identification information such
5521 as type string and/or serial number
5522 ethaddr - Ethernet address
c609719b 5523
2729af9d
WD
5524These variables can be set only once (usually during manufacturing of
5525the board). U-Boot refuses to delete or overwrite these variables
5526once they have been set once.
c609719b 5527
f07771cc 5528
2729af9d 5529Further special Environment Variables:
f07771cc 5530
2729af9d
WD
5531 ver - Contains the U-Boot version string as printed
5532 with the "version" command. This variable is
5533 readonly (see CONFIG_VERSION_VARIABLE).
f07771cc 5534
f07771cc 5535
2729af9d
WD
5536Please note that changes to some configuration parameters may take
5537only effect after the next boot (yes, that's just like Windoze :-).
f07771cc 5538
f07771cc 5539
170ab110
JH
5540Callback functions for environment variables:
5541---------------------------------------------
5542
5543For some environment variables, the behavior of u-boot needs to change
5544when their values are changed. This functionailty allows functions to
5545be associated with arbitrary variables. On creation, overwrite, or
5546deletion, the callback will provide the opportunity for some side
5547effect to happen or for the change to be rejected.
5548
5549The callbacks are named and associated with a function using the
5550U_BOOT_ENV_CALLBACK macro in your board or driver code.
5551
5552These callbacks are associated with variables in one of two ways. The
5553static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5554in the board configuration to a string that defines a list of
5555associations. The list must be in the following format:
5556
5557 entry = variable_name[:callback_name]
5558 list = entry[,list]
5559
5560If the callback name is not specified, then the callback is deleted.
5561Spaces are also allowed anywhere in the list.
5562
5563Callbacks can also be associated by defining the ".callbacks" variable
5564with the same list format above. Any association in ".callbacks" will
5565override any association in the static list. You can define
5566CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5567".callbacks" envirnoment variable in the default or embedded environment.
5568
5569
2729af9d
WD
5570Command Line Parsing:
5571=====================
f07771cc 5572
2729af9d
WD
5573There are two different command line parsers available with U-Boot:
5574the old "simple" one, and the much more powerful "hush" shell:
c609719b 5575
2729af9d
WD
5576Old, simple command line parser:
5577--------------------------------
c609719b 5578
2729af9d
WD
5579- supports environment variables (through setenv / saveenv commands)
5580- several commands on one line, separated by ';'
fe126d8b 5581- variable substitution using "... ${name} ..." syntax
2729af9d
WD
5582- special characters ('$', ';') can be escaped by prefixing with '\',
5583 for example:
fe126d8b 5584 setenv bootcmd bootm \${address}
2729af9d
WD
5585- You can also escape text by enclosing in single apostrophes, for example:
5586 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
c609719b 5587
2729af9d
WD
5588Hush shell:
5589-----------
c609719b 5590
2729af9d
WD
5591- similar to Bourne shell, with control structures like
5592 if...then...else...fi, for...do...done; while...do...done,
5593 until...do...done, ...
5594- supports environment ("global") variables (through setenv / saveenv
5595 commands) and local shell variables (through standard shell syntax
5596 "name=value"); only environment variables can be used with "run"
5597 command
5598
5599General rules:
5600--------------
c609719b 5601
2729af9d
WD
5602(1) If a command line (or an environment variable executed by a "run"
5603 command) contains several commands separated by semicolon, and
5604 one of these commands fails, then the remaining commands will be
5605 executed anyway.
c609719b 5606
2729af9d 5607(2) If you execute several variables with one call to run (i. e.
11ccc33f 5608 calling run with a list of variables as arguments), any failing
2729af9d
WD
5609 command will cause "run" to terminate, i. e. the remaining
5610 variables are not executed.
c609719b 5611
2729af9d
WD
5612Note for Redundant Ethernet Interfaces:
5613=======================================
c609719b 5614
11ccc33f 5615Some boards come with redundant Ethernet interfaces; U-Boot supports
2729af9d
WD
5616such configurations and is capable of automatic selection of a
5617"working" interface when needed. MAC assignment works as follows:
c609719b 5618
2729af9d
WD
5619Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5620MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5621"eth1addr" (=>eth1), "eth2addr", ...
c609719b 5622
2729af9d
WD
5623If the network interface stores some valid MAC address (for instance
5624in SROM), this is used as default address if there is NO correspon-
5625ding setting in the environment; if the corresponding environment
5626variable is set, this overrides the settings in the card; that means:
c609719b 5627
2729af9d
WD
5628o If the SROM has a valid MAC address, and there is no address in the
5629 environment, the SROM's address is used.
c609719b 5630
2729af9d
WD
5631o If there is no valid address in the SROM, and a definition in the
5632 environment exists, then the value from the environment variable is
5633 used.
c609719b 5634
2729af9d
WD
5635o If both the SROM and the environment contain a MAC address, and
5636 both addresses are the same, this MAC address is used.
c609719b 5637
2729af9d
WD
5638o If both the SROM and the environment contain a MAC address, and the
5639 addresses differ, the value from the environment is used and a
5640 warning is printed.
c609719b 5641
2729af9d
WD
5642o If neither SROM nor the environment contain a MAC address, an error
5643 is raised.
c609719b 5644
ecee9324 5645If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859 5646will be programmed into hardware as part of the initialization process. This
ecee9324
BW
5647may be skipped by setting the appropriate 'ethmacskip' environment variable.
5648The naming convention is as follows:
5649"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
c609719b 5650
2729af9d
WD
5651Image Formats:
5652==============
c609719b 5653
3310c549
MB
5654U-Boot is capable of booting (and performing other auxiliary operations on)
5655images in two formats:
5656
5657New uImage format (FIT)
5658-----------------------
5659
5660Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5661to Flattened Device Tree). It allows the use of images with multiple
5662components (several kernels, ramdisks, etc.), with contents protected by
5663SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5664
5665
5666Old uImage format
5667-----------------
5668
5669Old image format is based on binary files which can be basically anything,
5670preceded by a special header; see the definitions in include/image.h for
5671details; basically, the header defines the following image properties:
c609719b 5672
2729af9d
WD
5673* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5674 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
f5ed9e39
PT
5675 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5676 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5677 INTEGRITY).
7b64fef3 5678* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
afc1ce82
ML
5679 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5680 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2729af9d
WD
5681* Compression Type (uncompressed, gzip, bzip2)
5682* Load Address
5683* Entry Point
5684* Image Name
5685* Image Timestamp
c609719b 5686
2729af9d
WD
5687The header is marked by a special Magic Number, and both the header
5688and the data portions of the image are secured against corruption by
5689CRC32 checksums.
c609719b
WD
5690
5691
2729af9d
WD
5692Linux Support:
5693==============
c609719b 5694
2729af9d
WD
5695Although U-Boot should support any OS or standalone application
5696easily, the main focus has always been on Linux during the design of
5697U-Boot.
c609719b 5698
2729af9d
WD
5699U-Boot includes many features that so far have been part of some
5700special "boot loader" code within the Linux kernel. Also, any
5701"initrd" images to be used are no longer part of one big Linux image;
5702instead, kernel and "initrd" are separate images. This implementation
5703serves several purposes:
c609719b 5704
2729af9d
WD
5705- the same features can be used for other OS or standalone
5706 applications (for instance: using compressed images to reduce the
5707 Flash memory footprint)
c609719b 5708
2729af9d
WD
5709- it becomes much easier to port new Linux kernel versions because
5710 lots of low-level, hardware dependent stuff are done by U-Boot
c609719b 5711
2729af9d
WD
5712- the same Linux kernel image can now be used with different "initrd"
5713 images; of course this also means that different kernel images can
5714 be run with the same "initrd". This makes testing easier (you don't
5715 have to build a new "zImage.initrd" Linux image when you just
5716 change a file in your "initrd"). Also, a field-upgrade of the
5717 software is easier now.
c609719b 5718
c609719b 5719
2729af9d
WD
5720Linux HOWTO:
5721============
c609719b 5722
2729af9d
WD
5723Porting Linux to U-Boot based systems:
5724---------------------------------------
c609719b 5725
2729af9d
WD
5726U-Boot cannot save you from doing all the necessary modifications to
5727configure the Linux device drivers for use with your target hardware
5728(no, we don't intend to provide a full virtual machine interface to
5729Linux :-).
c609719b 5730
a47a12be 5731But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
24ee89b9 5732
2729af9d
WD
5733Just make sure your machine specific header file (for instance
5734include/asm-ppc/tqm8xx.h) includes the same definition of the Board
1dc30693
MH
5735Information structure as we define in include/asm-<arch>/u-boot.h,
5736and make sure that your definition of IMAP_ADDR uses the same value
6d0f6bcf 5737as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b9 5738
2eb31b13
SG
5739Note that U-Boot now has a driver model, a unified model for drivers.
5740If you are adding a new driver, plumb it into driver model. If there
5741is no uclass available, you are encouraged to create one. See
5742doc/driver-model.
5743
c609719b 5744
2729af9d
WD
5745Configuring the Linux kernel:
5746-----------------------------
c609719b 5747
2729af9d
WD
5748No specific requirements for U-Boot. Make sure you have some root
5749device (initial ramdisk, NFS) for your target system.
5750
5751
5752Building a Linux Image:
5753-----------------------
c609719b 5754
2729af9d
WD
5755With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5756not used. If you use recent kernel source, a new build target
5757"uImage" will exist which automatically builds an image usable by
5758U-Boot. Most older kernels also have support for a "pImage" target,
5759which was introduced for our predecessor project PPCBoot and uses a
5760100% compatible format.
5761
5762Example:
5763
ab584d67 5764 make TQM850L_defconfig
2729af9d
WD
5765 make oldconfig
5766 make dep
5767 make uImage
5768
5769The "uImage" build target uses a special tool (in 'tools/mkimage') to
5770encapsulate a compressed Linux kernel image with header information,
5771CRC32 checksum etc. for use with U-Boot. This is what we are doing:
5772
5773* build a standard "vmlinux" kernel image (in ELF binary format):
5774
5775* convert the kernel into a raw binary image:
5776
5777 ${CROSS_COMPILE}-objcopy -O binary \
5778 -R .note -R .comment \
5779 -S vmlinux linux.bin
5780
5781* compress the binary image:
5782
5783 gzip -9 linux.bin
5784
5785* package compressed binary image for U-Boot:
5786
5787 mkimage -A ppc -O linux -T kernel -C gzip \
5788 -a 0 -e 0 -n "Linux Kernel Image" \
5789 -d linux.bin.gz uImage
c609719b 5790
c609719b 5791
2729af9d
WD
5792The "mkimage" tool can also be used to create ramdisk images for use
5793with U-Boot, either separated from the Linux kernel image, or
5794combined into one file. "mkimage" encapsulates the images with a 64
5795byte header containing information about target architecture,
5796operating system, image type, compression method, entry points, time
5797stamp, CRC32 checksums, etc.
5798
5799"mkimage" can be called in two ways: to verify existing images and
5800print the header information, or to build new images.
5801
5802In the first form (with "-l" option) mkimage lists the information
5803contained in the header of an existing U-Boot image; this includes
5804checksum verification:
c609719b 5805
2729af9d
WD
5806 tools/mkimage -l image
5807 -l ==> list image header information
5808
5809The second form (with "-d" option) is used to build a U-Boot image
5810from a "data file" which is used as image payload:
5811
5812 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5813 -n name -d data_file image
5814 -A ==> set architecture to 'arch'
5815 -O ==> set operating system to 'os'
5816 -T ==> set image type to 'type'
5817 -C ==> set compression type 'comp'
5818 -a ==> set load address to 'addr' (hex)
5819 -e ==> set entry point to 'ep' (hex)
5820 -n ==> set image name to 'name'
5821 -d ==> use image data from 'datafile'
5822
69459791
WD
5823Right now, all Linux kernels for PowerPC systems use the same load
5824address (0x00000000), but the entry point address depends on the
5825kernel version:
2729af9d
WD
5826
5827- 2.2.x kernels have the entry point at 0x0000000C,
5828- 2.3.x and later kernels have the entry point at 0x00000000.
5829
5830So a typical call to build a U-Boot image would read:
5831
5832 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5833 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
a47a12be 5834 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d
WD
5835 > examples/uImage.TQM850L
5836 Image Name: 2.4.4 kernel for TQM850L
5837 Created: Wed Jul 19 02:34:59 2000
5838 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5839 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5840 Load Address: 0x00000000
5841 Entry Point: 0x00000000
5842
5843To verify the contents of the image (or check for corruption):
5844
5845 -> tools/mkimage -l examples/uImage.TQM850L
5846 Image Name: 2.4.4 kernel for TQM850L
5847 Created: Wed Jul 19 02:34:59 2000
5848 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5849 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5850 Load Address: 0x00000000
5851 Entry Point: 0x00000000
5852
5853NOTE: for embedded systems where boot time is critical you can trade
5854speed for memory and install an UNCOMPRESSED image instead: this
5855needs more space in Flash, but boots much faster since it does not
5856need to be uncompressed:
5857
a47a12be 5858 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d
WD
5859 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5860 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
a47a12be 5861 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d
WD
5862 > examples/uImage.TQM850L-uncompressed
5863 Image Name: 2.4.4 kernel for TQM850L
5864 Created: Wed Jul 19 02:34:59 2000
5865 Image Type: PowerPC Linux Kernel Image (uncompressed)
5866 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5867 Load Address: 0x00000000
5868 Entry Point: 0x00000000
5869
5870
5871Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5872when your kernel is intended to use an initial ramdisk:
5873
5874 -> tools/mkimage -n 'Simple Ramdisk Image' \
5875 > -A ppc -O linux -T ramdisk -C gzip \
5876 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5877 Image Name: Simple Ramdisk Image
5878 Created: Wed Jan 12 14:01:50 2000
5879 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5880 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5881 Load Address: 0x00000000
5882 Entry Point: 0x00000000
5883
a804b5ce
GMF
5884The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5885option performs the converse operation of the mkimage's second form (the "-d"
5886option). Given an image built by mkimage, the dumpimage extracts a "data file"
5887from the image:
5888
5889 tools/dumpimage -i image -p position data_file
5890 -i ==> extract from the 'image' a specific 'data_file', \
5891 indexed by 'position'
5892
2729af9d
WD
5893
5894Installing a Linux Image:
5895-------------------------
5896
5897To downloading a U-Boot image over the serial (console) interface,
5898you must convert the image to S-Record format:
5899
5900 objcopy -I binary -O srec examples/image examples/image.srec
5901
5902The 'objcopy' does not understand the information in the U-Boot
5903image header, so the resulting S-Record file will be relative to
5904address 0x00000000. To load it to a given address, you need to
5905specify the target address as 'offset' parameter with the 'loads'
5906command.
5907
5908Example: install the image to address 0x40100000 (which on the
5909TQM8xxL is in the first Flash bank):
5910
5911 => erase 40100000 401FFFFF
5912
5913 .......... done
5914 Erased 8 sectors
5915
5916 => loads 40100000
5917 ## Ready for S-Record download ...
5918 ~>examples/image.srec
5919 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5920 ...
5921 15989 15990 15991 15992
5922 [file transfer complete]
5923 [connected]
5924 ## Start Addr = 0x00000000
5925
5926
5927You can check the success of the download using the 'iminfo' command;
218ca724 5928this includes a checksum verification so you can be sure no data
2729af9d
WD
5929corruption happened:
5930
5931 => imi 40100000
5932
5933 ## Checking Image at 40100000 ...
5934 Image Name: 2.2.13 for initrd on TQM850L
5935 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5936 Data Size: 335725 Bytes = 327 kB = 0 MB
5937 Load Address: 00000000
5938 Entry Point: 0000000c
5939 Verifying Checksum ... OK
5940
5941
5942Boot Linux:
5943-----------
5944
5945The "bootm" command is used to boot an application that is stored in
5946memory (RAM or Flash). In case of a Linux kernel image, the contents
5947of the "bootargs" environment variable is passed to the kernel as
5948parameters. You can check and modify this variable using the
5949"printenv" and "setenv" commands:
5950
5951
5952 => printenv bootargs
5953 bootargs=root=/dev/ram
5954
5955 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5956
5957 => printenv bootargs
5958 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5959
5960 => bootm 40020000
5961 ## Booting Linux kernel at 40020000 ...
5962 Image Name: 2.2.13 for NFS on TQM850L
5963 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5964 Data Size: 381681 Bytes = 372 kB = 0 MB
5965 Load Address: 00000000
5966 Entry Point: 0000000c
5967 Verifying Checksum ... OK
5968 Uncompressing Kernel Image ... OK
5969 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
5970 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5971 time_init: decrementer frequency = 187500000/60
5972 Calibrating delay loop... 49.77 BogoMIPS
5973 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5974 ...
5975
11ccc33f 5976If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d
WD
5977the memory addresses of both the kernel and the initrd image (PPBCOOT
5978format!) to the "bootm" command:
5979
5980 => imi 40100000 40200000
5981
5982 ## Checking Image at 40100000 ...
5983 Image Name: 2.2.13 for initrd on TQM850L
5984 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5985 Data Size: 335725 Bytes = 327 kB = 0 MB
5986 Load Address: 00000000
5987 Entry Point: 0000000c
5988 Verifying Checksum ... OK
5989
5990 ## Checking Image at 40200000 ...
5991 Image Name: Simple Ramdisk Image
5992 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5993 Data Size: 566530 Bytes = 553 kB = 0 MB
5994 Load Address: 00000000
5995 Entry Point: 00000000
5996 Verifying Checksum ... OK
5997
5998 => bootm 40100000 40200000
5999 ## Booting Linux kernel at 40100000 ...
6000 Image Name: 2.2.13 for initrd on TQM850L
6001 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6002 Data Size: 335725 Bytes = 327 kB = 0 MB
6003 Load Address: 00000000
6004 Entry Point: 0000000c
6005 Verifying Checksum ... OK
6006 Uncompressing Kernel Image ... OK
6007 ## Loading RAMDisk Image at 40200000 ...
6008 Image Name: Simple Ramdisk Image
6009 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6010 Data Size: 566530 Bytes = 553 kB = 0 MB
6011 Load Address: 00000000
6012 Entry Point: 00000000
6013 Verifying Checksum ... OK
6014 Loading Ramdisk ... OK
6015 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
6016 Boot arguments: root=/dev/ram
6017 time_init: decrementer frequency = 187500000/60
6018 Calibrating delay loop... 49.77 BogoMIPS
6019 ...
6020 RAMDISK: Compressed image found at block 0
6021 VFS: Mounted root (ext2 filesystem).
6022
6023 bash#
6024
0267768e
MM
6025Boot Linux and pass a flat device tree:
6026-----------
6027
6028First, U-Boot must be compiled with the appropriate defines. See the section
6029titled "Linux Kernel Interface" above for a more in depth explanation. The
6030following is an example of how to start a kernel and pass an updated
6031flat device tree:
6032
6033=> print oftaddr
6034oftaddr=0x300000
6035=> print oft
6036oft=oftrees/mpc8540ads.dtb
6037=> tftp $oftaddr $oft
6038Speed: 1000, full duplex
6039Using TSEC0 device
6040TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6041Filename 'oftrees/mpc8540ads.dtb'.
6042Load address: 0x300000
6043Loading: #
6044done
6045Bytes transferred = 4106 (100a hex)
6046=> tftp $loadaddr $bootfile
6047Speed: 1000, full duplex
6048Using TSEC0 device
6049TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6050Filename 'uImage'.
6051Load address: 0x200000
6052Loading:############
6053done
6054Bytes transferred = 1029407 (fb51f hex)
6055=> print loadaddr
6056loadaddr=200000
6057=> print oftaddr
6058oftaddr=0x300000
6059=> bootm $loadaddr - $oftaddr
6060## Booting image at 00200000 ...
a9398e01
WD
6061 Image Name: Linux-2.6.17-dirty
6062 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6063 Data Size: 1029343 Bytes = 1005.2 kB
0267768e 6064 Load Address: 00000000
a9398e01 6065 Entry Point: 00000000
0267768e
MM
6066 Verifying Checksum ... OK
6067 Uncompressing Kernel Image ... OK
6068Booting using flat device tree at 0x300000
6069Using MPC85xx ADS machine description
6070Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6071[snip]
6072
6073
2729af9d
WD
6074More About U-Boot Image Types:
6075------------------------------
6076
6077U-Boot supports the following image types:
6078
6079 "Standalone Programs" are directly runnable in the environment
6080 provided by U-Boot; it is expected that (if they behave
6081 well) you can continue to work in U-Boot after return from
6082 the Standalone Program.
6083 "OS Kernel Images" are usually images of some Embedded OS which
6084 will take over control completely. Usually these programs
6085 will install their own set of exception handlers, device
6086 drivers, set up the MMU, etc. - this means, that you cannot
6087 expect to re-enter U-Boot except by resetting the CPU.
6088 "RAMDisk Images" are more or less just data blocks, and their
6089 parameters (address, size) are passed to an OS kernel that is
6090 being started.
6091 "Multi-File Images" contain several images, typically an OS
6092 (Linux) kernel image and one or more data images like
6093 RAMDisks. This construct is useful for instance when you want
6094 to boot over the network using BOOTP etc., where the boot
6095 server provides just a single image file, but you want to get
6096 for instance an OS kernel and a RAMDisk image.
6097
6098 "Multi-File Images" start with a list of image sizes, each
6099 image size (in bytes) specified by an "uint32_t" in network
6100 byte order. This list is terminated by an "(uint32_t)0".
6101 Immediately after the terminating 0 follow the images, one by
6102 one, all aligned on "uint32_t" boundaries (size rounded up to
6103 a multiple of 4 bytes).
6104
6105 "Firmware Images" are binary images containing firmware (like
6106 U-Boot or FPGA images) which usually will be programmed to
6107 flash memory.
6108
6109 "Script files" are command sequences that will be executed by
6110 U-Boot's command interpreter; this feature is especially
6111 useful when you configure U-Boot to use a real shell (hush)
6112 as command interpreter.
6113
44f074c7
MV
6114Booting the Linux zImage:
6115-------------------------
6116
6117On some platforms, it's possible to boot Linux zImage. This is done
6118using the "bootz" command. The syntax of "bootz" command is the same
6119as the syntax of "bootm" command.
6120
8ac28563 6121Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
017e1f3f
MV
6122kernel with raw initrd images. The syntax is slightly different, the
6123address of the initrd must be augmented by it's size, in the following
6124format: "<initrd addres>:<initrd size>".
6125
2729af9d
WD
6126
6127Standalone HOWTO:
6128=================
6129
6130One of the features of U-Boot is that you can dynamically load and
6131run "standalone" applications, which can use some resources of
6132U-Boot like console I/O functions or interrupt services.
6133
6134Two simple examples are included with the sources:
6135
6136"Hello World" Demo:
6137-------------------
6138
6139'examples/hello_world.c' contains a small "Hello World" Demo
6140application; it is automatically compiled when you build U-Boot.
6141It's configured to run at address 0x00040004, so you can play with it
6142like that:
6143
6144 => loads
6145 ## Ready for S-Record download ...
6146 ~>examples/hello_world.srec
6147 1 2 3 4 5 6 7 8 9 10 11 ...
6148 [file transfer complete]
6149 [connected]
6150 ## Start Addr = 0x00040004
6151
6152 => go 40004 Hello World! This is a test.
6153 ## Starting application at 0x00040004 ...
6154 Hello World
6155 argc = 7
6156 argv[0] = "40004"
6157 argv[1] = "Hello"
6158 argv[2] = "World!"
6159 argv[3] = "This"
6160 argv[4] = "is"
6161 argv[5] = "a"
6162 argv[6] = "test."
6163 argv[7] = "<NULL>"
6164 Hit any key to exit ...
6165
6166 ## Application terminated, rc = 0x0
6167
6168Another example, which demonstrates how to register a CPM interrupt
6169handler with the U-Boot code, can be found in 'examples/timer.c'.
6170Here, a CPM timer is set up to generate an interrupt every second.
6171The interrupt service routine is trivial, just printing a '.'
6172character, but this is just a demo program. The application can be
6173controlled by the following keys:
6174
6175 ? - print current values og the CPM Timer registers
6176 b - enable interrupts and start timer
6177 e - stop timer and disable interrupts
6178 q - quit application
6179
6180 => loads
6181 ## Ready for S-Record download ...
6182 ~>examples/timer.srec
6183 1 2 3 4 5 6 7 8 9 10 11 ...
6184 [file transfer complete]
6185 [connected]
6186 ## Start Addr = 0x00040004
6187
6188 => go 40004
6189 ## Starting application at 0x00040004 ...
6190 TIMERS=0xfff00980
6191 Using timer 1
6192 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6193
6194Hit 'b':
6195 [q, b, e, ?] Set interval 1000000 us
6196 Enabling timer
6197Hit '?':
6198 [q, b, e, ?] ........
6199 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6200Hit '?':
6201 [q, b, e, ?] .
6202 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6203Hit '?':
6204 [q, b, e, ?] .
6205 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6206Hit '?':
6207 [q, b, e, ?] .
6208 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6209Hit 'e':
6210 [q, b, e, ?] ...Stopping timer
6211Hit 'q':
6212 [q, b, e, ?] ## Application terminated, rc = 0x0
6213
6214
6215Minicom warning:
6216================
6217
6218Over time, many people have reported problems when trying to use the
6219"minicom" terminal emulation program for serial download. I (wd)
6220consider minicom to be broken, and recommend not to use it. Under
6221Unix, I recommend to use C-Kermit for general purpose use (and
6222especially for kermit binary protocol download ("loadb" command), and
e53515a2
KP
6223use "cu" for S-Record download ("loads" command). See
6224http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6225for help with kermit.
6226
2729af9d
WD
6227
6228Nevertheless, if you absolutely want to use it try adding this
6229configuration to your "File transfer protocols" section:
6230
6231 Name Program Name U/D FullScr IO-Red. Multi
6232 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6233 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
6234
6235
6236NetBSD Notes:
6237=============
6238
6239Starting at version 0.9.2, U-Boot supports NetBSD both as host
6240(build U-Boot) and target system (boots NetBSD/mpc8xx).
6241
6242Building requires a cross environment; it is known to work on
6243NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6244need gmake since the Makefiles are not compatible with BSD make).
6245Note that the cross-powerpc package does not install include files;
6246attempting to build U-Boot will fail because <machine/ansi.h> is
6247missing. This file has to be installed and patched manually:
6248
6249 # cd /usr/pkg/cross/powerpc-netbsd/include
6250 # mkdir powerpc
6251 # ln -s powerpc machine
6252 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6253 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
6254
6255Native builds *don't* work due to incompatibilities between native
6256and U-Boot include files.
6257
6258Booting assumes that (the first part of) the image booted is a
6259stage-2 loader which in turn loads and then invokes the kernel
6260proper. Loader sources will eventually appear in the NetBSD source
6261tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2a8af187 6262meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d
WD
6263
6264
6265Implementation Internals:
6266=========================
6267
6268The following is not intended to be a complete description of every
6269implementation detail. However, it should help to understand the
6270inner workings of U-Boot and make it easier to port it to custom
6271hardware.
6272
6273
6274Initial Stack, Global Data:
6275---------------------------
6276
6277The implementation of U-Boot is complicated by the fact that U-Boot
6278starts running out of ROM (flash memory), usually without access to
6279system RAM (because the memory controller is not initialized yet).
6280This means that we don't have writable Data or BSS segments, and BSS
6281is not initialized as zero. To be able to get a C environment working
6282at all, we have to allocate at least a minimal stack. Implementation
6283options for this are defined and restricted by the CPU used: Some CPU
6284models provide on-chip memory (like the IMMR area on MPC8xx and
6285MPC826x processors), on others (parts of) the data cache can be
6286locked as (mis-) used as memory, etc.
6287
218ca724 6288 Chris Hallinan posted a good summary of these issues to the
0668236b 6289 U-Boot mailing list:
2729af9d
WD
6290
6291 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6292 From: "Chris Hallinan" <clh@net1plus.com>
6293 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6294 ...
6295
6296 Correct me if I'm wrong, folks, but the way I understand it
6297 is this: Using DCACHE as initial RAM for Stack, etc, does not
6298 require any physical RAM backing up the cache. The cleverness
6299 is that the cache is being used as a temporary supply of
6300 necessary storage before the SDRAM controller is setup. It's
11ccc33f 6301 beyond the scope of this list to explain the details, but you
2729af9d
WD
6302 can see how this works by studying the cache architecture and
6303 operation in the architecture and processor-specific manuals.
6304
6305 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6306 is another option for the system designer to use as an
11ccc33f 6307 initial stack/RAM area prior to SDRAM being available. Either
2729af9d
WD
6308 option should work for you. Using CS 4 should be fine if your
6309 board designers haven't used it for something that would
6310 cause you grief during the initial boot! It is frequently not
6311 used.
6312
6d0f6bcf 6313 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d
WD
6314 with your processor/board/system design. The default value
6315 you will find in any recent u-boot distribution in
8a316c9b 6316 walnut.h should work for you. I'd set it to a value larger
2729af9d
WD
6317 than your SDRAM module. If you have a 64MB SDRAM module, set
6318 it above 400_0000. Just make sure your board has no resources
6319 that are supposed to respond to that address! That code in
6320 start.S has been around a while and should work as is when
6321 you get the config right.
6322
6323 -Chris Hallinan
6324 DS4.COM, Inc.
6325
6326It is essential to remember this, since it has some impact on the C
6327code for the initialization procedures:
6328
6329* Initialized global data (data segment) is read-only. Do not attempt
6330 to write it.
6331
11ccc33f 6332* Do not use any uninitialized global data (or implicitely initialized
2729af9d
WD
6333 as zero data - BSS segment) at all - this is undefined, initiali-
6334 zation is performed later (when relocating to RAM).
6335
6336* Stack space is very limited. Avoid big data buffers or things like
6337 that.
6338
6339Having only the stack as writable memory limits means we cannot use
6340normal global data to share information beween the code. But it
6341turned out that the implementation of U-Boot can be greatly
6342simplified by making a global data structure (gd_t) available to all
6343functions. We could pass a pointer to this data as argument to _all_
6344functions, but this would bloat the code. Instead we use a feature of
6345the GCC compiler (Global Register Variables) to share the data: we
6346place a pointer (gd) to the global data into a register which we
6347reserve for this purpose.
6348
6349When choosing a register for such a purpose we are restricted by the
6350relevant (E)ABI specifications for the current architecture, and by
6351GCC's implementation.
6352
6353For PowerPC, the following registers have specific use:
6354 R1: stack pointer
e7670f6c 6355 R2: reserved for system use
2729af9d
WD
6356 R3-R4: parameter passing and return values
6357 R5-R10: parameter passing
6358 R13: small data area pointer
6359 R30: GOT pointer
6360 R31: frame pointer
6361
e6bee808
JT
6362 (U-Boot also uses R12 as internal GOT pointer. r12
6363 is a volatile register so r12 needs to be reset when
6364 going back and forth between asm and C)
2729af9d 6365
e7670f6c 6366 ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d
WD
6367
6368 Note: on PPC, we could use a static initializer (since the
6369 address of the global data structure is known at compile time),
6370 but it turned out that reserving a register results in somewhat
6371 smaller code - although the code savings are not that big (on
6372 average for all boards 752 bytes for the whole U-Boot image,
6373 624 text + 127 data).
6374
c4db335c 6375On Blackfin, the normal C ABI (except for P3) is followed as documented here:
4c58eb55
MF
6376 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6377
c4db335c 6378 ==> U-Boot will use P3 to hold a pointer to the global data
4c58eb55 6379
2729af9d
WD
6380On ARM, the following registers are used:
6381
6382 R0: function argument word/integer result
6383 R1-R3: function argument word
12eba1b4
JH
6384 R9: platform specific
6385 R10: stack limit (used only if stack checking is enabled)
2729af9d
WD
6386 R11: argument (frame) pointer
6387 R12: temporary workspace
6388 R13: stack pointer
6389 R14: link register
6390 R15: program counter
6391
12eba1b4
JH
6392 ==> U-Boot will use R9 to hold a pointer to the global data
6393
6394 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
2729af9d 6395
0df01fd3
TC
6396On Nios II, the ABI is documented here:
6397 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6398
6399 ==> U-Boot will use gp to hold a pointer to the global data
6400
6401 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6402 to access small data sections, so gp is free.
6403
afc1ce82
ML
6404On NDS32, the following registers are used:
6405
6406 R0-R1: argument/return
6407 R2-R5: argument
6408 R15: temporary register for assembler
6409 R16: trampoline register
6410 R28: frame pointer (FP)
6411 R29: global pointer (GP)
6412 R30: link register (LP)
6413 R31: stack pointer (SP)
6414 PC: program counter (PC)
6415
6416 ==> U-Boot will use R10 to hold a pointer to the global data
6417
d87080b7
WD
6418NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6419or current versions of GCC may "optimize" the code too much.
2729af9d
WD
6420
6421Memory Management:
6422------------------
6423
6424U-Boot runs in system state and uses physical addresses, i.e. the
6425MMU is not used either for address mapping nor for memory protection.
6426
6427The available memory is mapped to fixed addresses using the memory
6428controller. In this process, a contiguous block is formed for each
6429memory type (Flash, SDRAM, SRAM), even when it consists of several
6430physical memory banks.
6431
6432U-Boot is installed in the first 128 kB of the first Flash bank (on
6433TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6434booting and sizing and initializing DRAM, the code relocates itself
6435to the upper end of DRAM. Immediately below the U-Boot code some
6d0f6bcf 6436memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d
WD
6437configuration setting]. Below that, a structure with global Board
6438Info data is placed, followed by the stack (growing downward).
6439
6440Additionally, some exception handler code is copied to the low 8 kB
6441of DRAM (0x00000000 ... 0x00001FFF).
6442
6443So a typical memory configuration with 16 MB of DRAM could look like
6444this:
6445
6446 0x0000 0000 Exception Vector code
6447 :
6448 0x0000 1FFF
6449 0x0000 2000 Free for Application Use
6450 :
6451 :
6452
6453 :
6454 :
6455 0x00FB FF20 Monitor Stack (Growing downward)
6456 0x00FB FFAC Board Info Data and permanent copy of global data
6457 0x00FC 0000 Malloc Arena
6458 :
6459 0x00FD FFFF
6460 0x00FE 0000 RAM Copy of Monitor Code
6461 ... eventually: LCD or video framebuffer
6462 ... eventually: pRAM (Protected RAM - unchanged by reset)
6463 0x00FF FFFF [End of RAM]
6464
6465
6466System Initialization:
6467----------------------
c609719b 6468
2729af9d 6469In the reset configuration, U-Boot starts at the reset entry point
11ccc33f 6470(on most PowerPC systems at address 0x00000100). Because of the reset
2729af9d
WD
6471configuration for CS0# this is a mirror of the onboard Flash memory.
6472To be able to re-map memory U-Boot then jumps to its link address.
6473To be able to implement the initialization code in C, a (small!)
6474initial stack is set up in the internal Dual Ported RAM (in case CPUs
6475which provide such a feature like MPC8xx or MPC8260), or in a locked
6476part of the data cache. After that, U-Boot initializes the CPU core,
6477the caches and the SIU.
6478
6479Next, all (potentially) available memory banks are mapped using a
6480preliminary mapping. For example, we put them on 512 MB boundaries
6481(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6482on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6483programmed for SDRAM access. Using the temporary configuration, a
6484simple memory test is run that determines the size of the SDRAM
6485banks.
6486
6487When there is more than one SDRAM bank, and the banks are of
6488different size, the largest is mapped first. For equal size, the first
6489bank (CS2#) is mapped first. The first mapping is always for address
64900x00000000, with any additional banks following immediately to create
6491contiguous memory starting from 0.
6492
6493Then, the monitor installs itself at the upper end of the SDRAM area
6494and allocates memory for use by malloc() and for the global Board
6495Info data; also, the exception vector code is copied to the low RAM
6496pages, and the final stack is set up.
6497
6498Only after this relocation will you have a "normal" C environment;
6499until that you are restricted in several ways, mostly because you are
6500running from ROM, and because the code will have to be relocated to a
6501new address in RAM.
6502
6503
6504U-Boot Porting Guide:
6505----------------------
c609719b 6506
2729af9d
WD
6507[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6508list, October 2002]
c609719b
WD
6509
6510
6c3fef28 6511int main(int argc, char *argv[])
2729af9d
WD
6512{
6513 sighandler_t no_more_time;
c609719b 6514
6c3fef28
JVB
6515 signal(SIGALRM, no_more_time);
6516 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
c609719b 6517
2729af9d 6518 if (available_money > available_manpower) {
6c3fef28 6519 Pay consultant to port U-Boot;
c609719b
WD
6520 return 0;
6521 }
6522
2729af9d
WD
6523 Download latest U-Boot source;
6524
0668236b 6525 Subscribe to u-boot mailing list;
2729af9d 6526
6c3fef28
JVB
6527 if (clueless)
6528 email("Hi, I am new to U-Boot, how do I get started?");
2729af9d
WD
6529
6530 while (learning) {
6531 Read the README file in the top level directory;
6c3fef28
JVB
6532 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6533 Read applicable doc/*.README;
2729af9d 6534 Read the source, Luke;
6c3fef28 6535 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d
WD
6536 }
6537
6c3fef28
JVB
6538 if (available_money > toLocalCurrency ($2500))
6539 Buy a BDI3000;
6540 else
2729af9d 6541 Add a lot of aggravation and time;
2729af9d 6542
6c3fef28
JVB
6543 if (a similar board exists) { /* hopefully... */
6544 cp -a board/<similar> board/<myboard>
6545 cp include/configs/<similar>.h include/configs/<myboard>.h
6546 } else {
6547 Create your own board support subdirectory;
6548 Create your own board include/configs/<myboard>.h file;
6549 }
6550 Edit new board/<myboard> files
6551 Edit new include/configs/<myboard>.h
6552
6553 while (!accepted) {
6554 while (!running) {
6555 do {
6556 Add / modify source code;
6557 } until (compiles);
6558 Debug;
6559 if (clueless)
6560 email("Hi, I am having problems...");
6561 }
6562 Send patch file to the U-Boot email list;
6563 if (reasonable critiques)
6564 Incorporate improvements from email list code review;
6565 else
6566 Defend code as written;
2729af9d 6567 }
2729af9d
WD
6568
6569 return 0;
6570}
6571
6572void no_more_time (int sig)
6573{
6574 hire_a_guru();
6575}
6576
c609719b 6577
2729af9d
WD
6578Coding Standards:
6579-----------------
c609719b 6580
2729af9d 6581All contributions to U-Boot should conform to the Linux kernel
2c051651 6582coding style; see the file "Documentation/CodingStyle" and the script
7ca9296e 6583"scripts/Lindent" in your Linux kernel source directory.
2c051651
DZ
6584
6585Source files originating from a different project (for example the
6586MTD subsystem) are generally exempt from these guidelines and are not
6587reformated to ease subsequent migration to newer versions of those
6588sources.
6589
6590Please note that U-Boot is implemented in C (and to some small parts in
6591Assembler); no C++ is used, so please do not use C++ style comments (//)
6592in your code.
c609719b 6593
2729af9d
WD
6594Please also stick to the following formatting rules:
6595- remove any trailing white space
7ca9296e 6596- use TAB characters for indentation and vertical alignment, not spaces
2729af9d 6597- make sure NOT to use DOS '\r\n' line feeds
7ca9296e 6598- do not add more than 2 consecutive empty lines to source files
2729af9d 6599- do not add trailing empty lines to source files
180d3f74 6600
2729af9d
WD
6601Submissions which do not conform to the standards may be returned
6602with a request to reformat the changes.
c609719b
WD
6603
6604
2729af9d
WD
6605Submitting Patches:
6606-------------------
c609719b 6607
2729af9d
WD
6608Since the number of patches for U-Boot is growing, we need to
6609establish some rules. Submissions which do not conform to these rules
6610may be rejected, even when they contain important and valuable stuff.
c609719b 6611
0d28f34b 6612Please see http://www.denx.de/wiki/U-Boot/Patches for details.
218ca724 6613
0668236b
WD
6614Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6615see http://lists.denx.de/mailman/listinfo/u-boot
6616
2729af9d
WD
6617When you send a patch, please include the following information with
6618it:
c609719b 6619
2729af9d
WD
6620* For bug fixes: a description of the bug and how your patch fixes
6621 this bug. Please try to include a way of demonstrating that the
6622 patch actually fixes something.
c609719b 6623
2729af9d
WD
6624* For new features: a description of the feature and your
6625 implementation.
c609719b 6626
2729af9d 6627* A CHANGELOG entry as plaintext (separate from the patch)
c609719b 6628
2729af9d 6629* For major contributions, your entry to the CREDITS file
c609719b 6630
27af930e
AA
6631* When you add support for a new board, don't forget to add a
6632 maintainer e-mail address to the boards.cfg file, too.
c609719b 6633
2729af9d
WD
6634* If your patch adds new configuration options, don't forget to
6635 document these in the README file.
c609719b 6636
218ca724
WD
6637* The patch itself. If you are using git (which is *strongly*
6638 recommended) you can easily generate the patch using the
7ca9296e 6639 "git format-patch". If you then use "git send-email" to send it to
218ca724
WD
6640 the U-Boot mailing list, you will avoid most of the common problems
6641 with some other mail clients.
6642
6643 If you cannot use git, use "diff -purN OLD NEW". If your version of
6644 diff does not support these options, then get the latest version of
6645 GNU diff.
c609719b 6646
218ca724
WD
6647 The current directory when running this command shall be the parent
6648 directory of the U-Boot source tree (i. e. please make sure that
6649 your patch includes sufficient directory information for the
6650 affected files).
6dff5529 6651
218ca724
WD
6652 We prefer patches as plain text. MIME attachments are discouraged,
6653 and compressed attachments must not be used.
c609719b 6654
2729af9d
WD
6655* If one logical set of modifications affects or creates several
6656 files, all these changes shall be submitted in a SINGLE patch file.
52f52c14 6657
2729af9d
WD
6658* Changesets that contain different, unrelated modifications shall be
6659 submitted as SEPARATE patches, one patch per changeset.
8bde7f77 6660
52f52c14 6661
2729af9d 6662Notes:
c609719b 6663
2729af9d
WD
6664* Before sending the patch, run the MAKEALL script on your patched
6665 source tree and make sure that no errors or warnings are reported
6666 for any of the boards.
c609719b 6667
2729af9d
WD
6668* Keep your modifications to the necessary minimum: A patch
6669 containing several unrelated changes or arbitrary reformats will be
6670 returned with a request to re-formatting / split it.
c609719b 6671
2729af9d
WD
6672* If you modify existing code, make sure that your new code does not
6673 add to the memory footprint of the code ;-) Small is beautiful!
6674 When adding new features, these should compile conditionally only
6675 (using #ifdef), and the resulting code with the new feature
6676 disabled must not need more memory than the old code without your
6677 modification.
90dc6704 6678
0668236b
WD
6679* Remember that there is a size limit of 100 kB per message on the
6680 u-boot mailing list. Bigger patches will be moderated. If they are
6681 reasonable and not too big, they will be acknowledged. But patches
6682 bigger than the size limit should be avoided.