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