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