README 219 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
38
39
40
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
41

42
43
44
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:
45
46
47

	make CHANGELOG

wdenk's avatar
wdenk committed
48
49
50
51

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

52
In case you have questions about, problems with or contributions for
53
U-Boot, you should send a message to the U-Boot mailing list at
54
55
56
57
<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
58
59


60
61
62
Where to get source code:
=========================

63
The U-Boot source code is maintained in the Git repository at
64
65
66
67
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
68
any version you might be interested in. Official releases are also
69
70
71
available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
directory.

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


wdenk's avatar
wdenk committed
76
77
78
79
Where we come from:
===================

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


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
115
116


wdenk's avatar
wdenk committed
117
118
119
Versioning:
===========

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


wdenk's avatar
wdenk committed
133
134
135
Directory Hierarchy:
====================

136
/arch			Architecture specific files
137
  /arc			Files generic to ARC architecture
138
139
140
141
142
143
  /arm			Files generic to ARM architecture
  /avr32		Files generic to AVR32 architecture
  /blackfin		Files generic to Analog Devices Blackfin architecture
  /m68k			Files generic to m68k architecture
  /microblaze		Files generic to microblaze architecture
  /mips			Files generic to MIPS architecture
144
  /nds32		Files generic to NDS32 architecture
145
  /nios2		Files generic to Altera NIOS2 architecture
146
  /openrisc		Files generic to OpenRISC architecture
Stefan Roese's avatar
Stefan Roese committed
147
  /powerpc		Files generic to PowerPC architecture
148
  /sandbox		Files generic to HW-independent "sandbox"
149
150
  /sh			Files generic to SH architecture
  /sparc		Files generic to SPARC architecture
151
  /x86			Files generic to x86 architecture
152
153
/api			Machine/arch independent API for external apps
/board			Board dependent files
154
/cmd			U-Boot commands functions
155
/common			Misc architecture independent functions
156
/configs		Board default configuration files
157
158
159
/disk			Code for disk drive partition handling
/doc			Documentation (don't expect too much)
/drivers		Commonly used device drivers
160
/dts			Contains Makefile for building internal U-Boot fdt.
161
162
163
/examples		Example code for standalone applications, etc.
/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
/include		Header Files
164
165
/lib			Library routines generic to all architectures
/Licenses		Various license files
166
167
/net			Networking code
/post			Power On Self Test
168
169
/scripts		Various build scripts and Makefiles
/test			Various unit test files
170
/tools			Tools to build S-Record or U-Boot images, etc.
wdenk's avatar
wdenk committed
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

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

189
190
191
192
193
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
194
195
196
197
198
199


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

For all supported boards there are ready-to-use default
200
configurations available; just type "make <board_name>_defconfig".
wdenk's avatar
wdenk committed
201
202
203
204

Example: For a TQM823L module type:

	cd u-boot
205
	make TQM823L_defconfig
wdenk's avatar
wdenk committed
206

207
208
209
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
210

211
212
213
214
215
216
217
218
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.

219
See board/sandbox/README.sandbox for more details.
220
221


222
223
224
225
Board Initialisation Flow:
--------------------------

This is the intended start-up flow for boards. This should apply for both
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
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
242

243
244
and so on. From there, three functions are called; the purpose and
limitations of each of these functions are described below.
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302

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
	- these is no need to clear BSS, it will be done by crt0.S
	- 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
		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
		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
318
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
319
320
The following options need to be configured:

321
322
323
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

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

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
326
		Define exactly one, e.g. CONFIG_ATSTK1002
wdenk's avatar
wdenk committed
327

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

333
- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk's avatar
wdenk committed
334
335
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
wdenk's avatar
wdenk committed
336
337
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
wdenk's avatar
wdenk committed
338
339
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
wdenk's avatar
wdenk committed
340

wdenk's avatar
wdenk committed
341
- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
342
343
		CONFIG_SYS_8xx_CPUCLK_MIN
		CONFIG_SYS_8xx_CPUCLK_MAX
wdenk's avatar
wdenk committed
344
		CONFIG_8xx_CPUCLK_DEFAULT
345
346
			See doc/README.MPC866

347
		CONFIG_SYS_MEASURE_CPUCLK
348

wdenk's avatar
wdenk committed
349
350
351
352
353
		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
354
		RTC clock or CONFIG_SYS_8XX_XIN)
355

356
357
358
359
360
		CONFIG_SYS_DELAYED_ICACHE

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

361
- 85xx CPU Options:
362
363
364
365
366
367
		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.

368
369
370
371
372
373
		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.

374
375
376
377
378
		CONFIG_SYS_FSL_PCIE_COMPAT

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

379
380
381
382
383
384
385
386
387
		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.

388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
		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.

408
409
		CONFIG_A003399_NOR_WORKAROUND
		Enables a workaround for IFC erratum A003399. It is only
410
		required during NOR boot.
411

412
413
		CONFIG_A008044_WORKAROUND
		Enables a workaround for T1040/T1042 erratum A008044. It is only
414
		required during NAND boot and valid for Rev 1.0 SoC revision
415

416
417
418
419
420
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY

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

421
422
423
424
		CONFIG_SYS_FSL_DSP_DDR_ADDR
		This value denotes start offset of DDR memory which is
		connected exclusively to the DSP cores.

425
426
427
428
		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
		This value denotes start offset of M2 memory
		which is directly connected to the DSP core.

429
430
431
432
		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
		This value denotes start offset of M3 memory which is directly
		connected to the DSP core.

433
434
435
		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
		This value denotes start offset of DSP CCSR space.

436
437
438
439
440
		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.

441
442
		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
443
		time of U-Boot entry and is required to be re-initialized.
444

445
		CONFIG_DEEP_SLEEP
446
		Indicates this SoC supports deep sleep feature. If deep sleep is
447
448
		supported, core will start to execute uboot when wakes up.

449
- Generic CPU options:
450
451
452
453
454
455
		CONFIG_SYS_GENERIC_GLOBAL_DATA
		Defines global data is initialized in generic board board_init_f().
		If this macro is defined, global data is created and cleared in
		generic board board_init_f(). Without this macro, architecture/board
		should initialize global data before calling board_init_f().

456
457
458
459
460
		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN

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

461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
		CONFIG_SYS_FSL_DDR
		Freescale DDR driver in use. This type of DDR controller is
		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
		SoCs.

		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.

482
483
484
		CONFIG_SYS_FSL_DDRC_GEN4
		Freescale DDR4 controller.

485
486
487
		CONFIG_SYS_FSL_DDRC_ARM_GEN3
		Freescale DDR3 controller for ARM-based SoCs.

488
489
490
491
492
493
		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
494
		Board config to use DDR2. It can be enabled for SoCs with
495
496
497
498
499
		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
500
501
502
503
504
505
506
507
508
		Freescale DDR3 or DDR3L controllers.

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

		CONFIG_SYS_FSL_DDR4
		Board config to use DDR4. It can be enabled for SoCs with
		DDR4 controllers.
509

510
511
512
513
514
515
		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

516
517
518
519
520
521
522
523
524
		CONFIG_SYS_FSL_PBL_PBI
		It enables addition of RCW (Power on reset configuration) in built image.
		Please refer doc/README.pblimage for more details

		CONFIG_SYS_FSL_PBL_RCW
		It adds PBI(pre-boot instructions) commands in u-boot build image.
		PBI commands can be used to configure SoC before it starts the execution.
		Please refer doc/README.pblimage for more details

525
526
527
528
		CONFIG_SPL_FSL_PBL
		It adds a target to create boot binary having SPL binary in PBI format
		concatenated with u-boot binary.

529
530
531
532
533
534
		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

535
536
537
538
539
		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.

540
541
542
543
544
		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.

545
546
547
548
549
550
		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.

551
552
553
		CONFIG_SYS_FSL_HAS_DP_DDR
		Defines the SoC has DP-DDR used for DPAA.

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

560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
- 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.

592
593
594
595
596
597
- 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
598
599
600
601
602
603
604
605
		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.

606
		CONFIG_ARM_ERRATA_716044
607
608
609
		CONFIG_ARM_ERRATA_742230
		CONFIG_ARM_ERRATA_743622
		CONFIG_ARM_ERRATA_751472
610
		CONFIG_ARM_ERRATA_761320
611
612
613
		CONFIG_ARM_ERRATA_773022
		CONFIG_ARM_ERRATA_774769
		CONFIG_ARM_ERRATA_794072
614
615
616
617
618
619
620

		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!

621
622
623
624
625
626
627
628
		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.

629
630
631
		NOTE: The following can be machine specific errata. These
		do have ability to provide rudimentary version and machine
		specific checks, but expect no product checks.
632
		CONFIG_ARM_ERRATA_430973
633
		CONFIG_ARM_ERRATA_454179
634
		CONFIG_ARM_ERRATA_621766
635
		CONFIG_ARM_ERRATA_798870
636
		CONFIG_ARM_ERRATA_801819
637

638
639
640
641
642
643
644
- 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
645
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
646
647
648
649
650
651
652
653
654
655
		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
656
		"clocks_in_mhz=1" is automatically included in the
wdenk's avatar
wdenk committed
657
658
		default environment.

wdenk's avatar
wdenk committed
659
660
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

661
		When transferring memsize parameter to Linux, some versions
wdenk's avatar
wdenk committed
662
663
664
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

665
		CONFIG_OF_LIBFDT
666
667

		New kernel versions are expecting firmware settings to be
668
669
670
671
672
673
		passed using flattened device trees (based on open firmware
		concepts).

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

676
677
678
679
		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).
680
		OF_TBCLK - The timebase frequency.
Kumar Gala's avatar
Kumar Gala committed
681
		OF_STDOUT_PATH - The path to the console device
682

683
684
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
685

686
687
688
689
		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
690

691
692
693
694
695
696
697
		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.

698
699
700
701
702
703
704
705
706
		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.

707
708
709
710
711
712
713
714
715
716
		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.

717
718
719
- vxWorks boot parameters:

		bootvx constructs a valid bootline using the following
720
721
		environments variables: bootdev, bootfile, ipaddr, netmask,
		serverip, gatewayip, hostname, othbootargs.
722
723
724
725
726
		It loads the vxWorks image pointed bootfile.

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

727
728
729
730
731
- 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
732
733
734
735
736
737
- 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
738
- Serial Ports:
739
		CONFIG_PL010_SERIAL
wdenk's avatar
wdenk committed
740
741
742

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

743
		CONFIG_PL011_SERIAL
wdenk's avatar
wdenk committed
744
745
746
747
748
749
750
751
752
753
754
755
756
757

		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

758
759
760
761
		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
762

wdenk's avatar
wdenk committed
763
- Console Interface:
764
765
766
767
		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
768
769
770
771
772
773
774
775

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

- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
776
777
		CONFIG_SYS_BAUDRATE_TABLE, see below.
		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenk's avatar
wdenk committed
778

779
780
781
- Console Rx buffer length
		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
		the maximum receive buffer length for the SMC.
782
		This option is actual only for 82xx and 8xx possible.
783
784
785
786
		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
		must be defined, to setup the maximum idle timeout for
		the SMC.

wdenk's avatar
wdenk committed
787
788
789
790
791
792
793
794
- 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
795
796
797
		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
798
799

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
800
801
802
		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
803
		RAM and NFS.
wdenk's avatar
wdenk committed
804

805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
- Bootcount:
		CONFIG_BOOTCOUNT_LIMIT
		Implements a mechanism for detecting a repeating reboot
		cycle, see:
		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit

		CONFIG_BOOTCOUNT_ENV
		If no softreset save registers are found on the hardware
		"bootcount" is stored in the environment. To prevent a
		saveenv on all reboots, the environment variable
		"upgrade_available" is used. If "upgrade_available" is
		0, "bootcount" is always 0, if "upgrade_available" is
		1 "bootcount" is incremented in the environment.
		So the Userspace Applikation must set the "upgrade_available"
		and "bootcount" variable to 0, if a boot was successfully.

wdenk's avatar
wdenk committed
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
- 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.

846
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenk's avatar
wdenk committed
847
848
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
849
		CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
850
851

- Monitor Functions:
852
853
		Monitor commands can be included or excluded
		from the build by using the #include files
854
		<config_cmd_all.h> and #undef'ing unwanted
855
		commands, or adding #define's for wanted commands.
856
857
858
859

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

860
		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
861
862
863
864
865
866
		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
867
		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
868
		CONFIG_CMD_CACHE	* icache, dcache
Michal Simek's avatar
Michal Simek committed
869
		CONFIG_CMD_CLK   	* clock command support
870
		CONFIG_CMD_CONSOLE	  coninfo
Mike Frysinger's avatar
Mike Frysinger committed
871
		CONFIG_CMD_CRC32	* crc32
872
873
874
		CONFIG_CMD_DATE		* support for RTC, date/time...
		CONFIG_CMD_DHCP		* DHCP support
		CONFIG_CMD_DIAG		* Diagnostics
875
876
877
878
		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
879
880
		CONFIG_CMD_DTT		* Digital Therm and Thermostat
		CONFIG_CMD_ECHO		  echo arguments
Peter Tyser's avatar
Peter Tyser committed
881
		CONFIG_CMD_EDITENV	  edit env variable
882
		CONFIG_CMD_EEPROM	* EEPROM read/write support
883
		CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
884
		CONFIG_CMD_ELF		* bootelf, bootvx
885
		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
886
		CONFIG_CMD_ENV_FLAGS	* display details about env flags
887
		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
888
		CONFIG_CMD_EXPORTENV	* export the environment
889
890
		CONFIG_CMD_EXT2		* ext2 command support
		CONFIG_CMD_EXT4		* ext4 command support
891
892
		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
					  that work for multiple fs types
893
		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
894
		CONFIG_CMD_SAVEENV	  saveenv
895
		CONFIG_CMD_FDC		* Floppy Disk Support
896
		CONFIG_CMD_FAT		* FAT command support
897
898
		CONFIG_CMD_FLASH	  flinfo, erase, protect
		CONFIG_CMD_FPGA		  FPGA device initialization support
899
		CONFIG_CMD_FUSE		* Device fuse support
Anton Staaf's avatar
Anton Staaf committed
900
		CONFIG_CMD_GETTIME	* Get time since boot
Mike Frysinger's avatar
Mike Frysinger committed
901
		CONFIG_CMD_GO		* the 'go' command (exec code)
Kim Phillips's avatar
Kim Phillips committed
902
		CONFIG_CMD_GREPENV	* search environment
903
		CONFIG_CMD_HASH		* calculate hash / digest
904
905
906
		CONFIG_CMD_I2C		* I2C serial bus support
		CONFIG_CMD_IDE		* IDE harddisk support
		CONFIG_CMD_IMI		  iminfo
907
		CONFIG_CMD_IMLS		  List all images found in NOR flash
908
		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
909
		CONFIG_CMD_IMMAP	* IMMR dump support
Simon Glass's avatar
Simon Glass committed
910
		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
911
		CONFIG_CMD_IMPORTENV	* import an environment
Joe Hershberger's avatar
Joe Hershberger committed
912
		CONFIG_CMD_INI		* import data from an ini file into the env
913
914
915
916
		CONFIG_CMD_IRQ		* irqinfo
		CONFIG_CMD_ITEST	  Integer/string test of 2 values
		CONFIG_CMD_JFFS2	* JFFS2 Support
		CONFIG_CMD_KGDB		* kgdb
917
		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
918
919
		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
					  (169.254.*.*)
920
921
		CONFIG_CMD_LOADB	  loadb
		CONFIG_CMD_LOADS	  loads
922
		CONFIG_CMD_MD5SUM	* print md5 message digest
Robin Getz's avatar
Robin Getz committed
923
					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
924
		CONFIG_CMD_MEMINFO	* Display detailed memory information
925
		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
926
					  loop, loopw
927
		CONFIG_CMD_MEMTEST	* mtest
928
929
930
		CONFIG_CMD_MISC		  Misc functions like sleep etc
		CONFIG_CMD_MMC		* MMC memory mapped support
		CONFIG_CMD_MII		* MII utility commands
931
		CONFIG_CMD_MTDPARTS	* MTD partition support
932
933
		CONFIG_CMD_NAND		* NAND support
		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
934
		CONFIG_CMD_NFS		  NFS support
935
		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
Wolfgang Denk's avatar
Wolfgang Denk committed
936
		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
937
938
939
940
941
		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
942
		CONFIG_CMD_READ		* Read raw data from partition
943
944
		CONFIG_CMD_REGINFO	* Register dump
		CONFIG_CMD_RUN		  run command in env variable
945
		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
946
		CONFIG_CMD_SAVES	* save S record dump
947
		CONFIG_SCSI		* SCSI Support
948
949
950
951
		CONFIG_CMD_SDRAM	* print SDRAM configuration information
					  (requires CONFIG_CMD_I2C)
		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
					  (4xx only)
952
		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
953
		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
Robin Getz's avatar
Robin Getz committed
954
					  (requires CONFIG_CMD_MEMORY)
955
		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
956
		CONFIG_CMD_SOURCE	  "source" command Support
957
		CONFIG_CMD_SPI		* SPI serial bus support
Luca Ceresoli's avatar
Luca Ceresoli committed
958
		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
959
		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
960
961
		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
		CONFIG_CMD_TIMER	* access to the system tick timer
962
963
		CONFIG_CMD_USB		* USB support
		CONFIG_CMD_CDP		* Cisco Discover Protocol support
964
		CONFIG_CMD_MFSL		* Microblaze FSL support
965
		CONFIG_CMD_XIMG		  Load part of Multi Image
966
		CONFIG_CMD_UUID		* Generate random UUID or GUID string
wdenk's avatar
wdenk committed
967
968
969
970

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

971
972
		#include "config_cmd_all.h"
		#undef CONFIG_CMD_NET
wdenk's avatar
wdenk committed
973

974
975
	Other Commands:
		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenk's avatar
wdenk committed
976
977

	Note:	Don't enable the "icache" and "dcache" commands
978
		(configuration option CONFIG_CMD_CACHE) unless you know
979
980
981
982
983
984
		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
985
986
987
988


		XXX - this list needs to get updated!

989
990
991
992
993
994
995
996
- 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.

997
998
- Regular expression support:
		CONFIG_REGEX
999
1000
		If this variable is defined, U-Boot is linked against
		the SLRE (Super Light Regular Expression) library,
For faster browsing, not all history is shown. View entire blame