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