README 166.7 KB
Newer Older
W
wdenk 已提交
1
#
W
Wolfgang Denk 已提交
2
# (C) Copyright 2000 - 2012
W
wdenk 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
#
# See file CREDITS for list of people who contributed to this
# project.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA
#

Summary:
========

27
This directory contains the source code for U-Boot, a boot loader for
W
wdenk 已提交
28 29 30 31
Embedded boards based on PowerPC, ARM, MIPS and several other
processors, which can be installed in a boot ROM and used to
initialize and test the hardware or to download and run application
code.
W
wdenk 已提交
32 33

The development of U-Boot is closely related to Linux: some parts of
34 35
the source code originate in the Linux source tree, we have some
header files in common, and special provision has been made to
W
wdenk 已提交
36 37 38 39 40 41 42 43 44 45 46 47 48 49
support booting of Linux images.

Some attention has been paid to make this software easily
configurable and extendable. For instance, all monitor commands are
implemented with the same call interface, so that it's very easy to
add new commands. Also, instead of permanently adding rarely used
code (for instance hardware test utilities) to the monitor, you can
load and run it dynamically.


Status:
=======

In general, all boards for which a configuration option exists in the
50
Makefile have been tested to some extent and can be considered
W
wdenk 已提交
51 52
"working". In fact, many of them are used in production systems.

53
In case of problems see the CHANGELOG and CREDITS files to find out
54 55
who contributed the specific port. The MAINTAINERS file lists board
maintainers.
W
wdenk 已提交
56 57 58 59 60


Where to get help:
==================

61 62
In case you have questions about, problems with or contributions for
U-Boot you should send a message to the U-Boot mailing list at
63 64 65 66
<u-boot@lists.denx.de>. There is also an archive of previous traffic
on the mailing list - please search the archive before asking FAQ's.
Please see http://lists.denx.de/pipermail/u-boot and
http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
W
wdenk 已提交
67 68


69 70 71 72 73 74 75 76
Where to get source code:
=========================

The U-Boot source code is maintained in the git repository at
git://www.denx.de/git/u-boot.git ; you can browse it online at
http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary

The "snapshot" links on this page allow you to download tarballs of
M
Marcel Ziswiler 已提交
77
any version you might be interested in. Official releases are also
78 79 80
available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
directory.

81
Pre-built (and tested) images are available from
82 83 84
ftp://ftp.denx.de/pub/u-boot/images/


W
wdenk 已提交
85 86 87 88
Where we come from:
===================

- start from 8xxrom sources
89
- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
W
wdenk 已提交
90 91 92 93 94 95 96
- clean up code
- make it easier to add custom boards
- make it possible to add other [PowerPC] CPUs
- extend functions, especially:
  * Provide extended interface to Linux boot loader
  * S-Record download
  * network boot
M
Marcel Ziswiler 已提交
97
  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
98
- create ARMBoot project (http://sourceforge.net/projects/armboot)
W
wdenk 已提交
99
- add other CPU families (starting with ARM)
100
- create U-Boot project (http://sourceforge.net/projects/u-boot)
M
Magnus Lilja 已提交
101
- current project page: see http://www.denx.de/wiki/U-Boot
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123


Names and Spelling:
===================

The "official" name of this project is "Das U-Boot". The spelling
"U-Boot" shall be used in all written text (documentation, comments
in source files etc.). Example:

	This is the README file for the U-Boot project.

File names etc. shall be based on the string "u-boot". Examples:

	include/asm-ppc/u-boot.h

	#include <asm/u-boot.h>

Variable names, preprocessor constants etc. shall be either based on
the string "u_boot" or on "U_BOOT". Example:

	U_BOOT_VERSION		u_boot_logo
	IH_OS_U_BOOT		u_boot_hush_start
W
wdenk 已提交
124 125


W
wdenk 已提交
126 127 128
Versioning:
===========

129 130 131 132 133 134 135 136
Starting with the release in October 2008, the names of the releases
were changed from numerical release numbers without deeper meaning
into a time stamp based numbering. Regular releases are identified by
names consisting of the calendar year and month of the release date.
Additional fields (if present) indicate release candidates or bug fix
releases in "stable" maintenance trees.

Examples:
W
Wolfgang Denk 已提交
137
	U-Boot v2009.11	    - Release November 2009
138 139
	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
W
wdenk 已提交
140 141


W
wdenk 已提交
142 143 144
Directory Hierarchy:
====================

145 146 147 148 149
/arch			Architecture specific files
  /arm			Files generic to ARM architecture
    /cpu		CPU specific files
      /arm720t		Files specific to ARM 720 CPUs
      /arm920t		Files specific to ARM 920 CPUs
150
	/at91		Files specific to Atmel AT91RM9200 CPU
W
Wolfgang Denk 已提交
151 152
	/imx		Files specific to Freescale MC9328 i.MX CPUs
	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
153 154 155 156 157 158 159 160 161 162 163 164 165 166
      /arm925t		Files specific to ARM 925 CPUs
      /arm926ejs	Files specific to ARM 926 CPUs
      /arm1136		Files specific to ARM 1136 CPUs
      /ixp		Files specific to Intel XScale IXP CPUs
      /pxa		Files specific to Intel XScale PXA CPUs
      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
    /lib		Architecture specific library files
  /avr32		Files generic to AVR32 architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
  /blackfin		Files generic to Analog Devices Blackfin architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
G
Graeme Russ 已提交
167
  /x86			Files generic to x86 architecture
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
    /cpu		CPU specific files
    /lib		Architecture specific library files
  /m68k			Files generic to m68k architecture
    /cpu		CPU specific files
      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
    /lib		Architecture specific library files
  /microblaze		Files generic to microblaze architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
  /mips			Files generic to MIPS architecture
    /cpu		CPU specific files
183
      /mips32		Files specific to MIPS32 CPUs
184
      /xburst		Files specific to Ingenic XBurst CPUs
185
    /lib		Architecture specific library files
186 187 188 189
  /nds32		Files generic to NDS32 architecture
    /cpu		CPU specific files
      /n1213		Files specific to Andes Technology N1213 CPUs
    /lib		Architecture specific library files
190 191 192
  /nios2		Files generic to Altera NIOS2 architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
S
Stefan Roese 已提交
193
  /powerpc		Files generic to PowerPC architecture
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    /cpu		CPU specific files
      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
      /mpc5xx		Files specific to Freescale MPC5xx CPUs
      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
      /mpc8xx		Files specific to Freescale MPC8xx CPUs
      /mpc8220		Files specific to Freescale MPC8220 CPUs
      /mpc824x		Files specific to Freescale MPC824x CPUs
      /mpc8260		Files specific to Freescale MPC8260 CPUs
      /mpc85xx		Files specific to Freescale MPC85xx CPUs
      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
    /lib		Architecture specific library files
  /sh			Files generic to SH architecture
    /cpu		CPU specific files
      /sh2		Files specific to sh2 CPUs
      /sh3		Files specific to sh3 CPUs
      /sh4		Files specific to sh4 CPUs
    /lib		Architecture specific library files
  /sparc		Files generic to SPARC architecture
    /cpu		CPU specific files
      /leon2		Files specific to Gaisler LEON2 SPARC CPU
      /leon3		Files specific to Gaisler LEON3 SPARC CPU
    /lib		Architecture specific library files
/api			Machine/arch independent API for external apps
/board			Board dependent files
/common			Misc architecture independent functions
/disk			Code for disk drive partition handling
/doc			Documentation (don't expect too much)
/drivers		Commonly used device drivers
/examples		Example code for standalone applications, etc.
/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
/include		Header Files
/lib			Files generic to all architectures
  /libfdt		Library files to support flattened device trees
  /lzma			Library files to support LZMA decompression
  /lzo			Library files to support LZO decompression
/net			Networking code
/post			Power On Self Test
/rtc			Real Time Clock drivers
/tools			Tools to build S-Record or U-Boot images, etc.
W
wdenk 已提交
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

Software Configuration:
=======================

Configuration is usually done using C preprocessor defines; the
rationale behind that is to avoid dead code whenever possible.

There are two classes of configuration variables:

* Configuration _OPTIONS_:
  These are selectable by the user and have names beginning with
  "CONFIG_".

* Configuration _SETTINGS_:
  These depend on the hardware etc. and should not be meddled with if
  you don't know what you're doing; they have names beginning with
249
  "CONFIG_SYS_".
W
wdenk 已提交
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

Later we will add a configuration tool - probably similar to or even
identical to what's used for the Linux kernel. Right now, we have to
do the configuration by hand, which means creating some symbolic
links and editing some configuration files. We use the TQM8xxL boards
as an example here.


Selection of Processor Architecture and Board Type:
---------------------------------------------------

For all supported boards there are ready-to-use default
configurations available; just type "make <board_name>_config".

Example: For a TQM823L module type:

	cd u-boot
	make TQM823L_config

M
Marcel Ziswiler 已提交
269
For the Cogent platform, you need to specify the CPU type as well;
W
wdenk 已提交
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
e.g. "make cogent_mpc8xx_config". And also configure the cogent
directory according to the instructions in cogent/README.


Configuration Options:
----------------------

Configuration depends on the combination of board and CPU type; all
such information is kept in a configuration file
"include/configs/<board_name>.h".

Example: For a TQM823L module, all configuration settings are in
"include/configs/TQM823L.h".


W
wdenk 已提交
285 286 287 288 289
Many of the options are named exactly as the corresponding Linux
kernel configuration options. The intention is to make it easier to
build a config tool - later.


W
wdenk 已提交
290 291
The following options need to be configured:

292 293 294
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
295 296

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
297
		Define exactly one, e.g. CONFIG_ATSTK1002
W
wdenk 已提交
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316

- CPU Module Type: (if CONFIG_COGENT is defined)
		Define exactly one of
		CONFIG_CMA286_60_OLD
--- FIXME --- not tested yet:
		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
		CONFIG_CMA287_23, CONFIG_CMA287_50

- Motherboard Type: (if CONFIG_COGENT is defined)
		Define exactly one of
		CONFIG_CMA101, CONFIG_CMA102

- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
		Define one or more of
		CONFIG_CMA302

- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
		Define one or more of
		CONFIG_LCD_HEARTBEAT	- update a character position on
M
Marcel Ziswiler 已提交
317
					  the LCD display every second with
W
wdenk 已提交
318 319
					  a "rotator" |\-/|\-/

W
wdenk 已提交
320 321 322
- Board flavour: (if CONFIG_MPC8260ADS is defined)
		CONFIG_ADSTYPE
		Possible values are:
323 324 325 326
			CONFIG_SYS_8260ADS	- original MPC8260ADS
			CONFIG_SYS_8266ADS	- MPC8266ADS
			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
			CONFIG_SYS_8272ADS	- MPC8272ADS
W
wdenk 已提交
327

328 329 330 331 332
- Marvell Family Member
		CONFIG_SYS_MVFS		- define it if you want to enable
					  multiple fs option at one time
					  for marvell soc family

W
wdenk 已提交
333
- MPC824X Family Member (if CONFIG_MPC824X is defined)
W
wdenk 已提交
334 335
		Define exactly one of
		CONFIG_MPC8240, CONFIG_MPC8245
W
wdenk 已提交
336

M
Marcel Ziswiler 已提交
337
- 8xx CPU Options: (if using an MPC8xx CPU)
W
wdenk 已提交
338 339
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
W
wdenk 已提交
340 341
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
W
wdenk 已提交
342 343
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
W
wdenk 已提交
344

W
wdenk 已提交
345
- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
346 347
		CONFIG_SYS_8xx_CPUCLK_MIN
		CONFIG_SYS_8xx_CPUCLK_MAX
W
wdenk 已提交
348
		CONFIG_8xx_CPUCLK_DEFAULT
349 350
			See doc/README.MPC866

351
		CONFIG_SYS_MEASURE_CPUCLK
352

W
wdenk 已提交
353 354 355 356 357
		Define this to measure the actual CPU clock instead
		of relying on the correctness of the configured
		values. Mostly useful for board bringup to make sure
		the PLL is locked at the intended frequency. Note
		that this requires a (stable) reference clock (32 kHz
358
		RTC clock or CONFIG_SYS_8XX_XIN)
359

360 361 362 363 364
		CONFIG_SYS_DELAYED_ICACHE

		Define this option if you want to enable the
		ICache only when Code runs from RAM.

365 366 367 368 369 370 371
- 85xx CPU Options:
		CONFIG_SYS_FSL_TBCLK_DIV

		Defines the core time base clock divider ratio compared to the
		system clock.  On most PQ3 devices this is 8, on newer QorIQ
		devices it can be 16 or 32.  The ratio varies from SoC to Soc.

372 373 374 375 376
		CONFIG_SYS_FSL_PCIE_COMPAT

		Defines the string to utilize when trying to match PCIe device
		tree nodes for the given platform.

377
- Intel Monahans options:
378
		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
379 380 381 382 383

		Defines the Monahans run mode to oscillator
		ratio. Valid values are 8, 16, 24, 31. The core
		frequency is this value multiplied by 13 MHz.

384
		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
W
Wolfgang Denk 已提交
385

386 387
		Defines the Monahans turbo mode to oscillator
		ratio. Valid values are 1 (default if undefined) and
W
Wolfgang Denk 已提交
388
		2. The core frequency as calculated above is multiplied
389
		by this value.
W
Wolfgang Denk 已提交
390

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
- MIPS CPU options:
		CONFIG_SYS_INIT_SP_OFFSET

		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
		pointer. This is needed for the temporary stack before
		relocation.

		CONFIG_SYS_MIPS_CACHE_MODE

		Cache operation mode for the MIPS CPU.
		See also arch/mips/include/asm/mipsregs.h.
		Possible values are:
			CONF_CM_CACHABLE_NO_WA
			CONF_CM_CACHABLE_WA
			CONF_CM_UNCACHED
			CONF_CM_CACHABLE_NONCOHERENT
			CONF_CM_CACHABLE_CE
			CONF_CM_CACHABLE_COW
			CONF_CM_CACHABLE_CUW
			CONF_CM_CACHABLE_ACCELERATED

		CONFIG_SYS_XWAY_EBU_BOOTCFG

		Special option for Lantiq XWAY SoCs for booting from NOR flash.
		See also arch/mips/cpu/mips32/start.S.

		CONFIG_XWAY_SWAP_BYTES

		Enable compilation of tools/xway-swap-bytes needed for Lantiq
		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
		be swapped if a flash programmer is used.

W
wdenk 已提交
423
- Linux Kernel Interface:
W
wdenk 已提交
424 425 426 427 428 429 430 431 432 433
		CONFIG_CLOCKS_IN_MHZ

		U-Boot stores all clock information in Hz
		internally. For binary compatibility with older Linux
		kernels (which expect the clocks passed in the
		bd_info data to be in MHz) the environment variable
		"clocks_in_mhz" can be defined so that U-Boot
		converts clock data to MHZ before passing it to the
		Linux kernel.
		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
434
		"clocks_in_mhz=1" is automatically included in the
W
wdenk 已提交
435 436
		default environment.

W
wdenk 已提交
437 438
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

M
Marcel Ziswiler 已提交
439
		When transferring memsize parameter to linux, some versions
W
wdenk 已提交
440 441 442
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

443
		CONFIG_OF_LIBFDT
444 445

		New kernel versions are expecting firmware settings to be
446 447 448 449 450 451
		passed using flattened device trees (based on open firmware
		concepts).

		CONFIG_OF_LIBFDT
		 * New libfdt-based support
		 * Adds the "fdt" command
452
		 * The bootm command automatically updates the fdt
453

454 455 456 457
		OF_CPU - The proper name of the cpus node (only required for
			MPC512X and MPC5xxx based boards).
		OF_SOC - The proper name of the soc node (only required for
			MPC512X and MPC5xxx based boards).
458
		OF_TBCLK - The timebase frequency.
K
Kumar Gala 已提交
459
		OF_STDOUT_PATH - The path to the console device
460

M
Marcel Ziswiler 已提交
461 462
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
463

464 465 466 467
		CONFIG_OF_BOARD_SETUP

		Board code has addition modification that it wants to make
		to the flat device tree before handing it off to the kernel
468

469 470
		CONFIG_OF_BOOT_CPU

M
Marcel Ziswiler 已提交
471
		This define fills in the correct boot CPU in the boot
472 473
		param header, the default value is zero if undefined.

474 475 476 477 478 479 480 481 482
		CONFIG_OF_IDE_FIXUP

		U-Boot can detect if an IDE device is present or not.
		If not, and this new config option is activated, U-Boot
		removes the ATA node from the DTS before booting Linux,
		so the Linux IDE driver does not probe the device and
		crash. This is needed for buggy hardware (uc101) where
		no pull down resistor is connected to the signal IDE5V_DD7.

483 484 485 486 487 488 489 490 491 492
		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]

		This setting is mandatory for all boards that have only one
		machine type and must be used to specify the machine type
		number as it appears in the ARM machine registry
		(see http://www.arm.linux.org.uk/developer/machines/).
		Only boards that have multiple machine types supported
		in a single configuration file and the machine type is
		runtime discoverable, do not have to use this setting.

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
- vxWorks boot parameters:

		bootvx constructs a valid bootline using the following
		environments variables: bootfile, ipaddr, serverip, hostname.
		It loads the vxWorks image pointed bootfile.

		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters

		CONFIG_SYS_VXWORKS_ADD_PARAMS

		Add it at the end of the bootline. E.g "u=username pw=secret"

		Note: If a "bootargs" environment is defined, it will overwride
		the defaults discussed just above.

511 512 513 514 515
- Cache Configuration:
		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot

A
Aneesh V 已提交
516 517 518 519 520 521
- Cache Configuration for ARM:
		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
				      controller
		CONFIG_SYS_PL310_BASE - Physical base address of PL310
					controller register space

W
wdenk 已提交
522
- Serial Ports:
523
		CONFIG_PL010_SERIAL
W
wdenk 已提交
524 525 526

		Define this if you want support for Amba PrimeCell PL010 UARTs.

527
		CONFIG_PL011_SERIAL
W
wdenk 已提交
528 529 530 531 532 533 534 535 536 537 538 539 540 541

		Define this if you want support for Amba PrimeCell PL011 UARTs.

		CONFIG_PL011_CLOCK

		If you have Amba PrimeCell PL011 UARTs, set this variable to
		the clock speed of the UARTs.

		CONFIG_PL01x_PORTS

		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
		define this to a list of base addresses for each (supported)
		port. See e.g. include/configs/versatile.h

542 543 544 545 546 547 548 549 550 551 552 553
		CONFIG_PL011_SERIAL_RLCR

		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
		have separate receive and transmit line control registers.  Set
		this variable to initialize the extra register.

		CONFIG_PL011_SERIAL_FLUSH_ON_INIT

		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
		boot loader that has already initialized the UART.  Define this
		variable to flush the UART at init time.

W
wdenk 已提交
554

W
wdenk 已提交
555
- Console Interface:
W
wdenk 已提交
556 557 558 559
		Depending on board, define exactly one serial port
		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
		console by defining CONFIG_8xx_CONS_NONE
W
wdenk 已提交
560 561 562 563 564 565 566

		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
		port routines must be defined elsewhere
		(i.e. serial_init(), serial_getc(), ...)

		CONFIG_CFB_CONSOLE
		Enables console device for a color framebuffer. Needs following
567
		defines (cf. smiLynxEM, i8042)
W
wdenk 已提交
568 569 570 571 572 573 574 575 576
			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
						(default big endian)
			VIDEO_HW_RECTFILL	graphic chip supports
						rectangle fill
						(cf. smiLynxEM)
			VIDEO_HW_BITBLT		graphic chip supports
						bit-blit (cf. smiLynxEM)
			VIDEO_VISIBLE_COLS	visible pixel columns
						(cols=pitch)
W
wdenk 已提交
577 578
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
W
wdenk 已提交
579 580
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
W
wdenk 已提交
581
			VIDEO_FB_ADRS		framebuffer address
W
wdenk 已提交
582 583 584 585 586 587 588 589 590
			VIDEO_KBD_INIT_FCT	keyboard int fct
						(i.e. i8042_kbd_init())
			VIDEO_TSTC_FCT		test char fct
						(i.e. i8042_tstc)
			VIDEO_GETC_FCT		get char fct
						(i.e. i8042_getc)
			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
						(requires blink timer
						cf. i8042.c)
591
			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
W
wdenk 已提交
592 593
			CONFIG_CONSOLE_TIME	display time/date info in
						upper right corner
594
						(requires CONFIG_CMD_DATE)
W
wdenk 已提交
595 596
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
597 598 599
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
W
wdenk 已提交
600
			CONFIG_CONSOLE_EXTRA_INFO
M
Marcel Ziswiler 已提交
601
						additional board info beside
W
wdenk 已提交
602 603
						the logo

W
wdenk 已提交
604 605 606
		When CONFIG_CFB_CONSOLE is defined, video console is
		default i/o. Serial console can be forced with
		environment 'console=serial'.
W
wdenk 已提交
607

W
wdenk 已提交
608 609 610 611
		When CONFIG_SILENT_CONSOLE is defined, all console
		messages (by U-Boot and Linux!) can be silenced with
		the "silent" environment variable. See
		doc/README.silent for more information.
W
wdenk 已提交
612

W
wdenk 已提交
613 614 615
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
616 617
		CONFIG_SYS_BAUDRATE_TABLE, see below.
		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
W
wdenk 已提交
618

619 620 621
- Console Rx buffer length
		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
		the maximum receive buffer length for the SMC.
622
		This option is actual only for 82xx and 8xx possible.
623 624 625 626
		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
		must be defined, to setup the maximum idle timeout for
		the SMC.

627
- Pre-Console Buffer:
628 629 630 631 632 633 634
		Prior to the console being initialised (i.e. serial UART
		initialised etc) all console output is silently discarded.
		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
		buffer any console messages prior to the console being
		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
W
Wolfgang Denk 已提交
635
		bytes are output before the console is initialised, the
636 637 638 639
		earlier bytes are discarded.

		'Sane' compilers will generate smaller code if
		CONFIG_PRE_CON_BUF_SZ is a power of 2
640

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
- Pre-console putc():
		Prior to the console being initialised, console output is
		normally silently discarded. This can be annoying if a
		panic() happens in this time.

		If the CONFIG_PRE_CONSOLE_PUTC option is defined, then
		U-Boot will call board_pre_console_putc() for each output
		character in this case, This function should try to output
		the character if possible, perhaps on all available UARTs
		(it will need to do this directly, since the console code
		is not functional yet). Note that if the panic happens
		early enough, then it is possible that board_init_f()
		(or even arch_cpu_init() on ARM) has not been called yet.
		You should init all clocks, GPIOs, etc. that are needed
		to get the character out. Baud rates will need to default
		to something sensible.

658 659 660 661 662 663 664 665 666
- Safe printf() functions
		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
		the printf() functions. These are defined in
		include/vsprintf.h and include snprintf(), vsnprintf() and
		so on. Code size increase is approximately 300-500 bytes.
		If this option is not given then these functions will
		silently discard their buffer size argument - this means
		you are not getting any overflow checking in this case.

W
wdenk 已提交
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
- Boot Delay:	CONFIG_BOOTDELAY - in seconds
		Delay before automatically booting the default image;
		set to -1 to disable autoboot.

		See doc/README.autoboot for these options that
		work with CONFIG_BOOTDELAY. None are required.
		CONFIG_BOOT_RETRY_TIME
		CONFIG_BOOT_RETRY_MIN
		CONFIG_AUTOBOOT_KEYED
		CONFIG_AUTOBOOT_PROMPT
		CONFIG_AUTOBOOT_DELAY_STR
		CONFIG_AUTOBOOT_STOP_STR
		CONFIG_AUTOBOOT_DELAY_STR2
		CONFIG_AUTOBOOT_STOP_STR2
		CONFIG_ZERO_BOOTDELAY_CHECK
		CONFIG_RESET_TO_RETRY

- Autoboot Command:
		CONFIG_BOOTCOMMAND
		Only needed when CONFIG_BOOTDELAY is enabled;
		define a command string that is automatically executed
		when no character is read on the console interface
		within "Boot Delay" after reset.

		CONFIG_BOOTARGS
W
wdenk 已提交
692 693 694
		This can be used to pass arguments to the bootm
		command. The value of CONFIG_BOOTARGS goes into the
		environment value "bootargs".
W
wdenk 已提交
695 696

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
W
wdenk 已提交
697 698 699
		The value of these goes into the environment as
		"ramboot" and "nfsboot" respectively, and can be used
		as a convenience, when switching between booting from
M
Marcel Ziswiler 已提交
700
		RAM and NFS.
W
wdenk 已提交
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726

- Pre-Boot Commands:
		CONFIG_PREBOOT

		When this option is #defined, the existence of the
		environment variable "preboot" will be checked
		immediately before starting the CONFIG_BOOTDELAY
		countdown and/or running the auto-boot command resp.
		entering interactive mode.

		This feature is especially useful when "preboot" is
		automatically generated or modified. For an example
		see the LWMON board specific code: here "preboot" is
		modified when the user holds down a certain
		combination of keys on the (special) keyboard when
		booting the systems

- Serial Download Echo Mode:
		CONFIG_LOADS_ECHO
		If defined to 1, all characters received during a
		serial download (using the "loads" command) are
		echoed back. This might be needed by some terminal
		emulations (like "cu"), but may as well just take
		time on others. This setting #define's the initial
		value of the "loads_echo" environment variable.

727
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
W
wdenk 已提交
728 729
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
730
		CONFIG_SYS_BAUDRATE_TABLE, see below.
W
wdenk 已提交
731 732

- Monitor Functions:
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
		Monitor commands can be included or excluded
		from the build by using the #include files
		"config_cmd_all.h" and #undef'ing unwanted
		commands, or using "config_cmd_default.h"
		and augmenting with additional #define's
		for wanted commands.

		The default command configuration includes all commands
		except those marked below with a "*".

		CONFIG_CMD_ASKENV	* ask for env variable
		CONFIG_CMD_BDI		  bdinfo
		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
		CONFIG_CMD_BMP		* BMP support
		CONFIG_CMD_BSP		* Board specific commands
		CONFIG_CMD_BOOTD	  bootd
		CONFIG_CMD_CACHE	* icache, dcache
		CONFIG_CMD_CONSOLE	  coninfo
M
Mike Frysinger 已提交
751
		CONFIG_CMD_CRC32	* crc32
752 753 754
		CONFIG_CMD_DATE		* support for RTC, date/time...
		CONFIG_CMD_DHCP		* DHCP support
		CONFIG_CMD_DIAG		* Diagnostics
755 756 757 758
		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
759 760
		CONFIG_CMD_DTT		* Digital Therm and Thermostat
		CONFIG_CMD_ECHO		  echo arguments
P
Peter Tyser 已提交
761
		CONFIG_CMD_EDITENV	  edit env variable
762 763
		CONFIG_CMD_EEPROM	* EEPROM read/write support
		CONFIG_CMD_ELF		* bootelf, bootvx
764
		CONFIG_CMD_EXPORTENV	* export the environment
765
		CONFIG_CMD_SAVEENV	  saveenv
766 767 768 769 770
		CONFIG_CMD_FDC		* Floppy Disk Support
		CONFIG_CMD_FAT		* FAT partition support
		CONFIG_CMD_FDOS		* Dos diskette Support
		CONFIG_CMD_FLASH	  flinfo, erase, protect
		CONFIG_CMD_FPGA		  FPGA device initialization support
M
Mike Frysinger 已提交
771
		CONFIG_CMD_GO		* the 'go' command (exec code)
K
Kim Phillips 已提交
772
		CONFIG_CMD_GREPENV	* search environment
773 774 775 776 777 778
		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
		CONFIG_CMD_I2C		* I2C serial bus support
		CONFIG_CMD_IDE		* IDE harddisk support
		CONFIG_CMD_IMI		  iminfo
		CONFIG_CMD_IMLS		  List all found images
		CONFIG_CMD_IMMAP	* IMMR dump support
779
		CONFIG_CMD_IMPORTENV	* import an environment
780 781 782 783
		CONFIG_CMD_IRQ		* irqinfo
		CONFIG_CMD_ITEST	  Integer/string test of 2 values
		CONFIG_CMD_JFFS2	* JFFS2 Support
		CONFIG_CMD_KGDB		* kgdb
M
Mike Frysinger 已提交
784
		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
785 786
		CONFIG_CMD_LOADB	  loadb
		CONFIG_CMD_LOADS	  loads
R
Robin Getz 已提交
787 788
		CONFIG_CMD_MD5SUM	  print md5 message digest
					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
789 790 791 792 793
		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
					  loop, loopw, mtest
		CONFIG_CMD_MISC		  Misc functions like sleep etc
		CONFIG_CMD_MMC		* MMC memory mapped support
		CONFIG_CMD_MII		* MII utility commands
794
		CONFIG_CMD_MTDPARTS	* MTD partition support
795 796
		CONFIG_CMD_NAND		* NAND support
		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
797
		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
W
Wolfgang Denk 已提交
798
		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
799 800 801 802 803 804 805 806 807 808 809 810 811
		CONFIG_CMD_PCI		* pciinfo
		CONFIG_CMD_PCMCIA		* PCMCIA support
		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
					  host
		CONFIG_CMD_PORTIO	* Port I/O
		CONFIG_CMD_REGINFO	* Register dump
		CONFIG_CMD_RUN		  run command in env variable
		CONFIG_CMD_SAVES	* save S record dump
		CONFIG_CMD_SCSI		* SCSI Support
		CONFIG_CMD_SDRAM	* print SDRAM configuration information
					  (requires CONFIG_CMD_I2C)
		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
					  (4xx only)
812
		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
R
Robin Getz 已提交
813
					  (requires CONFIG_CMD_MEMORY)
814
		CONFIG_CMD_SOURCE	  "source" command Support
815
		CONFIG_CMD_SPI		* SPI serial bus support
L
Luca Ceresoli 已提交
816
		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
S
Simon Glass 已提交
817
		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
C
Che-liang Chiou 已提交
818
		CONFIG_CMD_TIME		* run command and report execution time
819 820 821 822
		CONFIG_CMD_USB		* USB support
		CONFIG_CMD_CDP		* Cisco Discover Protocol support
		CONFIG_CMD_FSL		* Microblaze FSL support

W
wdenk 已提交
823 824 825 826

		EXAMPLE: If you want all functions except of network
		support you can write:

827 828
		#include "config_cmd_all.h"
		#undef CONFIG_CMD_NET
W
wdenk 已提交
829

830 831
	Other Commands:
		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
W
wdenk 已提交
832 833

	Note:	Don't enable the "icache" and "dcache" commands
834
		(configuration option CONFIG_CMD_CACHE) unless you know
W
wdenk 已提交
835 836 837 838 839 840
		what you (and your U-Boot users) are doing. Data
		cache cannot be enabled on systems like the 8xx or
		8260 (where accesses to the IMMR region must be
		uncached), and it cannot be disabled on all other
		systems where we (mis-) use the data cache to hold an
		initial stack and some data.
W
wdenk 已提交
841 842 843 844


		XXX - this list needs to get updated!

845 846 847 848 849 850 851 852
- Device tree:
		CONFIG_OF_CONTROL
		If this variable is defined, U-Boot will use a device tree
		to configure its devices, instead of relying on statically
		compiled #defines in the board file. This option is
		experimental and only available on a few boards. The device
		tree is available in the global data as gd->fdt_blob.

853 854
		U-Boot needs to get its device tree from somewhere. This can
		be done using one of the two options below:
855 856 857 858 859 860 861

		CONFIG_OF_EMBED
		If this variable is defined, U-Boot will embed a device tree
		binary in its image. This device tree file should be in the
		board directory and called <soc>-<board>.dts. The binary file
		is then picked up in board_init_f() and made available through
		the global data structure as gd->blob.
862

863 864 865 866 867 868 869 870 871 872 873 874
		CONFIG_OF_SEPARATE
		If this variable is defined, U-Boot will build a device tree
		binary. It will be called u-boot.dtb. Architecture-specific
		code will locate it at run-time. Generally this works by:

			cat u-boot.bin u-boot.dtb >image.bin

		and in fact, U-Boot does this for you, creating a file called
		u-boot-dtb.bin which is useful in the common case. You can
		still use the individual files if you need something more
		exotic.

W
wdenk 已提交
875 876 877
- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
878 879 880 881 882 883 884 885 886 887 888
		support for the SoC. There must be support in the SoC
		specific code for a watchdog. For the 8xx and 8260
		CPUs, the SIU Watchdog feature is enabled in the SYPCR
		register.  When supported for a specific SoC is
		available, then no further board specific code should
		be needed to use it.

		CONFIG_HW_WATCHDOG
		When using a watchdog circuitry external to the used
		SoC, then define this variable and provide board
		specific code for the "hw_watchdog_reset" function.
W
wdenk 已提交
889

890 891 892 893 894 895 896
- U-Boot Version:
		CONFIG_VERSION_VARIABLE
		If this variable is defined, an environment variable
		named "ver" is created by U-Boot showing the U-Boot
		version as printed by the "version" command.
		This variable is readonly.

W
wdenk 已提交
897 898
- Real-Time Clock:

899
		When CONFIG_CMD_DATE is selected, the type of the RTC
W
wdenk 已提交
900 901 902 903 904
		has to be selected, too. Define exactly one of the
		following options:

		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
905
		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
W
wdenk 已提交
906
		CONFIG_RTC_MC146818	- use MC146818 RTC
W
wdenk 已提交
907
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
W
wdenk 已提交
908
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
W
wdenk 已提交
909
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
W
wdenk 已提交
910
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
T
Tor Krill 已提交
911
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
W
wdenk 已提交
912
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
913
		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
914 915
		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
					  RV3029 RTC.
W
wdenk 已提交
916

W
wdenk 已提交
917 918 919
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

920 921 922 923
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
		CONFIG_PCA953X_INFO	- enable pca953x info command

C
Chris Packham 已提交
924 925 926 927
		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
		chip-ngpio pairs that tell the PCA953X driver the number of
		pins supported by a particular chip.

928 929 930
		Note that if the GPIO device uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

W
wdenk 已提交
931 932
- Timestamp Support:

W
wdenk 已提交
933 934 935
		When CONFIG_TIMESTAMP is selected, the timestamp
		(date and time) of an image is printed by image
		commands like bootm or iminfo. This option is
936
		automatically enabled when you select CONFIG_CMD_DATE .
W
wdenk 已提交
937 938 939

- Partition Support:
		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
940
		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
W
wdenk 已提交
941

942 943 944
		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
		CONFIG_CMD_SCSI) you must configure support for at
		least one partition type as well.
W
wdenk 已提交
945 946

- IDE Reset method:
W
wdenk 已提交
947 948
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
W
wdenk 已提交
949

W
wdenk 已提交
950 951 952 953
		CONFIG_IDE_RESET - is this is defined, IDE Reset will
		be performed by calling the function
			ide_set_reset(int reset)
		which has to be defined in a board specific file
W
wdenk 已提交
954 955 956 957 958 959

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

W
wdenk 已提交
960 961 962 963
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
964
		Also look at CONFIG_SYS_64BIT_LBA.
W
wdenk 已提交
965 966 967
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

968
		CONFIG_SYS_64BIT_LBA:
W
wdenk 已提交
969 970 971
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

W
wdenk 已提交
972 973 974 975 976
- SCSI Support:
		At the moment only there is only support for the
		SYM53C8XX SCSI controller; define
		CONFIG_SCSI_SYM53C8XX to enable it.

977 978 979
		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
W
wdenk 已提交
980 981
		maximum numbers of LUNs, SCSI ID's and target
		devices.
982
		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
W
wdenk 已提交
983 984

- NETWORK Support (PCI):
985
		CONFIG_E1000
986 987 988 989 990 991 992 993 994 995 996 997 998 999
		Support for Intel 8254x/8257x gigabit chips.

		CONFIG_E1000_SPI
		Utility code for direct access to the SPI bus on Intel 8257x.
		This does not do anything useful unless you set at least one
		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.

		CONFIG_E1000_SPI_GENERIC
		Allow generic access to the SPI bus on the Intel 8257x, for
		example with the "sspi" command.

		CONFIG_CMD_E1000
		Management command for E1000 devices.  When used on devices
		with SPI support you can reprogram the EEPROM from U-Boot.
S
stroese 已提交
1000

A
Andre Schwarz 已提交
1001
		CONFIG_E1000_FALLBACK_MAC
M
Marcel Ziswiler 已提交
1002
		default MAC for empty EEPROM after production.
A
Andre Schwarz 已提交
1003

W
wdenk 已提交
1004 1005
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
M
Marcel Ziswiler 已提交
1006
		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
W
wdenk 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
		write routine for first time initialisation.

		CONFIG_TULIP
		Support for Digital 2114x chips.
		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
		modem chip initialisation (KS8761/QS6611).

		CONFIG_NATSEMI
		Support for National dp83815 chips.

		CONFIG_NS8382X
		Support for National dp8382[01] gigabit chips.

W
wdenk 已提交
1020 1021
- NETWORK Support (other):

1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
		CONFIG_DRIVER_AT91EMAC
		Support for AT91RM9200 EMAC.

			CONFIG_RMII
			Define this to use reduced MII inteface

			CONFIG_DRIVER_AT91EMAC_QUIET
			If this defined, the driver is quiet.
			The driver doen't show link status messages.

R
Rob Herring 已提交
1032 1033 1034
		CONFIG_CALXEDA_XGMAC
		Support for the Calxeda XGMAC device

W
wdenk 已提交
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
		CONFIG_DRIVER_LAN91C96
		Support for SMSC's LAN91C96 chips.

			CONFIG_LAN91C96_BASE
			Define this to hold the physical address
			of the LAN91C96's I/O space

			CONFIG_LAN91C96_USE_32_BIT
			Define this to enable 32 bit addressing

W
wdenk 已提交
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
		CONFIG_DRIVER_SMC91111
		Support for SMSC's LAN91C111 chip

			CONFIG_SMC91111_BASE
			Define this to hold the physical address
			of the device (I/O space)

			CONFIG_SMC_USE_32_BIT
			Define this if data bus is 32 bits

			CONFIG_SMC_USE_IOFUNCS
			Define this to use i/o functions instead of macros
			(some hardware wont work with macros)

1059 1060 1061 1062 1063 1064
		CONFIG_DRIVER_TI_EMAC
		Support for davinci emac

			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
			Define this if you have more then 3 PHYs.

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
		CONFIG_FTGMAC100
		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet

			CONFIG_FTGMAC100_EGIGA
			Define this to use GE link update with gigabit PHY.
			Define this if FTGMAC100 is connected to gigabit PHY.
			If your system has 10/100 PHY only, it might not occur
			wrong behavior. Because PHY usually return timeout or
			useless data when polling gigabit status and gigabit
			control registers. This behavior won't affect the
			correctnessof 10/100 link speed update.

1077
		CONFIG_SMC911X
J
Jens Gehrlein 已提交
1078 1079
		Support for SMSC's LAN911x and LAN921x chips

1080
			CONFIG_SMC911X_BASE
J
Jens Gehrlein 已提交
1081 1082 1083
			Define this to hold the physical address
			of the device (I/O space)

1084
			CONFIG_SMC911X_32_BIT
J
Jens Gehrlein 已提交
1085 1086
			Define this if data bus is 32 bits

1087
			CONFIG_SMC911X_16_BIT
J
Jens Gehrlein 已提交
1088 1089
			Define this if data bus is 16 bits. If your processor
			automatically converts one 32 bit word to two 16 bit
1090
			words you may also try CONFIG_SMC911X_32_BIT.
J
Jens Gehrlein 已提交
1091

1092 1093 1094 1095 1096 1097 1098 1099 1100
		CONFIG_SH_ETHER
		Support for Renesas on-chip Ethernet controller

			CONFIG_SH_ETHER_USE_PORT
			Define the number of ports to be used

			CONFIG_SH_ETHER_PHY_ADDR
			Define the ETH PHY's address

1101 1102 1103
			CONFIG_SH_ETHER_CACHE_WRITEBACK
			If this option is set, the driver enables cache flush.

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
- TPM Support:
		CONFIG_GENERIC_LPC_TPM
		Support for generic parallel port TPM devices. Only one device
		per system is supported at this time.

			CONFIG_TPM_TIS_BASE_ADDRESS
			Base address where the generic TPM device is mapped
			to. Contemporary x86 systems usually map it at
			0xfed40000.

W
wdenk 已提交
1114 1115
- USB Support:
		At the moment only the UHCI host controller is
W
wdenk 已提交
1116
		supported (PIP405, MIP405, MPC5200); define
W
wdenk 已提交
1117 1118
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
W
wdenk 已提交
1119
		and define CONFIG_USB_STORAGE to enable the USB
W
wdenk 已提交
1120 1121 1122 1123
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
W
wdenk 已提交
1124 1125 1126
		MPC5200 USB requires additional defines:
			CONFIG_USB_CLOCK
				for 528 MHz Clock: 0x0001bbbb
1127 1128
			CONFIG_PSC3_USB
				for USB on PSC3
W
wdenk 已提交
1129 1130 1131
			CONFIG_USB_CONFIG
				for differential drivers: 0x00001000
				for single ended drivers: 0x00005000
1132 1133
				for differential drivers on PSC3: 0x00000100
				for single ended drivers on PSC3: 0x00004100
1134
			CONFIG_SYS_USB_EVENT_POLL
Z
Zhang Wei 已提交
1135 1136
				May be defined to allow interrupt polling
				instead of using asynchronous interrupts
W
wdenk 已提交
1137

W
Wolfgang Denk 已提交
1138 1139 1140 1141
- USB Device:
		Define the below if you wish to use the USB console.
		Once firmware is rebuilt from a serial console issue the
		command "setenv stdin usbtty; setenv stdout usbtty" and
M
Marcel Ziswiler 已提交
1142
		attach your USB cable. The Unix command "dmesg" should print
W
Wolfgang Denk 已提交
1143 1144
		it has found a new device. The environment variable usbtty
		can be set to gserial or cdc_acm to enable your device to
W
Wolfgang Denk 已提交
1145
		appear to a USB host as a Linux gserial device or a
W
Wolfgang Denk 已提交
1146 1147 1148 1149 1150 1151 1152
		Common Device Class Abstract Control Model serial device.
		If you select usbtty = gserial you should be able to enumerate
		a Linux host by
		# modprobe usbserial vendor=0xVendorID product=0xProductID
		else if using cdc_acm, simply setting the environment
		variable usbtty to be cdc_acm should suffice. The following
		might be defined in YourBoardName.h
W
Wolfgang Denk 已提交
1153

W
Wolfgang Denk 已提交
1154 1155 1156 1157 1158 1159
			CONFIG_USB_DEVICE
			Define this to build a UDC device

			CONFIG_USB_TTY
			Define this to have a tty type of device available to
			talk to the UDC device
W
Wolfgang Denk 已提交
1160

1161
			CONFIG_SYS_CONSOLE_IS_IN_ENV
W
Wolfgang Denk 已提交
1162 1163 1164 1165
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

			mpc8xx:
1166
				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
W
Wolfgang Denk 已提交
1167
				Derive USB clock from external clock "blah"
1168
				- CONFIG_SYS_USB_EXTC_CLK 0x02
W
Wolfgang Denk 已提交
1169

1170
				CONFIG_SYS_USB_BRG_CLK 0xBLAH
W
Wolfgang Denk 已提交
1171
				Derive USB clock from brgclk
1172
				- CONFIG_SYS_USB_BRG_CLK 0x04
W
Wolfgang Denk 已提交
1173

W
Wolfgang Denk 已提交
1174
		If you have a USB-IF assigned VendorID then you may wish to
W
Wolfgang Denk 已提交
1175
		define your own vendor specific values either in BoardName.h
W
Wolfgang Denk 已提交
1176
		or directly in usbd_vendor_info.h. If you don't define
W
Wolfgang Denk 已提交
1177 1178 1179 1180 1181 1182 1183
		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
		should pretend to be a Linux device to it's target host.

			CONFIG_USBD_MANUFACTURER
			Define this string as the name of your company for
			- CONFIG_USBD_MANUFACTURER "my company"
W
Wolfgang Denk 已提交
1184

W
Wolfgang Denk 已提交
1185 1186 1187 1188 1189 1190 1191 1192 1193
			CONFIG_USBD_PRODUCT_NAME
			Define this string as the name of your product
			- CONFIG_USBD_PRODUCT_NAME "acme usb device"

			CONFIG_USBD_VENDORID
			Define this as your assigned Vendor ID from the USB
			Implementors Forum. This *must* be a genuine Vendor ID
			to avoid polluting the USB namespace.
			- CONFIG_USBD_VENDORID 0xFFFF
W
Wolfgang Denk 已提交
1194

W
Wolfgang Denk 已提交
1195 1196 1197 1198
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
W
wdenk 已提交
1199

1200 1201 1202 1203 1204 1205 1206 1207
- ULPI Layer Support:
		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
		the generic ULPI layer. The generic layer accesses the ULPI PHY
		via the platform viewport, so you need both the genric layer and
		the viewport enabled. Currently only Chipidea/ARC based
		viewport is supported.
		To enable the ULPI layer support, define CONFIG_USB_ULPI and
		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
W
wdenk 已提交
1208

1209
- MMC Support:
W
wdenk 已提交
1210 1211 1212
		The MMC controller on the Intel PXA is supported. To
		enable this define CONFIG_MMC. The MMC can be
		accessed from the boot prompt by mapping the device
1213
		to physical memory similar to flash. Command line is
1214 1215
		enabled with CONFIG_CMD_MMC. The MMC driver also works with
		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1216

1217 1218 1219 1220 1221 1222 1223 1224 1225
		CONFIG_SH_MMCIF
		Support for Renesas on-chip MMCIF controller

			CONFIG_SH_MMCIF_ADDR
			Define the base address of MMCIF registers

			CONFIG_SH_MMCIF_CLK
			Define the clock frequency for MMCIF

W
wdenk 已提交
1226 1227 1228 1229 1230
- Journaling Flash filesystem support:
		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
		CONFIG_JFFS2_NAND_DEV
		Define these for a default partition on a NAND device

1231 1232
		CONFIG_SYS_JFFS2_FIRST_SECTOR,
		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
W
wdenk 已提交
1233 1234
		Define these for a default partition on a NOR device

1235
		CONFIG_SYS_JFFS_CUSTOM_PART
W
wdenk 已提交
1236 1237 1238 1239
		Define this to create an own partition. You have to provide a
		function struct part_info* jffs2_part_info(int part_num)

		If you define only one JFFS2 partition you may also want to
1240
		#define CONFIG_SYS_JFFS_SINGLE_PART	1
W
wdenk 已提交
1241 1242 1243
		to disable the command chpart. This is the default when you
		have not defined a custom partition

D
Donggeun Kim 已提交
1244 1245 1246 1247 1248
- FAT(File Allocation Table) filesystem write function support:
		CONFIG_FAT_WRITE
		Support for saving memory data as a file
		in FAT formatted partition

W
wdenk 已提交
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
- Keyboard Support:
		CONFIG_ISA_KEYBOARD

		Define this to enable standard (PC-Style) keyboard
		support

		CONFIG_I8042_KBD
		Standard PC keyboard driver with US (is default) and
		GERMAN key layout (switch via environment 'keymap=de') support.
		Export function i8042_kbd_init, i8042_tstc and i8042_getc
		for cfb_console. Supports cursor blinking.

- Video support:
		CONFIG_VIDEO

		Define this to enable video support (for output to
		video).

		CONFIG_VIDEO_CT69000

		Enable Chips & Technologies 69000 Video chip

		CONFIG_VIDEO_SMI_LYNXEM
W
wdenk 已提交
1272
		Enable Silicon Motion SMI 712/710/810 Video chip. The
W
wdenk 已提交
1273 1274 1275 1276
		video output is selected via environment 'videoout'
		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
		assumed.

W
wdenk 已提交
1277
		For the CT69000 and SMI_LYNXEM drivers, videomode is
M
Marcel Ziswiler 已提交
1278
		selected via environment 'videomode'. Two different ways
W
wdenk 已提交
1279 1280
		are possible:
		- "videomode=num"   'num' is a standard LiLo mode numbers.
W
wdenk 已提交
1281
		Following standard modes are supported	(* is default):
W
wdenk 已提交
1282 1283 1284 1285 1286 1287 1288 1289

		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
		-------------+---------------------------------------------
		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
		-------------+---------------------------------------------
W
wdenk 已提交
1290 1291
		(i.e. setenv videomode 317; saveenv; reset;)

W
wdenk 已提交
1292
		- "videomode=bootargs" all the video parameters are parsed
1293
		from the bootargs. (See drivers/video/videomodes.c)
W
wdenk 已提交
1294 1295


1296
		CONFIG_VIDEO_SED13806
W
wdenk 已提交
1297
		Enable Epson SED13806 driver. This driver supports 8bpp
1298 1299 1300
		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
		or CONFIG_VIDEO_SED13806_16BPP

1301
		CONFIG_FSL_DIU_FB
W
Wolfgang Denk 已提交
1302
		Enable the Freescale DIU video driver.	Reference boards for
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
		SOCs that have a DIU should define this macro to enable DIU
		support, and should also define these other macros:

			CONFIG_SYS_DIU_ADDR
			CONFIG_VIDEO
			CONFIG_CMD_BMP
			CONFIG_CFB_CONSOLE
			CONFIG_VIDEO_SW_CURSOR
			CONFIG_VGA_AS_SINGLE_DEVICE
			CONFIG_VIDEO_LOGO
			CONFIG_VIDEO_BMP_LOGO

1315 1316 1317 1318
		The DIU driver will look for the 'video-mode' environment
		variable, and if defined, enable the DIU as a console during
		boot.  See the documentation file README.video for a
		description of this variable.
1319

1320
- Keyboard Support:
W
wdenk 已提交
1321
		CONFIG_KEYBOARD
1322

W
wdenk 已提交
1323 1324 1325 1326
		Define this to enable a custom keyboard support.
		This simply calls drv_keyboard_init() which must be
		defined in your board-specific files.
		The only board using this so far is RBC823.
1327

W
wdenk 已提交
1328 1329 1330 1331 1332 1333
- LCD Support:	CONFIG_LCD

		Define this to enable LCD support (for output to LCD
		display); also select one of the supported displays
		by defining one of these:

S
Stelian Pop 已提交
1334 1335 1336 1337
		CONFIG_ATMEL_LCD:

			HITACHI TX09D70VM1CCA, 3.5", 240x320.

W
wdenk 已提交
1338
		CONFIG_NEC_NL6448AC33:
W
wdenk 已提交
1339

W
wdenk 已提交
1340
			NEC NL6448AC33-18. Active, color, single scan.
W
wdenk 已提交
1341

W
wdenk 已提交
1342
		CONFIG_NEC_NL6448BC20
W
wdenk 已提交
1343

W
wdenk 已提交
1344 1345 1346 1347 1348 1349
			NEC NL6448BC20-08. 6.5", 640x480.
			Active, color, single scan.

		CONFIG_NEC_NL6448BC33_54

			NEC NL6448BC33-54. 10.4", 640x480.
W
wdenk 已提交
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
			Active, color, single scan.

		CONFIG_SHARP_16x9

			Sharp 320x240. Active, color, single scan.
			It isn't 16x9, and I am not sure what it is.

		CONFIG_SHARP_LQ64D341

			Sharp LQ64D341 display, 640x480.
			Active, color, single scan.

		CONFIG_HLD1045

			HLD1045 display, 640x480.
			Active, color, single scan.

		CONFIG_OPTREX_BW

			Optrex	 CBL50840-2 NF-FW 99 22 M5
			or
			Hitachi	 LMG6912RPFC-00T
			or
			Hitachi	 SP14Q002

			320x240. Black & white.

		Normally display is black on white background; define
1378
		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
W
wdenk 已提交
1379

W
wdenk 已提交
1380
- Splash Screen Support: CONFIG_SPLASH_SCREEN
1381

W
wdenk 已提交
1382 1383 1384
		If this option is set, the environment is checked for
		a variable "splashimage". If found, the usual display
		of logo, copyright and system information on the LCD
1385
		is suppressed and the BMP image at the address
W
wdenk 已提交
1386 1387 1388 1389
		specified in "splashimage" is loaded instead. The
		console is redirected to the "nulldev", too. This
		allows for a "silent" boot where a splash screen is
		loaded very quickly after power-on.
1390

1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
		CONFIG_SPLASH_SCREEN_ALIGN

		If this option is set the splash image can be freely positioned
		on the screen. Environment variable "splashpos" specifies the
		position as "x,y". If a positive number is given it is used as
		number of pixel from left/top. If a negative number is given it
		is used as number of pixel from right/bottom. You can also
		specify 'm' for centering the image.

		Example:
		setenv splashpos m,m
			=> image at center of screen

		setenv splashpos 30,20
			=> image at x = 30 and y = 20

		setenv splashpos -10,m
			=> vertically centered image
			   at x = dspWidth - bmpWidth - 9

S
Stefan Roese 已提交
1411 1412 1413 1414 1415 1416
- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP

		If this option is set, additionally to standard BMP
		images, gzipped BMP images can be displayed via the
		splashscreen support or the bmp command.

1417 1418 1419 1420 1421 1422
- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8

		If this option is set, 8-bit RLE compressed BMP images
		can be displayed via the splashscreen support or the
		bmp command.

W
wdenk 已提交
1423 1424 1425 1426 1427 1428 1429
- Compression support:
		CONFIG_BZIP2

		If this option is set, support for bzip2 compressed
		images is included. If not, only uncompressed and gzip
		compressed images are supported.

W
wdenk 已提交
1430
		NOTE: the bzip2 algorithm requires a lot of RAM, so
1431
		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
W
wdenk 已提交
1432
		be at least 4MB.
1433

1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
		CONFIG_LZMA

		If this option is set, support for lzma compressed
		images is included.

		Note: The LZMA algorithm adds between 2 and 4KB of code and it
		requires an amount of dynamic memory that is given by the
		formula:

			(1846 + 768 << (lc + lp)) * sizeof(uint16)

		Where lc and lp stand for, respectively, Literal context bits
		and Literal pos bits.

		This value is upper-bounded by 14MB in the worst case. Anyway,
		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
		a very small buffer.

		Use the lzmainfo tool to determinate the lc and lp values and
		then calculate the amount of needed dynamic memory (ensuring
1455
		the appropriate CONFIG_SYS_MALLOC_LEN value).
1456

W
wdenk 已提交
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
- MII/PHY support:
		CONFIG_PHY_ADDR

		The address of PHY on MII bus.

		CONFIG_PHY_CLOCK_FREQ (ppc4xx)

		The clock frequency of the MII bus

		CONFIG_PHY_GIGE

		If this option is set, support for speed/duplex
M
Marcel Ziswiler 已提交
1469
		detection of gigabit PHY is included.
W
wdenk 已提交
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482

		CONFIG_PHY_RESET_DELAY

		Some PHY like Intel LXT971A need extra delay after
		reset before any MII register access is possible.
		For such PHY, set this option to the usec delay
		required. (minimum 300usec for LXT971A)

		CONFIG_PHY_CMD_DELAY (ppc4xx)

		Some PHY like Intel LXT971A need extra delay after
		command issued before MII status register can be read

W
wdenk 已提交
1483 1484
- Ethernet address:
		CONFIG_ETHADDR
1485
		CONFIG_ETH1ADDR
W
wdenk 已提交
1486 1487
		CONFIG_ETH2ADDR
		CONFIG_ETH3ADDR
1488 1489
		CONFIG_ETH4ADDR
		CONFIG_ETH5ADDR
W
wdenk 已提交
1490

M
Marcel Ziswiler 已提交
1491 1492
		Define a default value for Ethernet address to use
		for the respective Ethernet interface, in case this
W
wdenk 已提交
1493 1494 1495 1496 1497 1498
		is not determined automatically.

- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
M
Marcel Ziswiler 已提交
1499
		the default Ethernet interface, in case this is not
W
wdenk 已提交
1500
		determined through e.g. bootp.
1501
		(Environment variable "ipaddr")
W
wdenk 已提交
1502 1503 1504 1505

- Server IP address:
		CONFIG_SERVERIP

M
Marcel Ziswiler 已提交
1506
		Defines a default value for the IP address of a TFTP
W
wdenk 已提交
1507
		server to contact when using the "tftboot" command.
1508
		(Environment variable "serverip")
W
wdenk 已提交
1509

1510 1511 1512 1513 1514
		CONFIG_KEEP_SERVERADDR

		Keeps the server's MAC address, in the env 'serveraddr'
		for passing to bootargs (like Linux's netconsole option)

1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
- Gateway IP address:
		CONFIG_GATEWAYIP

		Defines a default value for the IP address of the
		default router where packets to other networks are
		sent to.
		(Environment variable "gatewayip")

- Subnet mask:
		CONFIG_NETMASK

		Defines a default value for the subnet mask (or
		routing prefix) which is used to determine if an IP
		address belongs to the local subnet or needs to be
		forwarded through a router.
		(Environment variable "netmask")

D
David Updegraff 已提交
1532 1533 1534 1535 1536
- Multicast TFTP Mode:
		CONFIG_MCAST_TFTP

		Defines whether you want to support multicast TFTP as per
		rfc-2090; for example to work with atftp.  Lets lots of targets
M
Marcel Ziswiler 已提交
1537
		tftp down the same boot image concurrently.  Note: the Ethernet
D
David Updegraff 已提交
1538 1539 1540
		driver in use must provide a function: mcast() to join/leave a
		multicast group.

W
wdenk 已提交
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551
- BOOTP Recovery Mode:
		CONFIG_BOOTP_RANDOM_DELAY

		If you have many targets in a network that try to
		boot using BOOTP, you may want to avoid that all
		systems send out BOOTP requests at precisely the same
		moment (which would happen for instance at recovery
		from a power failure, when all systems will try to
		boot, thus flooding the BOOTP server. Defining
		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
		inserted before sending out BOOTP requests. The
1552
		following delays are inserted then:
W
wdenk 已提交
1553 1554 1555 1556 1557 1558 1559

		1st BOOTP request:	delay 0 ... 1 sec
		2nd BOOTP request:	delay 0 ... 2 sec
		3rd BOOTP request:	delay 0 ... 4 sec
		4th and following
		BOOTP requests:		delay 0 ... 8 sec

1560
- DHCP Advanced Options:
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
		You can fine tune the DHCP functionality by defining
		CONFIG_BOOTP_* symbols:

		CONFIG_BOOTP_SUBNETMASK
		CONFIG_BOOTP_GATEWAY
		CONFIG_BOOTP_HOSTNAME
		CONFIG_BOOTP_NISDOMAIN
		CONFIG_BOOTP_BOOTPATH
		CONFIG_BOOTP_BOOTFILESIZE
		CONFIG_BOOTP_DNS
		CONFIG_BOOTP_DNS2
		CONFIG_BOOTP_SEND_HOSTNAME
		CONFIG_BOOTP_NTPSERVER
		CONFIG_BOOTP_TIMEOFFSET
		CONFIG_BOOTP_VENDOREX
1576

W
Wilson Callan 已提交
1577 1578
		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
		environment variable, not the BOOTP server.
1579 1580 1581 1582 1583 1584 1585 1586

		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
		serverip from a DHCP server, it is possible that more
		than one DNS serverip is offered to the client.
		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
		serverip will be stored in the additional environment
		variable "dnsip2". The first DNS serverip is always
		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1587
		is defined.
1588 1589 1590 1591

		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
		to do a dynamic update of a DNS server. To do this, they
		need the hostname of the DHCP requester.
W
Wilson Callan 已提交
1592
		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1593 1594
		of the "hostname" environment variable is passed as
		option 12 to the DHCP server.
1595

1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
		CONFIG_BOOTP_DHCP_REQUEST_DELAY

		A 32bit value in microseconds for a delay between
		receiving a "DHCP Offer" and sending the "DHCP Request".
		This fixes a problem with certain DHCP servers that don't
		respond 100% of the time to a "DHCP request". E.g. On an
		AT91RM9200 processor running at 180MHz, this delay needed
		to be *at least* 15,000 usec before a Windows Server 2003
		DHCP server would reply 100% of the time. I recommend at
		least 50,000 usec to be safe. The alternative is to hope
		that one of the retries will be successful but note that
		the DHCP timeout and retry process takes a longer than
		this delay.

1610
 - CDP Options:
W
wdenk 已提交
1611
		CONFIG_CDP_DEVICE_ID
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623

		The device id used in CDP trigger frames.

		CONFIG_CDP_DEVICE_ID_PREFIX

		A two character string which is prefixed to the MAC address
		of the device.

		CONFIG_CDP_PORT_ID

		A printf format string which contains the ascii name of
		the port. Normally is set to "eth%d" which sets
M
Marcel Ziswiler 已提交
1624
		eth0 for the first Ethernet, eth1 for the second etc.
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651

		CONFIG_CDP_CAPABILITIES

		A 32bit integer which indicates the device capabilities;
		0x00000010 for a normal host which does not forwards.

		CONFIG_CDP_VERSION

		An ascii string containing the version of the software.

		CONFIG_CDP_PLATFORM

		An ascii string containing the name of the platform.

		CONFIG_CDP_TRIGGER

		A 32bit integer sent on the trigger.

		CONFIG_CDP_POWER_CONSUMPTION

		A 16bit integer containing the power consumption of the
		device in .1 of milliwatts.

		CONFIG_CDP_APPLIANCE_VLAN_TYPE

		A byte containing the id of the VLAN.

W
wdenk 已提交
1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
- Status LED:	CONFIG_STATUS_LED

		Several configurations allow to display the current
		status using a LED. For instance, the LED will blink
		fast while running U-Boot code, stop blinking as
		soon as a reply to a BOOTP request was received, and
		start blinking slow once the Linux kernel is running
		(supported by a status LED driver in the Linux
		kernel). Defining CONFIG_STATUS_LED enables this
		feature in U-Boot.

- CAN Support:	CONFIG_CAN_DRIVER

		Defining CONFIG_CAN_DRIVER enables CAN driver support
		on those systems that support this (optional)
		feature, like the TQM8xxL modules.

- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C

W
wdenk 已提交
1671
		These enable I2C serial bus commands. Defining either of
1672
		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
M
Marcel Ziswiler 已提交
1673
		include the appropriate I2C driver for the selected CPU.
W
wdenk 已提交
1674

1675
		This will allow you to use i2c commands at the u-boot
1676
		command line (as long as you set CONFIG_CMD_I2C in
W
wdenk 已提交
1677 1678
		CONFIG_COMMANDS) and communicate with i2c based realtime
		clock chips. See common/cmd_i2c.c for a description of the
W
wdenk 已提交
1679
		command line interface.
W
wdenk 已提交
1680

B
Ben Warren 已提交
1681
		CONFIG_HARD_I2C selects a hardware I2C controller.
W
wdenk 已提交
1682

1683
		CONFIG_SOFT_I2C configures u-boot to use a software (aka
W
wdenk 已提交
1684 1685
		bit-banging) driver instead of CPM or similar hardware
		support for I2C.
W
wdenk 已提交
1686

1687
		There are several other quantities that must also be
W
wdenk 已提交
1688
		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
W
wdenk 已提交
1689

1690
		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1691
		to be the frequency (in Hz) at which you wish your i2c bus
1692
		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
M
Marcel Ziswiler 已提交
1693
		the CPU's i2c node address).
1694

1695
		Now, the u-boot i2c code for the mpc8xx
S
Stefan Roese 已提交
1696
		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
1697 1698 1699
		and so its address should therefore be cleared to 0 (See,
		eg, MPC823e User's Manual p.16-473). So, set
		CONFIG_SYS_I2C_SLAVE to 0.
W
wdenk 已提交
1700

1701 1702 1703 1704 1705 1706 1707
		CONFIG_SYS_I2C_INIT_MPC5XXX

		When a board is reset during an i2c bus transfer
		chips might think that the current transfer is still
		in progress.  Reset the slave devices by sending start
		commands until the slave device responds.

1708
		That's all that's required for CONFIG_HARD_I2C.
W
wdenk 已提交
1709

W
wdenk 已提交
1710 1711 1712
		If you use the software i2c interface (CONFIG_SOFT_I2C)
		then the following macros need to be defined (examples are
		from include/configs/lwmon.h):
W
wdenk 已提交
1713 1714 1715

		I2C_INIT

W
wdenk 已提交
1716
		(Optional). Any commands necessary to enable the I2C
W
wdenk 已提交
1717
		controller or configure ports.
W
wdenk 已提交
1718

W
wdenk 已提交
1719
		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
W
wdenk 已提交
1720

W
wdenk 已提交
1721 1722
		I2C_PORT

W
wdenk 已提交
1723 1724 1725
		(Only for MPC8260 CPU). The I/O port to use (the code
		assumes both bits are on the same port). Valid values
		are 0..3 for ports A..D.
W
wdenk 已提交
1726 1727 1728 1729 1730 1731 1732

		I2C_ACTIVE

		The code necessary to make the I2C data line active
		(driven).  If the data line is open collector, this
		define can be null.

W
wdenk 已提交
1733 1734
		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)

W
wdenk 已提交
1735 1736 1737 1738 1739 1740
		I2C_TRISTATE

		The code necessary to make the I2C data line tri-stated
		(inactive).  If the data line is open collector, this
		define can be null.

W
wdenk 已提交
1741 1742
		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)

W
wdenk 已提交
1743 1744 1745 1746 1747
		I2C_READ

		Code that returns TRUE if the I2C data line is high,
		FALSE if it is low.

W
wdenk 已提交
1748 1749
		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)

W
wdenk 已提交
1750 1751 1752 1753 1754
		I2C_SDA(bit)

		If <bit> is TRUE, sets the I2C data line high. If it
		is FALSE, it clears it (low).

W
wdenk 已提交
1755
		eg: #define I2C_SDA(bit) \
W
wdenk 已提交
1756
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
W
wdenk 已提交
1757
			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
W
wdenk 已提交
1758

W
wdenk 已提交
1759 1760 1761 1762 1763
		I2C_SCL(bit)

		If <bit> is TRUE, sets the I2C clock line high. If it
		is FALSE, it clears it (low).

W
wdenk 已提交
1764
		eg: #define I2C_SCL(bit) \
W
wdenk 已提交
1765
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
W
wdenk 已提交
1766
			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
W
wdenk 已提交
1767

W
wdenk 已提交
1768 1769 1770 1771
		I2C_DELAY

		This delay is invoked four times per clock cycle so this
		controls the rate of data transfer.  The data rate thus
W
wdenk 已提交
1772
		is 1 / (I2C_DELAY * 4). Often defined to be something
1773 1774
		like:

W
wdenk 已提交
1775
		#define I2C_DELAY  udelay(2)
W
wdenk 已提交
1776

1777 1778 1779 1780 1781 1782 1783 1784 1785 1786
		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA

		If your arch supports the generic GPIO framework (asm/gpio.h),
		then you may alternatively define the two GPIOs that are to be
		used as SCL / SDA.  Any of the previous I2C_xxx macros will
		have GPIO-based defaults assigned to them as appropriate.

		You should define these to the GPIO value as given directly to
		the generic GPIO functions.

1787
		CONFIG_SYS_I2C_INIT_BOARD
1788

W
wdenk 已提交
1789 1790 1791 1792 1793 1794 1795 1796
		When a board is reset during an i2c bus transfer
		chips might think that the current transfer is still
		in progress. On some boards it is possible to access
		the i2c SCLK line directly, either by using the
		processor pin as a GPIO or by having a second pin
		connected to the bus. If this option is defined a
		custom i2c_init_board() routine in boards/xxx/board.c
		is run early in the boot sequence.
1797

1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
		CONFIG_SYS_I2C_BOARD_LATE_INIT

		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
		defined a custom i2c_board_late_init() routine in
		boards/xxx/board.c is run AFTER the operations in i2c_init()
		is completed. This callpoint can be used to unreset i2c bus
		using CPU i2c controller register accesses for CPUs whose i2c
		controller provide such a method. It is called at the end of
		i2c_init() to allow i2c_init operations to setup the i2c bus
		controller on the CPU (e.g. setting bus speed & slave address).

W
wdenk 已提交
1809 1810 1811 1812 1813 1814
		CONFIG_I2CFAST (PPC405GP|PPC405EP only)

		This option enables configuration of bi_iic_fast[] flags
		in u-boot bd_info structure based on u-boot environment
		variable "i2cfast". (see also i2cfast)

B
Ben Warren 已提交
1815 1816 1817
		CONFIG_I2C_MULTI_BUS

		This option allows the use of multiple I2C buses, each of which
W
Wolfgang Denk 已提交
1818 1819
		must have a controller.	 At any point in time, only one bus is
		active.	 To switch to a different bus, use the 'i2c dev' command.
B
Ben Warren 已提交
1820 1821
		Note that bus numbering is zero-based.

1822
		CONFIG_SYS_I2C_NOPROBES
B
Ben Warren 已提交
1823 1824

		This option specifies a list of I2C devices that will be skipped
W
Wolfgang Denk 已提交
1825
		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
1826 1827
		is set, specify a list of bus-device pairs.  Otherwise, specify
		a 1D array of device addresses
B
Ben Warren 已提交
1828 1829 1830

		e.g.
			#undef	CONFIG_I2C_MULTI_BUS
W
Wolfgang Denk 已提交
1831
			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
B
Ben Warren 已提交
1832 1833 1834

		will skip addresses 0x50 and 0x68 on a board with one I2C bus

W
Wolfgang Denk 已提交
1835
			#define CONFIG_I2C_MULTI_BUS
1836
			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
B
Ben Warren 已提交
1837 1838 1839

		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1

1840
		CONFIG_SYS_SPD_BUS_NUM
T
Timur Tabi 已提交
1841 1842 1843 1844

		If defined, then this indicates the I2C bus number for DDR SPD.
		If not defined, then U-Boot assumes that SPD is on I2C bus 0.

1845
		CONFIG_SYS_RTC_BUS_NUM
1846 1847 1848 1849

		If defined, then this indicates the I2C bus number for the RTC.
		If not defined, then U-Boot assumes that RTC is on I2C bus 0.

1850
		CONFIG_SYS_DTT_BUS_NUM
1851 1852 1853 1854

		If defined, then this indicates the I2C bus number for the DTT.
		If not defined, then U-Boot assumes that DTT is on I2C bus 0.

1855
		CONFIG_SYS_I2C_DTT_ADDR:
1856 1857 1858 1859 1860

		If defined, specifies the I2C address of the DTT device.
		If not defined, then U-Boot uses predefined value for
		specified DTT device.

T
Timur Tabi 已提交
1861 1862 1863
		CONFIG_FSL_I2C

		Define this option if you want to use Freescale's I2C driver in
1864
		drivers/i2c/fsl_i2c.c.
T
Timur Tabi 已提交
1865

1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899
		CONFIG_I2C_MUX

		Define this option if you have I2C devices reached over 1 .. n
		I2C Muxes like the pca9544a. This option addes a new I2C
		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
		new I2C Bus to the existing I2C Busses. If you select the
		new Bus with "i2c dev", u-bbot sends first the commandos for
		the muxes to activate this new "bus".

		CONFIG_I2C_MULTI_BUS must be also defined, to use this
		feature!

		Example:
		Adding a new I2C Bus reached over 2 pca9544a muxes
			The First mux with address 70 and channel 6
			The Second mux with address 71 and channel 4

		=> i2c bus pca9544a:70:6:pca9544a:71:4

		Use the "i2c bus" command without parameter, to get a list
		of I2C Busses with muxes:

		=> i2c bus
		Busses reached over muxes:
		Bus ID: 2
		  reached over Mux(es):
		    pca9544a@70 ch: 4
		Bus ID: 3
		  reached over Mux(es):
		    pca9544a@70 ch: 6
		    pca9544a@71 ch: 4
		=>

		If you now switch to the new I2C Bus 3 with "i2c dev 3"
M
Michael Jones 已提交
1900 1901
		u-boot first sends the command to the mux@70 to enable
		channel 6, and then the command to the mux@71 to enable
1902 1903 1904
		the channel 4.

		After that, you can use the "normal" i2c commands as
M
Michael Jones 已提交
1905
		usual to communicate with your I2C devices behind
1906 1907 1908 1909 1910 1911 1912
		the 2 muxes.

		This option is actually implemented for the bitbanging
		algorithm in common/soft_i2c.c and for the Hardware I2C
		Bus on the MPC8260. But it should be not so difficult
		to add this option to other architectures.

1913 1914 1915 1916 1917 1918 1919 1920 1921
		CONFIG_SOFT_I2C_READ_REPEATED_START

		defining this will force the i2c_read() function in
		the soft_i2c driver to perform an I2C repeated start
		between writing the address pointer and reading the
		data.  If this define is omitted the default behaviour
		of doing a stop-start sequence will be used.  Most I2C
		devices can use either method, but some require one or
		the other.
T
Timur Tabi 已提交
1922

W
wdenk 已提交
1923 1924 1925 1926 1927 1928
- SPI Support:	CONFIG_SPI

		Enables SPI driver (so far only tested with
		SPI EEPROM, also an instance works with Crystal A/D and
		D/As on the SACSng board)

1929 1930 1931 1932 1933
		CONFIG_SH_SPI

		Enables the driver for SPI controller on SuperH. Currently
		only SH7757 is supported.

W
wdenk 已提交
1934 1935 1936 1937 1938 1939 1940
		CONFIG_SPI_X

		Enables extended (16-bit) SPI EEPROM addressing.
		(symmetrical to CONFIG_I2C_X)

		CONFIG_SOFT_SPI

W
wdenk 已提交
1941 1942 1943 1944 1945 1946 1947
		Enables a software (bit-bang) SPI driver rather than
		using hardware support. This is a general purpose
		driver that only requires three general I/O port pins
		(two outputs, one input) to function. If this is
		defined, the board configuration must define several
		SPI configuration items (port pins to use, etc). For
		an example, see include/configs/sacsng.h.
W
wdenk 已提交
1948

1949 1950 1951 1952 1953
		CONFIG_HARD_SPI

		Enables a hardware SPI driver for general-purpose reads
		and writes.  As with CONFIG_SOFT_SPI, the board configuration
		must define a list of chip-select function pointers.
W
Wolfgang Denk 已提交
1954
		Currently supported on some MPC8xxx processors.	 For an
1955 1956
		example, see include/configs/mpc8349emds.h.

G
Guennadi Liakhovetski 已提交
1957 1958 1959
		CONFIG_MXC_SPI

		Enables the driver for the SPI controllers on i.MX and MXC
1960
		SoCs. Currently i.MX31/35/51 are supported.
G
Guennadi Liakhovetski 已提交
1961

1962
- FPGA Support: CONFIG_FPGA
W
wdenk 已提交
1963

1964 1965 1966 1967 1968 1969
		Enables FPGA subsystem.

		CONFIG_FPGA_<vendor>

		Enables support for specific chip vendors.
		(ALTERA, XILINX)
W
wdenk 已提交
1970

1971
		CONFIG_FPGA_<family>
W
wdenk 已提交
1972

1973 1974 1975 1976 1977 1978
		Enables support for FPGA family.
		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)

		CONFIG_FPGA_COUNT

		Specify the number of FPGA devices to support.
W
wdenk 已提交
1979

1980
		CONFIG_SYS_FPGA_PROG_FEEDBACK
W
wdenk 已提交
1981

W
wdenk 已提交
1982
		Enable printing of hash marks during FPGA configuration.
W
wdenk 已提交
1983

1984
		CONFIG_SYS_FPGA_CHECK_BUSY
W
wdenk 已提交
1985

W
wdenk 已提交
1986 1987 1988 1989
		Enable checks on FPGA configuration interface busy
		status by the configuration function. This option
		will require a board or device specific function to
		be written.
W
wdenk 已提交
1990 1991 1992 1993 1994 1995

		CONFIG_FPGA_DELAY

		If defined, a function that provides delays in the FPGA
		configuration driver.

1996
		CONFIG_SYS_FPGA_CHECK_CTRLC
W
wdenk 已提交
1997 1998
		Allow Control-C to interrupt FPGA configuration

1999
		CONFIG_SYS_FPGA_CHECK_ERROR
W
wdenk 已提交
2000

W
wdenk 已提交
2001 2002 2003 2004
		Check for configuration errors during FPGA bitfile
		loading. For example, abort during Virtex II
		configuration if the INIT_B line goes low (which
		indicated a CRC error).
W
wdenk 已提交
2005

2006
		CONFIG_SYS_FPGA_WAIT_INIT
W
wdenk 已提交
2007

W
wdenk 已提交
2008 2009 2010
		Maximum time to wait for the INIT_B line to deassert
		after PROB_B has been deasserted during a Virtex II
		FPGA configuration sequence. The default time is 500
M
Marcel Ziswiler 已提交
2011
		ms.
W
wdenk 已提交
2012

2013
		CONFIG_SYS_FPGA_WAIT_BUSY
W
wdenk 已提交
2014

W
wdenk 已提交
2015
		Maximum time to wait for BUSY to deassert during
M
Marcel Ziswiler 已提交
2016
		Virtex II FPGA configuration. The default is 5 ms.
W
wdenk 已提交
2017

2018
		CONFIG_SYS_FPGA_WAIT_CONFIG
W
wdenk 已提交
2019

W
wdenk 已提交
2020
		Time to wait after FPGA configuration. The default is
M
Marcel Ziswiler 已提交
2021
		200 ms.
W
wdenk 已提交
2022 2023 2024 2025

- Configuration Management:
		CONFIG_IDENT_STRING

W
wdenk 已提交
2026 2027
		If defined, this string will be added to the U-Boot
		version information (U_BOOT_VERSION)
W
wdenk 已提交
2028 2029 2030

- Vendor Parameter Protection:

W
wdenk 已提交
2031 2032
		U-Boot considers the values of the environment
		variables "serial#" (Board Serial Number) and
W
wdenk 已提交
2033
		"ethaddr" (Ethernet Address) to be parameters that
W
wdenk 已提交
2034 2035 2036 2037
		are set once by the board vendor / manufacturer, and
		protects these variables from casual modification by
		the user. Once set, these variables are read-only,
		and write or delete attempts are rejected. You can
M
Marcel Ziswiler 已提交
2038
		change this behaviour:
W
wdenk 已提交
2039 2040 2041

		If CONFIG_ENV_OVERWRITE is #defined in your config
		file, the write protection for vendor parameters is
2042
		completely disabled. Anybody can change or delete
W
wdenk 已提交
2043 2044 2045 2046
		these parameters.

		Alternatively, if you #define _both_ CONFIG_ETHADDR
		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
M
Marcel Ziswiler 已提交
2047
		Ethernet address is installed in the environment,
W
wdenk 已提交
2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067
		which can be changed exactly ONCE by the user. [The
		serial# is unaffected by this, i. e. it remains
		read-only.]

- Protected RAM:
		CONFIG_PRAM

		Define this variable to enable the reservation of
		"protected RAM", i. e. RAM which is not overwritten
		by U-Boot. Define CONFIG_PRAM to hold the number of
		kB you want to reserve for pRAM. You can overwrite
		this default value by defining an environment
		variable "pram" to the number of kB you want to
		reserve. Note that the board info structure will
		still show the full amount of RAM. If pRAM is
		reserved, a new environment variable "mem" will
		automatically be defined to hold the amount of
		remaining RAM in a form that can be passed as boot
		argument to Linux, for instance like that:

2068
			setenv bootargs ... mem=\${mem}
W
wdenk 已提交
2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
			saveenv

		This way you can tell Linux not to use this memory,
		either, which results in a memory region that will
		not be affected by reboots.

		*WARNING* If your board configuration uses automatic
		detection of the RAM size, you must make sure that
		this memory test is non-destructive. So far, the
		following board configurations are known to be
		"pRAM-clean":

			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
			HERMES, IP860, RPXlite, LWMON, LANTEC,
2083
			FLAGADM, TQM8260
W
wdenk 已提交
2084 2085 2086 2087 2088 2089 2090

- Error Recovery:
		CONFIG_PANIC_HANG

		Define this variable to stop the system in case of a
		fatal error, so that you have to reset it manually.
		This is probably NOT a good idea for an embedded
M
Marcel Ziswiler 已提交
2091
		system where you want the system to reboot
W
wdenk 已提交
2092 2093 2094 2095 2096 2097
		automatically as fast as possible, but it may be
		useful during development since you can try to debug
		the conditions that lead to the situation.

		CONFIG_NET_RETRY_COUNT

W
wdenk 已提交
2098 2099 2100 2101
		This variable defines the number of retries for
		network operations like ARP, RARP, TFTP, or BOOTP
		before giving up the operation. If not defined, a
		default value of 5 is used.
W
wdenk 已提交
2102

2103 2104 2105 2106
		CONFIG_ARP_TIMEOUT

		Timeout waiting for an ARP reply in milliseconds.

W
wdenk 已提交
2107
- Command Interpreter:
2108
		CONFIG_AUTO_COMPLETE
2109 2110 2111

		Enable auto completion of commands using TAB.

2112 2113
		Note that this feature has NOT been implemented yet
		for the "hush" shell.
2114 2115


2116
		CONFIG_SYS_HUSH_PARSER
W
wdenk 已提交
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127

		Define this variable to enable the "hush" shell (from
		Busybox) as command line interpreter, thus enabling
		powerful command line syntax like
		if...then...else...fi conditionals or `&&' and '||'
		constructs ("shell scripts").

		If undefined, you get the old, much simpler behaviour
		with a somewhat smaller memory footprint.


2128
		CONFIG_SYS_PROMPT_HUSH_PS2
W
wdenk 已提交
2129 2130 2131 2132 2133 2134 2135

		This defines the secondary prompt string, which is
		printed when the command interpreter needs more input
		to complete a command. Usually "> ".

	Note:

W
wdenk 已提交
2136 2137 2138 2139 2140 2141 2142
		In the current implementation, the local variables
		space and global environment variables space are
		separated. Local variables are those you define by
		simply typing `name=value'. To access a local
		variable later on, you have write `$name' or
		`${name}'; to execute the contents of a variable
		directly type `$name' at the command prompt.
W
wdenk 已提交
2143

W
wdenk 已提交
2144 2145 2146 2147
		Global environment variables are those you use
		setenv/printenv to work with. To run a command stored
		in such a variable, you need to use the run command,
		and you must not use the '$' sign to access them.
W
wdenk 已提交
2148 2149 2150 2151 2152 2153 2154

		To store commands and special characters in a
		variable, please use double quotation marks
		surrounding the whole text of the variable, instead
		of the backslashes before semicolons and special
		symbols.

2155 2156 2157
- Commandline Editing and History:
		CONFIG_CMDLINE_EDITING

M
Marcel Ziswiler 已提交
2158
		Enable editing and History functions for interactive
W
Wolfgang Denk 已提交
2159
		commandline input operations
2160

W
wdenk 已提交
2161
- Default Environment:
W
wdenk 已提交
2162 2163
		CONFIG_EXTRA_ENV_SETTINGS

W
wdenk 已提交
2164 2165
		Define this to contain any number of null terminated
		strings (variable = value pairs) that will be part of
W
wdenk 已提交
2166
		the default environment compiled into the boot image.
W
wdenk 已提交
2167

W
wdenk 已提交
2168 2169
		For example, place something like this in your
		board's config file:
W
wdenk 已提交
2170 2171 2172 2173 2174

		#define CONFIG_EXTRA_ENV_SETTINGS \
			"myvar1=value1\0" \
			"myvar2=value2\0"

W
wdenk 已提交
2175 2176 2177 2178
		Warning: This method is based on knowledge about the
		internal format how the environment is stored by the
		U-Boot code. This is NOT an official, exported
		interface! Although it is unlikely that this format
W
wdenk 已提交
2179
		will change soon, there is no guarantee either.
W
wdenk 已提交
2180 2181
		You better know what you are doing here.

W
wdenk 已提交
2182 2183
		Note: overly (ab)use of the default environment is
		discouraged. Make sure to check other ways to preset
2184
		the environment like the "source" command or the
W
wdenk 已提交
2185
		boot command first.
W
wdenk 已提交
2186

W
wdenk 已提交
2187
- DataFlash Support:
2188 2189
		CONFIG_HAS_DATAFLASH

W
wdenk 已提交
2190 2191 2192
		Defining this option enables DataFlash features and
		allows to read/write in Dataflash via the standard
		commands cp, md...
2193

W
wdenk 已提交
2194 2195 2196 2197 2198
- SystemACE Support:
		CONFIG_SYSTEMACE

		Adding this option adds support for Xilinx SystemACE
		chips attached via some sort of local bus. The address
M
Marcel Ziswiler 已提交
2199
		of the chip must also be defined in the
2200
		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
W
wdenk 已提交
2201 2202

		#define CONFIG_SYSTEMACE
2203
		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
W
wdenk 已提交
2204 2205 2206 2207

		When SystemACE support is added, the "ace" device type
		becomes available to the fat commands, i.e. fatls.

2208 2209 2210
- TFTP Fixed UDP Port:
		CONFIG_TFTP_PORT

2211
		If this is defined, the environment variable tftpsrcp
2212
		is used to supply the TFTP UDP source port value.
2213
		If tftpsrcp isn't defined, the normal pseudo-random port
2214 2215
		number generator is used.

2216 2217 2218 2219 2220
		Also, the environment variable tftpdstp is used to supply
		the TFTP UDP destination port value.  If tftpdstp isn't
		defined, the normal port 69 is used.

		The purpose for tftpsrcp is to allow a TFTP server to
2221 2222 2223 2224 2225 2226 2227
		blindly start the TFTP transfer using the pre-configured
		target IP address and UDP port. This has the effect of
		"punching through" the (Windows XP) firewall, allowing
		the remainder of the TFTP transfer to proceed normally.
		A better solution is to properly configure the firewall,
		but sometimes that is not allowed.

W
wdenk 已提交
2228
- Show boot progress:
W
wdenk 已提交
2229 2230
		CONFIG_SHOW_BOOT_PROGRESS

W
wdenk 已提交
2231 2232 2233 2234 2235 2236
		Defining this option allows to add some board-
		specific code (calling a user-provided function
		"show_boot_progress(int)") that enables you to show
		the system's boot progress on some display (for
		example, some LED's) on your board. At the moment,
		the following checkpoints are implemented:
W
wdenk 已提交
2237

2238 2239
Legacy uImage format:

W
wdenk 已提交
2240 2241
  Arg	Where			When
    1	common/cmd_bootm.c	before attempting to boot an image
W
wdenk 已提交
2242
   -1	common/cmd_bootm.c	Image header has bad	 magic number
W
wdenk 已提交
2243
    2	common/cmd_bootm.c	Image header has correct magic number
W
wdenk 已提交
2244
   -2	common/cmd_bootm.c	Image header has bad	 checksum
W
wdenk 已提交
2245
    3	common/cmd_bootm.c	Image header has correct checksum
W
wdenk 已提交
2246
   -3	common/cmd_bootm.c	Image data   has bad	 checksum
W
wdenk 已提交
2247 2248 2249
    4	common/cmd_bootm.c	Image data   has correct checksum
   -4	common/cmd_bootm.c	Image is for unsupported architecture
    5	common/cmd_bootm.c	Architecture check OK
2250
   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
W
wdenk 已提交
2251 2252 2253 2254
    6	common/cmd_bootm.c	Image Type check OK
   -6	common/cmd_bootm.c	gunzip uncompression error
   -7	common/cmd_bootm.c	Unimplemented compression type
    7	common/cmd_bootm.c	Uncompression OK
2255
    8	common/cmd_bootm.c	No uncompress/copy overwrite error
W
wdenk 已提交
2256
   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
2257 2258 2259 2260 2261 2262 2263 2264

    9	common/image.c		Start initial ramdisk verification
  -10	common/image.c		Ramdisk header has bad	   magic number
  -11	common/image.c		Ramdisk header has bad	   checksum
   10	common/image.c		Ramdisk header is OK
  -12	common/image.c		Ramdisk data   has bad	   checksum
   11	common/image.c		Ramdisk data   has correct checksum
   12	common/image.c		Ramdisk verification complete, start loading
M
Marcel Ziswiler 已提交
2265
  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
2266 2267 2268
   13	common/image.c		Start multifile image verification
   14	common/image.c		No initial ramdisk, no multifile, continue.

W
Wolfgang Denk 已提交
2269
   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
W
wdenk 已提交
2270

S
Stefan Roese 已提交
2271
  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
W
wdenk 已提交
2272 2273
  -31	post/post.c		POST test failed, detected by post_output_backlog()
  -32	post/post.c		POST test failed, detected by post_run_single()
2274

2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324
   34	common/cmd_doc.c	before loading a Image from a DOC device
  -35	common/cmd_doc.c	Bad usage of "doc" command
   35	common/cmd_doc.c	correct usage of "doc" command
  -36	common/cmd_doc.c	No boot device
   36	common/cmd_doc.c	correct boot device
  -37	common/cmd_doc.c	Unknown Chip ID on boot device
   37	common/cmd_doc.c	correct chip ID found, device available
  -38	common/cmd_doc.c	Read Error on boot device
   38	common/cmd_doc.c	reading Image header from DOC device OK
  -39	common/cmd_doc.c	Image header has bad magic number
   39	common/cmd_doc.c	Image header has correct magic number
  -40	common/cmd_doc.c	Error reading Image from DOC device
   40	common/cmd_doc.c	Image header has correct magic number
   41	common/cmd_ide.c	before loading a Image from a IDE device
  -42	common/cmd_ide.c	Bad usage of "ide" command
   42	common/cmd_ide.c	correct usage of "ide" command
  -43	common/cmd_ide.c	No boot device
   43	common/cmd_ide.c	boot device found
  -44	common/cmd_ide.c	Device not available
   44	common/cmd_ide.c	Device available
  -45	common/cmd_ide.c	wrong partition selected
   45	common/cmd_ide.c	partition selected
  -46	common/cmd_ide.c	Unknown partition table
   46	common/cmd_ide.c	valid partition table found
  -47	common/cmd_ide.c	Invalid partition type
   47	common/cmd_ide.c	correct partition type
  -48	common/cmd_ide.c	Error reading Image Header on boot device
   48	common/cmd_ide.c	reading Image Header from IDE device OK
  -49	common/cmd_ide.c	Image header has bad magic number
   49	common/cmd_ide.c	Image header has correct magic number
  -50	common/cmd_ide.c	Image header has bad	 checksum
   50	common/cmd_ide.c	Image header has correct checksum
  -51	common/cmd_ide.c	Error reading Image from IDE device
   51	common/cmd_ide.c	reading Image from IDE device OK
   52	common/cmd_nand.c	before loading a Image from a NAND device
  -53	common/cmd_nand.c	Bad usage of "nand" command
   53	common/cmd_nand.c	correct usage of "nand" command
  -54	common/cmd_nand.c	No boot device
   54	common/cmd_nand.c	boot device found
  -55	common/cmd_nand.c	Unknown Chip ID on boot device
   55	common/cmd_nand.c	correct chip ID found, device available
  -56	common/cmd_nand.c	Error reading Image Header on boot device
   56	common/cmd_nand.c	reading Image Header from NAND device OK
  -57	common/cmd_nand.c	Image header has bad magic number
   57	common/cmd_nand.c	Image header has correct magic number
  -58	common/cmd_nand.c	Error reading Image from NAND device
   58	common/cmd_nand.c	reading Image from NAND device OK

  -60	common/env_common.c	Environment has a bad CRC, using default

M
Marcel Ziswiler 已提交
2325
   64	net/eth.c		starting with Ethernet configuration.
2326 2327 2328 2329 2330
  -64	net/eth.c		no Ethernet found.
   65	net/eth.c		Ethernet found.

  -80	common/cmd_net.c	usage wrong
   80	common/cmd_net.c	before calling NetLoop()
M
Marcel Ziswiler 已提交
2331
  -81	common/cmd_net.c	some error in NetLoop() occurred
2332 2333 2334
   81	common/cmd_net.c	NetLoop() back without error
  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
   82	common/cmd_net.c	trying automatic boot
2335 2336
   83	common/cmd_net.c	running "source" command
  -83	common/cmd_net.c	some error in automatic boot or "source" command
2337
   84	common/cmd_net.c	end without errors
W
wdenk 已提交
2338

2339 2340 2341 2342 2343 2344 2345 2346 2347
FIT uImage format:

  Arg	Where			When
  100	common/cmd_bootm.c	Kernel FIT Image has correct format
 -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
 -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
  102	common/cmd_bootm.c	Kernel unit name specified
 -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2348
  103	common/cmd_bootm.c	Found configuration node
2349 2350 2351 2352 2353
  104	common/cmd_bootm.c	Got kernel subimage node offset
 -104	common/cmd_bootm.c	Kernel subimage hash verification failed
  105	common/cmd_bootm.c	Kernel subimage hash verification OK
 -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
  106	common/cmd_bootm.c	Architecture check OK
M
Marcel Ziswiler 已提交
2354 2355
 -106	common/cmd_bootm.c	Kernel subimage has wrong type
  107	common/cmd_bootm.c	Kernel subimage type OK
2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367
 -107	common/cmd_bootm.c	Can't get kernel subimage data/size
  108	common/cmd_bootm.c	Got kernel subimage data/size
 -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
 -109	common/cmd_bootm.c	Can't get kernel subimage type
 -110	common/cmd_bootm.c	Can't get kernel subimage comp
 -111	common/cmd_bootm.c	Can't get kernel subimage os
 -112	common/cmd_bootm.c	Can't get kernel subimage load address
 -113	common/cmd_bootm.c	Image uncompress/copy overwrite error

  120	common/image.c		Start initial ramdisk verification
 -120	common/image.c		Ramdisk FIT image has incorrect format
  121	common/image.c		Ramdisk FIT image has correct format
M
Marcel Ziswiler 已提交
2368
  122	common/image.c		No ramdisk subimage unit name, using configuration
2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381
 -122	common/image.c		Can't get configuration for ramdisk subimage
  123	common/image.c		Ramdisk unit name specified
 -124	common/image.c		Can't get ramdisk subimage node offset
  125	common/image.c		Got ramdisk subimage node offset
 -125	common/image.c		Ramdisk subimage hash verification failed
  126	common/image.c		Ramdisk subimage hash verification OK
 -126	common/image.c		Ramdisk subimage for unsupported architecture
  127	common/image.c		Architecture check OK
 -127	common/image.c		Can't get ramdisk subimage data/size
  128	common/image.c		Got ramdisk subimage data/size
  129	common/image.c		Can't get ramdisk load address
 -129	common/image.c		Got ramdisk load address

M
Marcel Ziswiler 已提交
2382
 -130	common/cmd_doc.c	Incorrect FIT image format
2383 2384
  131	common/cmd_doc.c	FIT image format OK

M
Marcel Ziswiler 已提交
2385
 -140	common/cmd_ide.c	Incorrect FIT image format
2386 2387
  141	common/cmd_ide.c	FIT image format OK

M
Marcel Ziswiler 已提交
2388
 -150	common/cmd_nand.c	Incorrect FIT image format
2389 2390
  151	common/cmd_nand.c	FIT image format OK

2391 2392 2393
- Standalone program support:
		CONFIG_STANDALONE_LOAD_ADDR

W
Wolfgang Denk 已提交
2394 2395 2396
		This option defines a board specific value for the
		address where standalone program gets loaded, thus
		overwriting the architecture dependent default
2397 2398 2399 2400 2401 2402 2403 2404 2405
		settings.

- Frame Buffer Address:
		CONFIG_FB_ADDR

		Define CONFIG_FB_ADDR if you want to use specific
		address for frame buffer.
		Then system will reserve the frame buffer address to
		defined address instead of lcd_setmem (this function
W
Wolfgang Denk 已提交
2406
		grabs the memory for frame buffer by panel's size).
2407 2408 2409

		Please see board_init_f function.

2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428
- Automatic software updates via TFTP server
		CONFIG_UPDATE_TFTP
		CONFIG_UPDATE_TFTP_CNT_MAX
		CONFIG_UPDATE_TFTP_MSEC_MAX

		These options enable and control the auto-update feature;
		for a more detailed description refer to doc/README.update.

- MTD Support (mtdparts command, UBI support)
		CONFIG_MTD_DEVICE

		Adds the MTD device infrastructure from the Linux kernel.
		Needed for mtdparts command support.

		CONFIG_MTD_PARTITIONS

		Adds the MTD partitioning infrastructure from the Linux
		kernel. Needed for UBI support.

2429
- SPL framework
W
Wolfgang Denk 已提交
2430 2431
		CONFIG_SPL
		Enable building of SPL globally.
2432

W
Wolfgang Denk 已提交
2433 2434
		CONFIG_SPL_TEXT_BASE
		TEXT_BASE for linking the SPL binary.
2435

W
Wolfgang Denk 已提交
2436 2437
		CONFIG_SPL_LDSCRIPT
		LDSCRIPT for linking the SPL binary.
2438

W
Wolfgang Denk 已提交
2439 2440
		CONFIG_SPL_LIBCOMMON_SUPPORT
		Support for common/libcommon.o in SPL binary
2441

W
Wolfgang Denk 已提交
2442 2443
		CONFIG_SPL_LIBDISK_SUPPORT
		Support for disk/libdisk.o in SPL binary
2444

W
Wolfgang Denk 已提交
2445 2446
		CONFIG_SPL_I2C_SUPPORT
		Support for drivers/i2c/libi2c.o in SPL binary
2447

W
Wolfgang Denk 已提交
2448 2449
		CONFIG_SPL_GPIO_SUPPORT
		Support for drivers/gpio/libgpio.o in SPL binary
2450

W
Wolfgang Denk 已提交
2451 2452
		CONFIG_SPL_MMC_SUPPORT
		Support for drivers/mmc/libmmc.o in SPL binary
2453

W
Wolfgang Denk 已提交
2454 2455
		CONFIG_SPL_SERIAL_SUPPORT
		Support for drivers/serial/libserial.o in SPL binary
2456

W
Wolfgang Denk 已提交
2457 2458
		CONFIG_SPL_SPI_FLASH_SUPPORT
		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
2459

W
Wolfgang Denk 已提交
2460 2461
		CONFIG_SPL_SPI_SUPPORT
		Support for drivers/spi/libspi.o in SPL binary
2462

W
Wolfgang Denk 已提交
2463 2464
		CONFIG_SPL_FAT_SUPPORT
		Support for fs/fat/libfat.o in SPL binary
2465

W
Wolfgang Denk 已提交
2466 2467
		CONFIG_SPL_LIBGENERIC_SUPPORT
		Support for lib/libgeneric.o in SPL binary
2468

W
wdenk 已提交
2469 2470 2471
Modem Support:
--------------

2472
[so far only for SMDK2400 boards]
W
wdenk 已提交
2473

M
Marcel Ziswiler 已提交
2474
- Modem support enable:
W
wdenk 已提交
2475 2476 2477 2478 2479 2480 2481 2482
		CONFIG_MODEM_SUPPORT

- RTS/CTS Flow control enable:
		CONFIG_HWFLOW

- Modem debug support:
		CONFIG_MODEM_SUPPORT_DEBUG

W
wdenk 已提交
2483 2484
		Enables debugging stuff (char screen[1024], dbg())
		for modem support. Useful only with BDI2000.
W
wdenk 已提交
2485

W
wdenk 已提交
2486 2487
- Interrupt support (PPC):

W
wdenk 已提交
2488 2489
		There are common interrupt_init() and timer_interrupt()
		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
M
Marcel Ziswiler 已提交
2490
		for CPU specific initialization. interrupt_init_cpu()
W
wdenk 已提交
2491
		should set decrementer_count to appropriate value. If
M
Marcel Ziswiler 已提交
2492
		CPU resets decrementer automatically after interrupt
W
wdenk 已提交
2493
		(ppc4xx) it should set decrementer_count to zero.
M
Marcel Ziswiler 已提交
2494
		timer_interrupt() calls timer_interrupt_cpu() for CPU
W
wdenk 已提交
2495 2496 2497
		specific handling. If board has watchdog / status_led
		/ other_activity_monitor it works automatically from
		general timer_interrupt().
W
wdenk 已提交
2498

W
wdenk 已提交
2499 2500
- General:

W
wdenk 已提交
2501 2502 2503
		In the target system modem support is enabled when a
		specific key (key combination) is pressed during
		power-on. Otherwise U-Boot will boot normally
M
Marcel Ziswiler 已提交
2504
		(autoboot). The key_pressed() function is called from
W
wdenk 已提交
2505 2506 2507
		board_init(). Currently key_pressed() is a dummy
		function, returning 1 and thus enabling modem
		initialization.
W
wdenk 已提交
2508

W
wdenk 已提交
2509 2510 2511
		If there are no modem init strings in the
		environment, U-Boot proceed to autoboot; the
		previous output (banner, info printfs) will be
M
Marcel Ziswiler 已提交
2512
		suppressed, though.
W
wdenk 已提交
2513 2514 2515

		See also: doc/README.Modem

2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529
Board initialization settings:
------------------------------

During Initialization u-boot calls a number of board specific functions
to allow the preparation of board specific prerequisites, e.g. pin setup
before drivers are initialized. To enable these callbacks the
following configuration macros have to be defined. Currently this is
architecture specific, so please check arch/your_architecture/lib/board.c
typically in board_init_f() and board_init_r().

- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
- CONFIG_BOARD_LATE_INIT: Call board_late_init()
- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
W
wdenk 已提交
2530 2531 2532 2533

Configuration Settings:
-----------------------

2534
- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
W
wdenk 已提交
2535 2536
		undefine this when you're short of memory.

P
Peter Tyser 已提交
2537 2538 2539
- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
		width of the commands listed in the 'help' command output.

2540
- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
W
wdenk 已提交
2541 2542
		prompt for user input.

2543
- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
W
wdenk 已提交
2544

2545
- CONFIG_SYS_PBSIZE:	Buffer size for Console output
W
wdenk 已提交
2546

2547
- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
W
wdenk 已提交
2548

2549
- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
W
wdenk 已提交
2550 2551 2552
		the application (usually a Linux kernel) when it is
		booted

2553
- CONFIG_SYS_BAUDRATE_TABLE:
W
wdenk 已提交
2554 2555
		List of legal baudrate settings for this board.

2556
- CONFIG_SYS_CONSOLE_INFO_QUIET
W
wdenk 已提交
2557
		Suppress display of console information at boot.
W
wdenk 已提交
2558

2559
- CONFIG_SYS_CONSOLE_IS_IN_ENV
W
wdenk 已提交
2560 2561 2562
		If the board specific function
			extern int overwrite_console (void);
		returns 1, the stdin, stderr and stdout are switched to the
W
wdenk 已提交
2563 2564
		serial port, else the settings in the environment are used.

2565
- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
W
wdenk 已提交
2566
		Enable the call to overwrite_console().
W
wdenk 已提交
2567

2568
- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
W
wdenk 已提交
2569 2570
		Enable overwrite of previous console environment settings.

2571
- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
W
wdenk 已提交
2572 2573 2574
		Begin and End addresses of the area used by the
		simple memory test.

2575
- CONFIG_SYS_ALT_MEMTEST:
W
wdenk 已提交
2576
		Enable an alternate, more extensive memory test.
W
wdenk 已提交
2577

2578
- CONFIG_SYS_MEMTEST_SCRATCH:
W
wdenk 已提交
2579 2580 2581
		Scratch address used by the alternate memory test
		You only need to set this if address zero isn't writeable

2582 2583
- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2584
		this specified memory area will get subtracted from the top
M
Marcel Ziswiler 已提交
2585
		(end) of RAM and won't get "touched" at all by U-Boot. By
2586 2587 2588
		fixing up gd->ram_size the Linux kernel should gets passed
		the now "corrected" memory size and won't touch it either.
		This should work for arch/ppc and arch/powerpc. Only Linux
2589
		board ports in arch/powerpc with bootwrapper support that
2590
		recalculate the memory size from the SDRAM controller setup
2591
		will have to get fixed in Linux additionally.
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602

		This option can be used as a workaround for the 440EPx/GRx
		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
		be touched.

		WARNING: Please make sure that this value is a multiple of
		the Linux page size (normally 4k). If this is not the case,
		then the end address of the Linux memory will be located at a
		non page size aligned address and this could cause major
		problems.

2603
- CONFIG_SYS_TFTP_LOADADDR:
W
wdenk 已提交
2604 2605
		Default load address for network file downloads

2606
- CONFIG_SYS_LOADS_BAUD_CHANGE:
W
wdenk 已提交
2607 2608
		Enable temporary baudrate change while serial download

2609
- CONFIG_SYS_SDRAM_BASE:
W
wdenk 已提交
2610 2611
		Physical start address of SDRAM. _Must_ be 0 here.

2612
- CONFIG_SYS_MBIO_BASE:
W
wdenk 已提交
2613 2614 2615
		Physical start address of Motherboard I/O (if using a
		Cogent motherboard)

2616
- CONFIG_SYS_FLASH_BASE:
W
wdenk 已提交
2617 2618
		Physical start address of Flash memory.

2619
- CONFIG_SYS_MONITOR_BASE:
W
wdenk 已提交
2620 2621
		Physical start address of boot monitor code (set by
		make config files to be same as the text base address
2622
		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
2623
		CONFIG_SYS_FLASH_BASE when booting from flash.
W
wdenk 已提交
2624

2625
- CONFIG_SYS_MONITOR_LEN:
W
wdenk 已提交
2626 2627 2628 2629
		Size of memory reserved for monitor code, used to
		determine _at_compile_time_ (!) if the environment is
		embedded within the U-Boot image, or in a separate
		flash sector.
W
wdenk 已提交
2630

2631
- CONFIG_SYS_MALLOC_LEN:
W
wdenk 已提交
2632 2633
		Size of DRAM reserved for malloc() use.

2634
- CONFIG_SYS_BOOTM_LEN:
2635 2636
		Normally compressed uImages are limited to an
		uncompressed size of 8 MBytes. If this is not enough,
2637
		you can define CONFIG_SYS_BOOTM_LEN in your board config file
2638 2639
		to adjust this setting to your needs.

2640
- CONFIG_SYS_BOOTMAPSZ:
W
wdenk 已提交
2641 2642
		Maximum size of memory mapped by the startup code of
		the Linux kernel; all data that must be processed by
2643 2644 2645 2646
		the Linux kernel (bd_info, boot arguments, FDT blob if
		used) must be put below this limit, unless "bootm_low"
		enviroment variable is defined and non-zero. In such case
		all data for the Linux kernel must be between "bootm_low"
W
Wolfgang Denk 已提交
2647
		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2648 2649 2650
		variable "bootm_mapsize" will override the value of
		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
		then the value in "bootm_size" will be used instead.
W
wdenk 已提交
2651

2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664
- CONFIG_SYS_BOOT_RAMDISK_HIGH:
		Enable initrd_high functionality.  If defined then the
		initrd_high feature is enabled and the bootm ramdisk subcommand
		is enabled.

- CONFIG_SYS_BOOT_GET_CMDLINE:
		Enables allocating and saving kernel cmdline in space between
		"bootm_low" and "bootm_low" + BOOTMAPSZ.

- CONFIG_SYS_BOOT_GET_KBD:
		Enables allocating and saving a kernel copy of the bd_info in
		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.

2665
- CONFIG_SYS_MAX_FLASH_BANKS:
W
wdenk 已提交
2666 2667
		Max number of Flash memory banks

2668
- CONFIG_SYS_MAX_FLASH_SECT:
W
wdenk 已提交
2669 2670
		Max number of sectors on a Flash chip

2671
- CONFIG_SYS_FLASH_ERASE_TOUT:
W
wdenk 已提交
2672 2673
		Timeout for Flash erase operations (in ms)

2674
- CONFIG_SYS_FLASH_WRITE_TOUT:
W
wdenk 已提交
2675 2676
		Timeout for Flash write operations (in ms)

2677
- CONFIG_SYS_FLASH_LOCK_TOUT
W
wdenk 已提交
2678 2679
		Timeout for Flash set sector lock bit operation (in ms)

2680
- CONFIG_SYS_FLASH_UNLOCK_TOUT
W
wdenk 已提交
2681 2682
		Timeout for Flash clear lock bits operation (in ms)

2683
- CONFIG_SYS_FLASH_PROTECTION
W
wdenk 已提交
2684 2685 2686
		If defined, hardware flash sectors protection is used
		instead of U-Boot software protection.

2687
- CONFIG_SYS_DIRECT_FLASH_TFTP:
W
wdenk 已提交
2688 2689 2690 2691 2692 2693 2694 2695

		Enable TFTP transfers directly to flash memory;
		without this option such a download has to be
		performed in two steps: (1) download to RAM, and (2)
		copy from RAM to flash.

		The two-step approach is usually more reliable, since
		you can check if the download worked before you erase
M
Marcel Ziswiler 已提交
2696 2697
		the flash, but in some situations (when system RAM is
		too limited to allow for a temporary copy of the
W
wdenk 已提交
2698 2699
		downloaded image) this option may be very useful.

2700
- CONFIG_SYS_FLASH_CFI:
W
wdenk 已提交
2701
		Define if the flash driver uses extra elements in the
W
wdenk 已提交
2702 2703
		common flash structure for storing flash geometry.

2704
- CONFIG_FLASH_CFI_DRIVER
W
wdenk 已提交
2705 2706
		This option also enables the building of the cfi_flash driver
		in the drivers directory
W
wdenk 已提交
2707

P
Piotr Ziecik 已提交
2708 2709 2710 2711 2712
- CONFIG_FLASH_CFI_MTD
		This option enables the building of the cfi_mtd driver
		in the drivers directory. The driver exports CFI flash
		to the MTD layer.

2713
- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
2714 2715 2716 2717 2718 2719
		Use buffered writes to flash.

- CONFIG_FLASH_SPANSION_S29WS_N
		s29ws-n MirrorBit flash has non-standard addresses for buffered
		write commands.

2720
- CONFIG_SYS_FLASH_QUIET_TEST
2721 2722 2723 2724 2725
		If this option is defined, the common CFI flash doesn't
		print it's warning upon not recognized FLASH banks. This
		is useful, if some of the configured banks are only
		optionally available.

2726 2727 2728 2729 2730
- CONFIG_FLASH_SHOW_PROGRESS
		If defined (must be an integer), print out countdown
		digits and dots.  Recommended value: 45 (9..1) for 80
		column displays, 15 (3..1) for 40 column displays.

2731
- CONFIG_SYS_RX_ETH_BUFFER:
M
Marcel Ziswiler 已提交
2732 2733
		Defines the number of Ethernet receive buffers. On some
		Ethernet controllers it is recommended to set this value
S
stroese 已提交
2734 2735
		to 8 or even higher (EEPRO100 or 405 EMAC), since all
		buffers can be full shortly after enabling the interface
M
Marcel Ziswiler 已提交
2736
		on high Ethernet traffic.
S
stroese 已提交
2737 2738
		Defaults to 4 if not defined.

2739 2740
- CONFIG_ENV_MAX_ENTRIES

W
Wolfgang Denk 已提交
2741 2742 2743 2744 2745
	Maximum number of entries in the hash table that is used
	internally to store the environment settings. The default
	setting is supposed to be generous and should work in most
	cases. This setting can be used to tune behaviour; see
	lib/hashtable.c for details.
2746

W
wdenk 已提交
2747 2748 2749 2750
The following definitions that deal with the placement and management
of environment data (variable area); in general, we support the
following configurations:

2751 2752 2753 2754 2755
- CONFIG_BUILD_ENVCRC:

	Builds up envcrc with the target environment so that external utils
	may easily extract it and embed it in final U-Boot images.

2756
- CONFIG_ENV_IS_IN_FLASH:
W
wdenk 已提交
2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771

	Define this if the environment is in flash memory.

	a) The environment occupies one whole flash sector, which is
	   "embedded" in the text segment with the U-Boot code. This
	   happens usually with "bottom boot sector" or "top boot
	   sector" type flash chips, which have several smaller
	   sectors at the start or the end. For instance, such a
	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
	   such a case you would place the environment in one of the
	   4 kB sectors - with U-Boot code before and after it. With
	   "top boot sector" type flash chips, you would put the
	   environment in one of the last sectors, leaving a gap
	   between U-Boot and the environment.

2772
	- CONFIG_ENV_OFFSET:
W
wdenk 已提交
2773 2774 2775 2776 2777 2778

	   Offset of environment data (variable area) to the
	   beginning of flash memory; for instance, with bottom boot
	   type flash chips the second sector can be used: the offset
	   for this sector is given here.

2779
	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
W
wdenk 已提交
2780

2781
	- CONFIG_ENV_ADDR:
W
wdenk 已提交
2782 2783 2784

	   This is just another way to specify the start address of
	   the flash sector containing the environment (instead of
2785
	   CONFIG_ENV_OFFSET).
W
wdenk 已提交
2786

2787
	- CONFIG_ENV_SECT_SIZE:
W
wdenk 已提交
2788 2789 2790 2791 2792 2793 2794 2795

	   Size of the sector containing the environment.


	b) Sometimes flash chips have few, equal sized, BIG sectors.
	   In such a case you don't want to spend a whole sector for
	   the environment.

2796
	- CONFIG_ENV_SIZE:
W
wdenk 已提交
2797

2798
	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
2799
	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
W
wdenk 已提交
2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
	   of this flash sector for the environment. This saves
	   memory for the RAM copy of the environment.

	   It may also save flash memory if you decide to use this
	   when your environment is "embedded" within U-Boot code,
	   since then the remainder of the flash sector could be used
	   for U-Boot code. It should be pointed out that this is
	   STRONGLY DISCOURAGED from a robustness point of view:
	   updating the environment in flash makes it always
	   necessary to erase the WHOLE sector. If something goes
	   wrong before the contents has been restored from a copy in
	   RAM, your target system will be dead.

2813 2814
	- CONFIG_ENV_ADDR_REDUND
	  CONFIG_ENV_SIZE_REDUND
W
wdenk 已提交
2815

W
wdenk 已提交
2816
	   These settings describe a second storage area used to hold
M
Marcel Ziswiler 已提交
2817
	   a redundant copy of the environment data, so that there is
W
wdenk 已提交
2818
	   a valid backup copy in case there is a power failure during
W
wdenk 已提交
2819
	   a "saveenv" operation.
W
wdenk 已提交
2820 2821 2822 2823 2824 2825

BE CAREFUL! Any changes to the flash layout, and some changes to the
source code will make it necessary to adapt <board>/u-boot.lds*
accordingly!


2826
- CONFIG_ENV_IS_IN_NVRAM:
W
wdenk 已提交
2827 2828 2829 2830 2831

	Define this if you have some non-volatile memory device
	(NVRAM, battery buffered SRAM) which you want to use for the
	environment.

2832 2833
	- CONFIG_ENV_ADDR:
	- CONFIG_ENV_SIZE:
W
wdenk 已提交
2834

M
Marcel Ziswiler 已提交
2835
	  These two #defines are used to determine the memory area you
W
wdenk 已提交
2836 2837 2838 2839 2840 2841
	  want to use for environment. It is assumed that this memory
	  can just be read and written to, without any special
	  provision.

BE CAREFUL! The first access to the environment happens quite early
in U-Boot initalization (when we try to get the setting of for the
M
Marcel Ziswiler 已提交
2842
console baudrate). You *MUST* have mapped your NVRAM area then, or
W
wdenk 已提交
2843 2844 2845 2846 2847 2848 2849 2850
U-Boot will hang.

Please note that even with NVRAM we still use a copy of the
environment in RAM: we could work on NVRAM directly, but we want to
keep settings there always unmodified except somebody uses "saveenv"
to save the current settings.


2851
- CONFIG_ENV_IS_IN_EEPROM:
W
wdenk 已提交
2852 2853 2854 2855

	Use this if you have an EEPROM or similar serial access
	device and a driver for it.

2856 2857
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:
W
wdenk 已提交
2858 2859 2860 2861

	  These two #defines specify the offset and size of the
	  environment area within the total memory of your EEPROM.

2862
	- CONFIG_SYS_I2C_EEPROM_ADDR:
W
wdenk 已提交
2863 2864 2865
	  If defined, specified the chip address of the EEPROM device.
	  The default address is zero.

2866
	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
W
wdenk 已提交
2867 2868 2869 2870
	  If defined, the number of bits used to address bytes in a
	  single page in the EEPROM device.  A 64 byte page, for example
	  would require six bits.

2871
	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
W
wdenk 已提交
2872
	  If defined, the number of milliseconds to delay between
W
wdenk 已提交
2873
	  page writes.	The default is zero milliseconds.
W
wdenk 已提交
2874

2875
	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
W
wdenk 已提交
2876 2877 2878
	  The length in bytes of the EEPROM memory array address.  Note
	  that this is NOT the chip address length!

2879
	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
2880 2881 2882 2883 2884 2885 2886 2887 2888 2889
	  EEPROM chips that implement "address overflow" are ones
	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
	  address and the extra bits end up in the "chip address" bit
	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
	  byte chips.

	  Note that we consider the length of the address field to
	  still be one byte because the extra address bits are hidden
	  in the chip address.

2890
	- CONFIG_SYS_EEPROM_SIZE:
W
wdenk 已提交
2891 2892
	  The size in bytes of the EEPROM device.

H
Heiko Schocher 已提交
2893 2894 2895 2896 2897 2898 2899 2900 2901
	- CONFIG_ENV_EEPROM_IS_ON_I2C
	  define this, if you have I2C and SPI activated, and your
	  EEPROM, which holds the environment, is on the I2C bus.

	- CONFIG_I2C_ENV_EEPROM_BUS
	  if you have an Environment on an EEPROM reached over
	  I2C muxes, you can define here, how to reach this
	  EEPROM. For example:

W
Wolfgang Denk 已提交
2902
	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
H
Heiko Schocher 已提交
2903 2904 2905

	  EEPROM which holds the environment, is reached over
	  a pca9547 i2c mux with address 0x70, channel 3.
W
wdenk 已提交
2906

2907
- CONFIG_ENV_IS_IN_DATAFLASH:
2908

W
wdenk 已提交
2909
	Define this if you have a DataFlash memory device which you
2910 2911
	want to use for the environment.

2912 2913 2914
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_ADDR:
	- CONFIG_ENV_SIZE:
2915 2916 2917 2918 2919

	  These three #defines specify the offset and size of the
	  environment area within the total memory of your DataFlash placed
	  at the specified address.

2920
- CONFIG_ENV_IS_IN_NAND:
W
wdenk 已提交
2921 2922 2923 2924

	Define this if you have a NAND device which you want to use
	for the environment.

2925 2926
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:
W
wdenk 已提交
2927 2928

	  These two #defines specify the offset and size of the environment
S
Scott Wood 已提交
2929 2930
	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
	  aligned to an erase block boundary.
2931

S
Scott Wood 已提交
2932
	- CONFIG_ENV_OFFSET_REDUND (optional):
2933

2934
	  This setting describes a second storage area of CONFIG_ENV_SIZE
S
Scott Wood 已提交
2935 2936
	  size used to hold a redundant copy of the environment data, so
	  that there is a valid backup copy in case there is a power failure
W
Wolfgang Denk 已提交
2937
	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
S
Scott Wood 已提交
2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954
	  aligned to an erase block boundary.

	- CONFIG_ENV_RANGE (optional):

	  Specifies the length of the region in which the environment
	  can be written.  This should be a multiple of the NAND device's
	  block size.  Specifying a range with more erase blocks than
	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
	  the range to be avoided.

	- CONFIG_ENV_OFFSET_OOB (optional):

	  Enables support for dynamically retrieving the offset of the
	  environment from block zero's out-of-band data.  The
	  "nand env.oob" command can be used to record this offset.
	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
	  using CONFIG_ENV_OFFSET_OOB.
2955

2956 2957 2958 2959 2960 2961
- CONFIG_NAND_ENV_DST

	Defines address in RAM to which the nand_spl code should copy the
	environment. If redundant environment is used, it will be copied to
	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.

2962
- CONFIG_SYS_SPI_INIT_OFFSET
W
wdenk 已提交
2963 2964 2965 2966 2967 2968 2969 2970 2971

	Defines offset to the initial SPI buffer area in DPRAM. The
	area is used at an early stage (ROM part) if the environment
	is configured to reside in the SPI EEPROM: We need a 520 byte
	scratch DPRAM area. It is used between the two initialization
	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
	to be a good choice since it makes it far enough from the
	start of the data area as well as from the stack pointer.

B
Bruce Adler 已提交
2972
Please note that the environment is read-only until the monitor
W
wdenk 已提交
2973
has been relocated to RAM and a RAM copy of the environment has been
2974
created; also, when using EEPROM you will have to use getenv_f()
W
wdenk 已提交
2975 2976
until then to read environment variables.

W
wdenk 已提交
2977 2978 2979 2980 2981 2982
The environment is protected by a CRC32 checksum. Before the monitor
is relocated into RAM, as a result of a bad CRC you will be working
with the compiled-in default environment - *silently*!!! [This is
necessary, because the first environment variable we need is the
"baudrate" setting for the console - if we have a bad CRC, we don't
have any device yet where we could complain.]
W
wdenk 已提交
2983 2984 2985

Note: once the monitor has been relocated, then it will complain if
the default environment is used; a new CRC is computed as soon as you
W
wdenk 已提交
2986
use the "saveenv" command to store a valid environment.
W
wdenk 已提交
2987

2988
- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
W
wdenk 已提交
2989
		Echo the inverted Ethernet link state to the fault LED.
W
wdenk 已提交
2990

2991
		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
W
wdenk 已提交
2992 2993
		      also needs to be defined.

2994
- CONFIG_SYS_FAULT_MII_ADDR:
W
wdenk 已提交
2995
		MII address of the PHY to check for the Ethernet link state.
W
wdenk 已提交
2996

2997 2998 2999 3000 3001 3002 3003
- CONFIG_NS16550_MIN_FUNCTIONS:
		Define this if you desire to only have use of the NS16550_init
		and NS16550_putc functions for the serial driver located at
		drivers/serial/ns16550.c.  This option is useful for saving
		space for already greatly restricted images, including but not
		limited to NAND_SPL configurations.

W
wdenk 已提交
3004
Low Level (hardware related) configuration options:
W
wdenk 已提交
3005
---------------------------------------------------
W
wdenk 已提交
3006

3007
- CONFIG_SYS_CACHELINE_SIZE:
W
wdenk 已提交
3008 3009
		Cache Line Size of the CPU.

3010
- CONFIG_SYS_DEFAULT_IMMR:
W
wdenk 已提交
3011
		Default address of the IMMR after system reset.
W
wdenk 已提交
3012

W
wdenk 已提交
3013 3014 3015
		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
		and RPXsuper) to be able to adjust the position of
		the IMMR register after a reset.
W
wdenk 已提交
3016

3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030
- CONFIG_SYS_CCSRBAR_DEFAULT:
		Default (power-on reset) physical address of CCSR on Freescale
		PowerPC SOCs.

- CONFIG_SYS_CCSRBAR:
		Virtual address of CCSR.  On a 32-bit build, this is typically
		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.

		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
		for cross-platform code that uses that macro instead.

- CONFIG_SYS_CCSRBAR_PHYS:
		Physical address of CCSR.  CCSR can be relocated to a new
		physical address, if desired.  In this case, this macro should
W
Wolfgang Denk 已提交
3031
		be set to that address.	 Otherwise, it should be set to the
3032 3033 3034 3035 3036 3037 3038 3039
		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
		is typically relocated on 36-bit builds.  It is recommended
		that this macro be defined via the _HIGH and _LOW macros:

		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)

- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3040 3041
		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053
		used in assembly code, so it must not contain typecasts or
		integer size suffixes (e.g. "ULL").

- CONFIG_SYS_CCSRBAR_PHYS_LOW:
		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
		used in assembly code, so it must not contain typecasts or
		integer size suffixes (e.g. "ULL").

- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
		forced to a value that ensures that CCSR is not relocated.

W
wdenk 已提交
3054
- Floppy Disk Support:
3055
		CONFIG_SYS_FDC_DRIVE_NUMBER
W
wdenk 已提交
3056 3057 3058

		the default drive number (default value 0)

3059
		CONFIG_SYS_ISA_IO_STRIDE
W
wdenk 已提交
3060

M
Marcel Ziswiler 已提交
3061
		defines the spacing between FDC chipset registers
W
wdenk 已提交
3062 3063
		(default value 1)

3064
		CONFIG_SYS_ISA_IO_OFFSET
W
wdenk 已提交
3065

W
wdenk 已提交
3066 3067
		defines the offset of register from address. It
		depends on which part of the data bus is connected to
M
Marcel Ziswiler 已提交
3068
		the FDC chipset. (default value 0)
W
wdenk 已提交
3069

3070 3071
		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
W
wdenk 已提交
3072
		default value.
W
wdenk 已提交
3073

3074
		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
W
wdenk 已提交
3075 3076 3077 3078
		fdc_hw_init() is called at the beginning of the FDC
		setup. fdc_hw_init() must be provided by the board
		source code. It is used to make hardware dependant
		initializations.
W
wdenk 已提交
3079

3080 3081 3082 3083 3084 3085 3086 3087
- CONFIG_IDE_AHB:
		Most IDE controllers were designed to be connected with PCI
		interface. Only few of them were designed for AHB interface.
		When software is doing ATA command and data transfer to
		IDE devices through IDE-AHB controller, some additional
		registers accessing to these kind of IDE-AHB controller
		is requierd.

3088
- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
W
wdenk 已提交
3089
		DO NOT CHANGE unless you know exactly what you're
W
wdenk 已提交
3090
		doing! (11-4) [MPC8xx/82xx systems only]
W
wdenk 已提交
3091

3092
- CONFIG_SYS_INIT_RAM_ADDR:
W
wdenk 已提交
3093

W
wdenk 已提交
3094
		Start address of memory area that can be used for
W
wdenk 已提交
3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106
		initial data and stack; please note that this must be
		writable memory that is working WITHOUT special
		initialization, i. e. you CANNOT use normal RAM which
		will become available only after programming the
		memory controller and running certain initialization
		sequences.

		U-Boot uses the following memory types:
		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
		- MPC824X: data cache
		- PPC4xx:  data cache

3107
- CONFIG_SYS_GBL_DATA_OFFSET:
W
wdenk 已提交
3108 3109

		Offset of the initial data structure in the memory
3110 3111
		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
W
wdenk 已提交
3112
		data is located at the end of the available space
3113
		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
3114 3115 3116
		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
		CONFIG_SYS_GBL_DATA_OFFSET) downward.
W
wdenk 已提交
3117 3118 3119 3120

	Note:
		On the MPC824X (or other systems that use the data
		cache for initial memory) the address chosen for
3121
		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
W
wdenk 已提交
3122 3123 3124
		point to an otherwise UNUSED address space between
		the top of RAM and the start of the PCI space.

3125
- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
W
wdenk 已提交
3126

3127
- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
W
wdenk 已提交
3128

3129
- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
W
wdenk 已提交
3130

3131
- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
W
wdenk 已提交
3132

3133
- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
W
wdenk 已提交
3134

3135
- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
W
wdenk 已提交
3136

3137
- CONFIG_SYS_OR_TIMING_SDRAM:
W
wdenk 已提交
3138 3139
		SDRAM timing

3140
- CONFIG_SYS_MAMR_PTA:
W
wdenk 已提交
3141 3142
		periodic timer for refresh

3143
- CONFIG_SYS_DER:	Debug Event Register (37-47)
W
wdenk 已提交
3144

3145 3146 3147 3148
- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
  CONFIG_SYS_BR1_PRELIM:
W
wdenk 已提交
3149 3150 3151
		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)

- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
3152 3153
  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
W
wdenk 已提交
3154 3155
		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)

3156 3157
- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
W
wdenk 已提交
3158 3159 3160
		Machine Mode Register and Memory Periodic Timer
		Prescaler definitions (SDRAM timing)

3161
- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
W
wdenk 已提交
3162 3163 3164
		enable I2C microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [DSP2]

3165
- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3166 3167 3168
		enable SMC microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [SMC1]

3169
- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
W
wdenk 已提交
3170 3171 3172
		enable SPI microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [SCC4]

3173
- CONFIG_SYS_USE_OSCCLK:
W
wdenk 已提交
3174 3175 3176 3177
		Use OSCM clock mode on MBX8xx board. Be careful,
		wrong setting might damage your board. Read
		doc/README.MBX before setting this variable!

3178
- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
W
wdenk 已提交
3179 3180 3181 3182
		Offset of the bootmode word in DPRAM used by post
		(Power On Self Tests). This definition overrides
		#define'd default value in commproc.h resp.
		cpm_8260.h.
3183

3184 3185 3186 3187 3188 3189 3190 3191
- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
S
Stefan Roese 已提交
3192
		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
W
wdenk 已提交
3193

3194 3195 3196 3197
- CONFIG_PCI_DISABLE_PCIE:
		Disable PCI-Express on systems where it is supported but not
		required.

3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215
- CONFIG_SYS_SRIO:
		Chip has SRIO or not

- CONFIG_SRIO1:
		Board has SRIO 1 port available

- CONFIG_SRIO2:
		Board has SRIO 2 port available

- CONFIG_SYS_SRIOn_MEM_VIRT:
		Virtual Address of SRIO port 'n' memory region

- CONFIG_SYS_SRIOn_MEM_PHYS:
		Physical Address of SRIO port 'n' memory region

- CONFIG_SYS_SRIOn_MEM_SIZE:
		Size of SRIO port 'n' memory region

3216 3217 3218 3219 3220 3221 3222 3223
- CONFIG_SYS_NDFC_16
		Defined to tell the NDFC that the NAND chip is using a
		16 bit bus.

- CONFIG_SYS_NDFC_EBC0_CFG
		Sets the EBC0_CFG register for the NDFC. If not defined
		a default value will be used.

B
Ben Warren 已提交
3224
- CONFIG_SPD_EEPROM
3225 3226 3227
		Get DDR timing information from an I2C EEPROM. Common
		with pluggable memory modules such as SODIMMs

B
Ben Warren 已提交
3228 3229 3230
  SPD_EEPROM_ADDRESS
		I2C address of the SPD EEPROM

3231
- CONFIG_SYS_SPD_BUS_NUM
3232 3233 3234
		If SPD EEPROM is on an I2C bus other than the first
		one, specify here. Note that the value must resolve
		to something your driver can deal with.
B
Ben Warren 已提交
3235

3236 3237 3238 3239 3240 3241
- CONFIG_SYS_DDR_RAW_TIMING
		Get DDR timing information from other than SPD. Common with
		soldered DDR chips onboard without SPD. DDR raw timing
		parameters are extracted from datasheet and hard-coded into
		header files or board specific files.

3242 3243 3244
- CONFIG_FSL_DDR_INTERACTIVE
		Enable interactive DDR debugging. See doc/README.fsl-ddr.

3245
- CONFIG_SYS_83XX_DDR_USES_CS0
3246 3247
		Only for 83xx systems. If specified, then DDR should
		be configured using CS0 and CS1 instead of CS2 and CS3.
3248

3249 3250 3251 3252 3253
- CONFIG_ETHER_ON_FEC[12]
		Define to enable FEC[12] on a 8xx series processor.

- CONFIG_FEC[12]_PHY
		Define to the hardcoded PHY address which corresponds
W
wdenk 已提交
3254 3255
		to the given FEC; i. e.
			#define CONFIG_FEC1_PHY 4
3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268
		means that the PHY with address 4 is connected to FEC1

		When set to -1, means to probe for first available.

- CONFIG_FEC[12]_PHY_NORXERR
		The PHY does not have a RXERR line (RMII only).
		(so program the FEC to ignore it).

- CONFIG_RMII
		Enable RMII mode for all FECs.
		Note that this is a global option, we can't
		have one FEC in standard MII mode and another in RMII mode.

3269 3270 3271 3272 3273 3274 3275 3276 3277 3278
- CONFIG_CRC32_VERIFY
		Add a verify option to the crc32 command.
		The syntax is:

		=> crc32 -v <address> <count> <crc32>

		Where address/count indicate a memory area
		and crc32 is the correct crc32 which the
		area should have.

W
wdenk 已提交
3279 3280
- CONFIG_LOOPW
		Add the "loopw" memory command. This only takes effect if
3281
		the memory commands are activated globally (CONFIG_CMD_MEM).
W
wdenk 已提交
3282

S
stroese 已提交
3283 3284 3285 3286 3287
- CONFIG_MX_CYCLIC
		Add the "mdc" and "mwc" memory commands. These are cyclic
		"md/mw" commands.
		Examples:

W
wdenk 已提交
3288
		=> mdc.b 10 4 500
S
stroese 已提交
3289 3290
		This command will print 4 bytes (10,11,12,13) each 500 ms.

W
wdenk 已提交
3291
		=> mwc.l 100 12345678 10
S
stroese 已提交
3292 3293
		This command will write 12345678 to address 100 all 10 ms.

W
wdenk 已提交
3294
		This only takes effect if the memory commands are activated
3295
		globally (CONFIG_CMD_MEM).
S
stroese 已提交
3296

W
wdenk 已提交
3297
- CONFIG_SKIP_LOWLEVEL_INIT
3298
		[ARM, NDS32, MIPS only] If this variable is defined, then certain
W
Wolfgang Denk 已提交
3299 3300 3301 3302 3303 3304 3305 3306
		low level initializations (like setting up the memory
		controller) are omitted and/or U-Boot does not
		relocate itself into RAM.

		Normally this variable MUST NOT be defined. The only
		exception is when U-Boot is loaded (to RAM) by some
		other boot loader or by a debugger which performs
		these initializations itself.
W
wdenk 已提交
3307

3308
- CONFIG_SPL_BUILD
3309 3310 3311
		Modifies the behaviour of start.S when compiling a loader
		that is executed before the actual U-Boot. E.g. when
		compiling a NAND SPL.
W
wdenk 已提交
3312

3313 3314 3315 3316 3317
- CONFIG_SYS_NAND_HW_ECC_OOBFIRST
		define this, if you want to read first the oob data
		and then the data. This is used for example on
		davinci plattforms.

3318 3319 3320 3321 3322 3323
- CONFIG_USE_ARCH_MEMCPY
  CONFIG_USE_ARCH_MEMSET
		If these options are used a optimized version of memcpy/memset will
		be used if available. These functions may be faster under some
		conditions but may increase the binary size.

3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361
Freescale QE/FMAN Firmware Support:
-----------------------------------

The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
loading of "firmware", which is encoded in the QE firmware binary format.
This firmware often needs to be loaded during U-Boot booting, so macros
are used to identify the storage device (NOR flash, SPI, etc) and the address
within that device.

- CONFIG_SYS_QE_FMAN_FW_ADDR
	The address in the storage device where the firmware is located.  The
	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
	is also specified.

- CONFIG_SYS_QE_FMAN_FW_LENGTH
	The maximum possible size of the firmware.  The firmware binary format
	has a field that specifies the actual size of the firmware, but it
	might not be possible to read any part of the firmware unless some
	local storage is allocated to hold the entire firmware first.

- CONFIG_SYS_QE_FMAN_FW_IN_NOR
	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
	virtual address in NOR flash.

- CONFIG_SYS_QE_FMAN_FW_IN_NAND
	Specifies that QE/FMAN firmware is located in NAND flash.
	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.

- CONFIG_SYS_QE_FMAN_FW_IN_MMC
	Specifies that QE/FMAN firmware is located on the primary SD/MMC
	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.

- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
	Specifies that QE/FMAN firmware is located on the primary SPI
	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.


W
wdenk 已提交
3362 3363 3364
Building the Software:
======================

3365 3366 3367 3368 3369 3370
Building U-Boot has been tested in several native build environments
and in many different cross environments. Of course we cannot support
all possibly existing versions of cross development tools in all
(potentially obsolete) versions. In case of tool chain problems we
recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
which is extensively used to build and test U-Boot.
W
wdenk 已提交
3371

3372 3373 3374 3375 3376
If you are not using a native environment, it is assumed that you
have GNU cross compiling tools available in your path. In this case,
you must set the environment variable CROSS_COMPILE in your shell.
Note that no changes to the Makefile or any other source files are
necessary. For example using the ELDK on a 4xx CPU, please enter:
W
wdenk 已提交
3377

3378 3379
	$ CROSS_COMPILE=ppc_4xx-
	$ export CROSS_COMPILE
W
wdenk 已提交
3380

3381 3382 3383 3384 3385 3386 3387 3388 3389 3390
Note: If you wish to generate Windows versions of the utilities in
      the tools directory you can use the MinGW toolchain
      (http://www.mingw.org).  Set your HOST tools to the MinGW
      toolchain and execute 'make tools'.  For example:

       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools

      Binaries such as tools/mkimage.exe will be created which can
      be executed on computers running Windows.

3391 3392
U-Boot is intended to be simple to build. After installing the
sources you must configure U-Boot for one specific board type. This
W
wdenk 已提交
3393 3394 3395 3396
is done by typing:

	make NAME_config

3397 3398
where "NAME_config" is the name of one of the existing configu-
rations; see the main Makefile for supported names.
3399

W
wdenk 已提交
3400 3401 3402 3403
Note: for some board special configuration names may exist; check if
      additional information is available from the board vendor; for
      instance, the TQM823L systems are available without (standard)
      or with LCD support. You can select such additional "features"
M
Marcel Ziswiler 已提交
3404
      when choosing the configuration, i. e.
W
wdenk 已提交
3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421

      make TQM823L_config
	- will configure for a plain TQM823L, i. e. no LCD support

      make TQM823L_LCD_config
	- will configure for a TQM823L with U-Boot console on LCD

      etc.


Finally, type "make all", and you should get some working U-Boot
images ready for download to / installation on your system:

- "u-boot.bin" is a raw binary image
- "u-boot" is an image in ELF binary format
- "u-boot.srec" is in Motorola S-Record format

3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441
By default the build is performed locally and the objects are saved
in the source directory. One of the two methods can be used to change
this behavior and build U-Boot to some external directory:

1. Add O= to the make command line invocations:

	make O=/tmp/build distclean
	make O=/tmp/build NAME_config
	make O=/tmp/build all

2. Set environment variable BUILD_DIR to point to the desired location:

	export BUILD_DIR=/tmp/build
	make distclean
	make NAME_config
	make all

Note that the command line "O=" setting overrides the BUILD_DIR environment
variable.

W
wdenk 已提交
3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473

Please be aware that the Makefiles assume you are using GNU make, so
for instance on NetBSD you might need to use "gmake" instead of
native "make".


If the system board that you have is not listed, then you will need
to port U-Boot to your hardware platform. To do this, follow these
steps:

1.  Add a new configuration option for your board to the toplevel
    "Makefile" and to the "MAKEALL" script, using the existing
    entries as examples. Note that here and at many other places
    boards and other names are listed in alphabetical sort order. Please
    keep this order.
2.  Create a new directory to hold your board specific code. Add any
    files you need. In your board directory, you will need at least
    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
3.  Create a new configuration file "include/configs/<board>.h" for
    your board
3.  If you're porting U-Boot to a new CPU, then also create a new
    directory to hold your CPU specific code. Add any files you need.
4.  Run "make <board>_config" with your new name.
5.  Type "make", and you should get a working "u-boot.srec" file
    to be installed on your target system.
6.  Debug and solve any problems that might arise.
    [Of course, this last step is much harder than it sounds.]


Testing of U-Boot Modifications, Ports to New Hardware, etc.:
==============================================================

3474 3475
If you have modified U-Boot sources (for instance added a new board
or support for new devices, a new CPU, etc.) you are expected to
W
wdenk 已提交
3476 3477
provide feedback to the other developers. The feedback normally takes
the form of a "patch", i. e. a context diff against a certain (latest
3478
official or latest in the git repository) version of U-Boot sources.
W
wdenk 已提交
3479

3480 3481
But before you submit such a patch, please verify that your modifi-
cation did not break existing code. At least make sure that *ALL* of
W
wdenk 已提交
3482 3483
the supported boards compile WITHOUT ANY compiler warnings. To do so,
just run the "MAKEALL" script, which will configure and build U-Boot
3484 3485 3486 3487
for ALL supported system. Be warned, this will take a while. You can
select which (cross) compiler to use by passing a `CROSS_COMPILE'
environment variable to the script, i. e. to use the ELDK cross tools
you can type
W
wdenk 已提交
3488 3489 3490 3491 3492 3493 3494

	CROSS_COMPILE=ppc_8xx- MAKEALL

or to build on a native PowerPC system you can type

	CROSS_COMPILE=' ' MAKEALL

3495 3496 3497 3498 3499 3500 3501
When using the MAKEALL script, the default behaviour is to build
U-Boot in the source directory. This location can be changed by
setting the BUILD_DIR environment variable. Also, for each target
built, the MAKEALL script saves two log files (<target>.ERR and
<target>.MAKEALL) in the <source dir>/LOG directory. This default
location can be changed by setting the MAKEALL_LOGDIR environment
variable. For example:
3502 3503 3504 3505 3506

	export BUILD_DIR=/tmp/build
	export MAKEALL_LOGDIR=/tmp/log
	CROSS_COMPILE=ppc_8xx- MAKEALL

3507 3508 3509
With the above settings build objects are saved in the /tmp/build,
log files are saved in the /tmp/log and the source tree remains clean
during the whole build process.
3510 3511


W
wdenk 已提交
3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524
See also "U-Boot Porting Guide" below.


Monitor Commands - Overview:
============================

go	- start application at address 'addr'
run	- run commands in an environment variable
bootm	- boot application image from memory
bootp	- boot image via network using BootP/TFTP protocol
tftpboot- boot image via network using TFTP protocol
	       and env variables "ipaddr" and "serverip"
	       (and eventually "gatewayip")
S
Simon Glass 已提交
3525
tftpput - upload a file via network using TFTP protocol
W
wdenk 已提交
3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536
rarpboot- boot image via network using RARP/TFTP protocol
diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
loads	- load S-Record file over serial line
loadb	- load binary file over serial line (kermit mode)
md	- memory display
mm	- memory modify (auto-incrementing)
nm	- memory modify (constant address)
mw	- memory write (fill)
cp	- memory copy
cmp	- memory compare
crc32	- checksum calculation
3537
i2c	- I2C sub-system
W
wdenk 已提交
3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550
sspi	- SPI utility commands
base	- print or set address offset
printenv- print environment variables
setenv	- set environment variables
saveenv - save environment variables to persistent storage
protect - enable or disable FLASH write protection
erase	- erase FLASH memory
flinfo	- print FLASH memory information
bdinfo	- print Board Info structure
iminfo	- print header information for application image
coninfo - print console devices and informations
ide	- IDE sub-system
loop	- infinite loop on address range
W
wdenk 已提交
3551
loopw	- infinite write loop on address range
W
wdenk 已提交
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574
mtest	- simple RAM test
icache	- enable or disable instruction cache
dcache	- enable or disable data cache
reset	- Perform RESET of the CPU
echo	- echo args to console
version - print monitor version
help	- print online help
?	- alias for 'help'


Monitor Commands - Detailed Description:
========================================

TODO.

For now: just type "help <command>".


Environment Variables:
======================

U-Boot supports user configuration using Environment Variables which
can be made persistent by saving to Flash memory.
W
wdenk 已提交
3575

W
wdenk 已提交
3576 3577 3578 3579 3580 3581
Environment Variables are set using "setenv", printed using
"printenv", and saved to Flash using "saveenv". Using "setenv"
without a value can be used to delete a variable from the
environment. As long as you don't save the environment you are
working with an in-memory copy. In case the Flash area containing the
environment is erased by accident, a default environment is provided.
W
wdenk 已提交
3582

3583 3584 3585
Some configuration options can be set using Environment Variables.

List of environment variables (most likely not complete):
W
wdenk 已提交
3586

W
wdenk 已提交
3587
  baudrate	- see CONFIG_BAUDRATE
W
wdenk 已提交
3588

W
wdenk 已提交
3589
  bootdelay	- see CONFIG_BOOTDELAY
W
wdenk 已提交
3590

W
wdenk 已提交
3591
  bootcmd	- see CONFIG_BOOTCOMMAND
W
wdenk 已提交
3592

W
wdenk 已提交
3593
  bootargs	- Boot arguments when booting an RTOS image
W
wdenk 已提交
3594

W
wdenk 已提交
3595
  bootfile	- Name of the image to load with TFTP
W
wdenk 已提交
3596

3597 3598 3599 3600 3601 3602
  bootm_low	- Memory range available for image processing in the bootm
		  command can be restricted. This variable is given as
		  a hexadecimal number and defines lowest address allowed
		  for use by the bootm command. See also "bootm_size"
		  environment variable. Address defined by "bootm_low" is
		  also the base of the initial memory mapping for the Linux
3603 3604 3605
		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
		  bootm_mapsize.

W
Wolfgang Denk 已提交
3606
  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3607 3608 3609 3610 3611 3612
		  This variable is given as a hexadecimal number and it
		  defines the size of the memory region starting at base
		  address bootm_low that is accessible by the Linux kernel
		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
		  as the default value if it is defined, and bootm_size is
		  used otherwise.
3613 3614 3615 3616 3617 3618 3619

  bootm_size	- Memory range available for image processing in the bootm
		  command can be restricted. This variable is given as
		  a hexadecimal number and defines the size of the region
		  allowed for use by the bootm command. See also "bootm_low"
		  environment variable.

3620 3621 3622 3623
  updatefile	- Location of the software update file on a TFTP server, used
		  by the automatic software update feature. Please refer to
		  documentation in doc/README.update for more details.

W
wdenk 已提交
3624 3625 3626 3627
  autoload	- if set to "no" (any string beginning with 'n'),
		  "bootp" will just load perform a lookup of the
		  configuration from the BOOTP server, but not try to
		  load any image using TFTP
W
wdenk 已提交
3628

W
wdenk 已提交
3629 3630 3631 3632
  autostart	- if set to "yes", an image loaded using the "bootp",
		  "rarpboot", "tftpboot" or "diskboot" commands will
		  be automatically started (by internally calling
		  "bootm")
3633

W
wdenk 已提交
3634 3635 3636 3637 3638
		  If set to "no", a standalone image passed to the
		  "bootm" command will be copied to the load address
		  (and eventually uncompressed), but NOT be started.
		  This can be used to load and uncompress arbitrary
		  data.
W
wdenk 已提交
3639

3640 3641 3642 3643 3644 3645 3646 3647 3648
  fdt_high	- if set this restricts the maximum address that the
		  flattened device tree will be copied into upon boot.
		  If this is set to the special value 0xFFFFFFFF then
		  the fdt will not be copied at all on boot.  For this
		  to work it must reside in writable memory, have
		  sufficient padding on the end of it for u-boot to
		  add the information it needs into it, and the memory
		  must be accessible by the kernel.

3649 3650 3651 3652
  fdtcontroladdr- if set this is the address of the control flattened
		  device tree used by U-Boot when CONFIG_OF_CONTROL is
		  defined.

W
wdenk 已提交
3653 3654 3655 3656 3657 3658
  i2cfast	- (PPC405GP|PPC405EP only)
		  if set to 'y' configures Linux I2C driver for fast
		  mode (400kHZ). This environment variable is used in
		  initialization code. So, for changes to be effective
		  it must be saved and board must be reset.

W
wdenk 已提交
3659 3660 3661 3662 3663 3664
  initrd_high	- restrict positioning of initrd images:
		  If this variable is not set, initrd images will be
		  copied to the highest possible address in RAM; this
		  is usually what you want since it allows for
		  maximum initrd size. If for some reason you want to
		  make sure that the initrd image is loaded below the
3665
		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
W
wdenk 已提交
3666 3667 3668 3669
		  variable to a value of "no" or "off" or "0".
		  Alternatively, you can set it to a maximum upper
		  address to use (U-Boot will still check that it
		  does not overwrite the U-Boot stack and data).
W
wdenk 已提交
3670

W
wdenk 已提交
3671 3672 3673 3674 3675 3676
		  For instance, when you have a system with 16 MB
		  RAM, and want to reserve 4 MB from use by Linux,
		  you can do this by adding "mem=12M" to the value of
		  the "bootargs" variable. However, now you must make
		  sure that the initrd image is placed in the first
		  12 MB as well - this can be done with
W
wdenk 已提交
3677

W
wdenk 已提交
3678
		  setenv initrd_high 00c00000
W
wdenk 已提交
3679

W
wdenk 已提交
3680 3681 3682 3683 3684 3685 3686
		  If you set initrd_high to 0xFFFFFFFF, this is an
		  indication to U-Boot that all addresses are legal
		  for the Linux kernel, including addresses in flash
		  memory. In this case U-Boot will NOT COPY the
		  ramdisk at all. This may be useful to reduce the
		  boot time on your system, but requires that this
		  feature is supported by your Linux kernel.
W
wdenk 已提交
3687

W
wdenk 已提交
3688
  ipaddr	- IP address; needed for tftpboot command
W
wdenk 已提交
3689

W
wdenk 已提交
3690 3691
  loadaddr	- Default load address for commands like "bootp",
		  "rarpboot", "tftpboot", "loadb" or "diskboot"
W
wdenk 已提交
3692

W
wdenk 已提交
3693
  loads_echo	- see CONFIG_LOADS_ECHO
3694

W
wdenk 已提交
3695
  serverip	- TFTP server IP address; needed for tftpboot command
3696

W
wdenk 已提交
3697
  bootretry	- see CONFIG_BOOT_RETRY_TIME
3698

W
wdenk 已提交
3699
  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3700

W
wdenk 已提交
3701
  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
W
wdenk 已提交
3702

M
Mike Frysinger 已提交
3703
  ethprime	- controls which interface is used first.
W
wdenk 已提交
3704

M
Mike Frysinger 已提交
3705 3706
  ethact	- controls which interface is currently active.
		  For example you can do the following
W
wdenk 已提交
3707

3708 3709 3710 3711
		  => setenv ethact FEC
		  => ping 192.168.0.1 # traffic sent on FEC
		  => setenv ethact SCC
		  => ping 10.0.0.1 # traffic sent on SCC
W
wdenk 已提交
3712

3713 3714 3715 3716
  ethrotate	- When set to "no" U-Boot does not go through all
		  available network interfaces.
		  It just stays at the currently selected interface.

3717
  netretry	- When set to "no" each network operation will
W
wdenk 已提交
3718 3719 3720 3721 3722 3723
		  either succeed or fail without retrying.
		  When set to "once" the network operation will
		  fail when all the available network interfaces
		  are tried once without success.
		  Useful on scripts which control the retry operation
		  themselves.
W
wdenk 已提交
3724

3725
  npe_ucode	- set load address for the NPE microcode
3726

3727
  tftpsrcport	- If this is set, the value is used for TFTP's
3728 3729
		  UDP source port.

3730 3731 3732
  tftpdstport	- If this is set, the value is used for TFTP's UDP
		  destination port instead of the Well Know Port 69.

3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744
  tftpblocksize - Block size to use for TFTP transfers; if not set,
		  we use the TFTP server's default block size

  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
		  seconds, minimum value is 1000 = 1 second). Defines
		  when a packet is considered to be lost so it has to
		  be retransmitted. The default is 5000 = 5 seconds.
		  Lowering this value may make downloads succeed
		  faster in networks with high packet loss rates or
		  with unreliable TFTP servers.

  vlan		- When set to a value < 4095 the traffic over
M
Marcel Ziswiler 已提交
3745
		  Ethernet is encapsulated/received over 802.1q
W
wdenk 已提交
3746
		  VLAN tagged frames.
W
wdenk 已提交
3747

3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759
The following image location variables contain the location of images
used in booting. The "Image" column gives the role of the image and is
not an environment variable name. The other columns are environment
variable names. "File Name" gives the name of the file on a TFTP
server, "RAM Address" gives the location in RAM the image will be
loaded to, and "Flash Location" gives the image's address in NOR
flash or offset in NAND flash.

*Note* - these variables don't have to be defined for all boards, some
boards currenlty use other variables for these purposes, and some
boards use these variables for other purposes.

W
Wolfgang Denk 已提交
3760 3761 3762 3763 3764 3765
Image		    File Name	     RAM Address       Flash Location
-----		    ---------	     -----------       --------------
u-boot		    u-boot	     u-boot_addr_r     u-boot_addr
Linux kernel	    bootfile	     kernel_addr_r     kernel_addr
device tree blob    fdtfile	     fdt_addr_r	       fdt_addr
ramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
3766

W
wdenk 已提交
3767 3768 3769
The following environment variables may be used and automatically
updated by the network boot commands ("bootp" and "rarpboot"),
depending the information provided by your boot server:
W
wdenk 已提交
3770

W
wdenk 已提交
3771 3772 3773 3774 3775 3776 3777 3778 3779
  bootfile	- see above
  dnsip		- IP address of your Domain Name Server
  dnsip2	- IP address of your secondary Domain Name Server
  gatewayip	- IP address of the Gateway (Router) to use
  hostname	- Target hostname
  ipaddr	- see above
  netmask	- Subnet Mask
  rootpath	- Pathname of the root filesystem on the NFS server
  serverip	- see above
3780 3781


W
wdenk 已提交
3782
There are two special Environment Variables:
3783

W
wdenk 已提交
3784 3785 3786
  serial#	- contains hardware identification information such
		  as type string and/or serial number
  ethaddr	- Ethernet address
W
wdenk 已提交
3787

W
wdenk 已提交
3788 3789 3790
These variables can be set only once (usually during manufacturing of
the board). U-Boot refuses to delete or overwrite these variables
once they have been set once.
W
wdenk 已提交
3791

3792

W
wdenk 已提交
3793
Further special Environment Variables:
3794

W
wdenk 已提交
3795 3796 3797
  ver		- Contains the U-Boot version string as printed
		  with the "version" command. This variable is
		  readonly (see CONFIG_VERSION_VARIABLE).
3798 3799


W
wdenk 已提交
3800 3801
Please note that changes to some configuration parameters may take
only effect after the next boot (yes, that's just like Windoze :-).
3802 3803


W
wdenk 已提交
3804 3805
Command Line Parsing:
=====================
3806

W
wdenk 已提交
3807 3808
There are two different command line parsers available with U-Boot:
the old "simple" one, and the much more powerful "hush" shell:
W
wdenk 已提交
3809

W
wdenk 已提交
3810 3811
Old, simple command line parser:
--------------------------------
W
wdenk 已提交
3812

W
wdenk 已提交
3813 3814
- supports environment variables (through setenv / saveenv commands)
- several commands on one line, separated by ';'
3815
- variable substitution using "... ${name} ..." syntax
W
wdenk 已提交
3816 3817
- special characters ('$', ';') can be escaped by prefixing with '\',
  for example:
3818
	setenv bootcmd bootm \${address}
W
wdenk 已提交
3819 3820
- You can also escape text by enclosing in single apostrophes, for example:
	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
W
wdenk 已提交
3821

W
wdenk 已提交
3822 3823
Hush shell:
-----------
W
wdenk 已提交
3824

W
wdenk 已提交
3825 3826 3827 3828 3829 3830 3831 3832 3833 3834
- similar to Bourne shell, with control structures like
  if...then...else...fi, for...do...done; while...do...done,
  until...do...done, ...
- supports environment ("global") variables (through setenv / saveenv
  commands) and local shell variables (through standard shell syntax
  "name=value"); only environment variables can be used with "run"
  command

General rules:
--------------
W
wdenk 已提交
3835

W
wdenk 已提交
3836 3837 3838 3839
(1) If a command line (or an environment variable executed by a "run"
    command) contains several commands separated by semicolon, and
    one of these commands fails, then the remaining commands will be
    executed anyway.
W
wdenk 已提交
3840

W
wdenk 已提交
3841
(2) If you execute several variables with one call to run (i. e.
M
Marcel Ziswiler 已提交
3842
    calling run with a list of variables as arguments), any failing
W
wdenk 已提交
3843 3844
    command will cause "run" to terminate, i. e. the remaining
    variables are not executed.
W
wdenk 已提交
3845

W
wdenk 已提交
3846 3847
Note for Redundant Ethernet Interfaces:
=======================================
W
wdenk 已提交
3848

M
Marcel Ziswiler 已提交
3849
Some boards come with redundant Ethernet interfaces; U-Boot supports
W
wdenk 已提交
3850 3851
such configurations and is capable of automatic selection of a
"working" interface when needed. MAC assignment works as follows:
W
wdenk 已提交
3852

W
wdenk 已提交
3853 3854 3855
Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
"eth1addr" (=>eth1), "eth2addr", ...
W
wdenk 已提交
3856

W
wdenk 已提交
3857 3858 3859 3860
If the network interface stores some valid MAC address (for instance
in SROM), this is used as default address if there is NO correspon-
ding setting in the environment; if the corresponding environment
variable is set, this overrides the settings in the card; that means:
W
wdenk 已提交
3861

W
wdenk 已提交
3862 3863
o If the SROM has a valid MAC address, and there is no address in the
  environment, the SROM's address is used.
W
wdenk 已提交
3864

W
wdenk 已提交
3865 3866 3867
o If there is no valid address in the SROM, and a definition in the
  environment exists, then the value from the environment variable is
  used.
W
wdenk 已提交
3868

W
wdenk 已提交
3869 3870
o If both the SROM and the environment contain a MAC address, and
  both addresses are the same, this MAC address is used.
W
wdenk 已提交
3871

W
wdenk 已提交
3872 3873 3874
o If both the SROM and the environment contain a MAC address, and the
  addresses differ, the value from the environment is used and a
  warning is printed.
W
wdenk 已提交
3875

W
wdenk 已提交
3876 3877
o If neither SROM nor the environment contain a MAC address, an error
  is raised.
W
wdenk 已提交
3878

3879
If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
W
Wolfgang Denk 已提交
3880
will be programmed into hardware as part of the initialization process.	 This
3881 3882 3883
may be skipped by setting the appropriate 'ethmacskip' environment variable.
The naming convention is as follows:
"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
W
wdenk 已提交
3884

W
wdenk 已提交
3885 3886
Image Formats:
==============
W
wdenk 已提交
3887

3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905
U-Boot is capable of booting (and performing other auxiliary operations on)
images in two formats:

New uImage format (FIT)
-----------------------

Flexible and powerful format based on Flattened Image Tree -- FIT (similar
to Flattened Device Tree). It allows the use of images with multiple
components (several kernels, ramdisks, etc.), with contents protected by
SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.


Old uImage format
-----------------

Old image format is based on binary files which can be basically anything,
preceded by a special header; see the definitions in include/image.h for
details; basically, the header defines the following image properties:
W
wdenk 已提交
3906

W
wdenk 已提交
3907 3908
* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3909 3910 3911
  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
  INTEGRITY).
W
Wolfgang Denk 已提交
3912
* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
3913 3914
  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
W
wdenk 已提交
3915 3916 3917 3918 3919
* Compression Type (uncompressed, gzip, bzip2)
* Load Address
* Entry Point
* Image Name
* Image Timestamp
W
wdenk 已提交
3920

W
wdenk 已提交
3921 3922 3923
The header is marked by a special Magic Number, and both the header
and the data portions of the image are secured against corruption by
CRC32 checksums.
W
wdenk 已提交
3924 3925


W
wdenk 已提交
3926 3927
Linux Support:
==============
W
wdenk 已提交
3928

W
wdenk 已提交
3929 3930 3931
Although U-Boot should support any OS or standalone application
easily, the main focus has always been on Linux during the design of
U-Boot.
W
wdenk 已提交
3932

W
wdenk 已提交
3933 3934 3935 3936 3937
U-Boot includes many features that so far have been part of some
special "boot loader" code within the Linux kernel. Also, any
"initrd" images to be used are no longer part of one big Linux image;
instead, kernel and "initrd" are separate images. This implementation
serves several purposes:
W
wdenk 已提交
3938

W
wdenk 已提交
3939 3940 3941
- the same features can be used for other OS or standalone
  applications (for instance: using compressed images to reduce the
  Flash memory footprint)
W
wdenk 已提交
3942

W
wdenk 已提交
3943 3944
- it becomes much easier to port new Linux kernel versions because
  lots of low-level, hardware dependent stuff are done by U-Boot
W
wdenk 已提交
3945

W
wdenk 已提交
3946 3947 3948 3949 3950 3951
- the same Linux kernel image can now be used with different "initrd"
  images; of course this also means that different kernel images can
  be run with the same "initrd". This makes testing easier (you don't
  have to build a new "zImage.initrd" Linux image when you just
  change a file in your "initrd"). Also, a field-upgrade of the
  software is easier now.
W
wdenk 已提交
3952 3953


W
wdenk 已提交
3954 3955
Linux HOWTO:
============
W
wdenk 已提交
3956

W
wdenk 已提交
3957 3958
Porting Linux to U-Boot based systems:
---------------------------------------
W
wdenk 已提交
3959

W
wdenk 已提交
3960 3961 3962 3963
U-Boot cannot save you from doing all the necessary modifications to
configure the Linux device drivers for use with your target hardware
(no, we don't intend to provide a full virtual machine interface to
Linux :-).
W
wdenk 已提交
3964

S
Stefan Roese 已提交
3965
But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3966

W
wdenk 已提交
3967 3968
Just make sure your machine specific header file (for instance
include/asm-ppc/tqm8xx.h) includes the same definition of the Board
3969 3970
Information structure as we define in include/asm-<arch>/u-boot.h,
and make sure that your definition of IMAP_ADDR uses the same value
3971
as your U-Boot configuration in CONFIG_SYS_IMMR.
3972

W
wdenk 已提交
3973

W
wdenk 已提交
3974 3975
Configuring the Linux kernel:
-----------------------------
W
wdenk 已提交
3976

W
wdenk 已提交
3977 3978 3979 3980 3981 3982
No specific requirements for U-Boot. Make sure you have some root
device (initial ramdisk, NFS) for your target system.


Building a Linux Image:
-----------------------
W
wdenk 已提交
3983

W
wdenk 已提交
3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018
With U-Boot, "normal" build targets like "zImage" or "bzImage" are
not used. If you use recent kernel source, a new build target
"uImage" will exist which automatically builds an image usable by
U-Boot. Most older kernels also have support for a "pImage" target,
which was introduced for our predecessor project PPCBoot and uses a
100% compatible format.

Example:

	make TQM850L_config
	make oldconfig
	make dep
	make uImage

The "uImage" build target uses a special tool (in 'tools/mkimage') to
encapsulate a compressed Linux kernel image with header	 information,
CRC32 checksum etc. for use with U-Boot. This is what we are doing:

* build a standard "vmlinux" kernel image (in ELF binary format):

* convert the kernel into a raw binary image:

	${CROSS_COMPILE}-objcopy -O binary \
				 -R .note -R .comment \
				 -S vmlinux linux.bin

* compress the binary image:

	gzip -9 linux.bin

* package compressed binary image for U-Boot:

	mkimage -A ppc -O linux -T kernel -C gzip \
		-a 0 -e 0 -n "Linux Kernel Image" \
		-d linux.bin.gz uImage
W
wdenk 已提交
4019 4020


W
wdenk 已提交
4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033
The "mkimage" tool can also be used to create ramdisk images for use
with U-Boot, either separated from the Linux kernel image, or
combined into one file. "mkimage" encapsulates the images with a 64
byte header containing information about target architecture,
operating system, image type, compression method, entry points, time
stamp, CRC32 checksums, etc.

"mkimage" can be called in two ways: to verify existing images and
print the header information, or to build new images.

In the first form (with "-l" option) mkimage lists the information
contained in the header of an existing U-Boot image; this includes
checksum verification:
W
wdenk 已提交
4034

W
wdenk 已提交
4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051
	tools/mkimage -l image
	  -l ==> list image header information

The second form (with "-d" option) is used to build a U-Boot image
from a "data file" which is used as image payload:

	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
		      -n name -d data_file image
	  -A ==> set architecture to 'arch'
	  -O ==> set operating system to 'os'
	  -T ==> set image type to 'type'
	  -C ==> set compression type 'comp'
	  -a ==> set load address to 'addr' (hex)
	  -e ==> set entry point to 'ep' (hex)
	  -n ==> set image name to 'name'
	  -d ==> use image data from 'datafile'

W
wdenk 已提交
4052 4053 4054
Right now, all Linux kernels for PowerPC systems use the same load
address (0x00000000), but the entry point address depends on the
kernel version:
W
wdenk 已提交
4055 4056 4057 4058 4059 4060 4061 4062

- 2.2.x kernels have the entry point at 0x0000000C,
- 2.3.x and later kernels have the entry point at 0x00000000.

So a typical call to build a U-Boot image would read:

	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
S
Stefan Roese 已提交
4063
	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
W
wdenk 已提交
4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086
	> examples/uImage.TQM850L
	Image Name:   2.4.4 kernel for TQM850L
	Created:      Wed Jul 19 02:34:59 2000
	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
	Load Address: 0x00000000
	Entry Point:  0x00000000

To verify the contents of the image (or check for corruption):

	-> tools/mkimage -l examples/uImage.TQM850L
	Image Name:   2.4.4 kernel for TQM850L
	Created:      Wed Jul 19 02:34:59 2000
	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
	Load Address: 0x00000000
	Entry Point:  0x00000000

NOTE: for embedded systems where boot time is critical you can trade
speed for memory and install an UNCOMPRESSED image instead: this
needs more space in Flash, but boots much faster since it does not
need to be uncompressed:

S
Stefan Roese 已提交
4087
	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
W
wdenk 已提交
4088 4089
	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
S
Stefan Roese 已提交
4090
	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
W
wdenk 已提交
4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147
	> examples/uImage.TQM850L-uncompressed
	Image Name:   2.4.4 kernel for TQM850L
	Created:      Wed Jul 19 02:34:59 2000
	Image Type:   PowerPC Linux Kernel Image (uncompressed)
	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
	Load Address: 0x00000000
	Entry Point:  0x00000000


Similar you can build U-Boot images from a 'ramdisk.image.gz' file
when your kernel is intended to use an initial ramdisk:

	-> tools/mkimage -n 'Simple Ramdisk Image' \
	> -A ppc -O linux -T ramdisk -C gzip \
	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
	Image Name:   Simple Ramdisk Image
	Created:      Wed Jan 12 14:01:50 2000
	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
	Load Address: 0x00000000
	Entry Point:  0x00000000


Installing a Linux Image:
-------------------------

To downloading a U-Boot image over the serial (console) interface,
you must convert the image to S-Record format:

	objcopy -I binary -O srec examples/image examples/image.srec

The 'objcopy' does not understand the information in the U-Boot
image header, so the resulting S-Record file will be relative to
address 0x00000000. To load it to a given address, you need to
specify the target address as 'offset' parameter with the 'loads'
command.

Example: install the image to address 0x40100000 (which on the
TQM8xxL is in the first Flash bank):

	=> erase 40100000 401FFFFF

	.......... done
	Erased 8 sectors

	=> loads 40100000
	## Ready for S-Record download ...
	~>examples/image.srec
	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
	...
	15989 15990 15991 15992
	[file transfer complete]
	[connected]
	## Start Addr = 0x00000000


You can check the success of the download using the 'iminfo' command;
4148
this includes a checksum verification so you can be sure no data
W
wdenk 已提交
4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195
corruption happened:

	=> imi 40100000

	## Checking Image at 40100000 ...
	   Image Name:	 2.2.13 for initrd on TQM850L
	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
	   Data Size:	 335725 Bytes = 327 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 0000000c
	   Verifying Checksum ... OK


Boot Linux:
-----------

The "bootm" command is used to boot an application that is stored in
memory (RAM or Flash). In case of a Linux kernel image, the contents
of the "bootargs" environment variable is passed to the kernel as
parameters. You can check and modify this variable using the
"printenv" and "setenv" commands:


	=> printenv bootargs
	bootargs=root=/dev/ram

	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2

	=> printenv bootargs
	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2

	=> bootm 40020000
	## Booting Linux kernel at 40020000 ...
	   Image Name:	 2.2.13 for NFS on TQM850L
	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
	   Data Size:	 381681 Bytes = 372 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 0000000c
	   Verifying Checksum ... OK
	   Uncompressing Kernel Image ... OK
	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
	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
	time_init: decrementer frequency = 187500000/60
	Calibrating delay loop... 49.77 BogoMIPS
	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
	...

M
Marcel Ziswiler 已提交
4196
If you want to boot a Linux kernel with initial RAM disk, you pass
W
wdenk 已提交
4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244
the memory addresses of both the kernel and the initrd image (PPBCOOT
format!) to the "bootm" command:

	=> imi 40100000 40200000

	## Checking Image at 40100000 ...
	   Image Name:	 2.2.13 for initrd on TQM850L
	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
	   Data Size:	 335725 Bytes = 327 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 0000000c
	   Verifying Checksum ... OK

	## Checking Image at 40200000 ...
	   Image Name:	 Simple Ramdisk Image
	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
	   Data Size:	 566530 Bytes = 553 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 00000000
	   Verifying Checksum ... OK

	=> bootm 40100000 40200000
	## Booting Linux kernel at 40100000 ...
	   Image Name:	 2.2.13 for initrd on TQM850L
	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
	   Data Size:	 335725 Bytes = 327 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 0000000c
	   Verifying Checksum ... OK
	   Uncompressing Kernel Image ... OK
	## Loading RAMDisk Image at 40200000 ...
	   Image Name:	 Simple Ramdisk Image
	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
	   Data Size:	 566530 Bytes = 553 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 00000000
	   Verifying Checksum ... OK
	   Loading Ramdisk ... OK
	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
	Boot arguments: root=/dev/ram
	time_init: decrementer frequency = 187500000/60
	Calibrating delay loop... 49.77 BogoMIPS
	...
	RAMDISK: Compressed image found at block 0
	VFS: Mounted root (ext2 filesystem).

	bash#

4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280
Boot Linux and pass a flat device tree:
-----------

First, U-Boot must be compiled with the appropriate defines. See the section
titled "Linux Kernel Interface" above for a more in depth explanation. The
following is an example of how to start a kernel and pass an updated
flat device tree:

=> print oftaddr
oftaddr=0x300000
=> print oft
oft=oftrees/mpc8540ads.dtb
=> tftp $oftaddr $oft
Speed: 1000, full duplex
Using TSEC0 device
TFTP from server 192.168.1.1; our IP address is 192.168.1.101
Filename 'oftrees/mpc8540ads.dtb'.
Load address: 0x300000
Loading: #
done
Bytes transferred = 4106 (100a hex)
=> tftp $loadaddr $bootfile
Speed: 1000, full duplex
Using TSEC0 device
TFTP from server 192.168.1.1; our IP address is 192.168.1.2
Filename 'uImage'.
Load address: 0x200000
Loading:############
done
Bytes transferred = 1029407 (fb51f hex)
=> print loadaddr
loadaddr=200000
=> print oftaddr
oftaddr=0x300000
=> bootm $loadaddr - $oftaddr
## Booting image at 00200000 ...
4281 4282 4283
   Image Name:	 Linux-2.6.17-dirty
   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
   Data Size:	 1029343 Bytes = 1005.2 kB
4284
   Load Address: 00000000
4285
   Entry Point:	 00000000
4286 4287 4288 4289 4290 4291 4292 4293
   Verifying Checksum ... OK
   Uncompressing Kernel Image ... OK
Booting using flat device tree at 0x300000
Using MPC85xx ADS machine description
Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
[snip]


W
wdenk 已提交
4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466
More About U-Boot Image Types:
------------------------------

U-Boot supports the following image types:

   "Standalone Programs" are directly runnable in the environment
	provided by U-Boot; it is expected that (if they behave
	well) you can continue to work in U-Boot after return from
	the Standalone Program.
   "OS Kernel Images" are usually images of some Embedded OS which
	will take over control completely. Usually these programs
	will install their own set of exception handlers, device
	drivers, set up the MMU, etc. - this means, that you cannot
	expect to re-enter U-Boot except by resetting the CPU.
   "RAMDisk Images" are more or less just data blocks, and their
	parameters (address, size) are passed to an OS kernel that is
	being started.
   "Multi-File Images" contain several images, typically an OS
	(Linux) kernel image and one or more data images like
	RAMDisks. This construct is useful for instance when you want
	to boot over the network using BOOTP etc., where the boot
	server provides just a single image file, but you want to get
	for instance an OS kernel and a RAMDisk image.

	"Multi-File Images" start with a list of image sizes, each
	image size (in bytes) specified by an "uint32_t" in network
	byte order. This list is terminated by an "(uint32_t)0".
	Immediately after the terminating 0 follow the images, one by
	one, all aligned on "uint32_t" boundaries (size rounded up to
	a multiple of 4 bytes).

   "Firmware Images" are binary images containing firmware (like
	U-Boot or FPGA images) which usually will be programmed to
	flash memory.

   "Script files" are command sequences that will be executed by
	U-Boot's command interpreter; this feature is especially
	useful when you configure U-Boot to use a real shell (hush)
	as command interpreter.


Standalone HOWTO:
=================

One of the features of U-Boot is that you can dynamically load and
run "standalone" applications, which can use some resources of
U-Boot like console I/O functions or interrupt services.

Two simple examples are included with the sources:

"Hello World" Demo:
-------------------

'examples/hello_world.c' contains a small "Hello World" Demo
application; it is automatically compiled when you build U-Boot.
It's configured to run at address 0x00040004, so you can play with it
like that:

	=> loads
	## Ready for S-Record download ...
	~>examples/hello_world.srec
	1 2 3 4 5 6 7 8 9 10 11 ...
	[file transfer complete]
	[connected]
	## Start Addr = 0x00040004

	=> go 40004 Hello World! This is a test.
	## Starting application at 0x00040004 ...
	Hello World
	argc = 7
	argv[0] = "40004"
	argv[1] = "Hello"
	argv[2] = "World!"
	argv[3] = "This"
	argv[4] = "is"
	argv[5] = "a"
	argv[6] = "test."
	argv[7] = "<NULL>"
	Hit any key to exit ...

	## Application terminated, rc = 0x0

Another example, which demonstrates how to register a CPM interrupt
handler with the U-Boot code, can be found in 'examples/timer.c'.
Here, a CPM timer is set up to generate an interrupt every second.
The interrupt service routine is trivial, just printing a '.'
character, but this is just a demo program. The application can be
controlled by the following keys:

	? - print current values og the CPM Timer registers
	b - enable interrupts and start timer
	e - stop timer and disable interrupts
	q - quit application

	=> loads
	## Ready for S-Record download ...
	~>examples/timer.srec
	1 2 3 4 5 6 7 8 9 10 11 ...
	[file transfer complete]
	[connected]
	## Start Addr = 0x00040004

	=> go 40004
	## Starting application at 0x00040004 ...
	TIMERS=0xfff00980
	Using timer 1
	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0

Hit 'b':
	[q, b, e, ?] Set interval 1000000 us
	Enabling timer
Hit '?':
	[q, b, e, ?] ........
	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
Hit '?':
	[q, b, e, ?] .
	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
Hit '?':
	[q, b, e, ?] .
	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
Hit '?':
	[q, b, e, ?] .
	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
Hit 'e':
	[q, b, e, ?] ...Stopping timer
Hit 'q':
	[q, b, e, ?] ## Application terminated, rc = 0x0


Minicom warning:
================

Over time, many people have reported problems when trying to use the
"minicom" terminal emulation program for serial download. I (wd)
consider minicom to be broken, and recommend not to use it. Under
Unix, I recommend to use C-Kermit for general purpose use (and
especially for kermit binary protocol download ("loadb" command), and
use "cu" for S-Record download ("loads" command).

Nevertheless, if you absolutely want to use it try adding this
configuration to your "File transfer protocols" section:

	   Name	   Program			Name U/D FullScr IO-Red. Multi
	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N


NetBSD Notes:
=============

Starting at version 0.9.2, U-Boot supports NetBSD both as host
(build U-Boot) and target system (boots NetBSD/mpc8xx).

Building requires a cross environment; it is known to work on
NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
need gmake since the Makefiles are not compatible with BSD make).
Note that the cross-powerpc package does not install include files;
attempting to build U-Boot will fail because <machine/ansi.h> is
missing.  This file has to be installed and patched manually:

	# cd /usr/pkg/cross/powerpc-netbsd/include
	# mkdir powerpc
	# ln -s powerpc machine
	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST

Native builds *don't* work due to incompatibilities between native
and U-Boot include files.

Booting assumes that (the first part of) the image booted is a
stage-2 loader which in turn loads and then invokes the kernel
proper. Loader sources will eventually appear in the NetBSD source
tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
W
wdenk 已提交
4467
meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
W
wdenk 已提交
4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492


Implementation Internals:
=========================

The following is not intended to be a complete description of every
implementation detail. However, it should help to understand the
inner workings of U-Boot and make it easier to port it to custom
hardware.


Initial Stack, Global Data:
---------------------------

The implementation of U-Boot is complicated by the fact that U-Boot
starts running out of ROM (flash memory), usually without access to
system RAM (because the memory controller is not initialized yet).
This means that we don't have writable Data or BSS segments, and BSS
is not initialized as zero. To be able to get a C environment working
at all, we have to allocate at least a minimal stack. Implementation
options for this are defined and restricted by the CPU used: Some CPU
models provide on-chip memory (like the IMMR area on MPC8xx and
MPC826x processors), on others (parts of) the data cache can be
locked as (mis-) used as memory, etc.

4493
	Chris Hallinan posted a good summary of these issues to the
4494
	U-Boot mailing list:
W
wdenk 已提交
4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505

	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
	From: "Chris Hallinan" <clh@net1plus.com>
	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
	...

	Correct me if I'm wrong, folks, but the way I understand it
	is this: Using DCACHE as initial RAM for Stack, etc, does not
	require any physical RAM backing up the cache. The cleverness
	is that the cache is being used as a temporary supply of
	necessary storage before the SDRAM controller is setup. It's
M
Marcel Ziswiler 已提交
4506
	beyond the scope of this list to explain the details, but you
W
wdenk 已提交
4507 4508 4509 4510 4511
	can see how this works by studying the cache architecture and
	operation in the architecture and processor-specific manuals.

	OCM is On Chip Memory, which I believe the 405GP has 4K. It
	is another option for the system designer to use as an
M
Marcel Ziswiler 已提交
4512
	initial stack/RAM area prior to SDRAM being available. Either
W
wdenk 已提交
4513 4514 4515 4516 4517
	option should work for you. Using CS 4 should be fine if your
	board designers haven't used it for something that would
	cause you grief during the initial boot! It is frequently not
	used.

4518
	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
W
wdenk 已提交
4519 4520
	with your processor/board/system design. The default value
	you will find in any recent u-boot distribution in
4521
	walnut.h should work for you. I'd set it to a value larger
W
wdenk 已提交
4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536
	than your SDRAM module. If you have a 64MB SDRAM module, set
	it above 400_0000. Just make sure your board has no resources
	that are supposed to respond to that address! That code in
	start.S has been around a while and should work as is when
	you get the config right.

	-Chris Hallinan
	DS4.COM, Inc.

It is essential to remember this, since it has some impact on the C
code for the initialization procedures:

* Initialized global data (data segment) is read-only. Do not attempt
  to write it.

M
Marcel Ziswiler 已提交
4537
* Do not use any uninitialized global data (or implicitely initialized
W
wdenk 已提交
4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559
  as zero data - BSS segment) at all - this is undefined, initiali-
  zation is performed later (when relocating to RAM).

* Stack space is very limited. Avoid big data buffers or things like
  that.

Having only the stack as writable memory limits means we cannot use
normal global data to share information beween the code. But it
turned out that the implementation of U-Boot can be greatly
simplified by making a global data structure (gd_t) available to all
functions. We could pass a pointer to this data as argument to _all_
functions, but this would bloat the code. Instead we use a feature of
the GCC compiler (Global Register Variables) to share the data: we
place a pointer (gd) to the global data into a register which we
reserve for this purpose.

When choosing a register for such a purpose we are restricted by the
relevant  (E)ABI  specifications for the current architecture, and by
GCC's implementation.

For PowerPC, the following registers have specific use:
	R1:	stack pointer
4560
	R2:	reserved for system use
W
wdenk 已提交
4561 4562 4563 4564 4565 4566
	R3-R4:	parameter passing and return values
	R5-R10: parameter passing
	R13:	small data area pointer
	R30:	GOT pointer
	R31:	frame pointer

4567 4568 4569
	(U-Boot also uses R12 as internal GOT pointer. r12
	is a volatile register so r12 needs to be reset when
	going back and forth between asm and C)
W
wdenk 已提交
4570

4571
    ==> U-Boot will use R2 to hold a pointer to the global data
W
wdenk 已提交
4572 4573 4574 4575 4576 4577 4578 4579

    Note: on PPC, we could use a static initializer (since the
    address of the global data structure is known at compile time),
    but it turned out that reserving a register results in somewhat
    smaller code - although the code savings are not that big (on
    average for all boards 752 bytes for the whole U-Boot image,
    624 text + 127 data).

4580
On Blackfin, the normal C ABI (except for P3) is followed as documented here:
M
Mike Frysinger 已提交
4581 4582
	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface

4583
    ==> U-Boot will use P3 to hold a pointer to the global data
M
Mike Frysinger 已提交
4584

W
wdenk 已提交
4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598
On ARM, the following registers are used:

	R0:	function argument word/integer result
	R1-R3:	function argument word
	R9:	GOT pointer
	R10:	stack limit (used only if stack checking if enabled)
	R11:	argument (frame) pointer
	R12:	temporary workspace
	R13:	stack pointer
	R14:	link register
	R15:	program counter

    ==> U-Boot will use R8 to hold a pointer to the global data

T
Thomas Chou 已提交
4599 4600 4601 4602 4603 4604 4605 4606
On Nios II, the ABI is documented here:
	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf

    ==> U-Boot will use gp to hold a pointer to the global data

    Note: on Nios II, we give "-G0" option to gcc and don't use gp
    to access small data sections, so gp is free.

4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620
On NDS32, the following registers are used:

	R0-R1:	argument/return
	R2-R5:	argument
	R15:	temporary register for assembler
	R16:	trampoline register
	R28:	frame pointer (FP)
	R29:	global pointer (GP)
	R30:	link register (LP)
	R31:	stack pointer (SP)
	PC:	program counter (PC)

    ==> U-Boot will use R10 to hold a pointer to the global data

4621 4622
NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
or current versions of GCC may "optimize" the code too much.
W
wdenk 已提交
4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638

Memory Management:
------------------

U-Boot runs in system state and uses physical addresses, i.e. the
MMU is not used either for address mapping nor for memory protection.

The available memory is mapped to fixed addresses using the memory
controller. In this process, a contiguous block is formed for each
memory type (Flash, SDRAM, SRAM), even when it consists of several
physical memory banks.

U-Boot is installed in the first 128 kB of the first Flash bank (on
TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
booting and sizing and initializing DRAM, the code relocates itself
to the upper end of DRAM. Immediately below the U-Boot code some
4639
memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
W
wdenk 已提交
4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670
configuration setting]. Below that, a structure with global Board
Info data is placed, followed by the stack (growing downward).

Additionally, some exception handler code is copied to the low 8 kB
of DRAM (0x00000000 ... 0x00001FFF).

So a typical memory configuration with 16 MB of DRAM could look like
this:

	0x0000 0000	Exception Vector code
	      :
	0x0000 1FFF
	0x0000 2000	Free for Application Use
	      :
	      :

	      :
	      :
	0x00FB FF20	Monitor Stack (Growing downward)
	0x00FB FFAC	Board Info Data and permanent copy of global data
	0x00FC 0000	Malloc Arena
	      :
	0x00FD FFFF
	0x00FE 0000	RAM Copy of Monitor Code
	...		eventually: LCD or video framebuffer
	...		eventually: pRAM (Protected RAM - unchanged by reset)
	0x00FF FFFF	[End of RAM]


System Initialization:
----------------------
W
wdenk 已提交
4671

W
wdenk 已提交
4672
In the reset configuration, U-Boot starts at the reset entry point
M
Marcel Ziswiler 已提交
4673
(on most PowerPC systems at address 0x00000100). Because of the reset
W
wdenk 已提交
4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708
configuration for CS0# this is a mirror of the onboard Flash memory.
To be able to re-map memory U-Boot then jumps to its link address.
To be able to implement the initialization code in C, a (small!)
initial stack is set up in the internal Dual Ported RAM (in case CPUs
which provide such a feature like MPC8xx or MPC8260), or in a locked
part of the data cache. After that, U-Boot initializes the CPU core,
the caches and the SIU.

Next, all (potentially) available memory banks are mapped using a
preliminary mapping. For example, we put them on 512 MB boundaries
(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
programmed for SDRAM access. Using the temporary configuration, a
simple memory test is run that determines the size of the SDRAM
banks.

When there is more than one SDRAM bank, and the banks are of
different size, the largest is mapped first. For equal size, the first
bank (CS2#) is mapped first. The first mapping is always for address
0x00000000, with any additional banks following immediately to create
contiguous memory starting from 0.

Then, the monitor installs itself at the upper end of the SDRAM area
and allocates memory for use by malloc() and for the global Board
Info data; also, the exception vector code is copied to the low RAM
pages, and the final stack is set up.

Only after this relocation will you have a "normal" C environment;
until that you are restricted in several ways, mostly because you are
running from ROM, and because the code will have to be relocated to a
new address in RAM.


U-Boot Porting Guide:
----------------------
W
wdenk 已提交
4709

W
wdenk 已提交
4710 4711
[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
list, October 2002]
W
wdenk 已提交
4712 4713


4714
int main(int argc, char *argv[])
W
wdenk 已提交
4715 4716
{
	sighandler_t no_more_time;
W
wdenk 已提交
4717

4718 4719
	signal(SIGALRM, no_more_time);
	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
W
wdenk 已提交
4720

W
wdenk 已提交
4721
	if (available_money > available_manpower) {
4722
		Pay consultant to port U-Boot;
W
wdenk 已提交
4723 4724 4725
		return 0;
	}

W
wdenk 已提交
4726 4727
	Download latest U-Boot source;

4728
	Subscribe to u-boot mailing list;
W
wdenk 已提交
4729

4730 4731
	if (clueless)
		email("Hi, I am new to U-Boot, how do I get started?");
W
wdenk 已提交
4732 4733 4734

	while (learning) {
		Read the README file in the top level directory;
4735 4736
		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
		Read applicable doc/*.README;
W
wdenk 已提交
4737
		Read the source, Luke;
4738
		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
W
wdenk 已提交
4739 4740
	}

4741 4742 4743
	if (available_money > toLocalCurrency ($2500))
		Buy a BDI3000;
	else
W
wdenk 已提交
4744 4745
		Add a lot of aggravation and time;

4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769
	if (a similar board exists) {	/* hopefully... */
		cp -a board/<similar> board/<myboard>
		cp include/configs/<similar>.h include/configs/<myboard>.h
	} else {
		Create your own board support subdirectory;
		Create your own board include/configs/<myboard>.h file;
	}
	Edit new board/<myboard> files
	Edit new include/configs/<myboard>.h

	while (!accepted) {
		while (!running) {
			do {
				Add / modify source code;
			} until (compiles);
			Debug;
			if (clueless)
				email("Hi, I am having problems...");
		}
		Send patch file to the U-Boot email list;
		if (reasonable critiques)
			Incorporate improvements from email list code review;
		else
			Defend code as written;
W
wdenk 已提交
4770 4771 4772 4773 4774 4775 4776 4777 4778 4779
	}

	return 0;
}

void no_more_time (int sig)
{
      hire_a_guru();
}

W
wdenk 已提交
4780

W
wdenk 已提交
4781 4782
Coding Standards:
-----------------
W
wdenk 已提交
4783

W
wdenk 已提交
4784
All contributions to U-Boot should conform to the Linux kernel
4785
coding style; see the file "Documentation/CodingStyle" and the script
4786
"scripts/Lindent" in your Linux kernel source directory.
4787 4788 4789 4790 4791 4792 4793 4794 4795

Source files originating from a different project (for example the
MTD subsystem) are generally exempt from these guidelines and are not
reformated to ease subsequent migration to newer versions of those
sources.

Please note that U-Boot is implemented in C (and to some small parts in
Assembler); no C++ is used, so please do not use C++ style comments (//)
in your code.
W
wdenk 已提交
4796

W
wdenk 已提交
4797 4798
Please also stick to the following formatting rules:
- remove any trailing white space
4799
- use TAB characters for indentation and vertical alignment, not spaces
W
wdenk 已提交
4800
- make sure NOT to use DOS '\r\n' line feeds
4801
- do not add more than 2 consecutive empty lines to source files
W
wdenk 已提交
4802
- do not add trailing empty lines to source files
4803

W
wdenk 已提交
4804 4805
Submissions which do not conform to the standards may be returned
with a request to reformat the changes.
W
wdenk 已提交
4806 4807


W
wdenk 已提交
4808 4809
Submitting Patches:
-------------------
W
wdenk 已提交
4810

W
wdenk 已提交
4811 4812 4813
Since the number of patches for U-Boot is growing, we need to
establish some rules. Submissions which do not conform to these rules
may be rejected, even when they contain important and valuable stuff.
W
wdenk 已提交
4814

M
Magnus Lilja 已提交
4815
Please see http://www.denx.de/wiki/U-Boot/Patches for details.
4816

4817 4818 4819
Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
see http://lists.denx.de/mailman/listinfo/u-boot

W
wdenk 已提交
4820 4821
When you send a patch, please include the following information with
it:
W
wdenk 已提交
4822

W
wdenk 已提交
4823 4824 4825
* For bug fixes: a description of the bug and how your patch fixes
  this bug. Please try to include a way of demonstrating that the
  patch actually fixes something.
W
wdenk 已提交
4826

W
wdenk 已提交
4827 4828
* For new features: a description of the feature and your
  implementation.
W
wdenk 已提交
4829

W
wdenk 已提交
4830
* A CHANGELOG entry as plaintext (separate from the patch)
W
wdenk 已提交
4831

W
wdenk 已提交
4832
* For major contributions, your entry to the CREDITS file
W
wdenk 已提交
4833

W
wdenk 已提交
4834
* When you add support for a new board, don't forget to add this
4835
  board to the MAINTAINERS file, too.
W
wdenk 已提交
4836

W
wdenk 已提交
4837 4838
* If your patch adds new configuration options, don't forget to
  document these in the README file.
W
wdenk 已提交
4839

4840 4841
* The patch itself. If you are using git (which is *strongly*
  recommended) you can easily generate the patch using the
4842
  "git format-patch". If you then use "git send-email" to send it to
4843 4844 4845 4846 4847 4848
  the U-Boot mailing list, you will avoid most of the common problems
  with some other mail clients.

  If you cannot use git, use "diff -purN OLD NEW". If your version of
  diff does not support these options, then get the latest version of
  GNU diff.
W
wdenk 已提交
4849

4850 4851 4852 4853
  The current directory when running this command shall be the parent
  directory of the U-Boot source tree (i. e. please make sure that
  your patch includes sufficient directory information for the
  affected files).
W
wdenk 已提交
4854

4855 4856
  We prefer patches as plain text. MIME attachments are discouraged,
  and compressed attachments must not be used.
W
wdenk 已提交
4857

W
wdenk 已提交
4858 4859
* If one logical set of modifications affects or creates several
  files, all these changes shall be submitted in a SINGLE patch file.
W
wdenk 已提交
4860

W
wdenk 已提交
4861 4862
* Changesets that contain different, unrelated modifications shall be
  submitted as SEPARATE patches, one patch per changeset.
W
wdenk 已提交
4863

W
wdenk 已提交
4864

W
wdenk 已提交
4865
Notes:
W
wdenk 已提交
4866

W
wdenk 已提交
4867 4868 4869
* Before sending the patch, run the MAKEALL script on your patched
  source tree and make sure that no errors or warnings are reported
  for any of the boards.
W
wdenk 已提交
4870

W
wdenk 已提交
4871 4872 4873
* Keep your modifications to the necessary minimum: A patch
  containing several unrelated changes or arbitrary reformats will be
  returned with a request to re-formatting / split it.
W
wdenk 已提交
4874

W
wdenk 已提交
4875 4876 4877 4878 4879 4880
* If you modify existing code, make sure that your new code does not
  add to the memory footprint of the code ;-) Small is beautiful!
  When adding new features, these should compile conditionally only
  (using #ifdef), and the resulting code with the new feature
  disabled must not need more memory than the old code without your
  modification.
4881

4882 4883 4884 4885
* Remember that there is a size limit of 100 kB per message on the
  u-boot mailing list. Bigger patches will be moderated. If they are
  reasonable and not too big, they will be acknowledged. But patches
  bigger than the size limit should be avoided.