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

Summary:
========

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

The development of U-Boot is closely related to Linux: some parts of
16
17
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
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
32
Makefile have been tested to some extent and can be considered
wdenk's avatar
wdenk committed
33
34
"working". In fact, many of them are used in production systems.

35
36
37
38
In case of problems see the CHANGELOG file to find out who contributed
the specific port. In addition, there are various MAINTAINERS files
scattered throughout the U-Boot source identifying the people or
companies responsible for various boards and subsystems.
wdenk's avatar
wdenk committed
39

40
41
42
Note: As of August, 2010, there is no longer a CHANGELOG file in the
actual U-Boot source tree; however, it can be created dynamically
from the Git log using:
43
44
45

	make CHANGELOG

wdenk's avatar
wdenk committed
46
47
48
49

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

50
In case you have questions about, problems with or contributions for
51
U-Boot, you should send a message to the U-Boot mailing list at
52
53
<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.
54
55
Please see https://lists.denx.de/pipermail/u-boot and
https://marc.info/?l=u-boot
wdenk's avatar
wdenk committed
56

57
58
59
Where to get source code:
=========================

60
The U-Boot source code is maintained in the Git repository at
61
62
https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
https://source.denx.de/u-boot/u-boot
63

64
The "Tags" links on this page allow you to download tarballs of
65
any version you might be interested in. Official releases are also
66
67
68
available from the DENX file server through HTTPS or FTP.
https://ftp.denx.de/pub/u-boot/
ftp://ftp.denx.de/pub/u-boot/
69
70


wdenk's avatar
wdenk committed
71
72
73
74
Where we come from:
===================

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


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
110
111


wdenk's avatar
wdenk committed
112
113
114
Versioning:
===========

115
116
117
118
119
120
121
122
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
123
	U-Boot v2009.11	    - Release November 2009
124
	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
125
	U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk's avatar
wdenk committed
126
127


wdenk's avatar
wdenk committed
128
129
130
Directory Hierarchy:
====================

131
/arch			Architecture-specific files
132
  /arc			Files generic to ARC architecture
133
134
135
136
  /arm			Files generic to ARM architecture
  /m68k			Files generic to m68k architecture
  /microblaze		Files generic to microblaze architecture
  /mips			Files generic to MIPS architecture
137
  /nds32		Files generic to NDS32 architecture
138
  /nios2		Files generic to Altera NIOS2 architecture
Stefan Roese's avatar
Stefan Roese committed
139
  /powerpc		Files generic to PowerPC architecture
140
  /riscv		Files generic to RISC-V architecture
141
  /sandbox		Files generic to HW-independent "sandbox"
142
  /sh			Files generic to SH architecture
143
  /x86			Files generic to x86 architecture
144
  /xtensa		Files generic to Xtensa architecture
145
146
/api			Machine/arch-independent API for external apps
/board			Board-dependent files
147
/cmd			U-Boot commands functions
148
/common			Misc architecture-independent functions
149
/configs		Board default configuration files
150
/disk			Code for disk drive partition handling
151
152
153
154
/doc			Documentation (a mix of ReST and READMEs)
/drivers		Device drivers
/dts			Makefile for building internal U-Boot fdt.
/env			Environment support
155
156
157
/examples		Example code for standalone applications, etc.
/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
/include		Header Files
158
159
/lib			Library routines generic to all architectures
/Licenses		Various license files
160
161
/net			Networking code
/post			Power On Self Test
162
163
/scripts		Various build scripts and Makefiles
/test			Various unit test files
164
/tools			Tools to build and sign FIT images, etc.
wdenk's avatar
wdenk committed
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

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
181
  "CONFIG_SYS_".
wdenk's avatar
wdenk committed
182

183
184
185
186
187
Previously, all configuration was done by hand, which involved creating
symbolic links and editing configuration files manually. More recently,
U-Boot has added the Kbuild infrastructure used by the Linux kernel,
allowing you to use the "make menuconfig" command to configure your
build.
wdenk's avatar
wdenk committed
188
189
190
191
192
193


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

For all supported boards there are ready-to-use default
194
configurations available; just type "make <board_name>_defconfig".
wdenk's avatar
wdenk committed
195
196
197
198

Example: For a TQM823L module type:

	cd u-boot
199
	make TQM823L_defconfig
wdenk's avatar
wdenk committed
200

201
202
203
Note: If you're looking for the default configuration file for a board
you're sure used to be there but is now missing, check the file
doc/README.scrapyard for a list of no longer supported boards.
wdenk's avatar
wdenk committed
204

205
206
207
208
209
210
211
212
Sandbox Environment:
--------------------

U-Boot can be built natively to run on a Linux host using the 'sandbox'
board. This allows feature development which is not board- or architecture-
specific to be undertaken on a native platform. The sandbox is also used to
run some of U-Boot's tests.

213
See doc/arch/sandbox.rst for more details.
214
215


216
217
218
219
Board Initialisation Flow:
--------------------------

This is the intended start-up flow for boards. This should apply for both
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
SPL and U-Boot proper (i.e. they both follow the same rules).

Note: "SPL" stands for "Secondary Program Loader," which is explained in
more detail later in this file.

At present, SPL mostly uses a separate code path, but the function names
and roles of each function are the same. Some boards or architectures
may not conform to this.  At least most ARM boards which use
CONFIG_SPL_FRAMEWORK conform to this.

Execution typically starts with an architecture-specific (and possibly
CPU-specific) start.S file, such as:

	- arch/arm/cpu/armv7/start.S
	- arch/powerpc/cpu/mpc83xx/start.S
	- arch/mips/cpu/start.S
236

237
238
and so on. From there, three functions are called; the purpose and
limitations of each of these functions are described below.
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

lowlevel_init():
	- purpose: essential init to permit execution to reach board_init_f()
	- no global_data or BSS
	- there is no stack (ARMv7 may have one but it will soon be removed)
	- must not set up SDRAM or use console
	- must only do the bare minimum to allow execution to continue to
		board_init_f()
	- this is almost never needed
	- return normally from this function

board_init_f():
	- purpose: set up the machine ready for running board_init_r():
		i.e. SDRAM and serial UART
	- global_data is available
	- stack is in SRAM
	- BSS is not available, so you cannot use global/static variables,
		only stack variables and global_data

	Non-SPL-specific notes:
	- dram_init() is called to set up DRAM. If already done in SPL this
		can do nothing

	SPL-specific notes:
	- you can override the entire board_init_f() function with your own
		version as needed.
	- preloader_console_init() can be called here in extremis
	- should set up SDRAM, and anything needed to make the UART work
267
	- there is no need to clear BSS, it will be done by crt0.S
268
269
270
271
272
273
274
	- for specific scenarios on certain architectures an early BSS *can*
	  be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
	  of BSS prior to entering board_init_f()) but doing so is discouraged.
	  Instead it is strongly recommended to architect any code changes
	  or additions such to not depend on the availability of BSS during
	  board_init_f() as indicated in other sections of this README to
	  maintain compatibility and consistency across the entire code base.
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
	- must return normally from this function (don't call board_init_r()
		directly)

Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
this point the stack and global_data are relocated to below
CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
memory.

board_init_r():
	- purpose: main execution, common code
	- global_data is available
	- SDRAM is available
	- BSS is available, all static/global variables can be used
	- execution eventually continues to main_loop()

	Non-SPL-specific notes:
	- U-Boot is relocated to the top of memory and is now running from
		there.

	SPL-specific notes:
	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
		CONFIG_SPL_STACK_R_ADDR points into SDRAM
	- preloader_console_init() can be called here - typically this is
298
		done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
299
300
301
302
		spl_board_init() function containing this call
	- loads U-Boot or (in falcon mode) Linux


wdenk's avatar
wdenk committed
303
304
305
306
307
308
309
310
311
312
313
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
314
315
316
317
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.

318
319
320
321
322
323
324
325
326
- ARM Platform Bus Type(CCI):
		CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
		provides full cache coherency between two clusters of multi-core
		CPUs and I/O coherency for devices and I/O masters

		CONFIG_SYS_FSL_HAS_CCI400

		Defined For SoC that has cache coherent interconnect
		CCN-400
wdenk's avatar
wdenk committed
327

328
329
330
331
		CONFIG_SYS_FSL_HAS_CCN504

		Defined for SoC that has cache coherent interconnect CCN-504

wdenk's avatar
wdenk committed
332
333
The following options need to be configured:

334
335
336
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

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

338
- 85xx CPU Options:
339
340
341
342
343
344
		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.

345
346
347
348
349
350
		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.

351
352
353
354
355
		CONFIG_SYS_FSL_PCIE_COMPAT

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

356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
		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.

376
377
		CONFIG_A003399_NOR_WORKAROUND
		Enables a workaround for IFC erratum A003399. It is only
378
		required during NOR boot.
379

380
381
		CONFIG_A008044_WORKAROUND
		Enables a workaround for T1040/T1042 erratum A008044. It is only
382
		required during NAND boot and valid for Rev 1.0 SoC revision
383

384
385
386
387
388
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY

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

389
390
391
392
		CONFIG_SYS_FSL_DSP_DDR_ADDR
		This value denotes start offset of DDR memory which is
		connected exclusively to the DSP cores.

393
394
395
396
		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
		This value denotes start offset of M2 memory
		which is directly connected to the DSP core.

397
398
399
400
		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
		This value denotes start offset of M3 memory which is directly
		connected to the DSP core.

401
402
403
		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
		This value denotes start offset of DSP CCSR space.

404
405
406
407
408
		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
		Single Source Clock is clocking mode present in some of FSL SoC's.
		In this mode, a single differential clock is used to supply
		clocks to the sysclock, ddrclock and usbclock.

409
410
		CONFIG_SYS_CPC_REINIT_F
		This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng's avatar
Bin Meng committed
411
		time of U-Boot entry and is required to be re-initialized.
412

413
		CONFIG_DEEP_SLEEP
414
		Indicates this SoC supports deep sleep feature. If deep sleep is
415
416
		supported, core will start to execute uboot when wakes up.

417
418
419
420
421
422
- Generic CPU options:
		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN

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

423
424
		CONFIG_SYS_FSL_DDR
		Freescale DDR driver in use. This type of DDR controller is
Tom Rini's avatar
Tom Rini committed
425
		found in mpc83xx, mpc85xx as well as some ARM core SoCs.
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442

		CONFIG_SYS_FSL_DDR_ADDR
		Freescale DDR memory-mapped register base.

		CONFIG_SYS_FSL_DDR_EMU
		Specify emulator support for DDR. Some DDR features such as
		deskew training are not available.

		CONFIG_SYS_FSL_DDRC_GEN1
		Freescale DDR1 controller.

		CONFIG_SYS_FSL_DDRC_GEN2
		Freescale DDR2 controller.

		CONFIG_SYS_FSL_DDRC_GEN3
		Freescale DDR3 controller.

443
444
445
		CONFIG_SYS_FSL_DDRC_GEN4
		Freescale DDR4 controller.

446
447
448
		CONFIG_SYS_FSL_DDRC_ARM_GEN3
		Freescale DDR3 controller for ARM-based SoCs.

449
450
451
452
453
454
		CONFIG_SYS_FSL_DDR1
		Board config to use DDR1. It can be enabled for SoCs with
		Freescale DDR1 or DDR2 controllers, depending on the board
		implemetation.

		CONFIG_SYS_FSL_DDR2
455
		Board config to use DDR2. It can be enabled for SoCs with
456
457
458
459
460
		Freescale DDR2 or DDR3 controllers, depending on the board
		implementation.

		CONFIG_SYS_FSL_DDR3
		Board config to use DDR3. It can be enabled for SoCs with
461
462
463
464
465
		Freescale DDR3 or DDR3L controllers.

		CONFIG_SYS_FSL_DDR3L
		Board config to use DDR3L. It can be enabled for SoCs with
		DDR3L controllers.
466

467
468
469
470
471
472
		CONFIG_SYS_FSL_IFC_BE
		Defines the IFC controller register space as Big Endian

		CONFIG_SYS_FSL_IFC_LE
		Defines the IFC controller register space as Little Endian

473
474
475
		CONFIG_SYS_FSL_IFC_CLK_DIV
		Defines divider of platform clock(clock input to IFC controller).

476
477
478
		CONFIG_SYS_FSL_LBC_CLK_DIV
		Defines divider of platform clock(clock input to eLBC controller).

479
480
481
482
483
484
		CONFIG_SYS_FSL_DDR_BE
		Defines the DDR controller register space as Big Endian

		CONFIG_SYS_FSL_DDR_LE
		Defines the DDR controller register space as Little Endian

485
486
487
488
489
		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
		Physical address from the view of DDR controllers. It is the
		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
		it could be different for ARM SoCs.

490
491
492
493
494
		CONFIG_SYS_FSL_DDR_INTLV_256B
		DDR controller interleaving on 256-byte. This is a special
		interleaving mode, handled by Dickens for Freescale layerscape
		SoCs with ARM core.

495
496
497
498
499
500
		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
		Number of controllers used as main memory.

		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
		Number of controllers used for other than main memory.

501
502
503
		CONFIG_SYS_FSL_HAS_DP_DDR
		Defines the SoC has DP-DDR used for DPAA.

504
505
506
507
508
509
		CONFIG_SYS_FSL_SEC_BE
		Defines the SEC controller register space as Big Endian

		CONFIG_SYS_FSL_SEC_LE
		Defines the SEC controller register space as Little Endian

510
511
512
513
514
515
516
517
518
519
520
521
522
- 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_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.

523
524
525
526
527
528
- 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.

529
530
531
532
533
534
535
536
		COUNTER_FREQUENCY
		Generic timer clock source frequency.

		COUNTER_FREQUENCY_REAL
		Generic timer clock source frequency if the real clock is
		different from COUNTER_FREQUENCY, and can only be determined
		at run time.

537
538
539
540
541
542
543
- Tegra SoC options:
		CONFIG_TEGRA_SUPPORT_NON_SECURE

		Support executing U-Boot in non-secure (NS) mode. Certain
		impossible actions will be skipped if the CPU is in NS mode,
		such as ARM architectural timer initialization.

wdenk's avatar
wdenk committed
544
545
546
- Linux Kernel Interface:
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

547
		When transferring memsize parameter to Linux, some versions
wdenk's avatar
wdenk committed
548
549
550
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

551
		CONFIG_OF_LIBFDT
552
553

		New kernel versions are expecting firmware settings to be
554
555
556
557
558
559
		passed using flattened device trees (based on open firmware
		concepts).

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

562
563
		OF_TBCLK - The timebase frequency.

564
565
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
566

567
568
569
570
		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
571

572
573
574
575
576
577
578
		CONFIG_OF_SYSTEM_SETUP

		Other code has addition modification that it wants to make
		to the flat device tree before handing it off to the kernel.
		This causes ft_system_setup() to be called before booting
		the kernel.

579
580
581
582
583
584
585
586
587
		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.

588
589
590
- vxWorks boot parameters:

		bootvx constructs a valid bootline using the following
591
592
		environments variables: bootdev, bootfile, ipaddr, netmask,
		serverip, gatewayip, hostname, othbootargs.
593
594
		It loads the vxWorks image pointed bootfile.

595
		Note: If a "bootargs" environment is defined, it will override
596
597
		the defaults discussed just above.

598
599
600
- Cache Configuration:
		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot

Aneesh V's avatar
Aneesh V committed
601
602
603
604
605
606
- 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
607
- Serial Ports:
608
		CONFIG_PL011_SERIAL
wdenk's avatar
wdenk committed
609
610
611
612
613
614
615
616
617
618
619
620
621
622

		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

623
624
625
626
		CONFIG_SERIAL_HW_FLOW_CONTROL

		Define this variable to enable hw flow control in serial driver.
		Current user of this option is drivers/serial/nsl16550.c driver
wdenk's avatar
wdenk committed
627

wdenk's avatar
wdenk committed
628
629
630
631
632
633
634
635
- 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_RAMBOOT and CONFIG_NFSBOOT
636
637
638
		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
639
		RAM and NFS.
wdenk's avatar
wdenk committed
640
641
642
643
644
645
646
647
648
649

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

650
651
652
653
654
655
656
657
- Removal of commands
		If no commands are needed to boot, you can disable
		CONFIG_CMDLINE to remove them. In this case, the command line
		will not be available, and when U-Boot wants to execute the
		boot command (on start-up) it will call board_run_command()
		instead. This can reduce image size significantly for very
		simple boot procedures.

658
659
- Regular expression support:
		CONFIG_REGEX
660
661
662
663
		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".
664

665
666
667
668
669
670
671
672
- 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.

673
		U-Boot needs to get its device tree from somewhere. This can
674
		be done using one of the three options below:
675

676
677
678
679
680
681
682
683
684
685
686
687
		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.

688
689
690
691
692
693
		CONFIG_OF_BOARD
		If this variable is defined, U-Boot will use the device tree
		provided by the board at runtime instead of embedding one with
		the image. Only boards defining board_fdt_blob_setup() support
		this option (see include/fdtdec.h file).

wdenk's avatar
wdenk committed
694
695
696
- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
697
		support for the SoC. There must be support in the SoC
698
699
700
701
702
		specific code for a watchdog. For the 8xx
		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.
703
704
705
706
707

		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
708

709
710
711
712
713
714
715
716
717
		CONFIG_SYS_WATCHDOG_FREQ
		Some platforms automatically call WATCHDOG_RESET()
		from the timer interrupt handler every
		CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
		board configuration file, a default of CONFIG_SYS_HZ/2
		(i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
		to 0 disables calling WATCHDOG_RESET() from the timer
		interrupt.

wdenk's avatar
wdenk committed
718
719
- Real-Time Clock:

720
		When CONFIG_CMD_DATE is selected, the type of the RTC
wdenk's avatar
wdenk committed
721
722
723
724
		has to be selected, too. Define exactly one of the
		following options:

		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
725
		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
wdenk's avatar
wdenk committed
726
		CONFIG_RTC_MC146818	- use MC146818 RTC
wdenk's avatar
wdenk committed
727
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
728
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
729
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
730
		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
wdenk's avatar
wdenk committed
731
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
732
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
wdenk's avatar
wdenk committed
733
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
734
		CONFIG_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
735
736
		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
					  RV3029 RTC.
wdenk's avatar
wdenk committed
737

wdenk's avatar
wdenk committed
738
739
740
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

741
742
743
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO

744
745
746
747
		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.

748
749
750
		Note that if the GPIO device uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

Simon Glass's avatar
Simon Glass committed
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
- I/O tracing:
		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
		accesses and can checksum them or write a list of them out
		to memory. See the 'iotrace' command for details. This is
		useful for testing device drivers since it can confirm that
		the driver behaves the same way before and after a code
		change. Currently this is supported on sandbox and arm. To
		add support for your architecture, add '#include <iotrace.h>'
		to the bottom of arch/<arch>/include/asm/io.h and test.

		Example output from the 'iotrace stats' command is below.
		Note that if the trace buffer is exhausted, the checksum will
		still continue to operate.

			iotrace is enabled
			Start:  10000000	(buffer start address)
			Size:   00010000	(buffer size)
			Offset: 00000120	(current buffer offset)
			Output: 10000120	(start + offset)
			Count:  00000018	(number of trace records)
			CRC32:  9526fb66	(CRC32 of all trace records)

wdenk's avatar
wdenk committed
773
774
- Timestamp Support:

775
776
777
		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
778
		automatically enabled when you select CONFIG_CMD_DATE .
wdenk's avatar
wdenk committed
779

780
781
782
783
784
785
786
- Partition Labels (disklabels) Supported:
		Zero or more of the following:
		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
		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
787
		CONFIG_SCSI) you must configure support for at
788
		least one non-MTD partition type as well.
wdenk's avatar
wdenk committed
789
790

- IDE Reset method:
wdenk's avatar
wdenk committed
791
792
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
793

wdenk's avatar
wdenk committed
794
795
796
797
		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
798
799
800
801
802
803

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

804
805
806
807
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
808
		Also look at CONFIG_SYS_64BIT_LBA.
809
810
811
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

812
		CONFIG_SYS_64BIT_LBA:
813
814
815
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

wdenk's avatar
wdenk committed
816
- SCSI Support:
817
818
819
		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
820
821
822
		maximum numbers of LUNs, SCSI ID's and target
		devices.

823
824
		The environment variable 'scsidevs' is set to the number of
		SCSI devices found during the last scan.
825

wdenk's avatar
wdenk committed
826
- NETWORK Support (PCI):
827
		CONFIG_E1000
828
829
830
831
832
833
834
835
836
837
838
		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.

wdenk's avatar
wdenk committed
839
840
841
842
843
844
		CONFIG_NATSEMI
		Support for National dp83815 chips.

		CONFIG_NS8382X
		Support for National dp8382[01] gigabit chips.

wdenk's avatar
wdenk committed
845
- NETWORK Support (other):
Rob Herring's avatar
Rob Herring committed
846
847
848
		CONFIG_CALXEDA_XGMAC
		Support for the Calxeda XGMAC device

849
		CONFIG_LAN91C96
wdenk's avatar
wdenk committed
850
851
852
853
854
		Support for SMSC's LAN91C96 chips.

			CONFIG_LAN91C96_USE_32_BIT
			Define this to enable 32 bit addressing

855
		CONFIG_SMC91111
wdenk's avatar
wdenk committed
856
857
858
859
860
861
862
863
864
865
866
867
868
		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)

869
870
871
			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
			Define this if you have more then 3 PHYs.

872
873
874
875
876
877
878
879
880
881
882
883
		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.

884
885
886
887
888
889
890
891
892
		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

893
894
895
			CONFIG_SH_ETHER_CACHE_WRITEBACK
			If this option is set, the driver enables cache flush.

896
- TPM Support:
897
898
899
		CONFIG_TPM
		Support TPM devices.

900
901
		CONFIG_TPM_TIS_INFINEON
		Support for Infineon i2c bus TPM devices. Only one device
902
903
904
905
906
		per system is supported at this time.

			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
			Define the burst count bytes upper limit

907
908
909
910
911
912
913
		CONFIG_TPM_ST33ZP24
		Support for STMicroelectronics TPM devices. Requires DM_TPM support.

			CONFIG_TPM_ST33ZP24_I2C
			Support for STMicroelectronics ST33ZP24 I2C devices.
			Requires TPM_ST33ZP24 and I2C.

914
915
916
917
			CONFIG_TPM_ST33ZP24_SPI
			Support for STMicroelectronics ST33ZP24 SPI devices.
			Requires TPM_ST33ZP24 and SPI.

Dirk Eibach's avatar
Dirk Eibach committed
918
919
920
		CONFIG_TPM_ATMEL_TWI
		Support for Atmel TWI TPM device. Requires I2C support.

921
		CONFIG_TPM_TIS_LPC
922
923
924
925
926
927
928
929
		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.

930
931
932
933
934
935
936
937
938
		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
939
940
- USB Support:
		At the moment only the UHCI host controller is
941
		supported (PIP405, MIP405); define
wdenk's avatar
wdenk committed
942
943
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk's avatar
wdenk committed
944
		and define CONFIG_USB_STORAGE to enable the USB
wdenk's avatar
wdenk committed
945
946
947
948
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
wdenk's avatar
wdenk committed
949

950
951
952
		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
		txfilltuning field in the EHCI controller on reset.

953
954
955
		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
		HW module registers.

Wolfgang Denk's avatar
Wolfgang Denk committed
956
957
958
959
- 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
960
		attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk's avatar
Wolfgang Denk committed
961
962
		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
963
		appear to a USB host as a Linux gserial device or a
Wolfgang Denk's avatar
Wolfgang Denk committed
964
965
966
967
968
969
970
		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
971

Wolfgang Denk's avatar
Wolfgang Denk committed
972
973
974
975
976
977
			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
978

979
980
981
982
983
984
985
986
			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.

987
			CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk's avatar
Wolfgang Denk committed
988
989
990
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

Wolfgang Denk's avatar
Wolfgang Denk committed
991
		If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk's avatar
Wolfgang Denk committed
992
		define your own vendor specific values either in BoardName.h
Wolfgang Denk's avatar
Wolfgang Denk committed
993
		or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk's avatar
Wolfgang Denk committed
994
995
996
997
998
999
1000
		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
1001

Wolfgang Denk's avatar
Wolfgang Denk committed
1002
1003
1004
1005
1006
1007
1008
1009
1010
			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
1011

Wolfgang Denk's avatar
Wolfgang Denk committed
1012
1013
1014
1015
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
wdenk's avatar
wdenk committed
1016

1017
1018
1019
1020
1021
1022
1023
1024
- 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
1025
1026
1027
		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
1028

1029
- MMC Support:
wdenk's avatar
wdenk committed
1030
1031
1032
		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
1033
		to physical memory similar to flash. Command line is
1034
1035
		enabled with CONFIG_CMD_MMC. The MMC driver also works with
		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1036

1037
1038
1039
1040
1041
1042
1043
1044
1045
		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

1046
- USB Device Firmware Update (DFU) class support:
1047
		CONFIG_DFU_OVER_USB
1048
1049
		This enables the USB portion of the DFU USB class

1050
1051
1052
		CONFIG_DFU_NAND
		This enables support for exposing NAND devices via DFU.

Afzal Mohammed's avatar
Afzal Mohammed committed
1053
1054
1055
1056
1057
1058
		CONFIG_DFU_RAM
		This enables support for exposing RAM via DFU.
		Note: DFU spec refer to non-volatile memory usage, but
		allow usages beyond the scope of spec - here RAM usage,
		one that would help mostly the developer.

1059
1060
1061
1062
1063
1064
		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.

1065
1066
1067
1068
1069
1070
1071
		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.

1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
		DFU_DEFAULT_POLL_TIMEOUT
		Poll timeout [ms], is the timeout a device can send to the
		host. The host must wait for this timeout before sending
		a subsequent DFU_GET_STATUS request to the device.

		DFU_MANIFEST_POLL_TIMEOUT
		Poll timeout [ms], which the device sends to the host when
		entering dfuMANIFEST state. Host waits this timeout, before
		sending again an USB request to the device.

wdenk's avatar
wdenk committed
1082
- Journaling Flash filesystem support:
1083
		CONFIG_JFFS2_NAND
wdenk's avatar
wdenk committed
1084
1085
		Define these for a default partition on a NAND device

1086
1087
		CONFIG_SYS_JFFS2_FIRST_SECTOR,
		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk's avatar
wdenk committed
1088
1089
		Define these for a default partition on a NOR device

wdenk's avatar
wdenk committed
1090
- Keyboard Support:
1091
1092
1093
1094
1095
1096
1097
1098
1099
		See Kconfig help for available keyboard drivers.

		CONFIG_KEYBOARD

		Define this to enable a custom keyboard support.
		This simply calls drv_keyboard_init() which must be
		defined in your board-specific files. This option is deprecated
		and is only used by novena. For new boards, use driver model
		instead.
wdenk's avatar
wdenk committed
1100
1101

- Video support:
1102
		CONFIG_FSL_DIU_FB
Wolfgang Denk's avatar
Wolfgang Denk committed
1103
		Enable the Freescale DIU video driver.	Reference boards for
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
		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_CFB_CONSOLE
			CONFIG_VIDEO_SW_CURSOR
			CONFIG_VGA_AS_SINGLE_DEVICE
			CONFIG_VIDEO_LOGO
			CONFIG_VIDEO_BMP_LOGO

1115
1116
		The DIU driver will look for the 'video-mode' environment
		variable, and if defined, enable the DIU as a console during
1117
		boot.  See the documentation file doc/README.video for a
1118
		description of this variable.
1119

wdenk's avatar
wdenk committed
1120
1121
1122
1123
1124
1125
- 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
1126
1127
1128
1129
		CONFIG_ATMEL_LCD:

			HITACHI TX09D70VM1CCA, 3.5", 240x320.

wdenk's avatar
wdenk committed
1130
		CONFIG_NEC_NL6448AC33:
wdenk's avatar
wdenk committed
1131

wdenk's avatar
wdenk committed
1132
			NEC NL6448AC33-18. Active, color, single scan.
wdenk's avatar
wdenk committed
1133

wdenk's avatar
wdenk committed
1134
		CONFIG_NEC_NL6448BC20
wdenk's avatar
wdenk committed
1135

wdenk's avatar
wdenk committed
1136
1137
1138
1139
1140
1141
			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
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
			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.

1169
1170
		CONFIG_LCD_ALIGNMENT

1171
		Normally the LCD is page-aligned (typically 4KB). If this is
1172
1173
1174
1175
1176
1177
		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.


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
		CONFIG_LCD_ROTATION

		Sometimes, for example if the display is mounted in portrait
		mode or even if it's mounted landscape but rotated by 180degree,
		we need to rotate our content of the display relative to the
		framebuffer, so that user can read the messages which are
		printed out.
		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
		initialized with a given rotation from "vl_rot" out of
		"vidinfo_t" which is provided by the board specific code.
		The value for vl_rot is coded as following (matching to
		fbcon=rotate:<n> linux-kernel commandline):
		0 = no rotation respectively 0 degree
		1 = 90 degree rotation
		2 = 180 degree rotation
		3 = 270 degree rotation

		If CONFIG_LCD_ROTATION is not defined, the console will be
		initialized with 0degree rotation.

1198
1199
1200
1201
		CONFIG_LCD_BMP_RLE8

		Support drawing of RLE8-compressed bitmaps on the LCD.

1202
1203
1204
1205
1206
		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
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
- MII/PHY support:
		CONFIG_PHY_CLOCK_FREQ (ppc4xx)

		The clock frequency of the MII bus

		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
1224
1225
1226
1227
- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
1228
		the default Ethernet interface, in case this is not
wdenk's avatar
wdenk committed
1229
		determined through e.g. bootp.
1230
		(Environment variable "ipaddr")
wdenk's avatar
wdenk committed
1231
1232
1233
1234

- Server IP address:
		CONFIG_SERVERIP

1235
		Defines a default value for the IP address of a TFTP
wdenk's avatar
wdenk committed
1236
		server to contact when using the "tftboot" command.
1237
		(Environment variable "serverip")
wdenk's avatar
wdenk committed
1238

1239
1240
1241
1242
1243
		CONFIG_KEEP_SERVERADDR

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

1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
- 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")

wdenk's avatar
wdenk committed
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
- 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
1272
		following delays are inserted then:
wdenk's avatar
wdenk committed
1273
1274
1275
1276
1277
1278
1279

		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

1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
		CONFIG_BOOTP_ID_CACHE_SIZE

		BOOTP packets are uniquely identified using a 32-bit ID. The
		server will copy the ID from client requests to responses and
		U-Boot will use this to determine if it is the destination of
		an incoming response. Some servers will check that addresses
		aren't in use before handing them out (usually using an ARP
		ping) and therefore take up to a few hundred milliseconds to
		respond. Network congestion may also influence the time it
		takes for a response to make it back to the client. If that
		time is too long, U-Boot will retransmit requests. In order
		to allow earlier responses to still be accepted after these
		retransmissions, U-Boot's BOOTP client keeps a small cache of
		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
		cache. The default is to keep IDs for up to four outstanding
		requests. Increasing this will allow U-Boot to accept offers
		from a BOOTP client in networks with unusually high latency.

1298
- DHCP Advanced Options:
1299
1300
1301
1302
1303
1304
1305
1306
		You can fine tune the DHCP functionality by defining
		CONFIG_BOOTP_* symbols:

		CONFIG_BOOTP_NISDOMAIN
		CONFIG_BOOTP_BOOTFILESIZE
		CONFIG_BOOTP_NTPSERVER
		CONFIG_BOOTP_TIMEOFFSET
		CONFIG_BOOTP_VENDOREX
1307
		CONFIG_BOOTP_MAY_FAIL
1308

1309
1310
		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
		environment variable, not the BOOTP server.
1311

1312
1313
1314
1315
1316
1317
		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.

1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
		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.

1332
1333
1334
1335
1336
1337
1338
1339
 - 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.

1340
1341
1342
1343
1344
1345
1346
1347
1348
 - MAC address from environment variables

		FDT_SEQ_MACADDR_FROM_ENV

		Fix-up device tree with MAC addresses fetched sequentially from
		environment variables. This config work on assumption that
		non-usable ethernet node of device-tree are either not present
		or their status has been marked as "disabled".

1349
 - CDP Options:
wdenk's avatar
wdenk committed
1350
		CONFIG_CDP_DEVICE_ID
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362

		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
1363
		eth0 for the first Ethernet, eth1 for the second etc.
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390

		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.

1391
- Status LED:	CONFIG_LED_STATUS
wdenk's avatar
wdenk committed
1392
1393
1394
1395
1396
1397
1398

		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
1399
		kernel). Defining CONFIG_LED_STATUS enables this
wdenk's avatar
wdenk committed
1400
1401
		feature in U-Boot.

1402
1403
		Additional options:

1404
		CONFIG_LED_STATUS_GPIO
1405
1406
		The status LED can be connected to a GPIO pin.
		In such cases, the gpio_led driver can be used as a
1407
		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1408
1409
		to include the gpio_led driver in the U-Boot binary.

1410
1411
1412
1413
1414
1415
1416
		CONFIG_GPIO_LED_INVERTED_TABLE
		Some GPIO connected LEDs may have inverted polarity in which
		case the GPIO high value corresponds to LED off state and
		GPIO low value corresponds to LED on state.
		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
		with a list of GPIO LEDs that have inverted polarity.

1417
- I2C Support:
1418
		CONFIG_SYS_NUM_I2C_BUSES
1419
		Hold the number of i2c buses you want to use.
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431

		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
1432
		hold a list of buses you want to use, only used if
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
		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
1450
1451
1452
1453
1454
			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
1455
			bus 6 on adapter 1 without a mux
1456
1457
			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
1458
1459
1460

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

Simon Glass's avatar
Simon Glass committed
1461
- Legacy I2C Support:
1462
		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenk's avatar
wdenk committed
1463
1464
		then the following macros need to be defined (examples are
		from include/configs/lwmon.h):
wdenk's avatar
wdenk committed
1465
1466
1467

		I2C_INIT

wdenk's avatar
wdenk committed
1468
		(Optional). Any commands necessary to enable the I2C
1469
		controller or configure ports.
wdenk's avatar
wdenk committed
1470

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

wdenk's avatar
wdenk committed
1473
1474
1475
1476
1477
1478
		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
1479
1480
		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)

wdenk's avatar
wdenk committed
1481
1482
1483
1484
1485
1486
		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
1487
1488
		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)

wdenk's avatar
wdenk committed
1489
1490
		I2C_READ

York Sun's avatar
York Sun committed
1491
1492
		Code that returns true if the I2C data line is high,
		false if it is low.
wdenk's avatar
wdenk committed
1493

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

wdenk's avatar
wdenk committed
1496
1497
		I2C_SDA(bit)

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

wdenk's avatar
wdenk committed
1501
		eg: #define I2C_SDA(bit) \
wdenk's avatar
wdenk committed
1502
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
wdenk's avatar
wdenk committed
1503
			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenk's avatar
wdenk committed
1504

wdenk's avatar
wdenk committed
1505
1506
		I2C_SCL(bit)

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

wdenk's avatar
wdenk committed
1510
		eg: #define I2C_SCL(bit) \
wdenk's avatar
wdenk committed
1511
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
wdenk's avatar
wdenk committed
1512
			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenk's avatar
wdenk committed
1513

wdenk's avatar
wdenk committed
1514
1515
1516
1517
		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
1518
		is 1 / (I2C_DELAY * 4). Often defined to be something
1519
1520
		like:

wdenk's avatar
wdenk committed
1521
		#define I2C_DELAY  udelay(2)
wdenk's avatar
wdenk committed
1522

1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
		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.

1533
		CONFIG_SYS_I2C_INIT_BOARD
1534

wdenk's avatar
wdenk committed
1535
1536
1537
1538
1539
1540
1541
1542
		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.
1543

1544
1545
1546