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