README 201 KB
Newer Older
wdenk's avatar
wdenk committed
1
#
2
# (C) Copyright 2000 - 2013
wdenk's avatar
wdenk committed
3
4
# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
#
5
# SPDX-License-Identifier:	GPL-2.0+
wdenk's avatar
wdenk committed
6
7
8
9
10
#

Summary:
========

11
This directory contains the source code for U-Boot, a boot loader for
wdenk's avatar
wdenk committed
12
13
14
15
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.
wdenk's avatar
wdenk committed
16
17

The development of U-Boot is closely related to Linux: some parts of
18
19
the source code originate in the Linux source tree, we have some
header files in common, and special provision has been made to
wdenk's avatar
wdenk committed
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
34
Makefile have been tested to some extent and can be considered
wdenk's avatar
wdenk committed
35
36
"working". In fact, many of them are used in production systems.

37
In case of problems see the CHANGELOG and CREDITS files to find out
38
39
who contributed the specific port. The MAINTAINERS file lists board
maintainers.
wdenk's avatar
wdenk committed
40

41
42
43
44
45
Note: There is no CHANGELOG file in the actual U-Boot source tree;
it can be created dynamically from the Git log using:

	make CHANGELOG

wdenk's avatar
wdenk committed
46
47
48
49

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

50
51
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
52
53
54
55
<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
wdenk's avatar
wdenk committed
56
57


58
59
60
61
62
63
64
65
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
66
any version you might be interested in. Official releases are also
67
68
69
available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
directory.

70
Pre-built (and tested) images are available from
71
72
73
ftp://ftp.denx.de/pub/u-boot/images/


wdenk's avatar
wdenk committed
74
75
76
77
Where we come from:
===================

- start from 8xxrom sources
78
- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenk's avatar
wdenk committed
79
80
81
82
83
84
85
- 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
86
  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
87
- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenk's avatar
wdenk committed
88
- add other CPU families (starting with ARM)
89
- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja's avatar
Magnus Lilja committed
90
- current project page: see http://www.denx.de/wiki/U-Boot
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112


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
wdenk's avatar
wdenk committed
113
114


wdenk's avatar
wdenk committed
115
116
117
Versioning:
===========

118
119
120
121
122
123
124
125
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:
Wolfgang Denk's avatar
Wolfgang Denk committed
126
	U-Boot v2009.11	    - Release November 2009
127
128
	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
wdenk's avatar
wdenk committed
129
130


wdenk's avatar
wdenk committed
131
132
133
Directory Hierarchy:
====================

134
135
136
137
138
/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
139
	/at91		Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk's avatar
Wolfgang Denk committed
140
141
	/imx		Files specific to Freescale MC9328 i.MX CPUs
	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
142
143
144
145
146
147
148
149
150
151
152
153
154
155
      /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
Graeme Russ's avatar
Graeme Russ committed
156
  /x86			Files generic to x86 architecture
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
    /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
172
      /mips32		Files specific to MIPS32 CPUs
173
      /xburst		Files specific to Ingenic XBurst CPUs
174
    /lib		Architecture specific library files
175
176
177
178
  /nds32		Files generic to NDS32 architecture
    /cpu		CPU specific files
      /n1213		Files specific to Andes Technology N1213 CPUs
    /lib		Architecture specific library files
179
180
181
  /nios2		Files generic to Altera NIOS2 architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
Stefan Roese's avatar
Stefan Roese committed
182
  /powerpc		Files generic to PowerPC architecture
183
184
185
186
187
188
189
190
191
192
193
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
    /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
      /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.
wdenk's avatar
wdenk committed
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

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
237
  "CONFIG_SYS_".
wdenk's avatar
wdenk committed
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

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

257
For the Cogent platform, you need to specify the CPU type as well;
wdenk's avatar
wdenk committed
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
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".


wdenk's avatar
wdenk committed
273
274
275
276
277
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.


wdenk's avatar
wdenk committed
278
279
The following options need to be configured:

280
281
282
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
283
284

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
285
		Define exactly one, e.g. CONFIG_ATSTK1002
wdenk's avatar
wdenk committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304

- 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
305
					  the LCD display every second with
wdenk's avatar
wdenk committed
306
307
					  a "rotator" |\-/|\-/

wdenk's avatar
wdenk committed
308
309
310
- Board flavour: (if CONFIG_MPC8260ADS is defined)
		CONFIG_ADSTYPE
		Possible values are:
311
312
313
314
			CONFIG_SYS_8260ADS	- original MPC8260ADS
			CONFIG_SYS_8266ADS	- MPC8266ADS
			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
			CONFIG_SYS_8272ADS	- MPC8272ADS
wdenk's avatar
wdenk committed
315

316
317
318
319
320
- Marvell Family Member
		CONFIG_SYS_MVFS		- define it if you want to enable
					  multiple fs option at one time
					  for marvell soc family

wdenk's avatar
wdenk committed
321
- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk's avatar
wdenk committed
322
323
		Define exactly one of
		CONFIG_MPC8240, CONFIG_MPC8245
wdenk's avatar
wdenk committed
324

325
- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk's avatar
wdenk committed
326
327
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
wdenk's avatar
wdenk committed
328
329
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
wdenk's avatar
wdenk committed
330
331
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
wdenk's avatar
wdenk committed
332

wdenk's avatar
wdenk committed
333
- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
334
335
		CONFIG_SYS_8xx_CPUCLK_MIN
		CONFIG_SYS_8xx_CPUCLK_MAX
wdenk's avatar
wdenk committed
336
		CONFIG_8xx_CPUCLK_DEFAULT
337
338
			See doc/README.MPC866

339
		CONFIG_SYS_MEASURE_CPUCLK
340

wdenk's avatar
wdenk committed
341
342
343
344
345
		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
346
		RTC clock or CONFIG_SYS_8XX_XIN)
347

348
349
350
351
352
		CONFIG_SYS_DELAYED_ICACHE

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

353
- 85xx CPU Options:
354
355
356
357
358
359
		CONFIG_SYS_PPC64

		Specifies that the core is a 64-bit PowerPC implementation (implements
		the "64" category of the Power ISA). This is necessary for ePAPR
		compliance, among other possible reasons.

360
361
362
363
364
365
		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.

366
367
368
369
370
		CONFIG_SYS_FSL_PCIE_COMPAT

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

371
372
373
374
375
376
377
378
379
		CONFIG_SYS_PPC_E500_DEBUG_TLB

		Enables a temporary TLB entry to be used during boot to work
		around limitations in e500v1 and e500v2 external debugger
		support. This reduces the portions of the boot code where
		breakpoints and single stepping do not work.  The value of this
		symbol should be set to the TLB1 entry to be used for this
		purpose.

380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
		CONFIG_SYS_FSL_ERRATUM_A004510

		Enables a workaround for erratum A004510.  If set,
		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.

		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)

		Defines one or two SoC revisions (low 8 bits of SVR)
		for which the A004510 workaround should be applied.

		The rest of SVR is either not relevant to the decision
		of whether the erratum is present (e.g. p2040 versus
		p2041) or is implied by the build target, which controls
		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.

		See Freescale App Note 4493 for more information about
		this erratum.

400
401
402
403
		CONFIG_A003399_NOR_WORKAROUND
		Enables a workaround for IFC erratum A003399. It is only
		requred during NOR boot.

404
405
406
407
408
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY

		This is the value to write into CCSR offset 0x18600
		according to the A004510 workaround.

409
410
411
412
		CONFIG_SYS_FSL_DSP_DDR_ADDR
		This value denotes start offset of DDR memory which is
		connected exclusively to the DSP cores.

413
414
415
416
		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
		This value denotes start offset of M2 memory
		which is directly connected to the DSP core.

417
418
419
420
		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
		This value denotes start offset of M3 memory which is directly
		connected to the DSP core.

421
422
423
		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
		This value denotes start offset of DSP CCSR space.

York Sun's avatar
York Sun committed
424
425
426
427
		CONFIG_SYS_FSL_DDR_EMU
		Specify emulator support for DDR. Some DDR features such as
		deskew training are not available.

428
429
430
431
432
433
- Generic CPU options:
		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN

		Defines the endianess of the CPU. Implementation of those
		values is arch specific.

434
- Intel Monahans options:
435
		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
436
437
438
439
440

		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.

441
		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denk's avatar
Wolfgang Denk committed
442

443
444
		Defines the Monahans turbo mode to oscillator
		ratio. Valid values are 1 (default if undefined) and
Wolfgang Denk's avatar
Wolfgang Denk committed
445
		2. The core frequency as calculated above is multiplied
446
		by this value.
Wolfgang Denk's avatar
Wolfgang Denk committed
447

448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
- 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.

480
481
482
483
484
485
- ARM options:
		CONFIG_SYS_EXCEPTION_VECTORS_HIGH

		Select high exception vectors of the ARM core, e.g., do not
		clear the V bit of the c1 register of CP15.

Aneesh V's avatar
Aneesh V committed
486
487
488
489
490
491
492
493
		CONFIG_SYS_THUMB_BUILD

		Use this flag to build U-Boot using the Thumb instruction
		set for ARM architectures. Thumb instruction set provides
		better code density. For ARM architectures that support
		Thumb2 this flag will result in Thumb2 code generated by
		GCC.

494
		CONFIG_ARM_ERRATA_716044
495
496
497
498
499
500
501
502
503
504
		CONFIG_ARM_ERRATA_742230
		CONFIG_ARM_ERRATA_743622
		CONFIG_ARM_ERRATA_751472

		If set, the workarounds for these ARM errata are applied early
		during U-Boot startup. Note that these options force the
		workarounds to be applied; no CPU-type/version detection
		exists, unlike the similar options in the Linux kernel. Do not
		set these options unless they apply!

505
506
507
508
509
510
511
- CPU timer options:
		CONFIG_SYS_HZ

		The frequency of the timer returned by get_timer().
		get_timer() must operate in milliseconds and this CONFIG
		option must be set to 1000.

wdenk's avatar
wdenk committed
512
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
513
514
515
516
517
518
519
520
521
522
		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
523
		"clocks_in_mhz=1" is automatically included in the
wdenk's avatar
wdenk committed
524
525
		default environment.

wdenk's avatar
wdenk committed
526
527
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

528
		When transferring memsize parameter to linux, some versions
wdenk's avatar
wdenk committed
529
530
531
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

532
		CONFIG_OF_LIBFDT
533
534

		New kernel versions are expecting firmware settings to be
535
536
537
538
539
540
		passed using flattened device trees (based on open firmware
		concepts).

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

543
544
545
546
		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).
547
		OF_TBCLK - The timebase frequency.
Kumar Gala's avatar
Kumar Gala committed
548
		OF_STDOUT_PATH - The path to the console device
549

550
551
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
552

553
554
555
556
		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
557

558
559
		CONFIG_OF_BOOT_CPU

560
		This define fills in the correct boot CPU in the boot
561
562
		param header, the default value is zero if undefined.

563
564
565
566
567
568
569
570
571
		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.

572
573
574
575
576
577
578
579
580
581
		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.

582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
- 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.

600
601
602
603
604
- 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

Aneesh V's avatar
Aneesh V committed
605
606
607
608
609
610
- 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

wdenk's avatar
wdenk committed
611
- Serial Ports:
612
		CONFIG_PL010_SERIAL
wdenk's avatar
wdenk committed
613
614
615

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

616
		CONFIG_PL011_SERIAL
wdenk's avatar
wdenk committed
617
618
619
620
621
622
623
624
625
626
627
628
629
630

		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

631
632
633
634
635
636
637
638
639
640
641
642
		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.

wdenk's avatar
wdenk committed
643

wdenk's avatar
wdenk committed
644
- Console Interface:
645
646
647
648
		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
wdenk's avatar
wdenk committed
649
650
651
652
653
654
655

		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
656
		defines (cf. smiLynxEM, i8042)
wdenk's avatar
wdenk committed
657
658
659
660
661
662
663
664
665
			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)
wdenk's avatar
wdenk committed
666
667
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
wdenk's avatar
wdenk committed
668
669
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
wdenk's avatar
wdenk committed
670
			VIDEO_FB_ADRS		framebuffer address
wdenk's avatar
wdenk committed
671
672
673
674
675
676
677
678
679
			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)
680
			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenk's avatar
wdenk committed
681
682
			CONFIG_CONSOLE_TIME	display time/date info in
						upper right corner
683
						(requires CONFIG_CMD_DATE)
wdenk's avatar
wdenk committed
684
685
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
686
687
688
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
wdenk's avatar
wdenk committed
689
			CONFIG_CONSOLE_EXTRA_INFO
690
						additional board info beside
wdenk's avatar
wdenk committed
691
692
						the logo

693
694
695
696
		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
		a limited number of ANSI escape sequences (cursor control,
		erase functions and limited graphics rendition control).

697
698
699
		When CONFIG_CFB_CONSOLE is defined, video console is
		default i/o. Serial console can be forced with
		environment 'console=serial'.
wdenk's avatar
wdenk committed
700

wdenk's avatar
wdenk committed
701
702
703
704
		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.
wdenk's avatar
wdenk committed
705

wdenk's avatar
wdenk committed
706
707
708
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
709
710
		CONFIG_SYS_BAUDRATE_TABLE, see below.
		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenk's avatar
wdenk committed
711

712
713
714
- Console Rx buffer length
		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
		the maximum receive buffer length for the SMC.
715
		This option is actual only for 82xx and 8xx possible.
716
717
718
719
		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
		must be defined, to setup the maximum idle timeout for
		the SMC.

720
- Pre-Console Buffer:
721
722
723
724
725
726
727
		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
Wolfgang Denk's avatar
Wolfgang Denk committed
728
		bytes are output before the console is initialised, the
729
730
731
732
		earlier bytes are discarded.

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

734
735
736
737
738
739
740
741
742
- 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.

wdenk's avatar
wdenk committed
743
744
745
- Boot Delay:	CONFIG_BOOTDELAY - in seconds
		Delay before automatically booting the default image;
		set to -1 to disable autoboot.
746
747
		set to -2 to autoboot with no delay and not check for abort
		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenk's avatar
wdenk committed
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769

		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
770
771
772
		This can be used to pass arguments to the bootm
		command. The value of CONFIG_BOOTARGS goes into the
		environment value "bootargs".
wdenk's avatar
wdenk committed
773
774

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
775
776
777
		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
778
		RAM and NFS.
wdenk's avatar
wdenk committed
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804

- 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.

805
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenk's avatar
wdenk committed
806
807
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
808
		CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
809
810

- Monitor Functions:
811
812
		Monitor commands can be included or excluded
		from the build by using the #include files
813
814
		<config_cmd_all.h> and #undef'ing unwanted
		commands, or using <config_cmd_default.h>
815
816
817
818
819
820
821
822
823
824
825
826
827
828
		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
Mike Frysinger's avatar
Mike Frysinger committed
829
		CONFIG_CMD_CRC32	* crc32
830
831
832
		CONFIG_CMD_DATE		* support for RTC, date/time...
		CONFIG_CMD_DHCP		* DHCP support
		CONFIG_CMD_DIAG		* Diagnostics
833
834
835
836
		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
837
838
		CONFIG_CMD_DTT		* Digital Therm and Thermostat
		CONFIG_CMD_ECHO		  echo arguments
Peter Tyser's avatar
Peter Tyser committed
839
		CONFIG_CMD_EDITENV	  edit env variable
840
841
		CONFIG_CMD_EEPROM	* EEPROM read/write support
		CONFIG_CMD_ELF		* bootelf, bootvx
842
		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
843
		CONFIG_CMD_ENV_FLAGS	* display details about env flags
844
		CONFIG_CMD_EXPORTENV	* export the environment
845
846
		CONFIG_CMD_EXT2		* ext2 command support
		CONFIG_CMD_EXT4		* ext4 command support
847
		CONFIG_CMD_SAVEENV	  saveenv
848
		CONFIG_CMD_FDC		* Floppy Disk Support
849
		CONFIG_CMD_FAT		* FAT command support
850
851
852
		CONFIG_CMD_FDOS		* Dos diskette Support
		CONFIG_CMD_FLASH	  flinfo, erase, protect
		CONFIG_CMD_FPGA		  FPGA device initialization support
853
		CONFIG_CMD_FUSE		* Device fuse support
Anton Staaf's avatar
Anton Staaf committed
854
		CONFIG_CMD_GETTIME	* Get time since boot
Mike Frysinger's avatar
Mike Frysinger committed
855
		CONFIG_CMD_GO		* the 'go' command (exec code)
Kim Phillips's avatar
Kim Phillips committed
856
		CONFIG_CMD_GREPENV	* search environment
857
		CONFIG_CMD_HASH		* calculate hash / digest
858
859
860
861
		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
862
		CONFIG_CMD_IMLS		  List all images found in NOR flash
863
		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
864
		CONFIG_CMD_IMMAP	* IMMR dump support
865
		CONFIG_CMD_IMPORTENV	* import an environment
Joe Hershberger's avatar
Joe Hershberger committed
866
		CONFIG_CMD_INI		* import data from an ini file into the env
867
868
869
870
		CONFIG_CMD_IRQ		* irqinfo
		CONFIG_CMD_ITEST	  Integer/string test of 2 values
		CONFIG_CMD_JFFS2	* JFFS2 Support
		CONFIG_CMD_KGDB		* kgdb
871
		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
872
873
		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
					  (169.254.*.*)
874
875
		CONFIG_CMD_LOADB	  loadb
		CONFIG_CMD_LOADS	  loads
876
		CONFIG_CMD_MD5SUM	* print md5 message digest
Robin Getz's avatar
Robin Getz committed
877
					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
878
		CONFIG_CMD_MEMINFO	* Display detailed memory information
879
		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
880
					  loop, loopw
881
		CONFIG_CMD_MEMTEST	* mtest
882
883
884
		CONFIG_CMD_MISC		  Misc functions like sleep etc
		CONFIG_CMD_MMC		* MMC memory mapped support
		CONFIG_CMD_MII		* MII utility commands
885
		CONFIG_CMD_MTDPARTS	* MTD partition support
886
887
		CONFIG_CMD_NAND		* NAND support
		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
888
		CONFIG_CMD_NFS		  NFS support
889
		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
Wolfgang Denk's avatar
Wolfgang Denk committed
890
		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
891
892
893
894
895
		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
896
		CONFIG_CMD_READ		* Read raw data from partition
897
898
		CONFIG_CMD_REGINFO	* Register dump
		CONFIG_CMD_RUN		  run command in env variable
899
		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
900
901
902
903
904
905
		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)
906
		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
907
		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
Robin Getz's avatar
Robin Getz committed
908
					  (requires CONFIG_CMD_MEMORY)
909
		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
910
		CONFIG_CMD_SOURCE	  "source" command Support
911
		CONFIG_CMD_SPI		* SPI serial bus support
Luca Ceresoli's avatar
Luca Ceresoli committed
912
		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
913
		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
914
915
		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
		CONFIG_CMD_TIMER	* access to the system tick timer
916
917
		CONFIG_CMD_USB		* USB support
		CONFIG_CMD_CDP		* Cisco Discover Protocol support
918
		CONFIG_CMD_MFSL		* Microblaze FSL support
919
		CONFIG_CMD_XIMG		  Load part of Multi Image
920

wdenk's avatar
wdenk committed
921
922
923
924

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

925
926
		#include "config_cmd_all.h"
		#undef CONFIG_CMD_NET
wdenk's avatar
wdenk committed
927

928
929
	Other Commands:
		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenk's avatar
wdenk committed
930
931

	Note:	Don't enable the "icache" and "dcache" commands
932
		(configuration option CONFIG_CMD_CACHE) unless you know
933
934
935
936
937
938
		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.
wdenk's avatar
wdenk committed
939
940
941
942


		XXX - this list needs to get updated!

943
944
945
946
947
948
949
- Regular expression support:
		CONFIG_REGEX
                If this variable is defined, U-Boot is linked against
                the SLRE (Super Light Regular Expression) library,
                which adds regex support to some commands, as for
                example "env grep" and "setexpr".

950
951
952
953
954
955
956
957
- 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.

958
959
		U-Boot needs to get its device tree from somewhere. This can
		be done using one of the two options below:
960
961
962
963
964
965
966

		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.
967

968
969
970
971
972
973
974
975
976
977
978
979
		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.

wdenk's avatar
wdenk committed
980
981
982
- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
983
984
985
986
987
988
989
990
991
992
993
		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.
wdenk's avatar
wdenk committed
994

995
996
997
998
999
- 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.
1000
1001
		Any change to this variable will be reverted at the
		next reset.
1002

wdenk's avatar
wdenk committed
1003
1004
- Real-Time Clock:

1005
		When CONFIG_CMD_DATE is selected, the type of the RTC
wdenk's avatar
wdenk committed
1006
1007
1008
1009
1010
		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
1011
		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
wdenk's avatar
wdenk committed
1012
		CONFIG_RTC_MC146818	- use MC146818 RTC
wdenk's avatar
wdenk committed
1013
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
1014
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
1015
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
wdenk's avatar
wdenk committed
1016
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
1017
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
wdenk's avatar
wdenk committed
1018
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
1019
		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
1020
1021
		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
					  RV3029 RTC.
wdenk's avatar
wdenk committed
1022

wdenk's avatar
wdenk committed
1023
1024
1025
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

1026
1027
1028
1029
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
		CONFIG_PCA953X_INFO	- enable pca953x info command

1030
1031
1032
1033
		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.

1034
1035
1036
		Note that if the GPIO device uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

wdenk's avatar
wdenk committed
1037
1038
- Timestamp Support:

1039
1040
1041
		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
1042
		automatically enabled when you select CONFIG_CMD_DATE .
wdenk's avatar
wdenk committed
1043

1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
- Partition Labels (disklabels) Supported:
		Zero or more of the following:
		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
				       Intel architecture, USB sticks, etc.
		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
				       bootloader.  Note 2TB partition limit; see
				       disk/part_efi.c
		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
wdenk's avatar
wdenk committed
1054

1055
1056
		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
		CONFIG_CMD_SCSI) you must configure support for at
1057
		least one non-MTD partition type as well.
wdenk's avatar
wdenk committed
1058
1059

- IDE Reset method:
wdenk's avatar
wdenk committed
1060
1061
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
1062

wdenk's avatar
wdenk committed
1063
1064
1065
1066
		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
wdenk's avatar
wdenk committed
1067
1068
1069
1070
1071
1072

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

1073
1074
1075
1076
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
1077
		Also look at CONFIG_SYS_64BIT_LBA.
1078
1079
1080
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

1081
		CONFIG_SYS_64BIT_LBA:
1082
1083
1084
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

wdenk's avatar
wdenk committed
1085
1086
1087
1088
1089
- SCSI Support:
		At the moment only there is only support for the
		SYM53C8XX SCSI controller; define
		CONFIG_SCSI_SYM53C8XX to enable it.

1090
1091
1092
		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
wdenk's avatar
wdenk committed
1093
1094
		maximum numbers of LUNs, SCSI ID's and target
		devices.
1095
		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenk's avatar
wdenk committed
1096

1097
1098
1099
                The environment variable 'scsidevs' is set to the number of
                SCSI devices found during the last scan.

wdenk's avatar
wdenk committed
1100
- NETWORK Support (PCI):
1101
		CONFIG_E1000
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
		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.
stroese's avatar
stroese committed
1116

Andre Schwarz's avatar
Andre Schwarz committed
1117
		CONFIG_E1000_FALLBACK_MAC
1118
		default MAC for empty EEPROM after production.
Andre Schwarz's avatar
Andre Schwarz committed
1119

wdenk's avatar
wdenk committed
1120
1121
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
1122
		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenk's avatar
wdenk committed
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
		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.

wdenk's avatar
wdenk committed
1136
1137
- NETWORK Support (other):

1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
		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.

Rob Herring's avatar
Rob Herring committed
1148
1149
1150
		CONFIG_CALXEDA_XGMAC
		Support for the Calxeda XGMAC device

1151
		CONFIG_LAN91C96
wdenk's avatar
wdenk committed
1152
1153
1154
1155
1156
1157
1158
1159
1160
		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

1161
		CONFIG_SMC91111
wdenk's avatar
wdenk committed
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
		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)

1175
1176
1177
1178
1179
1180
		CONFIG_DRIVER_TI_EMAC
		Support for davinci emac

			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
			Define this if you have more then 3 PHYs.

1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
		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.

1193
		CONFIG_SMC911X
Jens Gehrlein's avatar
Jens Gehrlein committed
1194
1195
		Support for SMSC's LAN911x and LAN921x chips

1196
			CONFIG_SMC911X_BASE
Jens Gehrlein's avatar
Jens Gehrlein committed
1197
1198
1199
			Define this to hold the physical address
			of the device (I/O space)

1200
			CONFIG_SMC911X_32_BIT
Jens Gehrlein's avatar
Jens Gehrlein committed
1201
1202
			Define this if data bus is 32 bits

1203
			CONFIG_SMC911X_16_BIT
Jens Gehrlein's avatar
Jens Gehrlein committed
1204
1205
			Define this if data bus is 16 bits. If your processor
			automatically converts one 32 bit word to two 16 bit
1206
			words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein's avatar
Jens Gehrlein committed
1207

1208
1209
1210
1211
1212
1213
1214
1215
1216
		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

1217
1218
1219
			CONFIG_SH_ETHER_CACHE_WRITEBACK
			If this option is set, the driver enables cache flush.

1220
- TPM Support:
1221
1222
1223
		CONFIG_TPM
		Support TPM devices.

1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
		CONFIG_TPM_TIS_I2C
		Support for i2c bus TPM devices. Only one device
		per system is supported at this time.

			CONFIG_TPM_TIS_I2C_BUS_NUMBER
			Define the the i2c bus number for the TPM device

			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
			Define the TPM's address on the i2c bus

			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
			Define the burst count bytes upper limit

Dirk Eibach's avatar
Dirk Eibach committed
1237
1238
1239
		CONFIG_TPM_ATMEL_TWI
		Support for Atmel TWI TPM device. Requires I2C support.

1240
		CONFIG_TPM_TIS_LPC
1241
1242
1243
1244
1245
1246
1247
1248
		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.

1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
		CONFIG_CMD_TPM
		Add tpm monitor functions.
		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
		provides monitor access to authorized functions.

		CONFIG_TPM
		Define this to enable the TPM support library which provides
		functional interfaces to some TPM commands.
		Requires support for a TPM device.

		CONFIG_TPM_AUTH_SESSIONS
		Define this to enable authorized functions in the TPM library.
		Requires CONFIG_TPM and CONFIG_SHA1.

wdenk's avatar
wdenk committed
1263
1264
- USB Support:
		At the moment only the UHCI host controller is
wdenk's avatar
wdenk committed
1265
		supported (PIP405, MIP405, MPC5200); define
wdenk's avatar
wdenk committed
1266
1267
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk's avatar
wdenk committed
1268
		and define CONFIG_USB_STORAGE to enable the USB
wdenk's avatar
wdenk committed
1269
1270
1271
1272
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
wdenk's avatar
wdenk committed
1273
1274
1275
		MPC5200 USB requires additional defines:
			CONFIG_USB_CLOCK
				for 528 MHz Clock: 0x0001bbbb
1276
1277
			CONFIG_PSC3_USB
				for USB on PSC3
wdenk's avatar
wdenk committed
1278
1279
1280
			CONFIG_USB_CONFIG
				for differential drivers: 0x00001000
				for single ended drivers: 0x00005000
1281
1282
				for differential drivers on PSC3: 0x00000100
				for single ended drivers on PSC3: 0x00004100
1283
			CONFIG_SYS_USB_EVENT_POLL
Zhang Wei's avatar
Zhang Wei committed
1284
1285
				May be defined to allow interrupt polling
				instead of using asynchronous interrupts
wdenk's avatar
wdenk committed
1286

1287
1288
1289
		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
		txfilltuning field in the EHCI controller on reset.

1290
1291
1292
		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
		interval for usb hub power-on delay.(minimum 100msec)

Wolfgang Denk's avatar
Wolfgang Denk committed
1293
1294
1295
1296
- 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
1297
		attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk's avatar
Wolfgang Denk committed
1298
1299
		it has found a new device. The environment variable usbtty
		can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk's avatar
Wolfgang Denk committed
1300
		appear to a USB host as a Linux gserial device or a
Wolfgang Denk's avatar
Wolfgang Denk committed
1301
1302
1303
1304
1305
1306
1307
		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
Wolfgang Denk's avatar
Wolfgang Denk committed
1308

Wolfgang Denk's avatar
Wolfgang Denk committed
1309
1310
1311
1312
1313
1314
			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
Wolfgang Denk's avatar
Wolfgang Denk committed
1315

1316
1317
1318
1319
1320
1321
1322
1323
			CONFIG_USBD_HS
			Define this to enable the high speed support for usb
			device and usbtty. If this feature is enabled, a routine
			int is_usbd_high_speed(void)
			also needs to be defined by the driver to dynamically poll
			whether the enumeration has succeded at high speed or full
			speed.

1324
			CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk's avatar
Wolfgang Denk committed
1325
1326
1327
1328
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

			mpc8xx:
1329
				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk's avatar
Wolfgang Denk committed
1330
				Derive USB clock from external clock "blah"
1331
				- CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk's avatar
Wolfgang Denk committed
1332

1333
				CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk's avatar
Wolfgang Denk committed
1334
				Derive USB clock from brgclk
1335
				- CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk's avatar
Wolfgang Denk committed
1336

Wolfgang Denk's avatar
Wolfgang Denk committed
1337
		If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk's avatar
Wolfgang Denk committed
1338
		define your own vendor specific values either in BoardName.h
Wolfgang Denk's avatar
Wolfgang Denk committed
1339
		or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk's avatar
Wolfgang Denk committed
1340
1341
1342
1343
1344
1345
1346
		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"
Wolfgang Denk's avatar
Wolfgang Denk committed
1347

Wolfgang Denk's avatar
Wolfgang Denk committed
1348
1349
1350
1351
1352
1353
1354
1355
1356
			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
Wolfgang Denk's avatar
Wolfgang Denk committed
1357

Wolfgang Denk's avatar
Wolfgang Denk committed
1358
1359
1360
1361
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
wdenk's avatar
wdenk committed
1362

1363
1364
1365
1366
1367
1368
1369
1370
- 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.
Lucas Stach's avatar
Lucas Stach committed
1371
1372
1373
		If your ULPI phy needs a different reference clock than the
		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
		the appropriate value in Hz.
wdenk's avatar
wdenk committed
1374

1375
- MMC Support:
wdenk's avatar
wdenk committed
1376
1377
1378
		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
1379
		to physical memory similar to flash. Command line is
1380
1381
		enabled with CONFIG_CMD_MMC. The MMC driver also works with
		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1382

1383
1384
1385
1386
1387
1388
1389
1390
1391
		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

1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
- USB Device Firmware Update (DFU) class support:
		CONFIG_DFU_FUNCTION
		This enables the USB portion of the DFU USB class

		CONFIG_CMD_DFU
		This enables the command "dfu" which is used to have
		U-Boot create a DFU class device via USB.  This command
		requires that the "dfu_alt_info" environment variable be
		set and define the alt settings to expose to the host.

		CONFIG_DFU_MMC
		This enables support for exposing (e)MMC devices via DFU.

1405
1406
1407
		CONFIG_DFU_NAND
		This enables support for exposing NAND devices via DFU.

1408
1409
1410
1411
1412
1413
		CONFIG_SYS_DFU_DATA_BUF_SIZE
		Dfu transfer uses a buffer before writing data to the
		raw storage device. Make the size (in bytes) of this buffer
		configurable. The size of this buffer is also configurable
		through the "dfu_bufsiz" environment variable.

1414
1415
1416
1417
1418
1419
1420
		CONFIG_SYS_DFU_MAX_FILE_SIZE
		When updating files rather than the raw storage device,
		we use a static buffer to copy the file into and then write
		the buffer once we've been given the whole file.  Define
		this to the maximum filesize (in bytes) for the buffer.
		Default is 4 MiB if undefined.

wdenk's avatar
wdenk committed
1421
1422
1423
1424
1425
- 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

1426
1427
		CONFIG_SYS_JFFS2_FIRST_SECTOR,
		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk's avatar
wdenk committed
1428
1429
		Define these for a default partition on a NOR device

1430
		CONFIG_SYS_JFFS_CUSTOM_PART
wdenk's avatar
wdenk committed
1431
1432
1433
1434
		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
1435
		#define CONFIG_SYS_JFFS_SINGLE_PART	1
wdenk's avatar
wdenk committed
1436
1437
1438
		to disable the command chpart. This is the default when you
		have not defined a custom partition

Donggeun Kim's avatar
Donggeun Kim committed
1439
1440
- FAT(File Allocation Table) filesystem write function support:
		CONFIG_FAT_WRITE
Donggeun Kim's avatar
Donggeun Kim committed
1441
1442
1443
1444
1445
1446

		Define this to enable support for saving memory data as a
		file in FAT formatted partition.

		This will also enable the command "fatwrite" enabling the
		user to write files to FAT.
Donggeun Kim's avatar
Donggeun Kim committed
1447

1448
1449
1450
1451
1452
1453
1454
CBFS (Coreboot Filesystem) support
		CONFIG_CMD_CBFS

		Define this to enable support for reading from a Coreboot
		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
		and cbfsload.

wdenk's avatar
wdenk committed
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
- 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.

1467
1468
1469
1470
1471
		CONFIG_CROS_EC_KEYB
		Enables a Chrome OS keyboard using the CROS_EC interface.
		This uses CROS_EC to communicate with a second microcontroller
		which provides key scans on request.

wdenk's avatar
wdenk committed
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
- 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
wdenk's avatar
wdenk committed
1483
		Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenk's avatar
wdenk committed
1484
1485
1486
1487
		video output is selected via environment 'videoout'
		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
		assumed.

wdenk's avatar
wdenk committed
1488
		For the CT69000 and SMI_LYNXEM drivers, videomode is
1489
		selected via environment 'videomode'. Two different ways
wdenk's avatar
wdenk committed
1490
1491
		are possible:
		- "videomode=num"   'num' is a standard LiLo mode numbers.
wdenk's avatar
wdenk committed
1492
		Following standard modes are supported	(* is default):
wdenk's avatar
wdenk committed
1493
1494
1495
1496
1497
1498
1499
1500

		      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
		-------------+---------------------------------------------
wdenk's avatar
wdenk committed
1501
1502
		(i.e. setenv videomode 317; saveenv; reset;)

wdenk's avatar
wdenk committed
1503
		- "videomode=bootargs" all the video parameters are parsed
1504
		from the bootargs. (See drivers/video/videomodes.c)
wdenk's avatar
wdenk committed
1505
1506


1507
		CONFIG_VIDEO_SED13806
1508
		Enable Epson SED13806 driver. This driver supports 8bpp
1509
1510
1511
		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
		or CONFIG_VIDEO_SED13806_16BPP

1512
		CONFIG_FSL_DIU_FB
Wolfgang Denk's avatar
Wolfgang Denk committed
1513
		Enable the Freescale DIU video driver.	Reference boards for
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
		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

1526
1527
1528
1529
		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.
1530

1531
1532
1533
1534
1535
1536
1537
		CONFIG_VIDEO_VGA

		Enable the VGA video / BIOS for x86. The alternative if you
		are using coreboot is to use the coreboot frame buffer
		driver.


1538
- Keyboard Support:
wdenk's avatar
wdenk committed
1539
		CONFIG_KEYBOARD
1540

wdenk's avatar
wdenk committed
1541
1542
1543
1544
		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.
1545

wdenk's avatar
wdenk committed
1546
1547
1548
1549
1550
1551
- 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:

Stelian Pop's avatar
Stelian Pop committed
1552
1553
1554
1555
		CONFIG_ATMEL_LCD:

			HITACHI TX09D70VM1CCA, 3.5", 240x320.

wdenk's avatar
wdenk committed
1556
		CONFIG_NEC_NL6448AC33:
wdenk's avatar
wdenk committed
1557

wdenk's avatar
wdenk committed
1558
			NEC NL6448AC33-18. Active, color, single scan.
wdenk's avatar
wdenk committed
1559

wdenk's avatar
wdenk committed
1560
		CONFIG_NEC_NL6448BC20
wdenk's avatar
wdenk committed
1561

wdenk's avatar
wdenk committed
1562
1563
1564
1565
1566
1567
			NEC NL6448BC20-08. 6.5", 640x480.
			Active, color, single scan.

		CONFIG_NEC_NL6448BC33_54

			NEC NL6448BC33-54. 10.4", 640x480.
wdenk's avatar
wdenk committed
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
			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
1596
		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenk's avatar
wdenk committed
1597

1598
1599
1600
1601
1602
1603
1604
1605
		CONFIG_LCD_ALIGNMENT

		Normally the LCD is page-aligned (tyically 4KB). If this is
		defined then the LCD will be aligned to this value instead.
		For ARM it is sometimes useful to use MMU_SECTION_SIZE
		here, since it is cheaper to change data cache settings on
		a per-section basis.

1606
1607
1608
1609
1610
1611
		CONFIG_CONSOLE_SCROLL_LINES

		When the console need to be scrolled, this is the number of
		lines to scroll by. It defaults to 1. Increasing this makes
		the console jump but can help speed up operation when scrolling
		is slow.
1612

1613
1614
1615
1616
		CONFIG_LCD_BMP_RLE8

		Support drawing of RLE8-compressed bitmaps on the LCD.

1617
1618
1619
1620
1621
		CONFIG_I2C_EDID

		Enables an 'i2c edid' command which can read EDID
		information over I2C from an attached LCD display.

wdenk's avatar
wdenk committed
1622
- Splash Screen Support: CONFIG_SPLASH_SCREEN
1623

wdenk's avatar
wdenk committed
1624
1625
1626
		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
1627
		is suppressed and the BMP image at the address
wdenk's avatar
wdenk committed
1628
1629
1630
1631
		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.
1632

1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
		CONFIG_SPLASHIMAGE_GUARD

		If this option is set, then U-Boot will prevent the environment
		variable "splashimage" from being set to a problematic address
		(see README.displaying-bmps and README.arm-unaligned-accesses).
		This option is useful for targets where, due to alignment
		restrictions, an improperly aligned BMP image will cause a data
		abort. If you think you will not have problems with unaligned
		accesses (for example because your toolchain prevents them)
		there is no need to set this option.

1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
		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

1664
1665
1666
1667
1668
1669
- 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.

1670
1671
1672
1673
1674
1675
- 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.

Lei Wen's avatar
Lei Wen committed
1676
1677
1678
1679
1680
1681
- Do compresssing for memory range:
		CONFIG_CMD_ZIP

		If this option is set, it would use zlib deflate method
		to compress the specified memory at its best effort.

wdenk's avatar
wdenk committed
1682
- Compression support:
1683
1684
1685
1686
		CONFIG_GZIP

		Enabled by default to support gzip compressed images.

wdenk's avatar
wdenk committed
1687
1688
1689
1690
1691
1692
		CONFIG_BZIP2

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

1693
		NOTE: the bzip2 algorithm requires a lot of RAM, so
1694
		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1695
		be at least 4MB.
1696

1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
		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
1718
		the appropriate CONFIG_SYS_MALLOC_LEN value).
1719

1720
1721
1722
1723
1724
		CONFIG_LZO

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

wdenk's avatar
wdenk committed
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
- 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
1737
		detection of gigabit PHY is included.
wdenk's avatar
wdenk committed
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750

		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

wdenk's avatar
wdenk committed
1751
1752
- Ethernet address:
		CONFIG_ETHADDR
1753
		CONFIG_ETH1ADDR
wdenk's avatar
wdenk committed
1754
1755
		CONFIG_ETH2ADDR
		CONFIG_ETH3ADDR
1756
1757
		CONFIG_ETH4ADDR
		CONFIG_ETH5ADDR
wdenk's avatar
wdenk committed
1758

1759
1760
		Define a default value for Ethernet address to use
		for the respective Ethernet interface, in case this
wdenk's avatar
wdenk committed
1761
1762
1763
1764
1765
1766
		is not determined automatically.

- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
1767
		the default Ethernet interface, in case this is not
wdenk's avatar
wdenk committed
1768
		determined through e.g. bootp.
1769
		(Environment variable "ipaddr")
wdenk's avatar
wdenk committed
1770
1771
1772
1773

- Server IP address:
		CONFIG_SERVERIP

1774
		Defines a default value for the IP address of a TFTP
wdenk's avatar
wdenk committed
1775
		server to contact when using the "tftboot" command.
1776
		(Environment variable "serverip")
wdenk's avatar
wdenk committed
1777

1778
1779
1780
1781
1782
		CONFIG_KEEP_SERVERADDR

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

1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
- 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")

David Updegraff's avatar
David Updegraff committed
1800
1801
1802
1803
1804
- 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
1805
		tftp down the same boot image concurrently.  Note: the Ethernet
David Updegraff's avatar
David Updegraff committed
1806
1807
1808
		driver in use must provide a function: mcast() to join/leave a
		multicast group.

wdenk's avatar
wdenk committed
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
- 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
1820
		following delays are inserted then:
wdenk's avatar
wdenk committed
1821
1822
1823
1824
1825
1826
1827

		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

1828
- DHCP Advanced Options:
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
		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
1844
		CONFIG_BOOTP_MAY_FAIL
1845

1846
1847
		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
		environment variable, not the BOOTP server.
1848

1849
1850
1851
1852
1853
1854
		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
		after the configured retry count, the call will fail
		instead of starting over.  This can be used to fail over
		to Link-local IP address configuration if the DHCP server
		is not available.

1855
1856
1857
1858
1859
1860
1861
		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
1862
		is defined.
1863
1864
1865
1866

		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.
1867
		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1868
1869
		of the "hostname" environment variable is passed as
		option 12 to the DHCP server.
1870

1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
		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.

1885
1886
1887
1888
1889
1890
1891
1892
 - Link-local IP address negotiation:
		Negotiate with other link-local clients on the local network
		for an address that doesn't require explicit configuration.
		This is especially useful if a DHCP server cannot be guaranteed
		to exist in all environments that the device must operate.

		See doc/README.link-local for more information.

1893
 - CDP Options:
wdenk's avatar
wdenk committed
1894
		CONFIG_CDP_DEVICE_ID
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906

		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
1907
		eth0 for the first Ethernet, eth1 for the second etc.
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934

		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.

wdenk's avatar
wdenk committed
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
- 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.

1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
- I2C Support:	CONFIG_SYS_I2C

		This enable the NEW i2c subsystem, and will allow you to use
		i2c commands at the u-boot command line (as long as you set
		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
		based realtime clock chips or other i2c devices. See
		common/cmd_i2c.c for a description of the command line
		interface.

		ported i2c driver to the new framework:
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
		- drivers/i2c/soft_i2c.c:
		  - activate first bus with CONFIG_SYS_I2C_SOFT define
		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
		    for defining speed and slave address
		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
		    for defining speed and slave address
		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
		    for defining speed and slave address
		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
		    for defining speed and slave address
1975

1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
		- drivers/i2c/fsl_i2c.c:
		  - activate i2c driver with CONFIG_SYS_I2C_FSL
		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
		    bus.
                  - If your board supports a second fsl i2c bus, define
		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
		    second bus.

1988
1989
1990
1991
1992
		- drivers/i2c/tegra_i2c.c:
		 - activate this driver with CONFIG_SYS_I2C_TEGRA
		 - This driver adds 4 i2c buses with a fix speed from
		   100000 and the slave addr 0!

1993
1994
1995
1996
1997
		- drivers/i2c/ppc4xx_i2c.c
		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1

1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
		additional defines:

		CONFIG_SYS_NUM_I2C_BUSES
		Hold the number of i2c busses you want to use. If you
		don't use/have i2c muxes on your i2c bus, this
		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
		omit this define.

		CONFIG_SYS_I2C_DIRECT_BUS
		define this, if you don't use i2c muxes on your hardware.
		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
		omit this define.

		CONFIG_SYS_I2C_MAX_HOPS
		define how many muxes are maximal consecutively connected
		on one i2c bus. If you not use i2c muxes, omit this
		define.

		CONFIG_SYS_I2C_BUSES
		hold a list of busses you want to use, only used if
		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
		CONFIG_SYS_NUM_I2C_BUSES = 9:

		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
					{1, {I2C_NULL_HOP}}, \
					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
					}

		which defines
			bus 0 on adapter 0 without a mux
2035
2036
2037
2038
2039
			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
2040
			bus 6 on adapter 1 without a mux
2041
2042
			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
2043
2044
2045

		If you do not have i2c muxes on your board, omit this define.

2046
- Legacy I2C Support:	CONFIG_HARD_I2C
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056

		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
		provides the following compelling advantages:

		- more than one i2c adapter is usable
		- approved multibus support
		- better i2c mux support

		** Please consider updating your I2C driver now. **

2057
2058
2059
		These enable legacy I2C serial bus commands. Defining
		CONFIG_HARD_I2C will include the appropriate I2C driver
		for the selected CPU.
wdenk's avatar
wdenk committed
2060

2061
		This will allow you to use i2c commands at the u-boot
2062
		command line (as long as you set CONFIG_CMD_I2C in
wdenk's avatar
wdenk committed
2063
2064
		CONFIG_COMMANDS) and communicate with i2c based realtime
		clock chips. See common/cmd_i2c.c for a description of the
2065
		command line interface.
wdenk's avatar
wdenk committed
2066

2067
		CONFIG_HARD_I2C selects a hardware I2C controller.
wdenk's avatar
wdenk committed
2068

2069
		There are several other quantities that must also be
2070
		defined when you define CONFIG_HARD_I2C.
wdenk's avatar
wdenk committed
2071

2072
		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2073
		to be the frequency (in Hz) at which you wish your i2c bus
2074
		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
2075
		the CPU's i2c node address).
2076

2077
		Now, the u-boot i2c code for the mpc8xx
Stefan Roese's avatar
Stefan Roese committed
2078
		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
2079
2080
2081
		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.
wdenk's avatar
wdenk committed
2082

2083
2084
2085
2086
2087
2088
2089
		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.

2090
		That's all that's required for CONFIG_HARD_I2C.
wdenk's avatar
wdenk committed
2091

2092
		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenk's avatar
wdenk committed
2093
2094
		then the following macros need to be defined (examples are
		from include/configs/lwmon.h):
wdenk's avatar
wdenk committed
2095
2096
2097

		I2C_INIT

wdenk's avatar
wdenk committed
2098
		(Optional). Any commands necessary to enable the I2C
2099
		controller or configure ports.
wdenk's avatar
wdenk committed
2100

wdenk's avatar
wdenk committed
2101
		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
wdenk's avatar
wdenk committed
2102

wdenk's avatar
wdenk committed
2103
2104
		I2C_PORT

2105
2106
2107
		(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.
wdenk's avatar
wdenk committed
2108
2109
2110
2111
2112
2113
2114

		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.

wdenk's avatar
wdenk committed
2115
2116
		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)

wdenk's avatar
wdenk committed
2117
2118
2119
2120
2121
2122
		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.

wdenk's avatar
wdenk committed
2123
2124
		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)

wdenk's avatar
wdenk committed
2125
2126
		I2C_READ

York Sun's avatar
York Sun committed
2127
2128
		Code that returns true if the I2C data line is high,
		false if it is low.
wdenk's avatar
wdenk committed
2129

wdenk's avatar
wdenk committed
2130
2131
		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)

wdenk's avatar
wdenk committed
2132
2133
		I2C_SDA(bit)

York Sun's avatar
York Sun committed
2134
2135
		If <bit> is true, sets the I2C data line high. If it
		is false, it clears it (low).
wdenk's avatar
wdenk committed
2136

wdenk's avatar
wdenk committed
2137
		eg: #define I2C_SDA(bit) \
wdenk's avatar
wdenk committed
2138
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
wdenk's avatar
wdenk committed
2139
			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenk's avatar
wdenk committed
2140

wdenk's avatar
wdenk committed
2141
2142
		I2C_SCL(bit)

York Sun's avatar
York Sun committed
2143
2144
		If <bit> is true, sets the I2C clock line high. If it
		is false, it clears it (low).
wdenk's avatar
wdenk committed
2145

wdenk's avatar
wdenk committed
2146
		eg: #define I2C_SCL(bit) \
wdenk's avatar
wdenk committed
2147
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
wdenk's avatar
wdenk committed
2148
			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenk's avatar
wdenk committed
2149

wdenk's avatar
wdenk committed
2150
2151
2152
2153
		I2C_DELAY

		This delay is invoked four times per clock cycle so this
		controls the rate of data transfer.  The data rate thus
wdenk's avatar
wdenk committed
2154
		is 1 / (I2C_DELAY * 4). Often defined to be something
2155
2156
		like:

wdenk's avatar
wdenk committed
2157
		#define I2C_DELAY  udelay(2)
wdenk's avatar
wdenk committed
2158

2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
		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.

2169
		CONFIG_SYS_I2C_INIT_BOARD
2170

wdenk's avatar
wdenk committed
2171
2172
2173
2174
2175
2176
2177
2178
		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.
2179

2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
		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).

wdenk's avatar
wdenk committed
2191
2192
2193
2194
2195
2196
		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)

2197
2198
2199
		CONFIG_I2C_MULTI_BUS

		This option allows the use of multiple I2C buses, each of which
Wolfgang Denk's avatar
Wolfgang Denk committed
2200
2201
		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.
2202
2203
		Note that bus numbering is zero-based.

2204
		CONFIG_SYS_I2C_NOPROBES
2205
2206

		This option specifies a list of I2C devices that will be skipped
Wolfgang Denk's avatar
Wolfgang Denk committed
2207
		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
2208
2209
		is set, specify a list of bus-device pairs.  Otherwise, specify
		a 1D array of device addresses
2210
2211
2212

		e.g.
			#undef	CONFIG_I2C_MULTI_BUS
Wolfgang Denk's avatar
Wolfgang Denk committed
2213
			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2214
2215
2216

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

Wolfgang Denk's avatar
Wolfgang Denk committed
2217
			#define CONFIG_I2C_MULTI_BUS
2218
			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2219
2220
2221

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

2222
		CONFIG_SYS_SPD_BUS_NUM
2223
2224
2225
2226

		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.

2227
		CONFIG_SYS_RTC_BUS_NUM
2228
2229
2230
2231

		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.

2232
		CONFIG_SYS_DTT_BUS_NUM
2233
2234
2235
2236

		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.

2237
		CONFIG_SYS_I2C_DTT_ADDR:
2238
2239
2240
2241
2242

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

2243
2244
2245
2246
2247
2248
2249
2250
2251
		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.
2252

wdenk's avatar
wdenk committed
2253
2254
2255
2256
2257
2258
- 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)

2259
2260
2261
2262
2263
		CONFIG_SH_SPI

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

wdenk's avatar
wdenk committed
2264
2265
2266
2267
2268
2269
2270
		CONFIG_SPI_X

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

		CONFIG_SOFT_SPI

2271
2272
2273
2274
2275
2276
2277
		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.
wdenk's avatar
wdenk committed
2278

2279
2280
2281
2282
2283
		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.
Wolfgang Denk's avatar
Wolfgang Denk committed
2284
		Currently supported on some MPC8xxx processors.	 For an
2285
2286
		example, see include/configs/mpc8349emds.h.

Guennadi Liakhovetski's avatar
Guennadi Liakhovetski committed
2287
2288
2289
		CONFIG_MXC_SPI

		Enables the driver for the SPI controllers on i.MX and MXC
2290
		SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski's avatar
Guennadi Liakhovetski committed
2291

2292
- FPGA Support: CONFIG_FPGA
wdenk's avatar
wdenk committed
2293

2294
2295
2296
2297
2298
2299
		Enables FPGA subsystem.

		CONFIG_FPGA_<vendor>

		Enables support for specific chip vendors.
		(ALTERA, XILINX)
wdenk's avatar
wdenk committed
2300

2301
		CONFIG_FPGA_<family>
wdenk's avatar
wdenk committed
2302

2303
2304
2305
2306
2307
2308
		Enables support for FPGA family.
		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)

		CONFIG_FPGA_COUNT

		Specify the number of FPGA devices to support.
wdenk's avatar
wdenk committed
2309

2310
		CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenk's avatar
wdenk committed
2311

wdenk's avatar
wdenk committed
2312
		Enable printing of hash marks during FPGA configuration.
wdenk's avatar
wdenk committed
2313

2314
		CONFIG_SYS_FPGA_CHECK_BUSY
wdenk's avatar
wdenk committed
2315

2316
2317
2318
2319
		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.
wdenk's avatar
wdenk committed
2320
2321
2322
2323
2324
2325

		CONFIG_FPGA_DELAY

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

2326
		CONFIG_SYS_FPGA_CHECK_CTRLC
wdenk's avatar
wdenk committed
2327
2328
		Allow Control-C to interrupt FPGA configuration

2329
		CONFIG_SYS_FPGA_CHECK_ERROR
wdenk's avatar
wdenk committed
2330

2331
2332
2333
2334
		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).
wdenk's avatar
wdenk committed
2335

2336
		CONFIG_SYS_FPGA_WAIT_INIT
wdenk's avatar
wdenk committed
2337

2338
2339
2340
		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
2341
		ms.
wdenk's avatar
wdenk committed
2342

2343
		CONFIG_SYS_FPGA_WAIT_BUSY
wdenk's avatar
wdenk committed
2344

2345
		Maximum time to wait for BUSY to deassert during
2346
		Virtex II FPGA configuration. The default is 5 ms.
wdenk's avatar
wdenk committed
2347

2348
		CONFIG_SYS_FPGA_WAIT_CONFIG
wdenk's avatar
wdenk committed
2349

2350
		Time to wait after FPGA configuration. The default is
2351
		200 ms.
wdenk's avatar
wdenk committed
2352
2353
2354
2355

- Configuration Management:
		CONFIG_IDENT_STRING

2356
2357
		If defined, this string will be added to the U-Boot
		version information (U_BOOT_VERSION)
wdenk's avatar
wdenk committed
2358
2359
2360

- Vendor Parameter Protection:

2361
2362
		U-Boot considers the values of the environment
		variables "serial#" (Board Serial Number) and
wdenk's avatar
wdenk committed
2363
		"ethaddr" (Ethernet Address) to be parameters that
2364
2365
2366
2367
		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
2368
		change this behaviour:
wdenk's avatar
wdenk committed
2369
2370
2371

		If CONFIG_ENV_OVERWRITE is #defined in your config
		file, the write protection for vendor parameters is
2372
		completely disabled. Anybody can change or delete
wdenk's avatar
wdenk committed
2373
2374
2375
2376
		these parameters.

		Alternatively, if you #define _both_ CONFIG_ETHADDR
		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
2377
		Ethernet address is installed in the environment,
wdenk's avatar
wdenk committed
2378
2379
2380
2381
		which can be changed exactly ONCE by the user. [The
		serial# is unaffected by this, i. e. it remains
		read-only.]

2382
2383
2384
2385
2386
		The same can be accomplished in a more flexible way
		for any variable by configuring the type of access
		to allow for those variables in the ".flags" variable
		or define CONFIG_ENV_FLAGS_LIST_STATIC.

wdenk's avatar
wdenk committed
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
- 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:

2403
			setenv bootargs ... mem=\${mem}
wdenk's avatar
wdenk committed
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
			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":

2416
2417
			IVMS8, IVML24, SPD8xx, TQM8xxL,
			HERMES, IP860, RPXlite, LWMON,
2418
			FLAGADM, TQM8260
wdenk's avatar
wdenk committed
2419

2420
2421
2422
2423
2424
2425
2426
2427
- Access to physical memory region (> 4GB)
		Some basic support is provided for operations on memory not
		normally accessible to U-Boot - e.g. some architectures
		support access to more than 4GB of memory on 32-bit
		machines using physical address extension or similar.
		Define CONFIG_PHYSMEM to access this basic support, which
		currently only supports clearing the memory.

wdenk's avatar
wdenk committed
2428
2429
2430
2431
2432
2433
- 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
2434
		system where you want the system to reboot
wdenk's avatar
wdenk committed
2435
2436
2437
2438
2439
2440
		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

2441
2442
2443
2444
		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.
wdenk's avatar
wdenk committed
2445

2446
2447
2448
2449
		CONFIG_ARP_TIMEOUT

		Timeout waiting for an ARP reply in milliseconds.

2450
2451
2452
2453
2454
2455
2456
		CONFIG_NFS_TIMEOUT

		Timeout in milliseconds used in NFS protocol.
		If you encounter "ERROR: Cannot umount" in nfs command,
		try longer timeout such as
		#define CONFIG_NFS_TIMEOUT 10000UL

wdenk's avatar
wdenk committed
2457
- Command Interpreter:
2458
		CONFIG_AUTO_COMPLETE
2459
2460
2461

		Enable auto completion of commands using TAB.

2462
2463
		Note that this feature has NOT been implemented yet
		for the "hush" shell.
2464
2465


2466
		CONFIG_SYS_HUSH_PARSER
wdenk's avatar
wdenk committed
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477

		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.


2478
		CONFIG_SYS_PROMPT_HUSH_PS2
wdenk's avatar
wdenk committed
2479
2480
2481
2482
2483
2484
2485

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

	Note:

wdenk's avatar
wdenk committed
2486
2487
2488
2489
2490
2491
2492
		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.
wdenk's avatar
wdenk committed
2493

2494
2495
2496
2497
		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.
wdenk's avatar
wdenk committed
2498
2499
2500
2501
2502
2503
2504

		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.

2505
2506
2507
- Commandline Editing and History:
		CONFIG_CMDLINE_EDITING

2508
		Enable editing and History functions for interactive
Wolfgang Denk's avatar
Wolfgang Denk committed
2509
		commandline input operations
2510

wdenk's avatar
wdenk committed
2511
- Default Environment:
wdenk's avatar
wdenk committed
2512
2513
		CONFIG_EXTRA_ENV_SETTINGS

2514
2515
		Define this to contain any number of null terminated
		strings (variable = value pairs) that will be part of
wdenk's avatar
wdenk committed
2516
		the default environment compiled into the boot image.
2517

2518
2519
		For example, place something like this in your
		board's config file:
wdenk's avatar
wdenk committed
2520
2521
2522
2523
2524

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

2525
2526
2527
2528
		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
wdenk's avatar
wdenk committed
2529
		will change soon, there is no guarantee either.
wdenk's avatar
wdenk committed
2530
2531
		You better know what you are doing here.

2532
2533
		Note: overly (ab)use of the default environment is
		discouraged. Make sure to check other ways to preset
2534
		the environment like the "source" command or the
2535
		boot command first.
wdenk's avatar
wdenk committed
2536

2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
		CONFIG_ENV_VARS_UBOOT_CONFIG

		Define this in order to add variables describing the
		U-Boot build configuration to the default environment.
		These will be named arch, cpu, board, vendor, and soc.

		Enabling this option will cause the following to be defined:

		- CONFIG_SYS_ARCH
		- CONFIG_SYS_CPU
		- CONFIG_SYS_BOARD
		- CONFIG_SYS_VENDOR
		- CONFIG_SYS_SOC

2551
2552
2553
2554
2555
2556
		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG

		Define this in order to add variables describing certain
		run-time determined information about the hardware to the
		environment.  These will be named board_name, board_rev.

2557
2558
2559
2560
2561
2562
2563
2564
2565
		CONFIG_DELAY_ENVIRONMENT

		Normally the environment is loaded when the board is
		intialised so that it is available to U-Boot. This inhibits
		that so that the environment is not available until
		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
		this is instead controlled by the value of
		/config/load-environment.

wdenk's avatar
wdenk committed
2566
- DataFlash Support:
2567
2568
		CONFIG_HAS_DATAFLASH

wdenk's avatar
wdenk committed
2569
2570
2571
		Defining this option enables DataFlash features and
		allows to read/write in Dataflash via the standard
		commands cp, md...
2572

2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
- Serial Flash support
		CONFIG_CMD_SF

		Defining this option enables SPI flash commands
		'sf probe/read/write/erase/update'.

		Usage requires an initial 'probe' to define the serial
		flash parameters, followed by read/write/erase/update
		commands.

		The following defaults may be provided by the platform
		to handle the common case when only a single serial
		flash is present on the system.

		CONFIG_SF_DEFAULT_BUS		Bus identifier
		CONFIG_SF_DEFAULT_CS		Chip-select
		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
		CONFIG_SF_DEFAULT_SPEED		in Hz

Simon Glass's avatar
Simon Glass committed
2592
2593
2594
2595
2596
		CONFIG_CMD_SF_TEST

		Define this option to include a destructive SPI flash
		test ('sf test').

2597
2598
2599
2600
2601
		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg

		Define this option to use the Bank addr/Extended addr
		support on SPI flashes which has size > 16Mbytes.

wdenk's avatar
wdenk committed
2602
2603
2604
2605
2606
- SystemACE Support:
		CONFIG_SYSTEMACE

		Adding this option adds support for Xilinx SystemACE
		chips attached via some sort of local bus. The address
2607
		of the chip must also be defined in the
2608
		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk's avatar
wdenk committed
2609
2610

		#define CONFIG_SYSTEMACE
2611
		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk's avatar
wdenk committed
2612
2613
2614
2615

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

2616
2617
2618
- TFTP Fixed UDP Port:
		CONFIG_TFTP_PORT

2619
		If this is defined, the environment variable tftpsrcp
2620
		is used to supply the TFTP UDP source port value.
2621
		If tftpsrcp isn't defined, the normal pseudo-random port
2622
2623
		number generator is used.

2624
2625
2626
2627
2628
		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
2629
2630
2631
2632
2633
2634
2635
		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.

2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
- Hashing support:
		CONFIG_CMD_HASH

		This enables a generic 'hash' command which can produce
		hashes / digests from a few algorithms (e.g. SHA1, SHA256).

		CONFIG_HASH_VERIFY

		Enable the hash verify command (hash -v). This adds to code
		size a little.

		CONFIG_SHA1 - support SHA1 hashing
		CONFIG_SHA256 - support SHA256 hashing

		Note: There is also a sha1sum command, which should perhaps
		be deprecated in favour of 'hash sha1'.

2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
- Freescale i.MX specific commands:
		CONFIG_CMD_HDMIDETECT
		This enables 'hdmidet' command which returns true if an
		HDMI monitor is detected.  This command is i.MX 6 specific.

		CONFIG_CMD_BMODE
		This enables the 'bmode' (bootmode) command for forcing
		a boot from specific media.

		This is useful for forcing the ROM's usb downloader to
		activate upon a watchdog reset which is nice when iterating
		on U-Boot.  Using the reset button or running bmode normal
		will set it back to normal.  This command currently
		supports i.MX53 and i.MX6.

2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
- Signing support:
		CONFIG_RSA

		This enables the RSA algorithm used for FIT image verification
		in U-Boot. See doc/uImage/signature for more information.

		The signing part is build into mkimage regardless of this
		option.


wdenk's avatar
wdenk committed
2678
- Show boot progress:
wdenk's avatar
wdenk committed
2679
2680
		CONFIG_SHOW_BOOT_PROGRESS

2681
2682
2683
2684
2685
2686
		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:
wdenk's avatar
wdenk committed
2687

2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
- Detailed boot stage timing
		CONFIG_BOOTSTAGE
		Define this option to get detailed timing of each stage
		of the boot process.

		CONFIG_BOOTSTAGE_USER_COUNT
		This is the number of available user bootstage records.
		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
		a new ID will be allocated from this stash. If you exceed
		the limit, recording will stop.

		CONFIG_BOOTSTAGE_REPORT
		Define this to print a report before boot, similar to this:

		Timer summary in microseconds:
		       Mark    Elapsed  Stage
			  0          0  reset
		  3,575,678  3,575,678  board_init_f start
		  3,575,695         17  arch_cpu_init A9
		  3,575,777         82  arch_cpu_init done
		  3,659,598     83,821  board_init_r start
		  3,910,375    250,777  main_loop
		 29,916,167 26,005,792  bootm_start
		 30,361,327    445,160  start_kernel

Simon Glass's avatar
Simon Glass committed
2713
2714
2715
2716
		CONFIG_CMD_BOOTSTAGE
		Add a 'bootstage' command which supports printing a report
		and un/stashing of bootstage data.

2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
		CONFIG_BOOTSTAGE_FDT
		Stash the bootstage information in the FDT. A root 'bootstage'
		node is created with each bootstage id as a child. Each child
		has a 'name' property and either 'mark' containing the
		mark time in microsecond, or 'accum' containing the
		accumulated time for that bootstage id in microseconds.
		For example:

		bootstage {
			154 {
				name = "board_init_f";
				mark = <3575678>;
			};
			170 {
				name = "lcd";
				accum = <33482>;
			};
		};

		Code in the Linux kernel can find this in /proc/devicetree.

2738
2739
Legacy uImage format:

wdenk's avatar
wdenk committed
2740
2741
  Arg	Where			When
    1	common/cmd_bootm.c	before attempting to boot an image
wdenk's avatar
wdenk committed
2742
   -1	common/cmd_bootm.c	Image header has bad	 magic number
wdenk's avatar
wdenk committed
2743
    2	common/cmd_bootm.c	Image header has correct magic number
wdenk's avatar
wdenk committed
2744
   -2	common/cmd_bootm.c	Image header has bad	 checksum
wdenk's avatar
wdenk committed
2745
    3	common/cmd_bootm.c	Image header has correct checksum
wdenk's avatar
wdenk committed
2746
   -3	common/cmd_bootm.c	Image data   has bad	 checksum
wdenk's avatar
wdenk committed
2747
2748
2749
    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
2750
   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
wdenk's avatar
wdenk committed
2751
2752
2753
2754
    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
2755
    8	common/cmd_bootm.c	No uncompress/copy overwrite error
wdenk's avatar
wdenk committed
2756
   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
2757
2758
2759
2760
2761
2762
2763
2764

    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
2765
  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
2766
2767
2768
   13	common/image.c		Start multifile image verification
   14	common/image.c		No initial ramdisk, no multifile, continue.

Wolfgang Denk's avatar
Wolfgang Denk committed
2769
   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenk's avatar
wdenk committed
2770

Stefan Roese's avatar
Stefan Roese committed
2771
  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
wdenk's avatar
wdenk committed
2772
2773
  -31	post/post.c		POST test failed, detected by post_output_backlog()
  -32	post/post.c		POST test failed, detected by post_run_single()
2774

2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
   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

2825
   64	net/eth.c		starting with Ethernet configuration.
2826
2827
2828
2829
2830
  -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()
2831
  -81	common/cmd_net.c	some error in NetLoop() occurred
2832
2833
2834
   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
2835
2836
   83	common/cmd_net.c	running "source" command
  -83	common/cmd_net.c	some error in automatic boot or "source" command
2837
   84	common/cmd_net.c	end without errors
wdenk's avatar
wdenk committed
2838

2839
2840
2841
2842
2843
2844
2845
2846
2847
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
2848
  103	common/cmd_bootm.c	Found configuration node
2849
2850
2851
2852
2853
  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
2854
2855
 -106	common/cmd_bootm.c	Kernel subimage has wrong type
  107	common/cmd_bootm.c	Kernel subimage type OK
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 -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
2868
  122	common/image.c		No ramdisk subimage unit name, using configuration
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
 -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

2882
 -130	common/cmd_doc.c	Incorrect FIT image format
2883
2884
  131	common/cmd_doc.c	FIT image format OK

2885
 -140	common/cmd_ide.c	Incorrect FIT image format
2886
2887
  141	common/cmd_ide.c	FIT image format OK

2888
 -150	common/cmd_nand.c	Incorrect FIT image format
2889
2890
  151	common/cmd_nand.c	FIT image format OK

2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
- FIT image support:
		CONFIG_FIT
		Enable support for the FIT uImage format.

		CONFIG_FIT_BEST_MATCH
		When no configuration is explicitly selected, default to the
		one whose fdt's compatibility field best matches that of
		U-Boot itself. A match is considered "best" if it matches the
		most specific compatibility entry of U-Boot's fdt's root node.
		The order of entries in the configuration's fdt is ignored.

2902
2903
2904
2905
2906
		CONFIG_FIT_SIGNATURE
		This option enables signature verification of FIT uImages,
		using a hash signed and verified using RSA. See
		doc/uImage.FIT/signature.txt for more details.

2907
2908
2909
- Standalone program support:
		CONFIG_STANDALONE_LOAD_ADDR

Wolfgang Denk's avatar
Wolfgang Denk committed
2910
2911
2912
		This option defines a board specific value for the
		address where standalone program gets loaded, thus
		overwriting the architecture dependent default
2913
2914
2915
2916
2917
2918
		settings.

- Frame Buffer Address:
		CONFIG_FB_ADDR

		Define CONFIG_FB_ADDR if you want to use specific
2919
2920
2921
2922
2923
2924
2925
		address for frame buffer.  This is typically the case
		when using a graphics controller has separate video
		memory.  U-Boot will then place the frame buffer at
		the given address instead of dynamically reserving it
		in system RAM by calling lcd_setmem(), which grabs
		the memory for the frame buffer depending on the
		configured panel size.
2926
2927
2928

		Please see board_init_f function.

2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
- 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.

2948
2949
2950
2951
2952
2953
2954
2955
- UBI support
		CONFIG_CMD_UBI

		Adds commands for interacting with MTD partitions formatted
		with the UBI flash translation layer

		Requires also defining CONFIG_RBTREE

2956
2957
2958
2959
2960
		CONFIG_UBI_SILENCE_MSG

		Make the verbose messages from UBI stop printing.  This leaves
		warnings and errors enabled.

2961
2962
2963
2964
2965
2966
2967
2968
- UBIFS support
		CONFIG_CMD_UBIFS

		Adds commands for interacting with UBI volumes formatted as
		UBIFS.  UBIFS is read-only in u-boot.

		Requires UBI support as well as CONFIG_LZO

2969
2970
2971
2972
2973
		CONFIG_UBIFS_SILENCE_MSG

		Make the verbose messages from UBIFS stop printing.  This leaves
		warnings and errors enabled.

2974
- SPL framework
Wolfgang Denk's avatar
Wolfgang Denk committed
2975
2976
		CONFIG_SPL
		Enable building of SPL globally.
2977

2978
2979
2980
		CONFIG_SPL_LDSCRIPT
		LDSCRIPT for linking the SPL binary.

2981
2982
2983
2984
		CONFIG_SPL_MAX_FOOTPRINT
		Maximum size in memory allocated to the SPL, BSS included.
		When defined, the linker checks that the actual memory
		used by SPL from _start to __bss_end does not exceed it.
2985
		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2986
2987
		must not be both defined at the same time.

2988
		CONFIG_SPL_MAX_SIZE
2989
2990
2991
2992
		Maximum size of the SPL image (text, data, rodata, and
		linker lists sections), BSS excluded.
		When defined, the linker checks that the actual size does
		not exceed it.
2993

Wolfgang Denk's avatar
Wolfgang Denk committed
2994
2995
		CONFIG_SPL_TEXT_BASE
		TEXT_BASE for linking the SPL binary.
2996

2997
2998
2999
3000
		CONFIG_SPL_RELOC_TEXT_BASE
		Address to relocate to.  If unspecified, this is equal to
		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).

3001
3002
3003
3004
		CONFIG_SPL_BSS_START_ADDR
		Link address for the BSS within the SPL binary.

		CONFIG_SPL_BSS_MAX_SIZE
3005
3006
3007
		Maximum size in memory allocated to the SPL BSS.
		When defined, the linker checks that the actual memory used
		by SPL from __bss_start to __bss_end does not exceed it.
3008
		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3009
		must not be both defined at the same time.
3010
3011
3012
3013

		CONFIG_SPL_STACK
		Adress of the start of the stack SPL will use

3014
3015
3016
3017
3018
		CONFIG_SPL_RELOC_STACK
		Adress of the start of the stack SPL will use after
		relocation.  If unspecified, this is equal to
		CONFIG_SPL_STACK.

3019
3020
3021
3022
3023
		CONFIG_SYS_SPL_MALLOC_START
		Starting address of the malloc pool used in SPL.

		CONFIG_SYS_SPL_MALLOC_SIZE
		The size of the malloc pool used in SPL.
3024

3025
3026
3027
3028
3029
		CONFIG_SPL_FRAMEWORK
		Enable the SPL framework under common/.  This framework
		supports MMC, NAND and YMODEM loading of U-Boot and NAND
		NAND loading of the Linux Kernel.

3030
3031
3032
3033
		CONFIG_SPL_DISPLAY_PRINT
		For ARM, enable an optional function to print more information
		about the running system.

3034
3035
3036
		CONFIG_SPL_INIT_MINIMAL
		Arch init code should be built for a very small image

Wolfgang Denk's avatar
Wolfgang Denk committed
3037
3038
		CONFIG_SPL_LIBCOMMON_SUPPORT
		Support for common/libcommon.o in SPL binary
3039

Wolfgang Denk's avatar
Wolfgang Denk committed
3040
3041
		CONFIG_SPL_LIBDISK_SUPPORT
		Support for disk/libdisk.o in SPL binary
3042

Wolfgang Denk's avatar
Wolfgang Denk committed
3043
3044
		CONFIG_SPL_I2C_SUPPORT
		Support for drivers/i2c/libi2c.o in SPL binary
3045

Wolfgang Denk's avatar
Wolfgang Denk committed
3046
3047
		CONFIG_SPL_GPIO_SUPPORT
		Support for drivers/gpio/libgpio.o in SPL binary
3048

Wolfgang Denk's avatar
Wolfgang Denk committed
3049
3050
		CONFIG_SPL_MMC_SUPPORT
		Support for drivers/mmc/libmmc.o in SPL binary
3051

3052
3053
3054
3055
3056
3057
		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
		Address, size and partition on the MMC to load U-Boot from
		when the MMC is being used in raw mode.

3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
		Sector to load kernel uImage from when MMC is being
		used in raw mode (for Falcon mode)

		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
		Sector and number of sectors to load kernel argument
		parameters from when MMC is being used in raw mode
		(for falcon mode)

3068
3069
3070
3071
3072
3073
		CONFIG_SPL_FAT_SUPPORT
		Support for fs/fat/libfat.o in SPL binary

		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
		Filename to read to load U-Boot when reading from FAT

3074
3075
3076
3077
3078
3079
3080
3081
		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
		Filename to read to load kernel uImage when reading
		from FAT (for Falcon mode)

		CONFIG_SPL_FAT_LOAD_ARGS_NAME
		Filename to read to load kernel argument parameters
		when reading from FAT (for Falcon mode)

3082
3083
3084
3085
3086
3087
		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
		Set this for NAND SPL on PPC mpc83xx targets, so that
		start.S waits for the rest of the SPL to load before
		continuing (the hardware starts execution after just
		loading the first page rather than the full 4K).

3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
		CONFIG_SPL_NAND_BASE
		Include nand_base.c in the SPL.  Requires
		CONFIG_SPL_NAND_DRIVERS.

		CONFIG_SPL_NAND_DRIVERS
		SPL uses normal NAND drivers, not minimal drivers.

		CONFIG_SPL_NAND_ECC
		Include standard software ECC in the SPL

3098
		CONFIG_SPL_NAND_SIMPLE
3099
3100
		Support for NAND boot using simple NAND drivers that
		expose the cmd_ctrl() interface.
3101

3102
3103
3104
3105
		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
		Set for the SPL on PPC mpc8xxx targets, support for
		arch/powerpc/cpu/mpc8xxx/ddr/libddr.o in SPL binary.

3106
3107
3108
3109
		CONFIG_SPL_COMMON_INIT_DDR
		Set for common ddr init with serial presence detect in
		SPL binary.

3110
3111
3112
3113
3114
3115
		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
		CONFIG_SYS_NAND_ECCBYTES
		Defines the size and behavior of the NAND that SPL uses
3116
		to read U-Boot
3117
3118

		CONFIG_SYS_NAND_U_BOOT_OFFS
3119
3120
3121
3122
3123
3124
3125
		Location in NAND to read U-Boot from

		CONFIG_SYS_NAND_U_BOOT_DST
		Location in memory to load U-Boot to

		CONFIG_SYS_NAND_U_BOOT_SIZE
		Size of image to load
3126
3127

		CONFIG_SYS_NAND_U_BOOT_START
3128
		Entry point in loaded image to jump to
3129
3130
3131
3132
3133
3134
3135
3136
3137

		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
		Define this if you need to first read the OOB and then the
		data. This is used for example on davinci plattforms.

		CONFIG_SPL_OMAP3_ID_NAND
		Support for an OMAP3-specific set of functions to return the
		ID and MFR of the first attached NAND chip, if present.

Wolfgang Denk's avatar
Wolfgang Denk committed
3138
3139
		CONFIG_SPL_SERIAL_SUPPORT
		Support for drivers/serial/libserial.o in SPL binary
3140

Wolfgang Denk's avatar
Wolfgang Denk committed
3141
3142
		CONFIG_SPL_SPI_FLASH_SUPPORT
		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
3143

Wolfgang Denk's avatar
Wolfgang Denk committed
3144
3145
		CONFIG_SPL_SPI_SUPPORT
		Support for drivers/spi/libspi.o in SPL binary
3146
3147
3148

		CONFIG_SPL_RAM_DEVICE
		Support for running image already present in ram, in SPL binary
3149

Wolfgang Denk's avatar
Wolfgang Denk committed
3150
3151
		CONFIG_SPL_LIBGENERIC_SUPPORT
		Support for lib/libgeneric.o in SPL binary
3152

3153
3154
3155
3156
3157
3158
3159
3160
		CONFIG_SPL_ENV_SUPPORT
		Support for the environment operating in SPL binary

		CONFIG_SPL_NET_SUPPORT
		Support for the net/libnet.o in SPL binary.
		It conflicts with SPL env from storage medium specified by
		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE

3161
		CONFIG_SPL_PAD_TO
3162
3163
3164
3165
3166
		Image offset to which the SPL should be padded before appending
		the SPL payload. By default, this is defined as
		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3167

Scott Wood's avatar
Scott Wood committed
3168
3169
3170
3171
3172
		CONFIG_SPL_TARGET
		Final target image containing SPL and payload.  Some SPLs
		use an arch-specific makefile fragment instead, for
		example if more than one image needs to be produced.

3173
3174
3175
3176
3177
3178
		CONFIG_FIT_SPL_PRINT
		Printing information about a FIT image adds quite a bit of
		code to SPL. So this is normally disabled in SPL. Use this
		option to re-enable it. This will affect the output of the
		bootm command when booting a FIT image.

3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
- TPL framework
		CONFIG_TPL
		Enable building of TPL globally.

		CONFIG_TPL_PAD_TO
		Image offset to which the TPL should be padded before appending
		the TPL payload. By default, this is defined as
                CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
                CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
                payload without any padding, or >= CONFIG_SPL_MAX_SIZE.

wdenk's avatar
wdenk committed
3190
3191
3192
Modem Support:
--------------

3193
[so far only for SMDK2400 boards]
wdenk's avatar
wdenk committed
3194

3195
- Modem support enable:
wdenk's avatar
wdenk committed
3196
3197
3198
3199
3200
3201
3202
3203
		CONFIG_MODEM_SUPPORT

- RTS/CTS Flow control enable:
		CONFIG_HWFLOW

- Modem debug support:
		CONFIG_MODEM_SUPPORT_DEBUG

3204
3205
		Enables debugging stuff (char screen[1024], dbg())
		for modem support. Useful only with BDI2000.
wdenk's avatar
wdenk committed
3206

wdenk's avatar
wdenk committed
3207
3208
- Interrupt support (PPC):

wdenk's avatar
wdenk committed
3209
3210
		There are common interrupt_init() and timer_interrupt()
		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
3211
		for CPU specific initialization. interrupt_init_cpu()
wdenk's avatar
wdenk committed
3212
		should set decrementer_count to appropriate value. If
3213
		CPU resets decrementer automatically after interrupt
wdenk's avatar
wdenk committed
3214
		(ppc4xx) it should set decrementer_count to zero.
3215
		timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk's avatar
wdenk committed
3216
3217
3218
		specific handling. If board has watchdog / status_led
		/ other_activity_monitor it works automatically from
		general timer_interrupt().
wdenk's avatar
wdenk committed
3219

wdenk's avatar
wdenk committed
3220
3221
- General:

3222
3223
3224
		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
3225
		(autoboot). The key_pressed() function is called from
3226
3227
3228
		board_init(). Currently key_pressed() is a dummy
		function, returning 1 and thus enabling modem
		initialization.
wdenk's avatar
wdenk committed
3229

3230
3231
3232
		If there are no modem init strings in the
		environment, U-Boot proceed to autoboot; the
		previous output (banner, info printfs) will be
3233
		suppressed, though.
wdenk's avatar
wdenk committed
3234
3235
3236

		See also: doc/README.Modem

3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
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()
wdenk's avatar
wdenk committed
3251
3252
3253
3254

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

3255
- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenk's avatar
wdenk committed
3256
3257
		undefine this when you're short of memory.

Peter Tyser's avatar
Peter Tyser committed
3258
3259
3260
- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
		width of the commands listed in the 'help' command output.

3261
- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
wdenk's avatar
wdenk committed
3262
3263
		prompt for user input.

3264
- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
wdenk's avatar
wdenk committed
3265

3266
- CONFIG_SYS_PBSIZE:	Buffer size for Console output
wdenk's avatar
wdenk committed
3267

3268
- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
wdenk's avatar
wdenk committed
3269

3270
- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenk's avatar
wdenk committed
3271
3272
3273
		the application (usually a Linux kernel) when it is
		booted

3274
- CONFIG_SYS_BAUDRATE_TABLE:
wdenk's avatar
wdenk committed
3275
3276
		List of legal baudrate settings for this board.

3277
- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk's avatar
wdenk committed
3278
		Suppress display of console information at boot.
wdenk's avatar
wdenk committed
3279

3280
- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk's avatar
wdenk committed
3281
3282
3283
		If the board specific function
			extern int overwrite_console (void);
		returns 1, the stdin, stderr and stdout are switched to the
wdenk's avatar
wdenk committed
3284
3285
		serial port, else the settings in the environment are used.

3286
- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk's avatar
wdenk committed
3287
		Enable the call to overwrite_console().
wdenk's avatar
wdenk committed
3288

3289
- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenk's avatar
wdenk committed
3290
3291
		Enable overwrite of previous console environment settings.

3292
- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenk's avatar
wdenk committed
3293
3294
3295
		Begin and End addresses of the area used by the
		simple memory test.

3296
- CONFIG_SYS_ALT_MEMTEST:
wdenk's avatar
wdenk committed
3297
		Enable an alternate, more extensive memory test.
wdenk's avatar
wdenk committed
3298

3299
- CONFIG_SYS_MEMTEST_SCRATCH:
3300
3301
3302
		Scratch address used by the alternate memory test
		You only need to set this if address zero isn't writeable

3303
3304
- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
3305
		this specified memory area will get subtracted from the top
3306
		(end) of RAM and won't get "touched" at all by U-Boot. By
3307
3308
3309
		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
3310
		board ports in arch/powerpc with bootwrapper support that
3311
		recalculate the memory size from the SDRAM controller setup
3312
		will have to get fixed in Linux additionally.
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323

		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.

3324
- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenk's avatar
wdenk committed
3325
3326
		Enable temporary baudrate change while serial download

3327
- CONFIG_SYS_SDRAM_BASE:
wdenk's avatar
wdenk committed
3328
3329
		Physical start address of SDRAM. _Must_ be 0 here.

3330
- CONFIG_SYS_MBIO_BASE:
wdenk's avatar
wdenk committed
3331
3332
3333
		Physical start address of Motherboard I/O (if using a
		Cogent motherboard)

3334
- CONFIG_SYS_FLASH_BASE:
wdenk's avatar
wdenk committed
3335
3336
		Physical start address of Flash memory.

3337
- CONFIG_SYS_MONITOR_BASE:
wdenk's avatar
wdenk committed
3338
3339
		Physical start address of boot monitor code (set by
		make config files to be same as the text base address
3340
		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
3341
		CONFIG_SYS_FLASH_BASE when booting from flash.
wdenk's avatar
wdenk committed
3342

3343
- CONFIG_SYS_MONITOR_LEN:
wdenk's avatar
wdenk committed
3344
3345
3346
3347
		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.
wdenk's avatar
wdenk committed
3348

3349
- CONFIG_SYS_MALLOC_LEN:
wdenk's avatar
wdenk committed
3350
3351
		Size of DRAM reserved for malloc() use.

3352
- CONFIG_SYS_BOOTM_LEN:
3353
3354
		Normally compressed uImages are limited to an
		uncompressed size of 8 MBytes. If this is not enough,
3355
		you can define CONFIG_SYS_BOOTM_LEN in your board config file
3356
3357
		to adjust this setting to your needs.

3358
- CONFIG_SYS_BOOTMAPSZ:
wdenk's avatar
wdenk committed
3359
3360
		Maximum size of memory mapped by the startup code of
		the Linux kernel; all data that must be processed by
3361
3362
3363
3364
		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"
Wolfgang Denk's avatar
Wolfgang Denk committed
3365
		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3366
3367
3368
		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.
wdenk's avatar
wdenk committed
3369

3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
- 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.

3383
- CONFIG_SYS_MAX_FLASH_BANKS:
wdenk's avatar
wdenk committed
3384
3385
		Max number of Flash memory banks

3386
- CONFIG_SYS_MAX_FLASH_SECT:
wdenk's avatar
wdenk committed
3387
3388
		Max number of sectors on a Flash chip

3389
- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenk's avatar
wdenk committed
3390
3391
		Timeout for Flash erase operations (in ms)

3392
- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenk's avatar
wdenk committed
3393
3394
		Timeout for Flash write operations (in ms)

3395
- CONFIG_SYS_FLASH_LOCK_TOUT
3396
3397
		Timeout for Flash set sector lock bit operation (in ms)

3398
- CONFIG_SYS_FLASH_UNLOCK_TOUT
3399
3400
		Timeout for Flash clear lock bits operation (in ms)

3401
- CONFIG_SYS_FLASH_PROTECTION
3402
3403
3404
		If defined, hardware flash sectors protection is used
		instead of U-Boot software protection.

3405
- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenk's avatar
wdenk committed
3406
3407
3408
3409
3410
3411
3412
3413

		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
3414
3415
		the flash, but in some situations (when system RAM is
		too limited to allow for a temporary copy of the
wdenk's avatar
wdenk committed
3416
3417
		downloaded image) this option may be very useful.

3418
- CONFIG_SYS_FLASH_CFI:
3419
		Define if the flash driver uses extra elements in the
wdenk's avatar
wdenk committed
3420
3421
		common flash structure for storing flash geometry.

3422
- CONFIG_FLASH_CFI_DRIVER
wdenk's avatar
wdenk committed
3423
3424
		This option also enables the building of the cfi_flash driver
		in the drivers directory
wdenk's avatar
wdenk committed
3425

Piotr Ziecik's avatar
Piotr Ziecik committed
3426
3427
3428
3429
3430
- 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.

3431
- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3432
3433
3434
3435
3436
3437
		Use buffered writes to flash.

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

3438
- CONFIG_SYS_FLASH_QUIET_TEST
3439
3440
3441
3442
3443
		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.

3444
3445
3446
3447
3448
- 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.

3449
3450
3451
3452
3453
3454
3455
3456
3457
- CONFIG_FLASH_VERIFY
		If defined, the content of the flash (destination) is compared
		against the source after the write operation. An error message
		will be printed when the contents are not identical.
		Please note that this option is useless in nearly all cases,
		since such flash programming errors usually are detected earlier
		while unprotecting/erasing/programming. Please only enable
		this option if you really know what you are doing.

3458
- CONFIG_SYS_RX_ETH_BUFFER:
3459
3460
		Defines the number of Ethernet receive buffers. On some
		Ethernet controllers it is recommended to set this value
stroese's avatar
stroese committed
3461
3462
		to 8 or even higher (EEPRO100 or 405 EMAC), since all
		buffers can be full shortly after enabling the interface
3463
		on high Ethernet traffic.
stroese's avatar
stroese committed
3464
3465
		Defaults to 4 if not defined.

3466
3467
- CONFIG_ENV_MAX_ENTRIES

Wolfgang Denk's avatar
Wolfgang Denk committed
3468
3469
3470
3471
3472
	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.
3473

3474
3475
3476
3477
3478
3479
3480
3481
3482
- CONFIG_ENV_FLAGS_LIST_DEFAULT
- CONFIG_ENV_FLAGS_LIST_STATIC
	Enable validation of the values given to enviroment variables when
	calling env set.  Variables can be restricted to only decimal,
	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
	the variables can also be restricted to IP address or MAC address.

	The format of the list is:
		type_attribute = [s|d|x|b|i|m]
3483
3484
		access_atribute = [a|r|o|c]
		attributes = type_attribute[access_atribute]
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
		entry = variable_name[:attributes]
		list = entry[,list]

	The type attributes are:
		s - String (default)
		d - Decimal
		x - Hexadecimal
		b - Boolean ([1yYtT|0nNfF])
		i - IP address
		m - MAC address

3496
3497
3498
3499
3500
3501
	The access attributes are:
		a - Any (default)
		r - Read-only
		o - Write-once
		c - Change-default

3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
	- CONFIG_ENV_FLAGS_LIST_DEFAULT
		Define this to a list (string) to define the ".flags"
		envirnoment variable in the default or embedded environment.

	- CONFIG_ENV_FLAGS_LIST_STATIC
		Define this to a list (string) to define validation that
		should be done if an entry is not found in the ".flags"
		environment variable.  To override a setting in the static
		list, simply add an entry for the same variable name to the
		".flags" variable.

3513
3514
3515
3516
- CONFIG_ENV_ACCESS_IGNORE_FORCE
	If defined, don't allow the -f switch to env set override variable
	access flags.

3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
- CONFIG_SYS_GENERIC_BOARD
	This selects the architecture-generic board system instead of the
	architecture-specific board files. It is intended to move boards
	to this new framework over time. Defining this will disable the
	arch/foo/lib/board.c file and use common/board_f.c and
	common/board_r.c instead. To use this option your architecture
	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
	its config.mk file). If you find problems enabling this option on
	your board please report the problem and send patches!

3527
3528
3529
3530
3531
3532
- CONFIG_SYS_SYM_OFFSETS
	This is set by architectures that use offsets for link symbols
	instead of absolute values. So bss_start is obtained using an
	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
	directly. You should not need to touch this setting.

3533
3534
3535
3536
- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
	This is set by OMAP boards for the max time that reset should
	be asserted. See doc/README.omap-reset-time for details on how
	the value can be calulated on a given board.
3537

wdenk's avatar
wdenk committed
3538
3539
3540
3541
The following definitions that deal with the placement and management
of environment data (variable area); in general, we support the
following configurations:

3542
3543
3544
3545
3546
- 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.

3547
- CONFIG_ENV_IS_IN_FLASH:
wdenk's avatar
wdenk committed
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562

	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.

3563
	- CONFIG_ENV_OFFSET:
wdenk's avatar
wdenk committed
3564
3565
3566
3567
3568
3569

	   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.

3570
	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenk's avatar
wdenk committed
3571

3572
	- CONFIG_ENV_ADDR:
wdenk's avatar
wdenk committed
3573
3574
3575

	   This is just another way to specify the start address of
	   the flash sector containing the environment (instead of
3576
	   CONFIG_ENV_OFFSET).
wdenk's avatar
wdenk committed
3577

3578
	- CONFIG_ENV_SECT_SIZE:
wdenk's avatar
wdenk committed
3579
3580
3581
3582
3583
3584
3585
3586

	   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.

3587
	- CONFIG_ENV_SIZE:
wdenk's avatar
wdenk committed
3588

3589
	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
3590
	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenk's avatar
wdenk committed
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
	   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.

3604
3605
	- CONFIG_ENV_ADDR_REDUND
	  CONFIG_ENV_SIZE_REDUND
wdenk's avatar
wdenk committed
3606

3607
	   These settings describe a second storage area used to hold
3608
	   a redundant copy of the environment data, so that there is
wdenk's avatar
wdenk committed
3609
	   a valid backup copy in case there is a power failure during
3610
	   a "saveenv" operation.
wdenk's avatar
wdenk committed
3611
3612
3613
3614
3615
3616

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!


3617
- CONFIG_ENV_IS_IN_NVRAM:
wdenk's avatar
wdenk committed
3618
3619
3620
3621
3622

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

3623
3624
	- CONFIG_ENV_ADDR:
	- CONFIG_ENV_SIZE:
wdenk's avatar
wdenk committed
3625

3626
	  These two #defines are used to determine the memory area you
wdenk's avatar
wdenk committed
3627
3628
3629
3630
3631
3632
	  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
3633
console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenk's avatar
wdenk committed
3634
3635
3636
3637
3638
3639
3640
3641
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.


3642
- CONFIG_ENV_IS_IN_EEPROM:
wdenk's avatar
wdenk committed
3643
3644
3645
3646

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

3647
3648
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:
wdenk's avatar
wdenk committed
3649
3650
3651
3652

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

3653
	- CONFIG_SYS_I2C_EEPROM_ADDR:
wdenk's avatar
wdenk committed
3654
3655
3656
	  If defined, specified the chip address of the EEPROM device.
	  The default address is zero.

3657
	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenk's avatar
wdenk committed
3658
3659
3660
3661
	  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.

3662
	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenk's avatar
wdenk committed
3663
	  If defined, the number of milliseconds to delay between
wdenk's avatar
wdenk committed
3664
	  page writes.	The default is zero milliseconds.
wdenk's avatar
wdenk committed
3665

3666
	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenk's avatar
wdenk committed
3667
3668
3669
	  The length in bytes of the EEPROM memory array address.  Note
	  that this is NOT the chip address length!

3670
	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
	  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.

3681
	- CONFIG_SYS_EEPROM_SIZE:
wdenk's avatar
wdenk committed
3682
3683
	  The size in bytes of the EEPROM device.

Heiko Schocher's avatar
Heiko Schocher committed
3684
3685
3686
3687
3688
3689
3690
3691
3692
	- 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:

3693
	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
Heiko Schocher's avatar
Heiko Schocher committed
3694
3695
3696

	  EEPROM which holds the environment, is reached over
	  a pca9547 i2c mux with address 0x70, channel 3.
wdenk's avatar
wdenk committed
3697

3698
- CONFIG_ENV_IS_IN_DATAFLASH:
3699

wdenk's avatar
wdenk committed
3700
	Define this if you have a DataFlash memory device which you
3701
3702
	want to use for the environment.

3703
3704
3705
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_ADDR:
	- CONFIG_ENV_SIZE:
3706
3707
3708
3709
3710

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

3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
- CONFIG_ENV_IS_IN_REMOTE:

	Define this if you have a remote memory space which you
	want to use for the local device's environment.

	- CONFIG_ENV_ADDR:
	- CONFIG_ENV_SIZE:

	  These two #defines specify the address and size of the
	  environment area within the remote memory space. The
	  local device can get the environment from remote memory
3722
	  space by SRIO or PCIE links.
3723
3724
3725

BE CAREFUL! For some special cases, the local device can not use
"saveenv" command. For example, the local device will get the
3726
3727
environment stored in a remote NOR flash by SRIO or PCIE link,
but it can not erase, write this NOR flash by SRIO or PCIE interface.
3728

3729
- CONFIG_ENV_IS_IN_NAND:
wdenk's avatar
wdenk committed
3730
3731
3732
3733

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

3734
3735
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:
wdenk's avatar
wdenk committed
3736
3737

	  These two #defines specify the offset and size of the environment
Scott Wood's avatar
Scott Wood committed
3738
3739
	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
	  aligned to an erase block boundary.
3740

Scott Wood's avatar
Scott Wood committed
3741
	- CONFIG_ENV_OFFSET_REDUND (optional):
3742

3743
	  This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood's avatar
Scott Wood committed
3744
3745
	  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
Wolfgang Denk's avatar
Wolfgang Denk committed
3746
	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood's avatar
Scott Wood committed
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
	  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.
3764

3765
3766
3767
3768
3769
3770
- 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.

3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
- CONFIG_ENV_IS_IN_UBI:

	Define this if you have an UBI volume that you want to use for the
	environment.  This has the benefit of wear-leveling the environment
	accesses, which is important on NAND.

	- CONFIG_ENV_UBI_PART:

	  Define this to a string that is the mtd partition containing the UBI.

	- CONFIG_ENV_UBI_VOLUME:

	  Define this to the name of the volume that you want to store the
	  environment in.

3786
3787
3788
3789
3790
3791
	- CONFIG_ENV_UBI_VOLUME_REDUND:

	  Define this to the name of another volume to store a second copy of
	  the environment in.  This will enable redundant environments in UBI.
	  It is assumed that both volumes are in the same MTD partition.

3792
3793
3794
3795
3796
3797
	- CONFIG_UBI_SILENCE_MSG
	- CONFIG_UBIFS_SILENCE_MSG

	  You will probably want to define these to avoid a really noisy system
	  when storing the env in UBI.

3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
- CONFIG_ENV_IS_IN_MMC:

	Define this if you have an MMC device which you want to use for the
	environment.

	- CONFIG_SYS_MMC_ENV_DEV:

	  Specifies which MMC device the environment is stored in.

	- CONFIG_SYS_MMC_ENV_PART (optional):

	  Specifies which MMC partition the environment is stored in. If not
	  set, defaults to partition 0, the user area. Common values might be
	  1 (first MMC boot partition), 2 (second MMC boot partition).

	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:

	  These two #defines specify the offset and size of the environment
	  area within the specified MMC device.

3819
3820
3821
3822
3823
3824
3825
3826
	  If offset is positive (the usual case), it is treated as relative to
	  the start of the MMC partition. If offset is negative, it is treated
	  as relative to the end of the MMC partition. This can be useful if
	  your board may be fitted with different MMC devices, which have
	  different sizes for the MMC partitions, and you always want the
	  environment placed at the very end of the partition, to leave the
	  maximum possible space before it, to store other data.

3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
	  These two values are in units of bytes, but must be aligned to an
	  MMC sector boundary.

	- CONFIG_ENV_OFFSET_REDUND (optional):

	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
	  hold a redundant copy of the environment data. This provides a
	  valid backup copy in case the other copy is corrupted, e.g. due
	  to a power failure during a "saveenv" operation.

3837
3838
3839
	  This value may also be positive or negative; this is handled in the
	  same way as CONFIG_ENV_OFFSET.

3840
3841
3842
3843
3844
3845
3846
3847
3848
	  This value is also in units of bytes, but must also be aligned to
	  an MMC sector boundary.

	- CONFIG_ENV_SIZE_REDUND (optional):

	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
	  set. If this value is set, it must be set to the same value as
	  CONFIG_ENV_SIZE.

3849
- CONFIG_SYS_SPI_INIT_OFFSET
wdenk's avatar
wdenk committed
3850
3851
3852
3853
3854
3855
3856
3857
3858

	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.

Bruce Adler's avatar
Bruce Adler committed
3859
Please note that the environment is read-only until the monitor
wdenk's avatar
wdenk committed
3860
has been relocated to RAM and a RAM copy of the environment has been
3861
created; also, when using EEPROM you will have to use getenv_f()
wdenk's avatar
wdenk committed
3862
3863
until then to read environment variables.

3864
3865
3866
3867
3868
3869
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.]
wdenk's avatar
wdenk committed
3870
3871
3872

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
3873
use the "saveenv" command to store a valid environment.
wdenk's avatar
wdenk committed
3874

3875
- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3876
		Echo the inverted Ethernet link state to the fault LED.
wdenk's avatar
wdenk committed
3877

3878
		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk's avatar
wdenk committed
3879
3880
		      also needs to be defined.

3881
- CONFIG_SYS_FAULT_MII_ADDR:
3882
		MII address of the PHY to check for the Ethernet link state.
wdenk's avatar
wdenk committed
3883

3884
3885
3886
3887
3888
3889
3890
- 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.

3891
3892
3893
3894
3895
- CONFIG_DISPLAY_BOARDINFO
		Display information about the board that U-Boot is running on
		when U-Boot starts up. The board function checkboard() is called
		to do this.

3896
3897
3898
3899
3900
- CONFIG_DISPLAY_BOARDINFO_LATE
		Similar to the previous option, but display this information
		later, once stdio is running and output goes to the LCD, if
		present.

wdenk's avatar
wdenk committed
3901
Low Level (hardware related) configuration options:
wdenk's avatar
wdenk committed
3902
---------------------------------------------------
wdenk's avatar
wdenk committed
3903

3904
- CONFIG_SYS_CACHELINE_SIZE:
wdenk's avatar
wdenk committed
3905
3906
		Cache Line Size of the CPU.

3907
- CONFIG_SYS_DEFAULT_IMMR:
wdenk's avatar
wdenk committed
3908
		Default address of the IMMR after system reset.
wdenk's avatar
wdenk committed
3909

3910
3911
3912
		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
		and RPXsuper) to be able to adjust the position of
		the IMMR register after a reset.
wdenk's avatar
wdenk committed
3913

3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
- 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
Wolfgang Denk's avatar
Wolfgang Denk committed
3928
		be set to that address.	 Otherwise, it should be set to the
3929
3930
3931
3932
3933
3934
3935
3936
		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:
3937
3938
		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
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
		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.

wdenk's avatar
wdenk committed
3951
- Floppy Disk Support:
3952
		CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk's avatar
wdenk committed
3953
3954
3955

		the default drive number (default value 0)

3956
		CONFIG_SYS_ISA_IO_STRIDE
wdenk's avatar
wdenk committed
3957

3958
		defines the spacing between FDC chipset registers
wdenk's avatar
wdenk committed
3959
3960
		(default value 1)

3961
		CONFIG_SYS_ISA_IO_OFFSET
wdenk's avatar
wdenk committed
3962

3963
3964
		defines the offset of register from address. It
		depends on which part of the data bus is connected to
3965
		the FDC chipset. (default value 0)
wdenk's avatar
wdenk committed
3966

3967
3968
		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
3969
		default value.
wdenk's avatar
wdenk committed
3970

3971
		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
3972
3973
3974
3975
		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.
wdenk's avatar
wdenk committed
3976

3977
3978
3979
3980
3981
3982
3983
3984
- 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.

3985
- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
wdenk's avatar
wdenk committed
3986
		DO NOT CHANGE unless you know exactly what you're
wdenk's avatar
wdenk committed
3987
		doing! (11-4) [MPC8xx/82xx systems only]
wdenk's avatar
wdenk committed
3988

3989
- CONFIG_SYS_INIT_RAM_ADDR:
wdenk's avatar
wdenk committed
3990

wdenk's avatar
wdenk committed
3991
		Start address of memory area that can be used for
wdenk's avatar
wdenk committed
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
		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

4004
- CONFIG_SYS_GBL_DATA_OFFSET:
wdenk's avatar
wdenk committed
4005
4006

		Offset of the initial data structure in the memory
4007
4008
		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenk's avatar
wdenk committed
4009
		data is located at the end of the available space
4010
		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4011
4012
4013
		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.
wdenk's avatar
wdenk committed
4014
4015
4016
4017

	Note:
		On the MPC824X (or other systems that use the data
		cache for initial memory) the address chosen for
4018
		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenk's avatar
wdenk committed
4019
4020
4021
		point to an otherwise UNUSED address space between
		the top of RAM and the start of the PCI space.

4022
- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
wdenk's avatar
wdenk committed
4023

4024
- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
wdenk's avatar
wdenk committed
4025

4026
- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
wdenk's avatar
wdenk committed
4027

4028
- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
wdenk's avatar
wdenk committed
4029

4030
- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
wdenk's avatar
wdenk committed
4031

4032
- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
wdenk's avatar
wdenk committed
4033

4034
- CONFIG_SYS_OR_TIMING_SDRAM:
wdenk's avatar
wdenk committed
4035
4036
		SDRAM timing

4037
- CONFIG_SYS_MAMR_PTA:
wdenk's avatar
wdenk committed
4038
4039
		periodic timer for refresh

4040
- CONFIG_SYS_DER:	Debug Event Register (37-47)
wdenk's avatar
wdenk committed
4041

4042
4043
4044
4045
- 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:
wdenk's avatar
wdenk committed
4046
4047
4048
		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)

- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
4049
4050
  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenk's avatar
wdenk committed
4051
4052
		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)

4053
4054
- 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:
wdenk's avatar
wdenk committed
4055
4056
4057
		Machine Mode Register and Memory Periodic Timer
		Prescaler definitions (SDRAM timing)

4058
- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenk's avatar
wdenk committed
4059
4060
4061
		enable I2C microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [DSP2]

4062
- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4063
4064
4065
		enable SMC microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [SMC1]

4066
- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenk's avatar
wdenk committed
4067
4068
4069
		enable SPI microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [SCC4]

4070
- CONFIG_SYS_USE_OSCCLK:
wdenk's avatar
wdenk committed
4071
4072
4073
4074
		Use OSCM clock mode on MBX8xx board. Be careful,
		wrong setting might damage your board. Read
		doc/README.MBX before setting this variable!

4075
- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4076
4077
4078
4079
		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.
4080

4081
4082
4083
4084
4085
4086
4087
4088
- 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)
Stefan Roese's avatar
Stefan Roese committed
4089
		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk's avatar
wdenk committed
4090

4091
4092
4093
4094
- CONFIG_PCI_DISABLE_PCIE:
		Disable PCI-Express on systems where it is supported but not
		required.

4095
4096
4097
4098
4099
4100
4101
- CONFIG_PCI_ENUM_ONLY
		Only scan through and get the devices on the busses.
		Don't do any setup work, presumably because someone or
		something has already done it, and we don't need to do it
		a second time.	Useful for platforms that are pre-booted
		by coreboot or similar.

4102
4103
4104
- CONFIG_PCI_INDIRECT_BRIDGE:
		Enable support for indirect PCI bridges.

4105
4106
4107
4108
4109
4110
4111
4112
4113
- CONFIG_SYS_SRIO:
		Chip has SRIO or not

- CONFIG_SRIO1:
		Board has SRIO 1 port available

- CONFIG_SRIO2:
		Board has SRIO 2 port available

4114
4115
4116
- CONFIG_SRIO_PCIE_BOOT_MASTER
		Board can support master function for Boot from SRIO and PCIE

4117
4118
4119
4120
4121
4122
4123
4124
4125
- 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

4126
4127
4128
4129
- CONFIG_SYS_NAND_BUSWIDTH_16BIT
		Defined to tell the NAND controller that the NAND chip is using
		a 16 bit bus.
		Not all NAND drivers use this symbol.
4130
		Example of drivers that use it:
4131
		- drivers/mtd/nand/ndfc.c
4132
		- drivers/mtd/nand/mxc_nand.c
4133
4134
4135
4136
4137

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

4138
- CONFIG_SPD_EEPROM
4139
4140
4141
		Get DDR timing information from an I2C EEPROM. Common
		with pluggable memory modules such as SODIMMs

4142
4143
4144
  SPD_EEPROM_ADDRESS
		I2C address of the SPD EEPROM

4145
- CONFIG_SYS_SPD_BUS_NUM
4146
4147
4148
		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.
4149

4150
4151
4152
4153
4154
4155
- 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.

4156
4157
4158
- CONFIG_FSL_DDR_INTERACTIVE
		Enable interactive DDR debugging. See doc/README.fsl-ddr.

4159
- CONFIG_SYS_83XX_DDR_USES_CS0
4160
4161
		Only for 83xx systems. If specified, then DDR should
		be configured using CS0 and CS1 instead of CS2 and CS3.
4162

4163
4164
4165
4166
4167
- 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
wdenk's avatar
wdenk committed
4168
4169
		to the given FEC; i. e.
			#define CONFIG_FEC1_PHY 4
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
		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.

4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
- 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.

wdenk's avatar
wdenk committed
4193
4194
- CONFIG_LOOPW
		Add the "loopw" memory command. This only takes effect if
4195
		the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk's avatar
wdenk committed
4196

stroese's avatar
stroese committed
4197
4198
4199
4200
4201
- CONFIG_MX_CYCLIC
		Add the "mdc" and "mwc" memory commands. These are cyclic
		"md/mw" commands.
		Examples:

wdenk's avatar
wdenk committed
4202
		=> mdc.b 10 4 500
stroese's avatar
stroese committed
4203
4204
		This command will print 4 bytes (10,11,12,13) each 500 ms.

wdenk's avatar
wdenk committed
4205
		=> mwc.l 100 12345678 10
stroese's avatar
stroese committed
4206
4207
		This command will write 12345678 to address 100 all 10 ms.

wdenk's avatar
wdenk committed
4208
		This only takes effect if the memory commands are activated
4209
		globally (CONFIG_CMD_MEM).
stroese's avatar
stroese committed
4210

wdenk's avatar
wdenk committed
4211
- CONFIG_SKIP_LOWLEVEL_INIT
4212
		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4213
4214
4215
4216
4217
4218
4219
4220
		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.
wdenk's avatar
wdenk committed
4221

4222
- CONFIG_SPL_BUILD
4223
4224
4225
		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.
wdenk's avatar
wdenk committed
4226

4227
4228
4229
4230
4231
- CONFIG_TPL_BUILD
		Modifies the behaviour of start.S  when compiling a loader
		that is executed after the SPL and before the actual U-Boot.
		It is loaded by the SPL.

4232
4233
4234
4235
4236
- CONFIG_SYS_MPC85XX_NO_RESETVEC
		Only for 85xx systems. If this variable is specified, the section
		.resetvec is not kept and the section .bootpg is placed in the
		previous 4k of the .text section.

4237
4238
4239
4240
4241
4242
4243
4244
4245
- CONFIG_ARCH_MAP_SYSMEM
		Generally U-Boot (and in particular the md command) uses
		effective address. It is therefore not necessary to regard
		U-Boot address as virtual addresses that need to be translated
		to physical addresses. However, sandbox requires this, since
		it maintains its own little RAM buffer which contains all
		addressable memory. This option causes some memory accesses
		to be mapped through map_sysmem() / unmap_sysmem().

4246
4247
4248
4249
4250
4251
- 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.

4252
4253
4254
- CONFIG_X86_RESET_VECTOR
		If defined, the x86 reset vector code is included. This is not
		needed when U-Boot is running from Coreboot.
4255

4256
4257
4258
4259
- CONFIG_SYS_MPUCLK
		Defines the MPU clock speed (in MHz).

		NOTE : currently only supported on AM335x platforms.
4260

4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
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.

4298
4299
4300
- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
	Specifies that QE/FMAN firmware is located in the remote (master)
	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4301
4302
4303
	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
	window->master inbound window->master LAW->the ucode address in
	master's memory space.
4304

wdenk's avatar
wdenk committed
4305
4306
4307
Building the Software:
======================

4308
4309
4310
4311
4312
4313
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.
wdenk's avatar
wdenk committed
4314

4315
4316
4317
4318
4319
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:
wdenk's avatar
wdenk committed
4320

4321
4322
	$ CROSS_COMPILE=ppc_4xx-
	$ export CROSS_COMPILE
wdenk's avatar
wdenk committed
4323

4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
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.

4334
4335
U-Boot is intended to be simple to build. After installing the
sources you must configure U-Boot for one specific board type. This
wdenk's avatar
wdenk committed
4336
4337
4338
4339
is done by typing:

	make NAME_config

4340
where "NAME_config" is the name of one of the existing configu-
4341
rations; see boards.cfg for supported names.
4342

wdenk's avatar
wdenk committed
4343
4344
4345
4346
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"
4347
      when choosing the configuration, i. e.
wdenk's avatar
wdenk committed
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364

      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

4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
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.

wdenk's avatar
wdenk committed
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395

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
4396
4397
    "boards.cfg" file, using the existing entries as examples.
    Follow the instructions there to keep the boards in order.
wdenk's avatar
wdenk committed
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
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.:
==============================================================

4415
4416
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
wdenk's avatar
wdenk committed
4417
4418
provide feedback to the other developers. The feedback normally takes
the form of a "patch", i. e. a context diff against a certain (latest
4419
official or latest in the git repository) version of U-Boot sources.
wdenk's avatar
wdenk committed
4420

4421
4422
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
wdenk's avatar
wdenk committed
4423
4424
the supported boards compile WITHOUT ANY compiler warnings. To do so,
just run the "MAKEALL" script, which will configure and build U-Boot
4425
4426
4427
4428
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
wdenk's avatar
wdenk committed
4429
4430
4431
4432
4433
4434
4435

	CROSS_COMPILE=ppc_8xx- MAKEALL

or to build on a native PowerPC system you can type

	CROSS_COMPILE=' ' MAKEALL

4436
4437
4438
4439
4440
4441
4442
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:
4443
4444
4445
4446
4447

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

4448
4449
4450
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.
4451
4452


wdenk's avatar
wdenk committed
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
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
4463
bootz   - boot zImage from memory
wdenk's avatar
wdenk committed
4464
4465
4466
tftpboot- boot image via network using TFTP protocol
	       and env variables "ipaddr" and "serverip"
	       (and eventually "gatewayip")
4467
tftpput - upload a file via network using TFTP protocol
wdenk's avatar
wdenk committed
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
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
4479
i2c	- I2C sub-system
wdenk's avatar
wdenk committed
4480
4481
4482
4483
4484
4485
4486
4487
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
4488
nand	- NAND memory operations (see doc/README.nand)
wdenk's avatar
wdenk committed
4489
4490
4491
4492
4493
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
wdenk's avatar
wdenk committed
4494
loopw	- infinite write loop on address range
wdenk's avatar
wdenk committed
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
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.
wdenk's avatar
wdenk committed
4518

wdenk's avatar
wdenk committed
4519
4520
4521
4522
4523
4524
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.
wdenk's avatar
wdenk committed
4525

4526
4527
4528
Some configuration options can be set using Environment Variables.

List of environment variables (most likely not complete):
wdenk's avatar
wdenk committed
4529

wdenk's avatar
wdenk committed
4530
  baudrate	- see CONFIG_BAUDRATE
wdenk's avatar
wdenk committed
4531

wdenk's avatar
wdenk committed
4532
  bootdelay	- see CONFIG_BOOTDELAY
wdenk's avatar
wdenk committed
4533

wdenk's avatar
wdenk committed
4534
  bootcmd	- see CONFIG_BOOTCOMMAND
wdenk's avatar
wdenk committed
4535

wdenk's avatar
wdenk committed
4536
  bootargs	- Boot arguments when booting an RTOS image
wdenk's avatar
wdenk committed
4537

wdenk's avatar
wdenk committed
4538
  bootfile	- Name of the image to load with TFTP
wdenk's avatar
wdenk committed
4539

4540
4541
4542
4543
4544
4545
  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
4546
4547
4548
		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
		  bootm_mapsize.

Wolfgang Denk's avatar
Wolfgang Denk committed
4549
  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4550
4551
4552
4553
4554
4555
		  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.
4556
4557
4558
4559
4560
4561
4562

  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.

4563
4564
4565
4566
  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.

wdenk's avatar
wdenk committed
4567
4568
4569
4570
  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
wdenk's avatar
wdenk committed
4571

wdenk's avatar
wdenk committed
4572
4573
4574
4575
  autostart	- if set to "yes", an image loaded using the "bootp",
		  "rarpboot", "tftpboot" or "diskboot" commands will
		  be automatically started (by internally calling
		  "bootm")
4576

wdenk's avatar
wdenk committed
4577
4578
4579
4580
4581
		  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.
wdenk's avatar
wdenk committed
4582

4583
4584
  fdt_high	- if set this restricts the maximum address that the
		  flattened device tree will be copied into upon boot.
4585
4586
4587
4588
4589
4590
4591
4592
		  For example, if you have a system with 1 GB memory
		  at physical address 0x10000000, while Linux kernel
		  only recognizes the first 704 MB as low memory, you
		  may need to set fdt_high as 0x3C000000 to have the
		  device tree blob be copied to the maximum address
		  of the 704 MB low memory, so that Linux kernel can
		  access it during the boot procedure.

4593
4594
4595
4596
4597
4598
4599
		  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.

4600
4601
4602
4603
  fdtcontroladdr- if set this is the address of the control flattened
		  device tree used by U-Boot when CONFIG_OF_CONTROL is
		  defined.

wdenk's avatar
wdenk committed
4604
4605
4606
4607
4608
4609
  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.

wdenk's avatar
wdenk committed
4610
4611
4612
4613
4614
4615
  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
4616
		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk's avatar
wdenk committed
4617
4618
4619
4620
		  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).
wdenk's avatar
wdenk committed
4621

wdenk's avatar
wdenk committed
4622
4623
4624
4625
4626
4627
		  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
wdenk's avatar
wdenk committed
4628

wdenk's avatar
wdenk committed
4629
		  setenv initrd_high 00c00000
wdenk's avatar
wdenk committed
4630

wdenk's avatar
wdenk committed
4631
4632
4633
4634
4635
4636
4637
		  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.
wdenk's avatar
wdenk committed
4638

wdenk's avatar
wdenk committed
4639
  ipaddr	- IP address; needed for tftpboot command
wdenk's avatar
wdenk committed
4640

wdenk's avatar
wdenk committed
4641
4642
  loadaddr	- Default load address for commands like "bootp",
		  "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenk's avatar
wdenk committed
4643

wdenk's avatar
wdenk committed
4644
  loads_echo	- see CONFIG_LOADS_ECHO
4645

wdenk's avatar
wdenk committed
4646
  serverip	- TFTP server IP address; needed for tftpboot command
4647

wdenk's avatar
wdenk committed
4648
  bootretry	- see CONFIG_BOOT_RETRY_TIME
4649

wdenk's avatar
wdenk committed
4650
  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4651

wdenk's avatar
wdenk committed
4652
  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
wdenk's avatar
wdenk committed
4653

Mike Frysinger's avatar
Mike Frysinger committed
4654
  ethprime	- controls which interface is used first.
wdenk's avatar
wdenk committed
4655

Mike Frysinger's avatar
Mike Frysinger committed
4656
4657
  ethact	- controls which interface is currently active.
		  For example you can do the following
wdenk's avatar
wdenk committed
4658

4659
4660
4661
4662
		  => setenv ethact FEC
		  => ping 192.168.0.1 # traffic sent on FEC
		  => setenv ethact SCC
		  => ping 10.0.0.1 # traffic sent on SCC
wdenk's avatar
wdenk committed
4663

4664
4665
4666
4667
  ethrotate	- When set to "no" U-Boot does not go through all
		  available network interfaces.
		  It just stays at the currently selected interface.

4668
  netretry	- When set to "no" each network operation will
wdenk's avatar
wdenk committed
4669
4670
4671
4672
4673
4674
		  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.
wdenk's avatar
wdenk committed
4675

4676
  npe_ucode	- set load address for the NPE microcode
4677

4678
4679
4680
4681
4682
4683
  silent_linux  - If set then linux will be told to boot silently, by
		  changing the console to be empty. If "yes" it will be
		  made silent. If "no" it will not be made silent. If
		  unset, then it will be made silent if the U-Boot console
		  is silent.

4684
  tftpsrcport	- If this is set, the value is used for TFTP's
4685
4686
		  UDP source port.

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

4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
  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
4702
		  Ethernet is encapsulated/received over 802.1q
wdenk's avatar
wdenk committed
4703
		  VLAN tagged frames.
wdenk's avatar
wdenk committed
4704

4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
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.

Wolfgang Denk's avatar
Wolfgang Denk committed
4717
4718
4719
4720
4721
4722
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
4723

wdenk's avatar
wdenk committed
4724
4725
4726
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:
wdenk's avatar
wdenk committed
4727

wdenk's avatar
wdenk committed
4728
4729
4730
4731
4732
4733
4734
4735
4736
  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
4737
4738


wdenk's avatar
wdenk committed
4739
There are two special Environment Variables:
4740

wdenk's avatar
wdenk committed
4741
4742
4743
  serial#	- contains hardware identification information such
		  as type string and/or serial number
  ethaddr	- Ethernet address
wdenk's avatar
wdenk committed
4744

wdenk's avatar
wdenk committed
4745
4746
4747
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.
wdenk's avatar
wdenk committed
4748

4749

wdenk's avatar
wdenk committed
4750
Further special Environment Variables:
4751

wdenk's avatar
wdenk committed
4752
4753
4754
  ver		- Contains the U-Boot version string as printed
		  with the "version" command. This variable is
		  readonly (see CONFIG_VERSION_VARIABLE).
4755
4756


wdenk's avatar
wdenk committed
4757
4758
Please note that changes to some configuration parameters may take
only effect after the next boot (yes, that's just like Windoze :-).
4759
4760


4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
Callback functions for environment variables:
---------------------------------------------

For some environment variables, the behavior of u-boot needs to change
when their values are changed.  This functionailty allows functions to
be associated with arbitrary variables.  On creation, overwrite, or
deletion, the callback will provide the opportunity for some side
effect to happen or for the change to be rejected.

The callbacks are named and associated with a function using the
U_BOOT_ENV_CALLBACK macro in your board or driver code.

These callbacks are associated with variables in one of two ways.  The
static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
in the board configuration to a string that defines a list of
associations.  The list must be in the following format:

	entry = variable_name[:callback_name]
	list = entry[,list]

If the callback name is not specified, then the callback is deleted.
Spaces are also allowed anywhere in the list.

Callbacks can also be associated by defining the ".callbacks" variable
with the same list format above.  Any association in ".callbacks" will
override any association in the static list. You can define
CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
".callbacks" envirnoment variable in the default or embedded environment.


wdenk's avatar
wdenk committed
4791
4792
Command Line Parsing:
=====================
4793

wdenk's avatar
wdenk committed
4794
4795
There are two different command line parsers available with U-Boot:
the old "simple" one, and the much more powerful "hush" shell:
wdenk's avatar
wdenk committed
4796

wdenk's avatar
wdenk committed
4797
4798
Old, simple command line parser:
--------------------------------
wdenk's avatar
wdenk committed
4799

wdenk's avatar
wdenk committed
4800
4801
- supports environment variables (through setenv / saveenv commands)
- several commands on one line, separated by ';'
4802
- variable substitution using "... ${name} ..." syntax
wdenk's avatar
wdenk committed
4803
4804
- special characters ('$', ';') can be escaped by prefixing with '\',
  for example:
4805
	setenv bootcmd bootm \${address}
wdenk's avatar
wdenk committed
4806
4807
- You can also escape text by enclosing in single apostrophes, for example:
	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenk's avatar
wdenk committed
4808

wdenk's avatar
wdenk committed
4809
4810
Hush shell:
-----------
wdenk's avatar
wdenk committed
4811

wdenk's avatar
wdenk committed
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
- 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:
--------------
wdenk's avatar
wdenk committed
4822

wdenk's avatar
wdenk committed
4823
4824
4825
4826
(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.
wdenk's avatar
wdenk committed
4827

wdenk's avatar
wdenk committed
4828
(2) If you execute several variables with one call to run (i. e.
4829
    calling run with a list of variables as arguments), any failing
wdenk's avatar
wdenk committed
4830
4831
    command will cause "run" to terminate, i. e. the remaining
    variables are not executed.
wdenk's avatar
wdenk committed
4832

wdenk's avatar
wdenk committed
4833
4834
Note for Redundant Ethernet Interfaces:
=======================================
wdenk's avatar
wdenk committed
4835

4836
Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk's avatar
wdenk committed
4837
4838
such configurations and is capable of automatic selection of a
"working" interface when needed. MAC assignment works as follows:
wdenk's avatar
wdenk committed
4839

wdenk's avatar
wdenk committed
4840
4841
4842
Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
"eth1addr" (=>eth1), "eth2addr", ...
wdenk's avatar
wdenk committed
4843

wdenk's avatar
wdenk committed
4844
4845
4846
4847
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:
wdenk's avatar
wdenk committed
4848

wdenk's avatar
wdenk committed
4849
4850
o If the SROM has a valid MAC address, and there is no address in the
  environment, the SROM's address is used.
wdenk's avatar
wdenk committed
4851

wdenk's avatar
wdenk committed
4852
4853
4854
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.
wdenk's avatar
wdenk committed
4855

wdenk's avatar
wdenk committed
4856
4857
o If both the SROM and the environment contain a MAC address, and
  both addresses are the same, this MAC address is used.
wdenk's avatar
wdenk committed
4858

wdenk's avatar
wdenk committed
4859
4860
4861
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.
wdenk's avatar
wdenk committed
4862

wdenk's avatar
wdenk committed
4863
4864
o If neither SROM nor the environment contain a MAC address, an error
  is raised.
wdenk's avatar
wdenk committed
4865

4866
If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk's avatar
Wolfgang Denk committed
4867
will be programmed into hardware as part of the initialization process.	 This
4868
4869
4870
may be skipped by setting the appropriate 'ethmacskip' environment variable.
The naming convention is as follows:
"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenk's avatar
wdenk committed
4871

wdenk's avatar
wdenk committed
4872
4873
Image Formats:
==============
wdenk's avatar
wdenk committed
4874

4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
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:
wdenk's avatar
wdenk committed
4893

wdenk's avatar
wdenk committed
4894
4895
* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4896
4897
4898
  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
  INTEGRITY).
Wolfgang Denk's avatar
Wolfgang Denk committed
4899
* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4900
4901
  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk's avatar
wdenk committed
4902
4903
4904
4905
4906
* Compression Type (uncompressed, gzip, bzip2)
* Load Address
* Entry Point
* Image Name
* Image Timestamp
wdenk's avatar
wdenk committed
4907

wdenk's avatar
wdenk committed
4908
4909
4910
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.
wdenk's avatar
wdenk committed
4911
4912


wdenk's avatar
wdenk committed
4913
4914
Linux Support:
==============
wdenk's avatar
wdenk committed
4915

wdenk's avatar
wdenk committed
4916
4917
4918
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.
wdenk's avatar
wdenk committed
4919

wdenk's avatar
wdenk committed
4920
4921
4922
4923
4924
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:
wdenk's avatar
wdenk committed
4925

wdenk's avatar
wdenk committed
4926
4927
4928
- the same features can be used for other OS or standalone
  applications (for instance: using compressed images to reduce the
  Flash memory footprint)
wdenk's avatar
wdenk committed
4929

wdenk's avatar
wdenk committed
4930
4931
- it becomes much easier to port new Linux kernel versions because
  lots of low-level, hardware dependent stuff are done by U-Boot
wdenk's avatar
wdenk committed
4932

wdenk's avatar
wdenk committed
4933
4934
4935
4936
4937
4938
- 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.
wdenk's avatar
wdenk committed
4939
4940


wdenk's avatar
wdenk committed
4941
4942
Linux HOWTO:
============
wdenk's avatar
wdenk committed
4943

wdenk's avatar
wdenk committed
4944
4945
Porting Linux to U-Boot based systems:
---------------------------------------
wdenk's avatar
wdenk committed
4946

wdenk's avatar
wdenk committed
4947
4948
4949
4950
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 :-).
wdenk's avatar
wdenk committed
4951

Stefan Roese's avatar
Stefan Roese committed
4952
But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4953

wdenk's avatar
wdenk committed
4954
4955
Just make sure your machine specific header file (for instance
include/asm-ppc/tqm8xx.h) includes the same definition of the Board
4956
4957
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
4958
as your U-Boot configuration in CONFIG_SYS_IMMR.
4959

wdenk's avatar
wdenk committed
4960

wdenk's avatar
wdenk committed
4961
4962
Configuring the Linux kernel:
-----------------------------
wdenk's avatar
wdenk committed
4963

wdenk's avatar
wdenk committed
4964
4965
4966
4967
4968
4969
No specific requirements for U-Boot. Make sure you have some root
device (initial ramdisk, NFS) for your target system.


Building a Linux Image:
-----------------------
wdenk's avatar
wdenk committed
4970

wdenk's avatar
wdenk committed
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
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
wdenk's avatar
wdenk committed
5006
5007


wdenk's avatar
wdenk committed
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
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:
wdenk's avatar
wdenk committed
5021

wdenk's avatar
wdenk committed
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
	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'

wdenk's avatar
wdenk committed
5039
5040
5041
Right now, all Linux kernels for PowerPC systems use the same load
address (0x00000000), but the entry point address depends on the
kernel version:
wdenk's avatar
wdenk committed
5042
5043
5044
5045
5046
5047
5048
5049

- 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 \
Stefan Roese's avatar
Stefan Roese committed
5050
	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk's avatar
wdenk committed
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
	> 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:

Stefan Roese's avatar
Stefan Roese committed
5074
	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk's avatar
wdenk committed
5075
5076
	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese's avatar
Stefan Roese committed
5077
	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk's avatar
wdenk committed
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
	> 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;
5135
this includes a checksum verification so you can be sure no data
wdenk's avatar
wdenk committed
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
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]
	...

5183
If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk's avatar
wdenk committed
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
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#

5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
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 ...
5268
5269
5270
   Image Name:	 Linux-2.6.17-dirty
   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
   Data Size:	 1029343 Bytes = 1005.2 kB
5271
   Load Address: 00000000
5272
   Entry Point:	 00000000
5273
5274
5275
5276
5277
5278
5279
5280
   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]


wdenk's avatar
wdenk committed
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
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.

5321
5322
5323
5324
5325
5326
5327
Booting the Linux zImage:
-------------------------

On some platforms, it's possible to boot Linux zImage. This is done
using the "bootz" command. The syntax of "bootz" command is the same
as the syntax of "bootm" command.

5328
Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5329
5330
5331
5332
kernel with raw initrd images. The syntax is slightly different, the
address of the initrd must be augmented by it's size, in the following
format: "<initrd addres>:<initrd size>".

wdenk's avatar
wdenk committed
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429

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
Karl O. Pinc's avatar
Karl O. Pinc committed
5430
5431
5432
5433
use "cu" for S-Record download ("loads" command).  See
http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
for help with kermit.

wdenk's avatar
wdenk committed
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468

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
wdenk's avatar
wdenk committed
5469
meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenk's avatar
wdenk committed
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494


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.

5495
	Chris Hallinan posted a good summary of these issues to the
5496
	U-Boot mailing list:
wdenk's avatar
wdenk committed
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507

	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
5508
	beyond the scope of this list to explain the details, but you
wdenk's avatar
wdenk committed
5509
5510
5511
5512
5513
	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
5514
	initial stack/RAM area prior to SDRAM being available. Either
wdenk's avatar
wdenk committed
5515
5516
5517
5518
5519
	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.

5520
	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk's avatar
wdenk committed
5521
5522
	with your processor/board/system design. The default value
	you will find in any recent u-boot distribution in
5523
	walnut.h should work for you. I'd set it to a value larger
wdenk's avatar
wdenk committed
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
	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.

5539
* Do not use any uninitialized global data (or implicitely initialized
wdenk's avatar
wdenk committed
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
  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
5562
	R2:	reserved for system use
wdenk's avatar
wdenk committed
5563
5564
5565
5566
5567
5568
	R3-R4:	parameter passing and return values
	R5-R10: parameter passing
	R13:	small data area pointer
	R30:	GOT pointer
	R31:	frame pointer

5569
5570
5571
	(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)
wdenk's avatar
wdenk committed
5572

5573
    ==> U-Boot will use R2 to hold a pointer to the global data
wdenk's avatar
wdenk committed
5574
5575
5576
5577
5578
5579
5580
5581

    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).

5582
On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger's avatar
Mike Frysinger committed
5583
5584
	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface

5585
    ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger's avatar
Mike Frysinger committed
5586

wdenk's avatar
wdenk committed
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
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

Thomas Chou's avatar
Thomas Chou committed
5601
5602
5603
5604
5605
5606
5607
5608
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.

5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
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

5623
5624
NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
or current versions of GCC may "optimize" the code too much.
wdenk's avatar
wdenk committed
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640

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
5641
memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk's avatar
wdenk committed
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
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:
----------------------
wdenk's avatar
wdenk committed
5673

wdenk's avatar
wdenk committed
5674
In the reset configuration, U-Boot starts at the reset entry point
5675
(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk's avatar
wdenk committed
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
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:
----------------------
wdenk's avatar
wdenk committed
5711

wdenk's avatar
wdenk committed
5712
5713
[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
list, October 2002]
wdenk's avatar
wdenk committed
5714
5715


5716
int main(int argc, char *argv[])
wdenk's avatar
wdenk committed
5717
5718
{
	sighandler_t no_more_time;
wdenk's avatar
wdenk committed
5719

5720
5721
	signal(SIGALRM, no_more_time);
	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenk's avatar
wdenk committed
5722

wdenk's avatar
wdenk committed
5723
	if (available_money > available_manpower) {
5724
		Pay consultant to port U-Boot;
wdenk's avatar
wdenk committed
5725
5726
5727
		return 0;
	}

wdenk's avatar
wdenk committed
5728
5729
	Download latest U-Boot source;

5730
	Subscribe to u-boot mailing list;
wdenk's avatar
wdenk committed
5731

5732
5733
	if (clueless)
		email("Hi, I am new to U-Boot, how do I get started?");
wdenk's avatar
wdenk committed
5734
5735
5736

	while (learning) {
		Read the README file in the top level directory;
5737
5738
		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
		Read applicable doc/*.README;
wdenk's avatar
wdenk committed
5739
		Read the source, Luke;
5740
		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk's avatar
wdenk committed
5741
5742
	}

5743
5744
5745
	if (available_money > toLocalCurrency ($2500))
		Buy a BDI3000;
	else
wdenk's avatar
wdenk committed
5746
5747
		Add a lot of aggravation and time;

5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
	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;
wdenk's avatar
wdenk committed
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
	}

	return 0;
}

void no_more_time (int sig)
{
      hire_a_guru();
}

wdenk's avatar
wdenk committed
5782

wdenk's avatar
wdenk committed
5783
5784
Coding Standards:
-----------------
wdenk's avatar
wdenk committed
5785

wdenk's avatar
wdenk committed
5786
All contributions to U-Boot should conform to the Linux kernel
5787
coding style; see the file "Documentation/CodingStyle" and the script
5788
"scripts/Lindent" in your Linux kernel source directory.
5789
5790
5791
5792
5793
5794
5795
5796
5797

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.
wdenk's avatar
wdenk committed
5798

wdenk's avatar
wdenk committed
5799
5800
Please also stick to the following formatting rules:
- remove any trailing white space
5801
- use TAB characters for indentation and vertical alignment, not spaces
wdenk's avatar
wdenk committed
5802
- make sure NOT to use DOS '\r\n' line feeds
5803
- do not add more than 2 consecutive empty lines to source files
wdenk's avatar
wdenk committed
5804
- do not add trailing empty lines to source files
5805

wdenk's avatar
wdenk committed
5806
5807
Submissions which do not conform to the standards may be returned
with a request to reformat the changes.
wdenk's avatar
wdenk committed
5808
5809


wdenk's avatar
wdenk committed
5810
5811
Submitting Patches:
-------------------
wdenk's avatar
wdenk committed
5812

wdenk's avatar
wdenk committed
5813
5814
5815
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.
wdenk's avatar
wdenk committed
5816

Magnus Lilja's avatar
Magnus Lilja committed
5817
Please see http://www.denx.de/wiki/U-Boot/Patches for details.
5818

5819
5820
5821
Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
see http://lists.denx.de/mailman/listinfo/u-boot

wdenk's avatar
wdenk committed
5822
5823
When you send a patch, please include the following information with
it:
wdenk's avatar
wdenk committed
5824

wdenk's avatar
wdenk committed
5825
5826
5827
* 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.
wdenk's avatar
wdenk committed
5828

wdenk's avatar
wdenk committed
5829
5830
* For new features: a description of the feature and your
  implementation.
wdenk's avatar
wdenk committed
5831

wdenk's avatar
wdenk committed
5832
* A CHANGELOG entry as plaintext (separate from the patch)
wdenk's avatar
wdenk committed
5833

wdenk's avatar
wdenk committed
5834
* For major contributions, your entry to the CREDITS file
wdenk's avatar
wdenk committed
5835

wdenk's avatar
wdenk committed
5836
* When you add support for a new board, don't forget to add this
5837
  board to the MAINTAINERS file, too.
wdenk's avatar
wdenk committed
5838

wdenk's avatar
wdenk committed
5839
5840
* If your patch adds new configuration options, don't forget to
  document these in the README file.
wdenk's avatar
wdenk committed
5841

5842
5843
* The patch itself. If you are using git (which is *strongly*
  recommended) you can easily generate the patch using the
5844
  "git format-patch". If you then use "git send-email" to send it to
5845
5846
5847
5848
5849
5850
  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.
wdenk's avatar
wdenk committed
5851

5852
5853
5854
5855
  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).
5856

5857
5858
  We prefer patches as plain text. MIME attachments are discouraged,
  and compressed attachments must not be used.
wdenk's avatar
wdenk committed
5859

wdenk's avatar
wdenk committed
5860
5861
* If one logical set of modifications affects or creates several
  files, all these changes shall be submitted in a SINGLE patch file.
5862

wdenk's avatar
wdenk committed
5863
5864
* Changesets that contain different, unrelated modifications shall be
  submitted as SEPARATE patches, one patch per changeset.
wdenk's avatar
wdenk committed
5865

5866

wdenk's avatar
wdenk committed
5867
Notes:
wdenk's avatar
wdenk committed
5868

wdenk's avatar
wdenk committed
5869
5870
5871
* 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.
wdenk's avatar
wdenk committed
5872

wdenk's avatar
wdenk committed
5873
5874
5875
* 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.
wdenk's avatar
wdenk committed
5876

wdenk's avatar
wdenk committed
5877
5878
5879
5880
5881
5882
* 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.
5883

5884
5885
5886
5887
* 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.