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