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