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