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