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