]> git.ipfire.org Git - people/ms/u-boot.git/blame - README
efi_loader: correct efi_disk_register
[people/ms/u-boot.git] / README
CommitLineData
c609719b 1#
eca3aeb3 2# (C) Copyright 2000 - 2013
c609719b
WD
3# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
eca3aeb3 5# SPDX-License-Identifier: GPL-2.0+
c609719b
WD
6#
7
8Summary:
9========
10
24ee89b9 11This directory contains the source code for U-Boot, a boot loader for
e86e5a07
WD
12Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
c609719b
WD
16
17The development of U-Boot is closely related to Linux: some parts of
24ee89b9
WD
18the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
c609719b
WD
20support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
24ee89b9 34Makefile have been tested to some extent and can be considered
c609719b
WD
35"working". In fact, many of them are used in production systems.
36
7207b366
RD
37In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
c609719b 41
7207b366
RD
42Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
adb9d851
RD
45
46 make CHANGELOG
47
c609719b
WD
48
49Where to get help:
50==================
51
24ee89b9 52In case you have questions about, problems with or contributions for
7207b366 53U-Boot, you should send a message to the U-Boot mailing list at
0c32565f
PT
54<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
c609719b
WD
58
59
218ca724
WD
60Where to get source code:
61=========================
62
7207b366 63The U-Boot source code is maintained in the Git repository at
218ca724
WD
64git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
11ccc33f 68any version you might be interested in. Official releases are also
218ca724
WD
69available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
d4ee711d 72Pre-built (and tested) images are available from
218ca724
WD
73ftp://ftp.denx.de/pub/u-boot/images/
74
75
c609719b
WD
76Where we come from:
77===================
78
79- start from 8xxrom sources
24ee89b9 80- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
c609719b
WD
81- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
11ccc33f 88 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
24ee89b9 89- create ARMBoot project (http://sourceforge.net/projects/armboot)
c609719b 90- add other CPU families (starting with ARM)
24ee89b9 91- create U-Boot project (http://sourceforge.net/projects/u-boot)
0d28f34b 92- current project page: see http://www.denx.de/wiki/U-Boot
24ee89b9
WD
93
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
c609719b
WD
115
116
93f19cc0
WD
117Versioning:
118===========
119
360d883a
TW
120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
126
127Examples:
c0f40859 128 U-Boot v2009.11 - Release November 2009
360d883a 129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
0de21ecb 130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
93f19cc0
WD
131
132
c609719b
WD
133Directory Hierarchy:
134====================
135
8d321b81 136/arch Architecture specific files
6eae68e4 137 /arc Files generic to ARC architecture
8d321b81 138 /arm Files generic to ARM architecture
8d321b81 139 /m68k Files generic to m68k architecture
8d321b81 140 /microblaze Files generic to microblaze architecture
8d321b81 141 /mips Files generic to MIPS architecture
afc1ce82 142 /nds32 Files generic to NDS32 architecture
8d321b81 143 /nios2 Files generic to Altera NIOS2 architecture
33c7731b 144 /openrisc Files generic to OpenRISC architecture
a47a12be 145 /powerpc Files generic to PowerPC architecture
3fafced7 146 /riscv Files generic to RISC-V architecture
7207b366 147 /sandbox Files generic to HW-independent "sandbox"
8d321b81 148 /sh Files generic to SH architecture
33c7731b 149 /x86 Files generic to x86 architecture
8d321b81
PT
150/api Machine/arch independent API for external apps
151/board Board dependent files
740f7e5c 152/cmd U-Boot commands functions
8d321b81 153/common Misc architecture independent functions
7207b366 154/configs Board default configuration files
8d321b81
PT
155/disk Code for disk drive partition handling
156/doc Documentation (don't expect too much)
157/drivers Commonly used device drivers
33c7731b 158/dts Contains Makefile for building internal U-Boot fdt.
8d321b81
PT
159/examples Example code for standalone applications, etc.
160/fs Filesystem code (cramfs, ext2, jffs2, etc.)
161/include Header Files
7207b366
RD
162/lib Library routines generic to all architectures
163/Licenses Various license files
8d321b81
PT
164/net Networking code
165/post Power On Self Test
7207b366
RD
166/scripts Various build scripts and Makefiles
167/test Various unit test files
8d321b81 168/tools Tools to build S-Record or U-Boot images, etc.
c609719b 169
c609719b
WD
170Software Configuration:
171=======================
172
173Configuration is usually done using C preprocessor defines; the
174rationale behind that is to avoid dead code whenever possible.
175
176There are two classes of configuration variables:
177
178* Configuration _OPTIONS_:
179 These are selectable by the user and have names beginning with
180 "CONFIG_".
181
182* Configuration _SETTINGS_:
183 These depend on the hardware etc. and should not be meddled with if
184 you don't know what you're doing; they have names beginning with
6d0f6bcf 185 "CONFIG_SYS_".
c609719b 186
7207b366
RD
187Previously, all configuration was done by hand, which involved creating
188symbolic links and editing configuration files manually. More recently,
189U-Boot has added the Kbuild infrastructure used by the Linux kernel,
190allowing you to use the "make menuconfig" command to configure your
191build.
c609719b
WD
192
193
194Selection of Processor Architecture and Board Type:
195---------------------------------------------------
196
197For all supported boards there are ready-to-use default
ab584d67 198configurations available; just type "make <board_name>_defconfig".
c609719b
WD
199
200Example: For a TQM823L module type:
201
202 cd u-boot
ab584d67 203 make TQM823L_defconfig
c609719b 204
7207b366
RD
205Note: If you're looking for the default configuration file for a board
206you're sure used to be there but is now missing, check the file
207doc/README.scrapyard for a list of no longer supported boards.
c609719b 208
75b3c3aa
SG
209Sandbox Environment:
210--------------------
211
212U-Boot can be built natively to run on a Linux host using the 'sandbox'
213board. This allows feature development which is not board- or architecture-
214specific to be undertaken on a native platform. The sandbox is also used to
215run some of U-Boot's tests.
216
6b1978f8 217See board/sandbox/README.sandbox for more details.
75b3c3aa
SG
218
219
db910353
SG
220Board Initialisation Flow:
221--------------------------
222
223This is the intended start-up flow for boards. This should apply for both
7207b366
RD
224SPL and U-Boot proper (i.e. they both follow the same rules).
225
226Note: "SPL" stands for "Secondary Program Loader," which is explained in
227more detail later in this file.
228
229At present, SPL mostly uses a separate code path, but the function names
230and roles of each function are the same. Some boards or architectures
231may not conform to this. At least most ARM boards which use
232CONFIG_SPL_FRAMEWORK conform to this.
233
234Execution typically starts with an architecture-specific (and possibly
235CPU-specific) start.S file, such as:
236
237 - arch/arm/cpu/armv7/start.S
238 - arch/powerpc/cpu/mpc83xx/start.S
239 - arch/mips/cpu/start.S
db910353 240
7207b366
RD
241and so on. From there, three functions are called; the purpose and
242limitations of each of these functions are described below.
db910353
SG
243
244lowlevel_init():
245 - purpose: essential init to permit execution to reach board_init_f()
246 - no global_data or BSS
247 - there is no stack (ARMv7 may have one but it will soon be removed)
248 - must not set up SDRAM or use console
249 - must only do the bare minimum to allow execution to continue to
250 board_init_f()
251 - this is almost never needed
252 - return normally from this function
253
254board_init_f():
255 - purpose: set up the machine ready for running board_init_r():
256 i.e. SDRAM and serial UART
257 - global_data is available
258 - stack is in SRAM
259 - BSS is not available, so you cannot use global/static variables,
260 only stack variables and global_data
261
262 Non-SPL-specific notes:
263 - dram_init() is called to set up DRAM. If already done in SPL this
264 can do nothing
265
266 SPL-specific notes:
267 - you can override the entire board_init_f() function with your own
268 version as needed.
269 - preloader_console_init() can be called here in extremis
270 - should set up SDRAM, and anything needed to make the UART work
271 - these is no need to clear BSS, it will be done by crt0.S
272 - must return normally from this function (don't call board_init_r()
273 directly)
274
275Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
276this point the stack and global_data are relocated to below
277CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
278memory.
279
280board_init_r():
281 - purpose: main execution, common code
282 - global_data is available
283 - SDRAM is available
284 - BSS is available, all static/global variables can be used
285 - execution eventually continues to main_loop()
286
287 Non-SPL-specific notes:
288 - U-Boot is relocated to the top of memory and is now running from
289 there.
290
291 SPL-specific notes:
292 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
293 CONFIG_SPL_STACK_R_ADDR points into SDRAM
294 - preloader_console_init() can be called here - typically this is
0680f1b1 295 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
db910353
SG
296 spl_board_init() function containing this call
297 - loads U-Boot or (in falcon mode) Linux
298
299
300
c609719b
WD
301Configuration Options:
302----------------------
303
304Configuration depends on the combination of board and CPU type; all
305such information is kept in a configuration file
306"include/configs/<board_name>.h".
307
308Example: For a TQM823L module, all configuration settings are in
309"include/configs/TQM823L.h".
310
311
7f6c2cbc
WD
312Many of the options are named exactly as the corresponding Linux
313kernel configuration options. The intention is to make it easier to
314build a config tool - later.
315
63b2316c
AK
316- ARM Platform Bus Type(CCI):
317 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
318 provides full cache coherency between two clusters of multi-core
319 CPUs and I/O coherency for devices and I/O masters
320
321 CONFIG_SYS_FSL_HAS_CCI400
322
323 Defined For SoC that has cache coherent interconnect
324 CCN-400
7f6c2cbc 325
c055cee1
AK
326 CONFIG_SYS_FSL_HAS_CCN504
327
328 Defined for SoC that has cache coherent interconnect CCN-504
329
c609719b
WD
330The following options need to be configured:
331
2628114e
KP
332- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
333
334- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec449 335
cf946c6d
LW
336- Marvell Family Member
337 CONFIG_SYS_MVFS - define it if you want to enable
338 multiple fs option at one time
339 for marvell soc family
340
66412c63 341- 85xx CPU Options:
ffd06e02
YS
342 CONFIG_SYS_PPC64
343
344 Specifies that the core is a 64-bit PowerPC implementation (implements
345 the "64" category of the Power ISA). This is necessary for ePAPR
346 compliance, among other possible reasons.
347
66412c63
KG
348 CONFIG_SYS_FSL_TBCLK_DIV
349
350 Defines the core time base clock divider ratio compared to the
351 system clock. On most PQ3 devices this is 8, on newer QorIQ
352 devices it can be 16 or 32. The ratio varies from SoC to Soc.
353
8f29084a
KG
354 CONFIG_SYS_FSL_PCIE_COMPAT
355
356 Defines the string to utilize when trying to match PCIe device
357 tree nodes for the given platform.
358
33eee330
SW
359 CONFIG_SYS_FSL_ERRATUM_A004510
360
361 Enables a workaround for erratum A004510. If set,
362 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
363 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
364
365 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
366 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
367
368 Defines one or two SoC revisions (low 8 bits of SVR)
369 for which the A004510 workaround should be applied.
370
371 The rest of SVR is either not relevant to the decision
372 of whether the erratum is present (e.g. p2040 versus
373 p2041) or is implied by the build target, which controls
374 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
375
376 See Freescale App Note 4493 for more information about
377 this erratum.
378
74fa22ed
PK
379 CONFIG_A003399_NOR_WORKAROUND
380 Enables a workaround for IFC erratum A003399. It is only
b445bbb4 381 required during NOR boot.
74fa22ed 382
9f074e67
PK
383 CONFIG_A008044_WORKAROUND
384 Enables a workaround for T1040/T1042 erratum A008044. It is only
b445bbb4 385 required during NAND boot and valid for Rev 1.0 SoC revision
9f074e67 386
33eee330
SW
387 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
388
389 This is the value to write into CCSR offset 0x18600
390 according to the A004510 workaround.
391
64501c66
PJ
392 CONFIG_SYS_FSL_DSP_DDR_ADDR
393 This value denotes start offset of DDR memory which is
394 connected exclusively to the DSP cores.
395
765b0bdb
PJ
396 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
397 This value denotes start offset of M2 memory
398 which is directly connected to the DSP core.
399
64501c66
PJ
400 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
401 This value denotes start offset of M3 memory which is directly
402 connected to the DSP core.
403
765b0bdb
PJ
404 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
405 This value denotes start offset of DSP CCSR space.
406
b135991a
PJ
407 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
408 Single Source Clock is clocking mode present in some of FSL SoC's.
409 In this mode, a single differential clock is used to supply
410 clocks to the sysclock, ddrclock and usbclock.
411
fb4a2409
AB
412 CONFIG_SYS_CPC_REINIT_F
413 This CONFIG is defined when the CPC is configured as SRAM at the
a187559e 414 time of U-Boot entry and is required to be re-initialized.
fb4a2409 415
aade2004 416 CONFIG_DEEP_SLEEP
b445bbb4 417 Indicates this SoC supports deep sleep feature. If deep sleep is
aade2004
TY
418 supported, core will start to execute uboot when wakes up.
419
6cb461b4
DS
420- Generic CPU options:
421 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
422
423 Defines the endianess of the CPU. Implementation of those
424 values is arch specific.
425
5614e71b
YS
426 CONFIG_SYS_FSL_DDR
427 Freescale DDR driver in use. This type of DDR controller is
428 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
429 SoCs.
430
431 CONFIG_SYS_FSL_DDR_ADDR
432 Freescale DDR memory-mapped register base.
433
434 CONFIG_SYS_FSL_DDR_EMU
435 Specify emulator support for DDR. Some DDR features such as
436 deskew training are not available.
437
438 CONFIG_SYS_FSL_DDRC_GEN1
439 Freescale DDR1 controller.
440
441 CONFIG_SYS_FSL_DDRC_GEN2
442 Freescale DDR2 controller.
443
444 CONFIG_SYS_FSL_DDRC_GEN3
445 Freescale DDR3 controller.
446
34e026f9
YS
447 CONFIG_SYS_FSL_DDRC_GEN4
448 Freescale DDR4 controller.
449
9ac4ffbd
YS
450 CONFIG_SYS_FSL_DDRC_ARM_GEN3
451 Freescale DDR3 controller for ARM-based SoCs.
452
5614e71b
YS
453 CONFIG_SYS_FSL_DDR1
454 Board config to use DDR1. It can be enabled for SoCs with
455 Freescale DDR1 or DDR2 controllers, depending on the board
456 implemetation.
457
458 CONFIG_SYS_FSL_DDR2
62a3b7dd 459 Board config to use DDR2. It can be enabled for SoCs with
5614e71b
YS
460 Freescale DDR2 or DDR3 controllers, depending on the board
461 implementation.
462
463 CONFIG_SYS_FSL_DDR3
464 Board config to use DDR3. It can be enabled for SoCs with
34e026f9
YS
465 Freescale DDR3 or DDR3L controllers.
466
467 CONFIG_SYS_FSL_DDR3L
468 Board config to use DDR3L. It can be enabled for SoCs with
469 DDR3L controllers.
470
471 CONFIG_SYS_FSL_DDR4
472 Board config to use DDR4. It can be enabled for SoCs with
473 DDR4 controllers.
5614e71b 474
1b4175d6
PK
475 CONFIG_SYS_FSL_IFC_BE
476 Defines the IFC controller register space as Big Endian
477
478 CONFIG_SYS_FSL_IFC_LE
479 Defines the IFC controller register space as Little Endian
480
1c40707e
PK
481 CONFIG_SYS_FSL_IFC_CLK_DIV
482 Defines divider of platform clock(clock input to IFC controller).
483
add63f94
PK
484 CONFIG_SYS_FSL_LBC_CLK_DIV
485 Defines divider of platform clock(clock input to eLBC controller).
486
690e4258
PK
487 CONFIG_SYS_FSL_PBL_PBI
488 It enables addition of RCW (Power on reset configuration) in built image.
489 Please refer doc/README.pblimage for more details
490
491 CONFIG_SYS_FSL_PBL_RCW
492 It adds PBI(pre-boot instructions) commands in u-boot build image.
493 PBI commands can be used to configure SoC before it starts the execution.
494 Please refer doc/README.pblimage for more details
495
89ad7be8
PK
496 CONFIG_SPL_FSL_PBL
497 It adds a target to create boot binary having SPL binary in PBI format
498 concatenated with u-boot binary.
499
4e5b1bd0
YS
500 CONFIG_SYS_FSL_DDR_BE
501 Defines the DDR controller register space as Big Endian
502
503 CONFIG_SYS_FSL_DDR_LE
504 Defines the DDR controller register space as Little Endian
505
6b9e309a
YS
506 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
507 Physical address from the view of DDR controllers. It is the
508 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
509 it could be different for ARM SoCs.
510
6b1e1254
YS
511 CONFIG_SYS_FSL_DDR_INTLV_256B
512 DDR controller interleaving on 256-byte. This is a special
513 interleaving mode, handled by Dickens for Freescale layerscape
514 SoCs with ARM core.
515
1d71efbb
YS
516 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
517 Number of controllers used as main memory.
518
519 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
520 Number of controllers used for other than main memory.
521
44937214
PK
522 CONFIG_SYS_FSL_HAS_DP_DDR
523 Defines the SoC has DP-DDR used for DPAA.
524
028dbb8d
RG
525 CONFIG_SYS_FSL_SEC_BE
526 Defines the SEC controller register space as Big Endian
527
528 CONFIG_SYS_FSL_SEC_LE
529 Defines the SEC controller register space as Little Endian
530
92bbd64e
DS
531- MIPS CPU options:
532 CONFIG_SYS_INIT_SP_OFFSET
533
534 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
535 pointer. This is needed for the temporary stack before
536 relocation.
537
538 CONFIG_SYS_MIPS_CACHE_MODE
539
540 Cache operation mode for the MIPS CPU.
541 See also arch/mips/include/asm/mipsregs.h.
542 Possible values are:
543 CONF_CM_CACHABLE_NO_WA
544 CONF_CM_CACHABLE_WA
545 CONF_CM_UNCACHED
546 CONF_CM_CACHABLE_NONCOHERENT
547 CONF_CM_CACHABLE_CE
548 CONF_CM_CACHABLE_COW
549 CONF_CM_CACHABLE_CUW
550 CONF_CM_CACHABLE_ACCELERATED
551
552 CONFIG_SYS_XWAY_EBU_BOOTCFG
553
554 Special option for Lantiq XWAY SoCs for booting from NOR flash.
555 See also arch/mips/cpu/mips32/start.S.
556
557 CONFIG_XWAY_SWAP_BYTES
558
559 Enable compilation of tools/xway-swap-bytes needed for Lantiq
560 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
561 be swapped if a flash programmer is used.
562
b67d8816
CR
563- ARM options:
564 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
565
566 Select high exception vectors of the ARM core, e.g., do not
567 clear the V bit of the c1 register of CP15.
568
207774b2
YS
569 COUNTER_FREQUENCY
570 Generic timer clock source frequency.
571
572 COUNTER_FREQUENCY_REAL
573 Generic timer clock source frequency if the real clock is
574 different from COUNTER_FREQUENCY, and can only be determined
575 at run time.
576
73c38934
SW
577- Tegra SoC options:
578 CONFIG_TEGRA_SUPPORT_NON_SECURE
579
580 Support executing U-Boot in non-secure (NS) mode. Certain
581 impossible actions will be skipped if the CPU is in NS mode,
582 such as ARM architectural timer initialization.
583
5da627a4 584- Linux Kernel Interface:
c609719b
WD
585 CONFIG_CLOCKS_IN_MHZ
586
587 U-Boot stores all clock information in Hz
588 internally. For binary compatibility with older Linux
589 kernels (which expect the clocks passed in the
590 bd_info data to be in MHz) the environment variable
591 "clocks_in_mhz" can be defined so that U-Boot
592 converts clock data to MHZ before passing it to the
593 Linux kernel.
c609719b 594 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
218ca724 595 "clocks_in_mhz=1" is automatically included in the
c609719b
WD
596 default environment.
597
5da627a4
WD
598 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
599
b445bbb4 600 When transferring memsize parameter to Linux, some versions
5da627a4
WD
601 expect it to be in bytes, others in MB.
602 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
603
fec6d9ee 604 CONFIG_OF_LIBFDT
f57f70aa
WD
605
606 New kernel versions are expecting firmware settings to be
213bf8c8
GVB
607 passed using flattened device trees (based on open firmware
608 concepts).
609
610 CONFIG_OF_LIBFDT
611 * New libfdt-based support
612 * Adds the "fdt" command
3bb342fc 613 * The bootm command automatically updates the fdt
213bf8c8 614
f57f70aa 615 OF_TBCLK - The timebase frequency.
c2871f03 616 OF_STDOUT_PATH - The path to the console device
f57f70aa 617
11ccc33f
MZ
618 boards with QUICC Engines require OF_QE to set UCC MAC
619 addresses
3bb342fc 620
4e253137
KG
621 CONFIG_OF_BOARD_SETUP
622
623 Board code has addition modification that it wants to make
624 to the flat device tree before handing it off to the kernel
f57f70aa 625
c654b517
SG
626 CONFIG_OF_SYSTEM_SETUP
627
628 Other code has addition modification that it wants to make
629 to the flat device tree before handing it off to the kernel.
630 This causes ft_system_setup() to be called before booting
631 the kernel.
632
3887c3fb
HS
633 CONFIG_OF_IDE_FIXUP
634
635 U-Boot can detect if an IDE device is present or not.
636 If not, and this new config option is activated, U-Boot
637 removes the ATA node from the DTS before booting Linux,
638 so the Linux IDE driver does not probe the device and
639 crash. This is needed for buggy hardware (uc101) where
640 no pull down resistor is connected to the signal IDE5V_DD7.
641
7eb29398
IG
642 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
643
644 This setting is mandatory for all boards that have only one
645 machine type and must be used to specify the machine type
646 number as it appears in the ARM machine registry
647 (see http://www.arm.linux.org.uk/developer/machines/).
648 Only boards that have multiple machine types supported
649 in a single configuration file and the machine type is
650 runtime discoverable, do not have to use this setting.
651
0b2f4eca
NG
652- vxWorks boot parameters:
653
654 bootvx constructs a valid bootline using the following
9e98b7e3
BM
655 environments variables: bootdev, bootfile, ipaddr, netmask,
656 serverip, gatewayip, hostname, othbootargs.
0b2f4eca
NG
657 It loads the vxWorks image pointed bootfile.
658
0b2f4eca
NG
659 Note: If a "bootargs" environment is defined, it will overwride
660 the defaults discussed just above.
661
2c451f78
A
662- Cache Configuration:
663 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
664 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
665 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
666
93bc2193
A
667- Cache Configuration for ARM:
668 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
669 controller
670 CONFIG_SYS_PL310_BASE - Physical base address of PL310
671 controller register space
672
6705d81e 673- Serial Ports:
48d0192f 674 CONFIG_PL010_SERIAL
6705d81e
WD
675
676 Define this if you want support for Amba PrimeCell PL010 UARTs.
677
48d0192f 678 CONFIG_PL011_SERIAL
6705d81e
WD
679
680 Define this if you want support for Amba PrimeCell PL011 UARTs.
681
682 CONFIG_PL011_CLOCK
683
684 If you have Amba PrimeCell PL011 UARTs, set this variable to
685 the clock speed of the UARTs.
686
687 CONFIG_PL01x_PORTS
688
689 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
690 define this to a list of base addresses for each (supported)
691 port. See e.g. include/configs/versatile.h
692
d57dee57
KM
693 CONFIG_SERIAL_HW_FLOW_CONTROL
694
695 Define this variable to enable hw flow control in serial driver.
696 Current user of this option is drivers/serial/nsl16550.c driver
6705d81e 697
c609719b
WD
698- Console Baudrate:
699 CONFIG_BAUDRATE - in bps
700 Select one of the baudrates listed in
6d0f6bcf 701 CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b 702
c609719b
WD
703- Autoboot Command:
704 CONFIG_BOOTCOMMAND
705 Only needed when CONFIG_BOOTDELAY is enabled;
706 define a command string that is automatically executed
707 when no character is read on the console interface
708 within "Boot Delay" after reset.
709
c609719b 710 CONFIG_RAMBOOT and CONFIG_NFSBOOT
43d9616c
WD
711 The value of these goes into the environment as
712 "ramboot" and "nfsboot" respectively, and can be used
713 as a convenience, when switching between booting from
11ccc33f 714 RAM and NFS.
c609719b 715
eda0ba38
HS
716- Bootcount:
717 CONFIG_BOOTCOUNT_LIMIT
718 Implements a mechanism for detecting a repeating reboot
719 cycle, see:
720 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
721
722 CONFIG_BOOTCOUNT_ENV
723 If no softreset save registers are found on the hardware
724 "bootcount" is stored in the environment. To prevent a
725 saveenv on all reboots, the environment variable
726 "upgrade_available" is used. If "upgrade_available" is
727 0, "bootcount" is always 0, if "upgrade_available" is
728 1 "bootcount" is incremented in the environment.
729 So the Userspace Applikation must set the "upgrade_available"
730 and "bootcount" variable to 0, if a boot was successfully.
731
c609719b
WD
732- Pre-Boot Commands:
733 CONFIG_PREBOOT
734
735 When this option is #defined, the existence of the
736 environment variable "preboot" will be checked
737 immediately before starting the CONFIG_BOOTDELAY
738 countdown and/or running the auto-boot command resp.
739 entering interactive mode.
740
741 This feature is especially useful when "preboot" is
742 automatically generated or modified. For an example
743 see the LWMON board specific code: here "preboot" is
744 modified when the user holds down a certain
745 combination of keys on the (special) keyboard when
746 booting the systems
747
748- Serial Download Echo Mode:
749 CONFIG_LOADS_ECHO
750 If defined to 1, all characters received during a
751 serial download (using the "loads" command) are
752 echoed back. This might be needed by some terminal
753 emulations (like "cu"), but may as well just take
754 time on others. This setting #define's the initial
755 value of the "loads_echo" environment variable.
756
602ad3b3 757- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
c609719b
WD
758 CONFIG_KGDB_BAUDRATE
759 Select one of the baudrates listed in
6d0f6bcf 760 CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b 761
302a6487
SG
762- Removal of commands
763 If no commands are needed to boot, you can disable
764 CONFIG_CMDLINE to remove them. In this case, the command line
765 will not be available, and when U-Boot wants to execute the
766 boot command (on start-up) it will call board_run_command()
767 instead. This can reduce image size significantly for very
768 simple boot procedures.
769
a5ecbe62
WD
770- Regular expression support:
771 CONFIG_REGEX
93e14596
WD
772 If this variable is defined, U-Boot is linked against
773 the SLRE (Super Light Regular Expression) library,
774 which adds regex support to some commands, as for
775 example "env grep" and "setexpr".
a5ecbe62 776
45ba8077
SG
777- Device tree:
778 CONFIG_OF_CONTROL
779 If this variable is defined, U-Boot will use a device tree
780 to configure its devices, instead of relying on statically
781 compiled #defines in the board file. This option is
782 experimental and only available on a few boards. The device
783 tree is available in the global data as gd->fdt_blob.
784
2c0f79e4 785 U-Boot needs to get its device tree from somewhere. This can
82f766d1 786 be done using one of the three options below:
bbb0b128
SG
787
788 CONFIG_OF_EMBED
789 If this variable is defined, U-Boot will embed a device tree
790 binary in its image. This device tree file should be in the
791 board directory and called <soc>-<board>.dts. The binary file
792 is then picked up in board_init_f() and made available through
eb3eb602 793 the global data structure as gd->fdt_blob.
45ba8077 794
2c0f79e4
SG
795 CONFIG_OF_SEPARATE
796 If this variable is defined, U-Boot will build a device tree
797 binary. It will be called u-boot.dtb. Architecture-specific
798 code will locate it at run-time. Generally this works by:
799
800 cat u-boot.bin u-boot.dtb >image.bin
801
802 and in fact, U-Boot does this for you, creating a file called
803 u-boot-dtb.bin which is useful in the common case. You can
804 still use the individual files if you need something more
805 exotic.
806
82f766d1
AD
807 CONFIG_OF_BOARD
808 If this variable is defined, U-Boot will use the device tree
809 provided by the board at runtime instead of embedding one with
810 the image. Only boards defining board_fdt_blob_setup() support
811 this option (see include/fdtdec.h file).
812
c609719b
WD
813- Watchdog:
814 CONFIG_WATCHDOG
815 If this variable is defined, it enables watchdog
6abe6fb6 816 support for the SoC. There must be support in the SoC
907208c4
CL
817 specific code for a watchdog. For the 8xx
818 CPUs, the SIU Watchdog feature is enabled in the SYPCR
819 register. When supported for a specific SoC is
820 available, then no further board specific code should
821 be needed to use it.
6abe6fb6
DZ
822
823 CONFIG_HW_WATCHDOG
824 When using a watchdog circuitry external to the used
825 SoC, then define this variable and provide board
826 specific code for the "hw_watchdog_reset" function.
c609719b 827
7bae0d6f
HS
828 CONFIG_AT91_HW_WDT_TIMEOUT
829 specify the timeout in seconds. default 2 seconds.
830
c1551ea8
SR
831- U-Boot Version:
832 CONFIG_VERSION_VARIABLE
833 If this variable is defined, an environment variable
834 named "ver" is created by U-Boot showing the U-Boot
835 version as printed by the "version" command.
a1ea8e51
BT
836 Any change to this variable will be reverted at the
837 next reset.
c1551ea8 838
c609719b
WD
839- Real-Time Clock:
840
602ad3b3 841 When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b
WD
842 has to be selected, too. Define exactly one of the
843 following options:
844
c609719b 845 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
4e8b7544 846 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
c609719b 847 CONFIG_RTC_MC146818 - use MC146818 RTC
1cb8e980 848 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
c609719b 849 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
7f70e853 850 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
412921d2 851 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
3bac3513 852 CONFIG_RTC_DS164x - use Dallas DS164x RTC
9536dfcc 853 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
4c0d4c3b 854 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
2bd3cab3 855 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
71d19f30
HS
856 CONFIG_SYS_RV3029_TCR - enable trickle charger on
857 RV3029 RTC.
c609719b 858
b37c7e5e
WD
859 Note that if the RTC uses I2C, then the I2C interface
860 must also be configured. See I2C Support, below.
861
e92739d3
PT
862- GPIO Support:
863 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
e92739d3 864
5dec49ca
CP
865 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
866 chip-ngpio pairs that tell the PCA953X driver the number of
867 pins supported by a particular chip.
868
e92739d3
PT
869 Note that if the GPIO device uses I2C, then the I2C interface
870 must also be configured. See I2C Support, below.
871
aa53233a
SG
872- I/O tracing:
873 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
874 accesses and can checksum them or write a list of them out
875 to memory. See the 'iotrace' command for details. This is
876 useful for testing device drivers since it can confirm that
877 the driver behaves the same way before and after a code
878 change. Currently this is supported on sandbox and arm. To
879 add support for your architecture, add '#include <iotrace.h>'
880 to the bottom of arch/<arch>/include/asm/io.h and test.
881
882 Example output from the 'iotrace stats' command is below.
883 Note that if the trace buffer is exhausted, the checksum will
884 still continue to operate.
885
886 iotrace is enabled
887 Start: 10000000 (buffer start address)
888 Size: 00010000 (buffer size)
889 Offset: 00000120 (current buffer offset)
890 Output: 10000120 (start + offset)
891 Count: 00000018 (number of trace records)
892 CRC32: 9526fb66 (CRC32 of all trace records)
893
c609719b
WD
894- Timestamp Support:
895
43d9616c
WD
896 When CONFIG_TIMESTAMP is selected, the timestamp
897 (date and time) of an image is printed by image
898 commands like bootm or iminfo. This option is
602ad3b3 899 automatically enabled when you select CONFIG_CMD_DATE .
c609719b 900
923c46f9
KP
901- Partition Labels (disklabels) Supported:
902 Zero or more of the following:
903 CONFIG_MAC_PARTITION Apple's MacOS partition table.
923c46f9
KP
904 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
905 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
906 bootloader. Note 2TB partition limit; see
907 disk/part_efi.c
908 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
c609719b 909
fc843a02 910 If IDE or SCSI support is enabled (CONFIG_IDE or
c649e3c9 911 CONFIG_SCSI) you must configure support for at
923c46f9 912 least one non-MTD partition type as well.
c609719b
WD
913
914- IDE Reset method:
4d13cbad
WD
915 CONFIG_IDE_RESET_ROUTINE - this is defined in several
916 board configurations files but used nowhere!
c609719b 917
4d13cbad
WD
918 CONFIG_IDE_RESET - is this is defined, IDE Reset will
919 be performed by calling the function
920 ide_set_reset(int reset)
921 which has to be defined in a board specific file
c609719b
WD
922
923- ATAPI Support:
924 CONFIG_ATAPI
925
926 Set this to enable ATAPI support.
927
c40b2956
WD
928- LBA48 Support
929 CONFIG_LBA48
930
931 Set this to enable support for disks larger than 137GB
4b142feb 932 Also look at CONFIG_SYS_64BIT_LBA.
c40b2956
WD
933 Whithout these , LBA48 support uses 32bit variables and will 'only'
934 support disks up to 2.1TB.
935
6d0f6bcf 936 CONFIG_SYS_64BIT_LBA:
c40b2956
WD
937 When enabled, makes the IDE subsystem use 64bit sector addresses.
938 Default is 32bit.
939
c609719b 940- SCSI Support:
6d0f6bcf
JCPV
941 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
942 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
943 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
c609719b
WD
944 maximum numbers of LUNs, SCSI ID's and target
945 devices.
c609719b 946
93e14596
WD
947 The environment variable 'scsidevs' is set to the number of
948 SCSI devices found during the last scan.
447c031b 949
c609719b 950- NETWORK Support (PCI):
682011ff 951 CONFIG_E1000
ce5207e1
KM
952 Support for Intel 8254x/8257x gigabit chips.
953
954 CONFIG_E1000_SPI
955 Utility code for direct access to the SPI bus on Intel 8257x.
956 This does not do anything useful unless you set at least one
957 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
958
959 CONFIG_E1000_SPI_GENERIC
960 Allow generic access to the SPI bus on the Intel 8257x, for
961 example with the "sspi" command.
962
c609719b
WD
963 CONFIG_EEPRO100
964 Support for Intel 82557/82559/82559ER chips.
11ccc33f 965 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
c609719b
WD
966 write routine for first time initialisation.
967
968 CONFIG_TULIP
969 Support for Digital 2114x chips.
970 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
971 modem chip initialisation (KS8761/QS6611).
972
973 CONFIG_NATSEMI
974 Support for National dp83815 chips.
975
976 CONFIG_NS8382X
977 Support for National dp8382[01] gigabit chips.
978
45219c46
WD
979- NETWORK Support (other):
980
c041e9d2
JS
981 CONFIG_DRIVER_AT91EMAC
982 Support for AT91RM9200 EMAC.
983
984 CONFIG_RMII
985 Define this to use reduced MII inteface
986
987 CONFIG_DRIVER_AT91EMAC_QUIET
988 If this defined, the driver is quiet.
989 The driver doen't show link status messages.
990
efdd7319
RH
991 CONFIG_CALXEDA_XGMAC
992 Support for the Calxeda XGMAC device
993
3bb46d23 994 CONFIG_LAN91C96
45219c46
WD
995 Support for SMSC's LAN91C96 chips.
996
45219c46
WD
997 CONFIG_LAN91C96_USE_32_BIT
998 Define this to enable 32 bit addressing
999
3bb46d23 1000 CONFIG_SMC91111
f39748ae
WD
1001 Support for SMSC's LAN91C111 chip
1002
1003 CONFIG_SMC91111_BASE
1004 Define this to hold the physical address
1005 of the device (I/O space)
1006
1007 CONFIG_SMC_USE_32_BIT
1008 Define this if data bus is 32 bits
1009
1010 CONFIG_SMC_USE_IOFUNCS
1011 Define this to use i/o functions instead of macros
1012 (some hardware wont work with macros)
1013
dc02bada
HS
1014 CONFIG_DRIVER_TI_EMAC
1015 Support for davinci emac
1016
1017 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1018 Define this if you have more then 3 PHYs.
1019
b3dbf4a5
ML
1020 CONFIG_FTGMAC100
1021 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1022
1023 CONFIG_FTGMAC100_EGIGA
1024 Define this to use GE link update with gigabit PHY.
1025 Define this if FTGMAC100 is connected to gigabit PHY.
1026 If your system has 10/100 PHY only, it might not occur
1027 wrong behavior. Because PHY usually return timeout or
1028 useless data when polling gigabit status and gigabit
1029 control registers. This behavior won't affect the
1030 correctnessof 10/100 link speed update.
1031
3d0075fa
YS
1032 CONFIG_SH_ETHER
1033 Support for Renesas on-chip Ethernet controller
1034
1035 CONFIG_SH_ETHER_USE_PORT
1036 Define the number of ports to be used
1037
1038 CONFIG_SH_ETHER_PHY_ADDR
1039 Define the ETH PHY's address
1040
68260aab
YS
1041 CONFIG_SH_ETHER_CACHE_WRITEBACK
1042 If this option is set, the driver enables cache flush.
1043
b2f97cf2
HS
1044- PWM Support:
1045 CONFIG_PWM_IMX
5052e819 1046 Support for PWM module on the imx6.
b2f97cf2 1047
5e124724 1048- TPM Support:
90899cc0
CC
1049 CONFIG_TPM
1050 Support TPM devices.
1051
0766ad2f
CR
1052 CONFIG_TPM_TIS_INFINEON
1053 Support for Infineon i2c bus TPM devices. Only one device
1b393db5
TWHT
1054 per system is supported at this time.
1055
1b393db5
TWHT
1056 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1057 Define the burst count bytes upper limit
1058
3aa74088
CR
1059 CONFIG_TPM_ST33ZP24
1060 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1061
1062 CONFIG_TPM_ST33ZP24_I2C
1063 Support for STMicroelectronics ST33ZP24 I2C devices.
1064 Requires TPM_ST33ZP24 and I2C.
1065
b75fdc11
CR
1066 CONFIG_TPM_ST33ZP24_SPI
1067 Support for STMicroelectronics ST33ZP24 SPI devices.
1068 Requires TPM_ST33ZP24 and SPI.
1069
c01939c7
DE
1070 CONFIG_TPM_ATMEL_TWI
1071 Support for Atmel TWI TPM device. Requires I2C support.
1072
90899cc0 1073 CONFIG_TPM_TIS_LPC
5e124724
VB
1074 Support for generic parallel port TPM devices. Only one device
1075 per system is supported at this time.
1076
1077 CONFIG_TPM_TIS_BASE_ADDRESS
1078 Base address where the generic TPM device is mapped
1079 to. Contemporary x86 systems usually map it at
1080 0xfed40000.
1081
be6c1529
RP
1082 CONFIG_TPM
1083 Define this to enable the TPM support library which provides
1084 functional interfaces to some TPM commands.
1085 Requires support for a TPM device.
1086
1087 CONFIG_TPM_AUTH_SESSIONS
1088 Define this to enable authorized functions in the TPM library.
1089 Requires CONFIG_TPM and CONFIG_SHA1.
1090
c609719b
WD
1091- USB Support:
1092 At the moment only the UHCI host controller is
064b55cf 1093 supported (PIP405, MIP405); define
c609719b
WD
1094 CONFIG_USB_UHCI to enable it.
1095 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae 1096 and define CONFIG_USB_STORAGE to enable the USB
c609719b
WD
1097 storage devices.
1098 Note:
1099 Supported are USB Keyboards and USB Floppy drives
1100 (TEAC FD-05PUB).
4d13cbad 1101
9ab4ce22
SG
1102 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1103 txfilltuning field in the EHCI controller on reset.
1104
6e9e0626
OT
1105 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1106 HW module registers.
1107
16c8d5e7
WD
1108- USB Device:
1109 Define the below if you wish to use the USB console.
1110 Once firmware is rebuilt from a serial console issue the
1111 command "setenv stdin usbtty; setenv stdout usbtty" and
11ccc33f 1112 attach your USB cable. The Unix command "dmesg" should print
16c8d5e7
WD
1113 it has found a new device. The environment variable usbtty
1114 can be set to gserial or cdc_acm to enable your device to
386eda02 1115 appear to a USB host as a Linux gserial device or a
16c8d5e7
WD
1116 Common Device Class Abstract Control Model serial device.
1117 If you select usbtty = gserial you should be able to enumerate
1118 a Linux host by
1119 # modprobe usbserial vendor=0xVendorID product=0xProductID
1120 else if using cdc_acm, simply setting the environment
1121 variable usbtty to be cdc_acm should suffice. The following
1122 might be defined in YourBoardName.h
386eda02 1123
16c8d5e7
WD
1124 CONFIG_USB_DEVICE
1125 Define this to build a UDC device
1126
1127 CONFIG_USB_TTY
1128 Define this to have a tty type of device available to
1129 talk to the UDC device
386eda02 1130
f9da0f89
VK
1131 CONFIG_USBD_HS
1132 Define this to enable the high speed support for usb
1133 device and usbtty. If this feature is enabled, a routine
1134 int is_usbd_high_speed(void)
1135 also needs to be defined by the driver to dynamically poll
1136 whether the enumeration has succeded at high speed or full
1137 speed.
1138
6d0f6bcf 1139 CONFIG_SYS_CONSOLE_IS_IN_ENV
16c8d5e7
WD
1140 Define this if you want stdin, stdout &/or stderr to
1141 be set to usbtty.
1142
386eda02 1143 If you have a USB-IF assigned VendorID then you may wish to
16c8d5e7 1144 define your own vendor specific values either in BoardName.h
386eda02 1145 or directly in usbd_vendor_info.h. If you don't define
16c8d5e7
WD
1146 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1147 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1148 should pretend to be a Linux device to it's target host.
1149
1150 CONFIG_USBD_MANUFACTURER
1151 Define this string as the name of your company for
1152 - CONFIG_USBD_MANUFACTURER "my company"
386eda02 1153
16c8d5e7
WD
1154 CONFIG_USBD_PRODUCT_NAME
1155 Define this string as the name of your product
1156 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1157
1158 CONFIG_USBD_VENDORID
1159 Define this as your assigned Vendor ID from the USB
1160 Implementors Forum. This *must* be a genuine Vendor ID
1161 to avoid polluting the USB namespace.
1162 - CONFIG_USBD_VENDORID 0xFFFF
386eda02 1163
16c8d5e7
WD
1164 CONFIG_USBD_PRODUCTID
1165 Define this as the unique Product ID
1166 for your device
1167 - CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad 1168
d70a560f
IG
1169- ULPI Layer Support:
1170 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1171 the generic ULPI layer. The generic layer accesses the ULPI PHY
1172 via the platform viewport, so you need both the genric layer and
1173 the viewport enabled. Currently only Chipidea/ARC based
1174 viewport is supported.
1175 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1176 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
6d365ea0
LS
1177 If your ULPI phy needs a different reference clock than the
1178 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1179 the appropriate value in Hz.
c609719b 1180
71f95118 1181- MMC Support:
8bde7f77
WD
1182 The MMC controller on the Intel PXA is supported. To
1183 enable this define CONFIG_MMC. The MMC can be
1184 accessed from the boot prompt by mapping the device
71f95118 1185 to physical memory similar to flash. Command line is
602ad3b3
JL
1186 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1187 the FAT fs. This is enabled with CONFIG_CMD_FAT.
71f95118 1188
afb35666
YS
1189 CONFIG_SH_MMCIF
1190 Support for Renesas on-chip MMCIF controller
1191
1192 CONFIG_SH_MMCIF_ADDR
1193 Define the base address of MMCIF registers
1194
1195 CONFIG_SH_MMCIF_CLK
1196 Define the clock frequency for MMCIF
1197
1fd93c6e
PA
1198 CONFIG_SUPPORT_EMMC_BOOT
1199 Enable some additional features of the eMMC boot partitions.
1200
1201 CONFIG_SUPPORT_EMMC_RPMB
1202 Enable the commands for reading, writing and programming the
1203 key for the Replay Protection Memory Block partition in eMMC.
1204
b3ba6e94 1205- USB Device Firmware Update (DFU) class support:
01acd6ab 1206 CONFIG_USB_FUNCTION_DFU
b3ba6e94
TR
1207 This enables the USB portion of the DFU USB class
1208
b3ba6e94
TR
1209 CONFIG_DFU_MMC
1210 This enables support for exposing (e)MMC devices via DFU.
1211
c6631764
PA
1212 CONFIG_DFU_NAND
1213 This enables support for exposing NAND devices via DFU.
1214
a9479f04
AM
1215 CONFIG_DFU_RAM
1216 This enables support for exposing RAM via DFU.
1217 Note: DFU spec refer to non-volatile memory usage, but
1218 allow usages beyond the scope of spec - here RAM usage,
1219 one that would help mostly the developer.
1220
e7e75c70
HS
1221 CONFIG_SYS_DFU_DATA_BUF_SIZE
1222 Dfu transfer uses a buffer before writing data to the
1223 raw storage device. Make the size (in bytes) of this buffer
1224 configurable. The size of this buffer is also configurable
1225 through the "dfu_bufsiz" environment variable.
1226
ea2453d5
PA
1227 CONFIG_SYS_DFU_MAX_FILE_SIZE
1228 When updating files rather than the raw storage device,
1229 we use a static buffer to copy the file into and then write
1230 the buffer once we've been given the whole file. Define
1231 this to the maximum filesize (in bytes) for the buffer.
1232 Default is 4 MiB if undefined.
1233
001a8319
HS
1234 DFU_DEFAULT_POLL_TIMEOUT
1235 Poll timeout [ms], is the timeout a device can send to the
1236 host. The host must wait for this timeout before sending
1237 a subsequent DFU_GET_STATUS request to the device.
1238
1239 DFU_MANIFEST_POLL_TIMEOUT
1240 Poll timeout [ms], which the device sends to the host when
1241 entering dfuMANIFEST state. Host waits this timeout, before
1242 sending again an USB request to the device.
1243
6705d81e 1244- Journaling Flash filesystem support:
b2482dff 1245 CONFIG_JFFS2_NAND
6705d81e
WD
1246 Define these for a default partition on a NAND device
1247
6d0f6bcf
JCPV
1248 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1249 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e
WD
1250 Define these for a default partition on a NOR device
1251
c609719b 1252- Keyboard Support:
39f615ed
SG
1253 See Kconfig help for available keyboard drivers.
1254
1255 CONFIG_KEYBOARD
1256
1257 Define this to enable a custom keyboard support.
1258 This simply calls drv_keyboard_init() which must be
1259 defined in your board-specific files. This option is deprecated
1260 and is only used by novena. For new boards, use driver model
1261 instead.
c609719b
WD
1262
1263- Video support:
7d3053fb 1264 CONFIG_FSL_DIU_FB
04e5ae79 1265 Enable the Freescale DIU video driver. Reference boards for
7d3053fb
TT
1266 SOCs that have a DIU should define this macro to enable DIU
1267 support, and should also define these other macros:
1268
1269 CONFIG_SYS_DIU_ADDR
1270 CONFIG_VIDEO
7d3053fb
TT
1271 CONFIG_CFB_CONSOLE
1272 CONFIG_VIDEO_SW_CURSOR
1273 CONFIG_VGA_AS_SINGLE_DEVICE
1274 CONFIG_VIDEO_LOGO
1275 CONFIG_VIDEO_BMP_LOGO
1276
ba8e76bd
TT
1277 The DIU driver will look for the 'video-mode' environment
1278 variable, and if defined, enable the DIU as a console during
8eca9439 1279 boot. See the documentation file doc/README.video for a
ba8e76bd 1280 description of this variable.
7d3053fb 1281
c609719b
WD
1282- LCD Support: CONFIG_LCD
1283
1284 Define this to enable LCD support (for output to LCD
1285 display); also select one of the supported displays
1286 by defining one of these:
1287
39cf4804
SP
1288 CONFIG_ATMEL_LCD:
1289
1290 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1291
fd3103bb 1292 CONFIG_NEC_NL6448AC33:
c609719b 1293
fd3103bb 1294 NEC NL6448AC33-18. Active, color, single scan.
c609719b 1295
fd3103bb 1296 CONFIG_NEC_NL6448BC20
c609719b 1297
fd3103bb
WD
1298 NEC NL6448BC20-08. 6.5", 640x480.
1299 Active, color, single scan.
1300
1301 CONFIG_NEC_NL6448BC33_54
1302
1303 NEC NL6448BC33-54. 10.4", 640x480.
c609719b
WD
1304 Active, color, single scan.
1305
1306 CONFIG_SHARP_16x9
1307
1308 Sharp 320x240. Active, color, single scan.
1309 It isn't 16x9, and I am not sure what it is.
1310
1311 CONFIG_SHARP_LQ64D341
1312
1313 Sharp LQ64D341 display, 640x480.
1314 Active, color, single scan.
1315
1316 CONFIG_HLD1045
1317
1318 HLD1045 display, 640x480.
1319 Active, color, single scan.
1320
1321 CONFIG_OPTREX_BW
1322
1323 Optrex CBL50840-2 NF-FW 99 22 M5
1324 or
1325 Hitachi LMG6912RPFC-00T
1326 or
1327 Hitachi SP14Q002
1328
1329 320x240. Black & white.
1330
676d319e
SG
1331 CONFIG_LCD_ALIGNMENT
1332
b445bbb4 1333 Normally the LCD is page-aligned (typically 4KB). If this is
676d319e
SG
1334 defined then the LCD will be aligned to this value instead.
1335 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1336 here, since it is cheaper to change data cache settings on
1337 a per-section basis.
1338
1339
604c7d4a
HP
1340 CONFIG_LCD_ROTATION
1341
1342 Sometimes, for example if the display is mounted in portrait
1343 mode or even if it's mounted landscape but rotated by 180degree,
1344 we need to rotate our content of the display relative to the
1345 framebuffer, so that user can read the messages which are
1346 printed out.
1347 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1348 initialized with a given rotation from "vl_rot" out of
1349 "vidinfo_t" which is provided by the board specific code.
1350 The value for vl_rot is coded as following (matching to
1351 fbcon=rotate:<n> linux-kernel commandline):
1352 0 = no rotation respectively 0 degree
1353 1 = 90 degree rotation
1354 2 = 180 degree rotation
1355 3 = 270 degree rotation
1356
1357 If CONFIG_LCD_ROTATION is not defined, the console will be
1358 initialized with 0degree rotation.
1359
45d7f525
TWHT
1360 CONFIG_LCD_BMP_RLE8
1361
1362 Support drawing of RLE8-compressed bitmaps on the LCD.
1363
735987c5
TWHT
1364 CONFIG_I2C_EDID
1365
1366 Enables an 'i2c edid' command which can read EDID
1367 information over I2C from an attached LCD display.
1368
7152b1d0 1369- Splash Screen Support: CONFIG_SPLASH_SCREEN
d791b1dc 1370
8bde7f77
WD
1371 If this option is set, the environment is checked for
1372 a variable "splashimage". If found, the usual display
1373 of logo, copyright and system information on the LCD
e94d2cd9 1374 is suppressed and the BMP image at the address
8bde7f77
WD
1375 specified in "splashimage" is loaded instead. The
1376 console is redirected to the "nulldev", too. This
1377 allows for a "silent" boot where a splash screen is
1378 loaded very quickly after power-on.
d791b1dc 1379
c0880485
NK
1380 CONFIG_SPLASHIMAGE_GUARD
1381
1382 If this option is set, then U-Boot will prevent the environment
1383 variable "splashimage" from being set to a problematic address
ab5645f1 1384 (see doc/README.displaying-bmps).
c0880485
NK
1385 This option is useful for targets where, due to alignment
1386 restrictions, an improperly aligned BMP image will cause a data
1387 abort. If you think you will not have problems with unaligned
1388 accesses (for example because your toolchain prevents them)
1389 there is no need to set this option.
1390
1ca298ce
MW
1391 CONFIG_SPLASH_SCREEN_ALIGN
1392
1393 If this option is set the splash image can be freely positioned
1394 on the screen. Environment variable "splashpos" specifies the
1395 position as "x,y". If a positive number is given it is used as
1396 number of pixel from left/top. If a negative number is given it
1397 is used as number of pixel from right/bottom. You can also
1398 specify 'm' for centering the image.
1399
1400 Example:
1401 setenv splashpos m,m
1402 => image at center of screen
1403
1404 setenv splashpos 30,20
1405 => image at x = 30 and y = 20
1406
1407 setenv splashpos -10,m
1408 => vertically centered image
1409 at x = dspWidth - bmpWidth - 9
1410
98f4a3df
SR
1411- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1412
1413 If this option is set, additionally to standard BMP
1414 images, gzipped BMP images can be displayed via the
1415 splashscreen support or the bmp command.
1416
d5011762
AG
1417- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1418
1419 If this option is set, 8-bit RLE compressed BMP images
1420 can be displayed via the splashscreen support or the
1421 bmp command.
1422
c29fdfc1 1423- Compression support:
8ef70478
KC
1424 CONFIG_GZIP
1425
1426 Enabled by default to support gzip compressed images.
1427
c29fdfc1
WD
1428 CONFIG_BZIP2
1429
1430 If this option is set, support for bzip2 compressed
1431 images is included. If not, only uncompressed and gzip
1432 compressed images are supported.
1433
42d1f039 1434 NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf 1435 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f039 1436 be at least 4MB.
d791b1dc 1437
17ea1177
WD
1438- MII/PHY support:
1439 CONFIG_PHY_ADDR
1440
1441 The address of PHY on MII bus.
1442
1443 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1444
1445 The clock frequency of the MII bus
1446
17ea1177
WD
1447 CONFIG_PHY_RESET_DELAY
1448
1449 Some PHY like Intel LXT971A need extra delay after
1450 reset before any MII register access is possible.
1451 For such PHY, set this option to the usec delay
1452 required. (minimum 300usec for LXT971A)
1453
1454 CONFIG_PHY_CMD_DELAY (ppc4xx)
1455
1456 Some PHY like Intel LXT971A need extra delay after
1457 command issued before MII status register can be read
1458
c609719b
WD
1459- IP address:
1460 CONFIG_IPADDR
1461
1462 Define a default value for the IP address to use for
11ccc33f 1463 the default Ethernet interface, in case this is not
c609719b 1464 determined through e.g. bootp.
1ebcd654 1465 (Environment variable "ipaddr")
c609719b
WD
1466
1467- Server IP address:
1468 CONFIG_SERVERIP
1469
11ccc33f 1470 Defines a default value for the IP address of a TFTP
c609719b 1471 server to contact when using the "tftboot" command.
1ebcd654 1472 (Environment variable "serverip")
c609719b 1473
97cfe861
RG
1474 CONFIG_KEEP_SERVERADDR
1475
1476 Keeps the server's MAC address, in the env 'serveraddr'
1477 for passing to bootargs (like Linux's netconsole option)
1478
1ebcd654
WD
1479- Gateway IP address:
1480 CONFIG_GATEWAYIP
1481
1482 Defines a default value for the IP address of the
1483 default router where packets to other networks are
1484 sent to.
1485 (Environment variable "gatewayip")
1486
1487- Subnet mask:
1488 CONFIG_NETMASK
1489
1490 Defines a default value for the subnet mask (or
1491 routing prefix) which is used to determine if an IP
1492 address belongs to the local subnet or needs to be
1493 forwarded through a router.
1494 (Environment variable "netmask")
1495
53a5c424
DU
1496- Multicast TFTP Mode:
1497 CONFIG_MCAST_TFTP
1498
1499 Defines whether you want to support multicast TFTP as per
1500 rfc-2090; for example to work with atftp. Lets lots of targets
11ccc33f 1501 tftp down the same boot image concurrently. Note: the Ethernet
53a5c424
DU
1502 driver in use must provide a function: mcast() to join/leave a
1503 multicast group.
1504
c609719b
WD
1505- BOOTP Recovery Mode:
1506 CONFIG_BOOTP_RANDOM_DELAY
1507
1508 If you have many targets in a network that try to
1509 boot using BOOTP, you may want to avoid that all
1510 systems send out BOOTP requests at precisely the same
1511 moment (which would happen for instance at recovery
1512 from a power failure, when all systems will try to
1513 boot, thus flooding the BOOTP server. Defining
1514 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1515 inserted before sending out BOOTP requests. The
6c33c785 1516 following delays are inserted then:
c609719b
WD
1517
1518 1st BOOTP request: delay 0 ... 1 sec
1519 2nd BOOTP request: delay 0 ... 2 sec
1520 3rd BOOTP request: delay 0 ... 4 sec
1521 4th and following
1522 BOOTP requests: delay 0 ... 8 sec
1523
92ac8acc
TR
1524 CONFIG_BOOTP_ID_CACHE_SIZE
1525
1526 BOOTP packets are uniquely identified using a 32-bit ID. The
1527 server will copy the ID from client requests to responses and
1528 U-Boot will use this to determine if it is the destination of
1529 an incoming response. Some servers will check that addresses
1530 aren't in use before handing them out (usually using an ARP
1531 ping) and therefore take up to a few hundred milliseconds to
1532 respond. Network congestion may also influence the time it
1533 takes for a response to make it back to the client. If that
1534 time is too long, U-Boot will retransmit requests. In order
1535 to allow earlier responses to still be accepted after these
1536 retransmissions, U-Boot's BOOTP client keeps a small cache of
1537 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1538 cache. The default is to keep IDs for up to four outstanding
1539 requests. Increasing this will allow U-Boot to accept offers
1540 from a BOOTP client in networks with unusually high latency.
1541
fe389a82 1542- DHCP Advanced Options:
1fe80d79
JL
1543 You can fine tune the DHCP functionality by defining
1544 CONFIG_BOOTP_* symbols:
1545
1546 CONFIG_BOOTP_SUBNETMASK
1547 CONFIG_BOOTP_GATEWAY
1548 CONFIG_BOOTP_HOSTNAME
1549 CONFIG_BOOTP_NISDOMAIN
1550 CONFIG_BOOTP_BOOTPATH
1551 CONFIG_BOOTP_BOOTFILESIZE
1552 CONFIG_BOOTP_DNS
1553 CONFIG_BOOTP_DNS2
1554 CONFIG_BOOTP_SEND_HOSTNAME
1555 CONFIG_BOOTP_NTPSERVER
1556 CONFIG_BOOTP_TIMEOFFSET
1557 CONFIG_BOOTP_VENDOREX
2c00e099 1558 CONFIG_BOOTP_MAY_FAIL
fe389a82 1559
5d110f0a
WC
1560 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1561 environment variable, not the BOOTP server.
fe389a82 1562
2c00e099
JH
1563 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1564 after the configured retry count, the call will fail
1565 instead of starting over. This can be used to fail over
1566 to Link-local IP address configuration if the DHCP server
1567 is not available.
1568
fe389a82
SR
1569 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1570 serverip from a DHCP server, it is possible that more
1571 than one DNS serverip is offered to the client.
1572 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1573 serverip will be stored in the additional environment
1574 variable "dnsip2". The first DNS serverip is always
1575 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1fe80d79 1576 is defined.
fe389a82
SR
1577
1578 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1579 to do a dynamic update of a DNS server. To do this, they
1580 need the hostname of the DHCP requester.
5d110f0a 1581 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79
JL
1582 of the "hostname" environment variable is passed as
1583 option 12 to the DHCP server.
fe389a82 1584
d9a2f416
AV
1585 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1586
1587 A 32bit value in microseconds for a delay between
1588 receiving a "DHCP Offer" and sending the "DHCP Request".
1589 This fixes a problem with certain DHCP servers that don't
1590 respond 100% of the time to a "DHCP request". E.g. On an
1591 AT91RM9200 processor running at 180MHz, this delay needed
1592 to be *at least* 15,000 usec before a Windows Server 2003
1593 DHCP server would reply 100% of the time. I recommend at
1594 least 50,000 usec to be safe. The alternative is to hope
1595 that one of the retries will be successful but note that
1596 the DHCP timeout and retry process takes a longer than
1597 this delay.
1598
d22c338e
JH
1599 - Link-local IP address negotiation:
1600 Negotiate with other link-local clients on the local network
1601 for an address that doesn't require explicit configuration.
1602 This is especially useful if a DHCP server cannot be guaranteed
1603 to exist in all environments that the device must operate.
1604
1605 See doc/README.link-local for more information.
1606
24acb83d
PK
1607 - MAC address from environment variables
1608
1609 FDT_SEQ_MACADDR_FROM_ENV
1610
1611 Fix-up device tree with MAC addresses fetched sequentially from
1612 environment variables. This config work on assumption that
1613 non-usable ethernet node of device-tree are either not present
1614 or their status has been marked as "disabled".
1615
a3d991bd 1616 - CDP Options:
6e592385 1617 CONFIG_CDP_DEVICE_ID
a3d991bd
WD
1618
1619 The device id used in CDP trigger frames.
1620
1621 CONFIG_CDP_DEVICE_ID_PREFIX
1622
1623 A two character string which is prefixed to the MAC address
1624 of the device.
1625
1626 CONFIG_CDP_PORT_ID
1627
1628 A printf format string which contains the ascii name of
1629 the port. Normally is set to "eth%d" which sets
11ccc33f 1630 eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd
WD
1631
1632 CONFIG_CDP_CAPABILITIES
1633
1634 A 32bit integer which indicates the device capabilities;
1635 0x00000010 for a normal host which does not forwards.
1636
1637 CONFIG_CDP_VERSION
1638
1639 An ascii string containing the version of the software.
1640
1641 CONFIG_CDP_PLATFORM
1642
1643 An ascii string containing the name of the platform.
1644
1645 CONFIG_CDP_TRIGGER
1646
1647 A 32bit integer sent on the trigger.
1648
1649 CONFIG_CDP_POWER_CONSUMPTION
1650
1651 A 16bit integer containing the power consumption of the
1652 device in .1 of milliwatts.
1653
1654 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1655
1656 A byte containing the id of the VLAN.
1657
79267edd 1658- Status LED: CONFIG_LED_STATUS
c609719b
WD
1659
1660 Several configurations allow to display the current
1661 status using a LED. For instance, the LED will blink
1662 fast while running U-Boot code, stop blinking as
1663 soon as a reply to a BOOTP request was received, and
1664 start blinking slow once the Linux kernel is running
1665 (supported by a status LED driver in the Linux
79267edd 1666 kernel). Defining CONFIG_LED_STATUS enables this
c609719b
WD
1667 feature in U-Boot.
1668
1df7bbba
IG
1669 Additional options:
1670
79267edd 1671 CONFIG_LED_STATUS_GPIO
1df7bbba
IG
1672 The status LED can be connected to a GPIO pin.
1673 In such cases, the gpio_led driver can be used as a
79267edd 1674 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1df7bbba
IG
1675 to include the gpio_led driver in the U-Boot binary.
1676
9dfdcdfe
IG
1677 CONFIG_GPIO_LED_INVERTED_TABLE
1678 Some GPIO connected LEDs may have inverted polarity in which
1679 case the GPIO high value corresponds to LED off state and
1680 GPIO low value corresponds to LED on state.
1681 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1682 with a list of GPIO LEDs that have inverted polarity.
1683
3f4978c7
HS
1684- I2C Support: CONFIG_SYS_I2C
1685
1686 This enable the NEW i2c subsystem, and will allow you to use
1687 i2c commands at the u-boot command line (as long as you set
1688 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1689 based realtime clock chips or other i2c devices. See
1690 common/cmd_i2c.c for a description of the command line
1691 interface.
1692
1693 ported i2c driver to the new framework:
ea818dbb
HS
1694 - drivers/i2c/soft_i2c.c:
1695 - activate first bus with CONFIG_SYS_I2C_SOFT define
1696 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1697 for defining speed and slave address
1698 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1699 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1700 for defining speed and slave address
1701 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1702 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1703 for defining speed and slave address
1704 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1705 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1706 for defining speed and slave address
3f4978c7 1707
00f792e0
HS
1708 - drivers/i2c/fsl_i2c.c:
1709 - activate i2c driver with CONFIG_SYS_I2C_FSL
1710 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1711 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1712 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1713 bus.
93e14596 1714 - If your board supports a second fsl i2c bus, define
00f792e0
HS
1715 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1716 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1717 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1718 second bus.
1719
1f2ba722 1720 - drivers/i2c/tegra_i2c.c:
10cee516
NI
1721 - activate this driver with CONFIG_SYS_I2C_TEGRA
1722 - This driver adds 4 i2c buses with a fix speed from
1723 100000 and the slave addr 0!
1f2ba722 1724
880540de
DE
1725 - drivers/i2c/ppc4xx_i2c.c
1726 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1727 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1728 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1729
fac96408 1730 - drivers/i2c/i2c_mxc.c
1731 - activate this driver with CONFIG_SYS_I2C_MXC
03544c66
AA
1732 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1733 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1734 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1735 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
fac96408 1736 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1737 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1738 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1739 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1740 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1741 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
03544c66
AA
1742 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1743 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
b445bbb4 1744 If those defines are not set, default value is 100000
fac96408 1745 for speed, and 0 for slave.
1746
1086bfa9
NI
1747 - drivers/i2c/rcar_i2c.c:
1748 - activate this driver with CONFIG_SYS_I2C_RCAR
1749 - This driver adds 4 i2c buses
1750
1751 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1752 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1753 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1754 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1755 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1756 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1757 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1758 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1759 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1760
2035d77d
NI
1761 - drivers/i2c/sh_i2c.c:
1762 - activate this driver with CONFIG_SYS_I2C_SH
1763 - This driver adds from 2 to 5 i2c buses
1764
1765 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1766 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1767 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1768 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1769 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1770 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1771 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1772 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1773 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1774 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
b445bbb4 1775 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
2035d77d 1776
6789e84e
HS
1777 - drivers/i2c/omap24xx_i2c.c
1778 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1779 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1780 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1781 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1782 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1783 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1784 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1785 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1786 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1787 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1788 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1789
0bdffe71
HS
1790 - drivers/i2c/zynq_i2c.c
1791 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1792 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1793 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1794
e717fc6d
NKC
1795 - drivers/i2c/s3c24x0_i2c.c:
1796 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1797 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1798 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1799 with a fix speed from 100000 and the slave addr 0!
1800
b46226bd
DE
1801 - drivers/i2c/ihs_i2c.c
1802 - activate this driver with CONFIG_SYS_I2C_IHS
1803 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1804 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1805 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1806 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1807 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1808 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1809 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1810 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1811 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1812 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1813 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1814 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
071be896
DE
1815 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1816 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1817 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1818 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1819 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1820 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1821 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1822 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1823 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
b46226bd 1824
3f4978c7
HS
1825 additional defines:
1826
1827 CONFIG_SYS_NUM_I2C_BUSES
945a18e6 1828 Hold the number of i2c buses you want to use.
3f4978c7
HS
1829
1830 CONFIG_SYS_I2C_DIRECT_BUS
1831 define this, if you don't use i2c muxes on your hardware.
1832 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1833 omit this define.
1834
1835 CONFIG_SYS_I2C_MAX_HOPS
1836 define how many muxes are maximal consecutively connected
1837 on one i2c bus. If you not use i2c muxes, omit this
1838 define.
1839
1840 CONFIG_SYS_I2C_BUSES
b445bbb4 1841 hold a list of buses you want to use, only used if
3f4978c7
HS
1842 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1843 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1844 CONFIG_SYS_NUM_I2C_BUSES = 9:
1845
1846 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1847 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1848 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1849 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1850 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1851 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1852 {1, {I2C_NULL_HOP}}, \
1853 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1854 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1855 }
1856
1857 which defines
1858 bus 0 on adapter 0 without a mux
ea818dbb
HS
1859 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1860 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1861 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1862 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1863 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
3f4978c7 1864 bus 6 on adapter 1 without a mux
ea818dbb
HS
1865 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1866 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
3f4978c7
HS
1867
1868 If you do not have i2c muxes on your board, omit this define.
1869
ce3b5d69 1870- Legacy I2C Support:
ea818dbb 1871 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
b37c7e5e
WD
1872 then the following macros need to be defined (examples are
1873 from include/configs/lwmon.h):
c609719b
WD
1874
1875 I2C_INIT
1876
b37c7e5e 1877 (Optional). Any commands necessary to enable the I2C
43d9616c 1878 controller or configure ports.
c609719b 1879
ba56f625 1880 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
b37c7e5e 1881
c609719b
WD
1882 I2C_ACTIVE
1883
1884 The code necessary to make the I2C data line active
1885 (driven). If the data line is open collector, this
1886 define can be null.
1887
b37c7e5e
WD
1888 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1889
c609719b
WD
1890 I2C_TRISTATE
1891
1892 The code necessary to make the I2C data line tri-stated
1893 (inactive). If the data line is open collector, this
1894 define can be null.
1895
b37c7e5e
WD
1896 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1897
c609719b
WD
1898 I2C_READ
1899
472d5460
YS
1900 Code that returns true if the I2C data line is high,
1901 false if it is low.
c609719b 1902
b37c7e5e
WD
1903 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1904
c609719b
WD
1905 I2C_SDA(bit)
1906
472d5460
YS
1907 If <bit> is true, sets the I2C data line high. If it
1908 is false, it clears it (low).
c609719b 1909
b37c7e5e 1910 eg: #define I2C_SDA(bit) \
2535d602 1911 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
ba56f625 1912 else immr->im_cpm.cp_pbdat &= ~PB_SDA
b37c7e5e 1913
c609719b
WD
1914 I2C_SCL(bit)
1915
472d5460
YS
1916 If <bit> is true, sets the I2C clock line high. If it
1917 is false, it clears it (low).
c609719b 1918
b37c7e5e 1919 eg: #define I2C_SCL(bit) \
2535d602 1920 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
ba56f625 1921 else immr->im_cpm.cp_pbdat &= ~PB_SCL
b37c7e5e 1922
c609719b
WD
1923 I2C_DELAY
1924
1925 This delay is invoked four times per clock cycle so this
1926 controls the rate of data transfer. The data rate thus
b37c7e5e 1927 is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d7
WD
1928 like:
1929
b37c7e5e 1930 #define I2C_DELAY udelay(2)
c609719b 1931
793b5726
MF
1932 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1933
1934 If your arch supports the generic GPIO framework (asm/gpio.h),
1935 then you may alternatively define the two GPIOs that are to be
1936 used as SCL / SDA. Any of the previous I2C_xxx macros will
1937 have GPIO-based defaults assigned to them as appropriate.
1938
1939 You should define these to the GPIO value as given directly to
1940 the generic GPIO functions.
1941
6d0f6bcf 1942 CONFIG_SYS_I2C_INIT_BOARD
47cd00fa 1943
8bde7f77
WD
1944 When a board is reset during an i2c bus transfer
1945 chips might think that the current transfer is still
1946 in progress. On some boards it is possible to access
1947 the i2c SCLK line directly, either by using the
1948 processor pin as a GPIO or by having a second pin
1949 connected to the bus. If this option is defined a
1950 custom i2c_init_board() routine in boards/xxx/board.c
1951 is run early in the boot sequence.
47cd00fa 1952
bb99ad6d
BW
1953 CONFIG_I2C_MULTI_BUS
1954
1955 This option allows the use of multiple I2C buses, each of which
c0f40859
WD
1956 must have a controller. At any point in time, only one bus is
1957 active. To switch to a different bus, use the 'i2c dev' command.
bb99ad6d
BW
1958 Note that bus numbering is zero-based.
1959
6d0f6bcf 1960 CONFIG_SYS_I2C_NOPROBES
bb99ad6d
BW
1961
1962 This option specifies a list of I2C devices that will be skipped
c0f40859 1963 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
0f89c54b
PT
1964 is set, specify a list of bus-device pairs. Otherwise, specify
1965 a 1D array of device addresses
bb99ad6d
BW
1966
1967 e.g.
1968 #undef CONFIG_I2C_MULTI_BUS
c0f40859 1969 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d
BW
1970
1971 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1972
c0f40859 1973 #define CONFIG_I2C_MULTI_BUS
945a18e6 1974 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d
BW
1975
1976 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1977
6d0f6bcf 1978 CONFIG_SYS_SPD_BUS_NUM
be5e6181
TT
1979
1980 If defined, then this indicates the I2C bus number for DDR SPD.
1981 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1982
6d0f6bcf 1983 CONFIG_SYS_RTC_BUS_NUM
0dc018ec
SR
1984
1985 If defined, then this indicates the I2C bus number for the RTC.
1986 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1987
2ac6985a
AD
1988 CONFIG_SOFT_I2C_READ_REPEATED_START
1989
1990 defining this will force the i2c_read() function in
1991 the soft_i2c driver to perform an I2C repeated start
1992 between writing the address pointer and reading the
1993 data. If this define is omitted the default behaviour
1994 of doing a stop-start sequence will be used. Most I2C
1995 devices can use either method, but some require one or
1996 the other.
be5e6181 1997
c609719b
WD
1998- SPI Support: CONFIG_SPI
1999
2000 Enables SPI driver (so far only tested with
2001 SPI EEPROM, also an instance works with Crystal A/D and
2002 D/As on the SACSng board)
2003
6639562e
YS
2004 CONFIG_SH_SPI
2005
2006 Enables the driver for SPI controller on SuperH. Currently
2007 only SH7757 is supported.
2008
c609719b
WD
2009 CONFIG_SOFT_SPI
2010
43d9616c
WD
2011 Enables a software (bit-bang) SPI driver rather than
2012 using hardware support. This is a general purpose
2013 driver that only requires three general I/O port pins
2014 (two outputs, one input) to function. If this is
2015 defined, the board configuration must define several
2016 SPI configuration items (port pins to use, etc). For
2017 an example, see include/configs/sacsng.h.
c609719b 2018
04a9e118
BW
2019 CONFIG_HARD_SPI
2020
2021 Enables a hardware SPI driver for general-purpose reads
2022 and writes. As with CONFIG_SOFT_SPI, the board configuration
2023 must define a list of chip-select function pointers.
c0f40859 2024 Currently supported on some MPC8xxx processors. For an
04a9e118
BW
2025 example, see include/configs/mpc8349emds.h.
2026
38254f45
GL
2027 CONFIG_MXC_SPI
2028
2029 Enables the driver for the SPI controllers on i.MX and MXC
2e3cd1cd 2030 SoCs. Currently i.MX31/35/51 are supported.
38254f45 2031
f659b573
HS
2032 CONFIG_SYS_SPI_MXC_WAIT
2033 Timeout for waiting until spi transfer completed.
2034 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2035
0133502e 2036- FPGA Support: CONFIG_FPGA
c609719b 2037
0133502e
MF
2038 Enables FPGA subsystem.
2039
2040 CONFIG_FPGA_<vendor>
2041
2042 Enables support for specific chip vendors.
2043 (ALTERA, XILINX)
c609719b 2044
0133502e 2045 CONFIG_FPGA_<family>
c609719b 2046
0133502e
MF
2047 Enables support for FPGA family.
2048 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2049
2050 CONFIG_FPGA_COUNT
2051
2052 Specify the number of FPGA devices to support.
c609719b 2053
6d0f6bcf 2054 CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b 2055
8bde7f77 2056 Enable printing of hash marks during FPGA configuration.
c609719b 2057
6d0f6bcf 2058 CONFIG_SYS_FPGA_CHECK_BUSY
c609719b 2059
43d9616c
WD
2060 Enable checks on FPGA configuration interface busy
2061 status by the configuration function. This option
2062 will require a board or device specific function to
2063 be written.
c609719b
WD
2064
2065 CONFIG_FPGA_DELAY
2066
2067 If defined, a function that provides delays in the FPGA
2068 configuration driver.
2069
6d0f6bcf 2070 CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b
WD
2071 Allow Control-C to interrupt FPGA configuration
2072
6d0f6bcf 2073 CONFIG_SYS_FPGA_CHECK_ERROR
c609719b 2074
43d9616c
WD
2075 Check for configuration errors during FPGA bitfile
2076 loading. For example, abort during Virtex II
2077 configuration if the INIT_B line goes low (which
2078 indicated a CRC error).
c609719b 2079
6d0f6bcf 2080 CONFIG_SYS_FPGA_WAIT_INIT
c609719b 2081
b445bbb4
JM
2082 Maximum time to wait for the INIT_B line to de-assert
2083 after PROB_B has been de-asserted during a Virtex II
43d9616c 2084 FPGA configuration sequence. The default time is 500
11ccc33f 2085 ms.
c609719b 2086
6d0f6bcf 2087 CONFIG_SYS_FPGA_WAIT_BUSY
c609719b 2088
b445bbb4 2089 Maximum time to wait for BUSY to de-assert during
11ccc33f 2090 Virtex II FPGA configuration. The default is 5 ms.
c609719b 2091
6d0f6bcf 2092 CONFIG_SYS_FPGA_WAIT_CONFIG
c609719b 2093
43d9616c 2094 Time to wait after FPGA configuration. The default is
11ccc33f 2095 200 ms.
c609719b
WD
2096
2097- Configuration Management:
b2b8a696
SR
2098 CONFIG_BUILD_TARGET
2099
2100 Some SoCs need special image types (e.g. U-Boot binary
2101 with a special header) as build targets. By defining
2102 CONFIG_BUILD_TARGET in the SoC / board header, this
2103 special image will be automatically built upon calling
6de80f21 2104 make / buildman.
b2b8a696 2105
c609719b
WD
2106 CONFIG_IDENT_STRING
2107
43d9616c
WD
2108 If defined, this string will be added to the U-Boot
2109 version information (U_BOOT_VERSION)
c609719b
WD
2110
2111- Vendor Parameter Protection:
2112
43d9616c
WD
2113 U-Boot considers the values of the environment
2114 variables "serial#" (Board Serial Number) and
7152b1d0 2115 "ethaddr" (Ethernet Address) to be parameters that
43d9616c
WD
2116 are set once by the board vendor / manufacturer, and
2117 protects these variables from casual modification by
2118 the user. Once set, these variables are read-only,
2119 and write or delete attempts are rejected. You can
11ccc33f 2120 change this behaviour:
c609719b
WD
2121
2122 If CONFIG_ENV_OVERWRITE is #defined in your config
2123 file, the write protection for vendor parameters is
47cd00fa 2124 completely disabled. Anybody can change or delete
c609719b
WD
2125 these parameters.
2126
92ac5208
JH
2127 Alternatively, if you define _both_ an ethaddr in the
2128 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33f 2129 Ethernet address is installed in the environment,
c609719b
WD
2130 which can be changed exactly ONCE by the user. [The
2131 serial# is unaffected by this, i. e. it remains
2132 read-only.]
2133
2598090b
JH
2134 The same can be accomplished in a more flexible way
2135 for any variable by configuring the type of access
2136 to allow for those variables in the ".flags" variable
2137 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2138
c609719b
WD
2139- Protected RAM:
2140 CONFIG_PRAM
2141
2142 Define this variable to enable the reservation of
2143 "protected RAM", i. e. RAM which is not overwritten
2144 by U-Boot. Define CONFIG_PRAM to hold the number of
2145 kB you want to reserve for pRAM. You can overwrite
2146 this default value by defining an environment
2147 variable "pram" to the number of kB you want to
2148 reserve. Note that the board info structure will
2149 still show the full amount of RAM. If pRAM is
2150 reserved, a new environment variable "mem" will
2151 automatically be defined to hold the amount of
2152 remaining RAM in a form that can be passed as boot
2153 argument to Linux, for instance like that:
2154
fe126d8b 2155 setenv bootargs ... mem=\${mem}
c609719b
WD
2156 saveenv
2157
2158 This way you can tell Linux not to use this memory,
2159 either, which results in a memory region that will
2160 not be affected by reboots.
2161
2162 *WARNING* If your board configuration uses automatic
2163 detection of the RAM size, you must make sure that
2164 this memory test is non-destructive. So far, the
2165 following board configurations are known to be
2166 "pRAM-clean":
2167
5b8e76c3 2168 IVMS8, IVML24, SPD8xx,
1b0757ec 2169 HERMES, IP860, RPXlite, LWMON,
2eb48ff7 2170 FLAGADM
c609719b 2171
40fef049
GB
2172- Access to physical memory region (> 4GB)
2173 Some basic support is provided for operations on memory not
2174 normally accessible to U-Boot - e.g. some architectures
2175 support access to more than 4GB of memory on 32-bit
2176 machines using physical address extension or similar.
2177 Define CONFIG_PHYSMEM to access this basic support, which
2178 currently only supports clearing the memory.
2179
c609719b 2180- Error Recovery:
c609719b
WD
2181 CONFIG_NET_RETRY_COUNT
2182
43d9616c
WD
2183 This variable defines the number of retries for
2184 network operations like ARP, RARP, TFTP, or BOOTP
2185 before giving up the operation. If not defined, a
2186 default value of 5 is used.
c609719b 2187
40cb90ee
GL
2188 CONFIG_ARP_TIMEOUT
2189
2190 Timeout waiting for an ARP reply in milliseconds.
2191
48a3e999
TK
2192 CONFIG_NFS_TIMEOUT
2193
2194 Timeout in milliseconds used in NFS protocol.
2195 If you encounter "ERROR: Cannot umount" in nfs command,
2196 try longer timeout such as
2197 #define CONFIG_NFS_TIMEOUT 10000UL
2198
c609719b 2199- Command Interpreter:
8078f1a5 2200 CONFIG_AUTO_COMPLETE
04a85b3b
WD
2201
2202 Enable auto completion of commands using TAB.
2203
6d0f6bcf 2204 CONFIG_SYS_PROMPT_HUSH_PS2
c609719b
WD
2205
2206 This defines the secondary prompt string, which is
2207 printed when the command interpreter needs more input
2208 to complete a command. Usually "> ".
2209
2210 Note:
2211
8bde7f77
WD
2212 In the current implementation, the local variables
2213 space and global environment variables space are
2214 separated. Local variables are those you define by
2215 simply typing `name=value'. To access a local
2216 variable later on, you have write `$name' or
2217 `${name}'; to execute the contents of a variable
2218 directly type `$name' at the command prompt.
c609719b 2219
43d9616c
WD
2220 Global environment variables are those you use
2221 setenv/printenv to work with. To run a command stored
2222 in such a variable, you need to use the run command,
2223 and you must not use the '$' sign to access them.
c609719b
WD
2224
2225 To store commands and special characters in a
2226 variable, please use double quotation marks
2227 surrounding the whole text of the variable, instead
2228 of the backslashes before semicolons and special
2229 symbols.
2230
b445bbb4 2231- Command Line Editing and History:
aa0c71ac
WD
2232 CONFIG_CMDLINE_EDITING
2233
11ccc33f 2234 Enable editing and History functions for interactive
b445bbb4 2235 command line input operations
aa0c71ac 2236
f3b267b3
MV
2237- Command Line PS1/PS2 support:
2238 CONFIG_CMDLINE_PS_SUPPORT
2239
2240 Enable support for changing the command prompt string
2241 at run-time. Only static string is supported so far.
2242 The string is obtained from environment variables PS1
2243 and PS2.
2244
a8c7c708 2245- Default Environment:
c609719b
WD
2246 CONFIG_EXTRA_ENV_SETTINGS
2247
43d9616c
WD
2248 Define this to contain any number of null terminated
2249 strings (variable = value pairs) that will be part of
7152b1d0 2250 the default environment compiled into the boot image.
2262cfee 2251
43d9616c
WD
2252 For example, place something like this in your
2253 board's config file:
c609719b
WD
2254
2255 #define CONFIG_EXTRA_ENV_SETTINGS \
2256 "myvar1=value1\0" \
2257 "myvar2=value2\0"
2258
43d9616c
WD
2259 Warning: This method is based on knowledge about the
2260 internal format how the environment is stored by the
2261 U-Boot code. This is NOT an official, exported
2262 interface! Although it is unlikely that this format
7152b1d0 2263 will change soon, there is no guarantee either.
c609719b
WD
2264 You better know what you are doing here.
2265
43d9616c
WD
2266 Note: overly (ab)use of the default environment is
2267 discouraged. Make sure to check other ways to preset
74de7aef 2268 the environment like the "source" command or the
43d9616c 2269 boot command first.
c609719b 2270
5e724ca2
SW
2271 CONFIG_ENV_VARS_UBOOT_CONFIG
2272
2273 Define this in order to add variables describing the
2274 U-Boot build configuration to the default environment.
2275 These will be named arch, cpu, board, vendor, and soc.
2276
2277 Enabling this option will cause the following to be defined:
2278
2279 - CONFIG_SYS_ARCH
2280 - CONFIG_SYS_CPU
2281 - CONFIG_SYS_BOARD
2282 - CONFIG_SYS_VENDOR
2283 - CONFIG_SYS_SOC
2284
7e27f89f
TR
2285 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2286
2287 Define this in order to add variables describing certain
2288 run-time determined information about the hardware to the
2289 environment. These will be named board_name, board_rev.
2290
06fd8538
SG
2291 CONFIG_DELAY_ENVIRONMENT
2292
2293 Normally the environment is loaded when the board is
b445bbb4 2294 initialised so that it is available to U-Boot. This inhibits
06fd8538
SG
2295 that so that the environment is not available until
2296 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2297 this is instead controlled by the value of
2298 /config/load-environment.
2299
f61ec45e 2300- Serial Flash support
00fd59dd 2301 Usage requires an initial 'sf probe' to define the serial
f61ec45e
EN
2302 flash parameters, followed by read/write/erase/update
2303 commands.
2304
2305 The following defaults may be provided by the platform
2306 to handle the common case when only a single serial
2307 flash is present on the system.
2308
2309 CONFIG_SF_DEFAULT_BUS Bus identifier
2310 CONFIG_SF_DEFAULT_CS Chip-select
2311 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2312 CONFIG_SF_DEFAULT_SPEED in Hz
2313
3f85ce27 2314
ecb0ccd9
WD
2315- TFTP Fixed UDP Port:
2316 CONFIG_TFTP_PORT
2317
28cb9375 2318 If this is defined, the environment variable tftpsrcp
ecb0ccd9 2319 is used to supply the TFTP UDP source port value.
28cb9375 2320 If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9
WD
2321 number generator is used.
2322
28cb9375
WD
2323 Also, the environment variable tftpdstp is used to supply
2324 the TFTP UDP destination port value. If tftpdstp isn't
2325 defined, the normal port 69 is used.
2326
2327 The purpose for tftpsrcp is to allow a TFTP server to
ecb0ccd9
WD
2328 blindly start the TFTP transfer using the pre-configured
2329 target IP address and UDP port. This has the effect of
2330 "punching through" the (Windows XP) firewall, allowing
2331 the remainder of the TFTP transfer to proceed normally.
2332 A better solution is to properly configure the firewall,
2333 but sometimes that is not allowed.
2334
9e50c406
HS
2335- bootcount support:
2336 CONFIG_BOOTCOUNT_LIMIT
2337
2338 This enables the bootcounter support, see:
2339 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2340
2341 CONFIG_AT91SAM9XE
2342 enable special bootcounter support on at91sam9xe based boards.
9e50c406
HS
2343 CONFIG_SOC_DA8XX
2344 enable special bootcounter support on da850 based boards.
2345 CONFIG_BOOTCOUNT_RAM
2346 enable support for the bootcounter in RAM
2347 CONFIG_BOOTCOUNT_I2C
2348 enable support for the bootcounter on an i2c (like RTC) device.
2349 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2350 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2351 the bootcounter.
2352 CONFIG_BOOTCOUNT_ALEN = address len
f31dac4e
IR
2353 CONFIG_BOOTCOUNT_EXT
2354 enable support for the bootcounter in EXT filesystem
2355 CONFIG_SYS_BOOTCOUNT_ADDR = RAM address used for read
2356 and write.
2357 CONFIG_SYS_BOOTCOUNT_EXT_INTERFACE = interface
2358 CONFIG_SYS_BOOTCOUNT_EXT_DEVPART = device and part
2359 CONFIG_SYS_BOOTCOUNT_EXT_NAME = filename
19c402af 2360
a8c7c708 2361- Show boot progress:
c609719b
WD
2362 CONFIG_SHOW_BOOT_PROGRESS
2363
43d9616c
WD
2364 Defining this option allows to add some board-
2365 specific code (calling a user-provided function
2366 "show_boot_progress(int)") that enables you to show
2367 the system's boot progress on some display (for
2368 example, some LED's) on your board. At the moment,
2369 the following checkpoints are implemented:
c609719b 2370
94fd1316 2371
1372cce2
MB
2372Legacy uImage format:
2373
c609719b
WD
2374 Arg Where When
2375 1 common/cmd_bootm.c before attempting to boot an image
ba56f625 2376 -1 common/cmd_bootm.c Image header has bad magic number
c609719b 2377 2 common/cmd_bootm.c Image header has correct magic number
ba56f625 2378 -2 common/cmd_bootm.c Image header has bad checksum
c609719b 2379 3 common/cmd_bootm.c Image header has correct checksum
ba56f625 2380 -3 common/cmd_bootm.c Image data has bad checksum
c609719b
WD
2381 4 common/cmd_bootm.c Image data has correct checksum
2382 -4 common/cmd_bootm.c Image is for unsupported architecture
2383 5 common/cmd_bootm.c Architecture check OK
1372cce2 2384 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
c609719b
WD
2385 6 common/cmd_bootm.c Image Type check OK
2386 -6 common/cmd_bootm.c gunzip uncompression error
2387 -7 common/cmd_bootm.c Unimplemented compression type
2388 7 common/cmd_bootm.c Uncompression OK
1372cce2 2389 8 common/cmd_bootm.c No uncompress/copy overwrite error
c609719b 2390 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2
MB
2391
2392 9 common/image.c Start initial ramdisk verification
2393 -10 common/image.c Ramdisk header has bad magic number
2394 -11 common/image.c Ramdisk header has bad checksum
2395 10 common/image.c Ramdisk header is OK
2396 -12 common/image.c Ramdisk data has bad checksum
2397 11 common/image.c Ramdisk data has correct checksum
2398 12 common/image.c Ramdisk verification complete, start loading
11ccc33f 2399 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1372cce2
MB
2400 13 common/image.c Start multifile image verification
2401 14 common/image.c No initial ramdisk, no multifile, continue.
2402
c0f40859 2403 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
c609719b 2404
a47a12be 2405 -30 arch/powerpc/lib/board.c Fatal error, hang the system
11dadd54
WD
2406 -31 post/post.c POST test failed, detected by post_output_backlog()
2407 -32 post/post.c POST test failed, detected by post_run_single()
63e73c9a 2408
566a494f
HS
2409 34 common/cmd_doc.c before loading a Image from a DOC device
2410 -35 common/cmd_doc.c Bad usage of "doc" command
2411 35 common/cmd_doc.c correct usage of "doc" command
2412 -36 common/cmd_doc.c No boot device
2413 36 common/cmd_doc.c correct boot device
2414 -37 common/cmd_doc.c Unknown Chip ID on boot device
2415 37 common/cmd_doc.c correct chip ID found, device available
2416 -38 common/cmd_doc.c Read Error on boot device
2417 38 common/cmd_doc.c reading Image header from DOC device OK
2418 -39 common/cmd_doc.c Image header has bad magic number
2419 39 common/cmd_doc.c Image header has correct magic number
2420 -40 common/cmd_doc.c Error reading Image from DOC device
2421 40 common/cmd_doc.c Image header has correct magic number
2422 41 common/cmd_ide.c before loading a Image from a IDE device
2423 -42 common/cmd_ide.c Bad usage of "ide" command
2424 42 common/cmd_ide.c correct usage of "ide" command
2425 -43 common/cmd_ide.c No boot device
2426 43 common/cmd_ide.c boot device found
2427 -44 common/cmd_ide.c Device not available
2428 44 common/cmd_ide.c Device available
2429 -45 common/cmd_ide.c wrong partition selected
2430 45 common/cmd_ide.c partition selected
2431 -46 common/cmd_ide.c Unknown partition table
2432 46 common/cmd_ide.c valid partition table found
2433 -47 common/cmd_ide.c Invalid partition type
2434 47 common/cmd_ide.c correct partition type
2435 -48 common/cmd_ide.c Error reading Image Header on boot device
2436 48 common/cmd_ide.c reading Image Header from IDE device OK
2437 -49 common/cmd_ide.c Image header has bad magic number
2438 49 common/cmd_ide.c Image header has correct magic number
2439 -50 common/cmd_ide.c Image header has bad checksum
2440 50 common/cmd_ide.c Image header has correct checksum
2441 -51 common/cmd_ide.c Error reading Image from IDE device
2442 51 common/cmd_ide.c reading Image from IDE device OK
2443 52 common/cmd_nand.c before loading a Image from a NAND device
2444 -53 common/cmd_nand.c Bad usage of "nand" command
2445 53 common/cmd_nand.c correct usage of "nand" command
2446 -54 common/cmd_nand.c No boot device
2447 54 common/cmd_nand.c boot device found
2448 -55 common/cmd_nand.c Unknown Chip ID on boot device
2449 55 common/cmd_nand.c correct chip ID found, device available
2450 -56 common/cmd_nand.c Error reading Image Header on boot device
2451 56 common/cmd_nand.c reading Image Header from NAND device OK
2452 -57 common/cmd_nand.c Image header has bad magic number
2453 57 common/cmd_nand.c Image header has correct magic number
2454 -58 common/cmd_nand.c Error reading Image from NAND device
2455 58 common/cmd_nand.c reading Image from NAND device OK
2456
2457 -60 common/env_common.c Environment has a bad CRC, using default
2458
11ccc33f 2459 64 net/eth.c starting with Ethernet configuration.
566a494f
HS
2460 -64 net/eth.c no Ethernet found.
2461 65 net/eth.c Ethernet found.
2462
2463 -80 common/cmd_net.c usage wrong
bc0571fc
JH
2464 80 common/cmd_net.c before calling net_loop()
2465 -81 common/cmd_net.c some error in net_loop() occurred
2466 81 common/cmd_net.c net_loop() back without error
566a494f
HS
2467 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2468 82 common/cmd_net.c trying automatic boot
74de7aef
WD
2469 83 common/cmd_net.c running "source" command
2470 -83 common/cmd_net.c some error in automatic boot or "source" command
566a494f 2471 84 common/cmd_net.c end without errors
c609719b 2472
1372cce2
MB
2473FIT uImage format:
2474
2475 Arg Where When
2476 100 common/cmd_bootm.c Kernel FIT Image has correct format
2477 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2478 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2479 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2480 102 common/cmd_bootm.c Kernel unit name specified
2481 -103 common/cmd_bootm.c Can't get kernel subimage node offset
f773bea8 2482 103 common/cmd_bootm.c Found configuration node
1372cce2
MB
2483 104 common/cmd_bootm.c Got kernel subimage node offset
2484 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2485 105 common/cmd_bootm.c Kernel subimage hash verification OK
2486 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2487 106 common/cmd_bootm.c Architecture check OK
11ccc33f
MZ
2488 -106 common/cmd_bootm.c Kernel subimage has wrong type
2489 107 common/cmd_bootm.c Kernel subimage type OK
1372cce2
MB
2490 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2491 108 common/cmd_bootm.c Got kernel subimage data/size
2492 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2493 -109 common/cmd_bootm.c Can't get kernel subimage type
2494 -110 common/cmd_bootm.c Can't get kernel subimage comp
2495 -111 common/cmd_bootm.c Can't get kernel subimage os
2496 -112 common/cmd_bootm.c Can't get kernel subimage load address
2497 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2498
2499 120 common/image.c Start initial ramdisk verification
2500 -120 common/image.c Ramdisk FIT image has incorrect format
2501 121 common/image.c Ramdisk FIT image has correct format
11ccc33f 2502 122 common/image.c No ramdisk subimage unit name, using configuration
1372cce2
MB
2503 -122 common/image.c Can't get configuration for ramdisk subimage
2504 123 common/image.c Ramdisk unit name specified
2505 -124 common/image.c Can't get ramdisk subimage node offset
2506 125 common/image.c Got ramdisk subimage node offset
2507 -125 common/image.c Ramdisk subimage hash verification failed
2508 126 common/image.c Ramdisk subimage hash verification OK
2509 -126 common/image.c Ramdisk subimage for unsupported architecture
2510 127 common/image.c Architecture check OK
2511 -127 common/image.c Can't get ramdisk subimage data/size
2512 128 common/image.c Got ramdisk subimage data/size
2513 129 common/image.c Can't get ramdisk load address
2514 -129 common/image.c Got ramdisk load address
2515
11ccc33f 2516 -130 common/cmd_doc.c Incorrect FIT image format
1372cce2
MB
2517 131 common/cmd_doc.c FIT image format OK
2518
11ccc33f 2519 -140 common/cmd_ide.c Incorrect FIT image format
1372cce2
MB
2520 141 common/cmd_ide.c FIT image format OK
2521
11ccc33f 2522 -150 common/cmd_nand.c Incorrect FIT image format
1372cce2
MB
2523 151 common/cmd_nand.c FIT image format OK
2524
21d29f7f
HS
2525- legacy image format:
2526 CONFIG_IMAGE_FORMAT_LEGACY
2527 enables the legacy image format support in U-Boot.
2528
2529 Default:
2530 enabled if CONFIG_FIT_SIGNATURE is not defined.
2531
2532 CONFIG_DISABLE_IMAGE_LEGACY
2533 disable the legacy image format
2534
2535 This define is introduced, as the legacy image format is
2536 enabled per default for backward compatibility.
2537
4cf2609b
WD
2538- Standalone program support:
2539 CONFIG_STANDALONE_LOAD_ADDR
2540
6feff899
WD
2541 This option defines a board specific value for the
2542 address where standalone program gets loaded, thus
2543 overwriting the architecture dependent default
4cf2609b
WD
2544 settings.
2545
2546- Frame Buffer Address:
2547 CONFIG_FB_ADDR
2548
2549 Define CONFIG_FB_ADDR if you want to use specific
44a53b57
WD
2550 address for frame buffer. This is typically the case
2551 when using a graphics controller has separate video
2552 memory. U-Boot will then place the frame buffer at
2553 the given address instead of dynamically reserving it
2554 in system RAM by calling lcd_setmem(), which grabs
2555 the memory for the frame buffer depending on the
2556 configured panel size.
4cf2609b
WD
2557
2558 Please see board_init_f function.
2559
cccfc2ab
DZ
2560- Automatic software updates via TFTP server
2561 CONFIG_UPDATE_TFTP
2562 CONFIG_UPDATE_TFTP_CNT_MAX
2563 CONFIG_UPDATE_TFTP_MSEC_MAX
2564
2565 These options enable and control the auto-update feature;
2566 for a more detailed description refer to doc/README.update.
2567
2568- MTD Support (mtdparts command, UBI support)
2569 CONFIG_MTD_DEVICE
2570
2571 Adds the MTD device infrastructure from the Linux kernel.
2572 Needed for mtdparts command support.
2573
2574 CONFIG_MTD_PARTITIONS
2575
2576 Adds the MTD partitioning infrastructure from the Linux
2577 kernel. Needed for UBI support.
2578
70c219cd 2579- UBI support
147162da
JH
2580 CONFIG_UBI_SILENCE_MSG
2581
2582 Make the verbose messages from UBI stop printing. This leaves
2583 warnings and errors enabled.
2584
ff94bc40
HS
2585
2586 CONFIG_MTD_UBI_WL_THRESHOLD
2587 This parameter defines the maximum difference between the highest
2588 erase counter value and the lowest erase counter value of eraseblocks
2589 of UBI devices. When this threshold is exceeded, UBI starts performing
2590 wear leveling by means of moving data from eraseblock with low erase
2591 counter to eraseblocks with high erase counter.
2592
2593 The default value should be OK for SLC NAND flashes, NOR flashes and
2594 other flashes which have eraseblock life-cycle 100000 or more.
2595 However, in case of MLC NAND flashes which typically have eraseblock
2596 life-cycle less than 10000, the threshold should be lessened (e.g.,
2597 to 128 or 256, although it does not have to be power of 2).
2598
2599 default: 4096
c654b517 2600
ff94bc40
HS
2601 CONFIG_MTD_UBI_BEB_LIMIT
2602 This option specifies the maximum bad physical eraseblocks UBI
2603 expects on the MTD device (per 1024 eraseblocks). If the
2604 underlying flash does not admit of bad eraseblocks (e.g. NOR
2605 flash), this value is ignored.
2606
2607 NAND datasheets often specify the minimum and maximum NVM
2608 (Number of Valid Blocks) for the flashes' endurance lifetime.
2609 The maximum expected bad eraseblocks per 1024 eraseblocks
2610 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2611 which gives 20 for most NANDs (MaxNVB is basically the total
2612 count of eraseblocks on the chip).
2613
2614 To put it differently, if this value is 20, UBI will try to
2615 reserve about 1.9% of physical eraseblocks for bad blocks
2616 handling. And that will be 1.9% of eraseblocks on the entire
2617 NAND chip, not just the MTD partition UBI attaches. This means
2618 that if you have, say, a NAND flash chip admits maximum 40 bad
2619 eraseblocks, and it is split on two MTD partitions of the same
2620 size, UBI will reserve 40 eraseblocks when attaching a
2621 partition.
2622
2623 default: 20
2624
2625 CONFIG_MTD_UBI_FASTMAP
2626 Fastmap is a mechanism which allows attaching an UBI device
2627 in nearly constant time. Instead of scanning the whole MTD device it
2628 only has to locate a checkpoint (called fastmap) on the device.
2629 The on-flash fastmap contains all information needed to attach
2630 the device. Using fastmap makes only sense on large devices where
2631 attaching by scanning takes long. UBI will not automatically install
2632 a fastmap on old images, but you can set the UBI parameter
2633 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2634 that fastmap-enabled images are still usable with UBI implementations
2635 without fastmap support. On typical flash devices the whole fastmap
2636 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2637
2638 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2639 Set this parameter to enable fastmap automatically on images
2640 without a fastmap.
2641 default: 0
2642
0195a7bb
HS
2643 CONFIG_MTD_UBI_FM_DEBUG
2644 Enable UBI fastmap debug
2645 default: 0
2646
70c219cd 2647- UBIFS support
147162da
JH
2648 CONFIG_UBIFS_SILENCE_MSG
2649
2650 Make the verbose messages from UBIFS stop printing. This leaves
2651 warnings and errors enabled.
2652
6a11cf48 2653- SPL framework
04e5ae79
WD
2654 CONFIG_SPL
2655 Enable building of SPL globally.
6a11cf48 2656
95579793
TR
2657 CONFIG_SPL_LDSCRIPT
2658 LDSCRIPT for linking the SPL binary.
2659
6ebc3461
AA
2660 CONFIG_SPL_MAX_FOOTPRINT
2661 Maximum size in memory allocated to the SPL, BSS included.
2662 When defined, the linker checks that the actual memory
2663 used by SPL from _start to __bss_end does not exceed it.
8960af8b 2664 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc3461
AA
2665 must not be both defined at the same time.
2666
95579793 2667 CONFIG_SPL_MAX_SIZE
6ebc3461
AA
2668 Maximum size of the SPL image (text, data, rodata, and
2669 linker lists sections), BSS excluded.
2670 When defined, the linker checks that the actual size does
2671 not exceed it.
95579793 2672
04e5ae79
WD
2673 CONFIG_SPL_TEXT_BASE
2674 TEXT_BASE for linking the SPL binary.
6a11cf48 2675
94a45bb1
SW
2676 CONFIG_SPL_RELOC_TEXT_BASE
2677 Address to relocate to. If unspecified, this is equal to
2678 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2679
95579793
TR
2680 CONFIG_SPL_BSS_START_ADDR
2681 Link address for the BSS within the SPL binary.
2682
2683 CONFIG_SPL_BSS_MAX_SIZE
6ebc3461
AA
2684 Maximum size in memory allocated to the SPL BSS.
2685 When defined, the linker checks that the actual memory used
2686 by SPL from __bss_start to __bss_end does not exceed it.
8960af8b 2687 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc3461 2688 must not be both defined at the same time.
95579793
TR
2689
2690 CONFIG_SPL_STACK
2691 Adress of the start of the stack SPL will use
2692
8c80eb3b
AA
2693 CONFIG_SPL_PANIC_ON_RAW_IMAGE
2694 When defined, SPL will panic() if the image it has
2695 loaded does not have a signature.
2696 Defining this is useful when code which loads images
2697 in SPL cannot guarantee that absolutely all read errors
2698 will be caught.
2699 An example is the LPC32XX MLC NAND driver, which will
2700 consider that a completely unreadable NAND block is bad,
2701 and thus should be skipped silently.
2702
94a45bb1
SW
2703 CONFIG_SPL_RELOC_STACK
2704 Adress of the start of the stack SPL will use after
2705 relocation. If unspecified, this is equal to
2706 CONFIG_SPL_STACK.
2707
95579793
TR
2708 CONFIG_SYS_SPL_MALLOC_START
2709 Starting address of the malloc pool used in SPL.
9ac4fc82
FE
2710 When this option is set the full malloc is used in SPL and
2711 it is set up by spl_init() and before that, the simple malloc()
2712 can be used if CONFIG_SYS_MALLOC_F is defined.
95579793
TR
2713
2714 CONFIG_SYS_SPL_MALLOC_SIZE
2715 The size of the malloc pool used in SPL.
6a11cf48 2716
47f7bcae
TR
2717 CONFIG_SPL_FRAMEWORK
2718 Enable the SPL framework under common/. This framework
2719 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2720 NAND loading of the Linux Kernel.
2721
9607faf2
TR
2722 CONFIG_SPL_OS_BOOT
2723 Enable booting directly to an OS from SPL.
2724 See also: doc/README.falcon
2725
861a86f4
TR
2726 CONFIG_SPL_DISPLAY_PRINT
2727 For ARM, enable an optional function to print more information
2728 about the running system.
2729
4b919725
SW
2730 CONFIG_SPL_INIT_MINIMAL
2731 Arch init code should be built for a very small image
2732
b97300b6
PK
2733 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2734 Partition on the MMC to load U-Boot from when the MMC is being
2735 used in raw mode
2736
2b75b0ad
PK
2737 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2738 Sector to load kernel uImage from when MMC is being
2739 used in raw mode (for Falcon mode)
2740
2741 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2742 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2743 Sector and number of sectors to load kernel argument
2744 parameters from when MMC is being used in raw mode
2745 (for falcon mode)
2746
e2ccdf89
PK
2747 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2748 Partition on the MMC to load U-Boot from when the MMC is being
2749 used in fs mode
2750
fae81c72
GG
2751 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2752 Filename to read to load U-Boot when reading from filesystem
2753
2754 CONFIG_SPL_FS_LOAD_KERNEL_NAME
7ad2cc79 2755 Filename to read to load kernel uImage when reading
fae81c72 2756 from filesystem (for Falcon mode)
7ad2cc79 2757
fae81c72 2758 CONFIG_SPL_FS_LOAD_ARGS_NAME
7ad2cc79 2759 Filename to read to load kernel argument parameters
fae81c72 2760 when reading from filesystem (for Falcon mode)
7ad2cc79 2761
06f60ae3
SW
2762 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2763 Set this for NAND SPL on PPC mpc83xx targets, so that
2764 start.S waits for the rest of the SPL to load before
2765 continuing (the hardware starts execution after just
2766 loading the first page rather than the full 4K).
2767
651fcf60
PK
2768 CONFIG_SPL_SKIP_RELOCATE
2769 Avoid SPL relocation
2770
6f2f01b9
SW
2771 CONFIG_SPL_NAND_BASE
2772 Include nand_base.c in the SPL. Requires
2773 CONFIG_SPL_NAND_DRIVERS.
2774
2775 CONFIG_SPL_NAND_DRIVERS
2776 SPL uses normal NAND drivers, not minimal drivers.
2777
2778 CONFIG_SPL_NAND_ECC
2779 Include standard software ECC in the SPL
2780
95579793 2781 CONFIG_SPL_NAND_SIMPLE
7d4b7955
SW
2782 Support for NAND boot using simple NAND drivers that
2783 expose the cmd_ctrl() interface.
95579793 2784
6f4e7d3c
TG
2785 CONFIG_SPL_UBI
2786 Support for a lightweight UBI (fastmap) scanner and
2787 loader
2788
0c3117b1
HS
2789 CONFIG_SPL_NAND_RAW_ONLY
2790 Support to boot only raw u-boot.bin images. Use this only
2791 if you need to save space.
2792
7c8eea59
YZ
2793 CONFIG_SPL_COMMON_INIT_DDR
2794 Set for common ddr init with serial presence detect in
2795 SPL binary.
2796
95579793
TR
2797 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2798 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2799 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2800 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2801 CONFIG_SYS_NAND_ECCBYTES
2802 Defines the size and behavior of the NAND that SPL uses
7d4b7955 2803 to read U-Boot
95579793 2804
fbe76ae4
PK
2805 CONFIG_SPL_NAND_BOOT
2806 Add support NAND boot
2807
95579793 2808 CONFIG_SYS_NAND_U_BOOT_OFFS
7d4b7955
SW
2809 Location in NAND to read U-Boot from
2810
2811 CONFIG_SYS_NAND_U_BOOT_DST
2812 Location in memory to load U-Boot to
2813
2814 CONFIG_SYS_NAND_U_BOOT_SIZE
2815 Size of image to load
95579793
TR
2816
2817 CONFIG_SYS_NAND_U_BOOT_START
7d4b7955 2818 Entry point in loaded image to jump to
95579793
TR
2819
2820 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2821 Define this if you need to first read the OOB and then the
b445bbb4 2822 data. This is used, for example, on davinci platforms.
95579793 2823
c57b953d
PM
2824 CONFIG_SPL_RAM_DEVICE
2825 Support for running image already present in ram, in SPL binary
6a11cf48 2826
74752baa 2827 CONFIG_SPL_PAD_TO
6113d3f2
BT
2828 Image offset to which the SPL should be padded before appending
2829 the SPL payload. By default, this is defined as
2830 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2831 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2832 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
74752baa 2833
ca2fca22
SW
2834 CONFIG_SPL_TARGET
2835 Final target image containing SPL and payload. Some SPLs
2836 use an arch-specific makefile fragment instead, for
2837 example if more than one image needs to be produced.
2838
87ebee39
SG
2839 CONFIG_FIT_SPL_PRINT
2840 Printing information about a FIT image adds quite a bit of
2841 code to SPL. So this is normally disabled in SPL. Use this
2842 option to re-enable it. This will affect the output of the
2843 bootm command when booting a FIT image.
2844
3aa29de0
YZ
2845- TPL framework
2846 CONFIG_TPL
2847 Enable building of TPL globally.
2848
2849 CONFIG_TPL_PAD_TO
2850 Image offset to which the TPL should be padded before appending
2851 the TPL payload. By default, this is defined as
93e14596
WD
2852 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
2853 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
2854 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3aa29de0 2855
a8c7c708
WD
2856- Interrupt support (PPC):
2857
d4ca31c4
WD
2858 There are common interrupt_init() and timer_interrupt()
2859 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33f 2860 for CPU specific initialization. interrupt_init_cpu()
d4ca31c4 2861 should set decrementer_count to appropriate value. If
11ccc33f 2862 CPU resets decrementer automatically after interrupt
d4ca31c4 2863 (ppc4xx) it should set decrementer_count to zero.
11ccc33f 2864 timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c4
WD
2865 specific handling. If board has watchdog / status_led
2866 / other_activity_monitor it works automatically from
2867 general timer_interrupt().
a8c7c708 2868
c609719b 2869
9660e442
HR
2870Board initialization settings:
2871------------------------------
2872
2873During Initialization u-boot calls a number of board specific functions
2874to allow the preparation of board specific prerequisites, e.g. pin setup
2875before drivers are initialized. To enable these callbacks the
2876following configuration macros have to be defined. Currently this is
2877architecture specific, so please check arch/your_architecture/lib/board.c
2878typically in board_init_f() and board_init_r().
2879
2880- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2881- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2882- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2883- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
c609719b 2884
c609719b
WD
2885Configuration Settings:
2886-----------------------
2887
4d1fd7f1
YS
2888- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
2889 Optionally it can be defined to support 64-bit memory commands.
2890
6d0f6bcf 2891- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b
WD
2892 undefine this when you're short of memory.
2893
2fb2604d
PT
2894- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2895 width of the commands listed in the 'help' command output.
2896
6d0f6bcf 2897- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
c609719b
WD
2898 prompt for user input.
2899
6d0f6bcf 2900- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
c609719b 2901
6d0f6bcf 2902- CONFIG_SYS_PBSIZE: Buffer size for Console output
c609719b 2903
6d0f6bcf 2904- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
c609719b 2905
6d0f6bcf 2906- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b
WD
2907 the application (usually a Linux kernel) when it is
2908 booted
2909
6d0f6bcf 2910- CONFIG_SYS_BAUDRATE_TABLE:
c609719b
WD
2911 List of legal baudrate settings for this board.
2912
6d0f6bcf 2913- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b
WD
2914 Begin and End addresses of the area used by the
2915 simple memory test.
2916
6d0f6bcf 2917- CONFIG_SYS_ALT_MEMTEST:
8bde7f77 2918 Enable an alternate, more extensive memory test.
c609719b 2919
6d0f6bcf 2920- CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe1
WD
2921 Scratch address used by the alternate memory test
2922 You only need to set this if address zero isn't writeable
2923
e8149522 2924- CONFIG_SYS_MEM_RESERVE_SECURE
e61a7534 2925 Only implemented for ARMv8 for now.
e8149522
YS
2926 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2927 is substracted from total RAM and won't be reported to OS.
2928 This memory can be used as secure memory. A variable
e61a7534 2929 gd->arch.secure_ram is used to track the location. In systems
e8149522
YS
2930 the RAM base is not zero, or RAM is divided into banks,
2931 this variable needs to be recalcuated to get the address.
2932
aabd7ddb 2933- CONFIG_SYS_MEM_TOP_HIDE:
6d0f6bcf 2934 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
14f73ca6 2935 this specified memory area will get subtracted from the top
11ccc33f 2936 (end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca6
SR
2937 fixing up gd->ram_size the Linux kernel should gets passed
2938 the now "corrected" memory size and won't touch it either.
2939 This should work for arch/ppc and arch/powerpc. Only Linux
5e12e75d 2940 board ports in arch/powerpc with bootwrapper support that
14f73ca6 2941 recalculate the memory size from the SDRAM controller setup
5e12e75d 2942 will have to get fixed in Linux additionally.
14f73ca6
SR
2943
2944 This option can be used as a workaround for the 440EPx/GRx
2945 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2946 be touched.
2947
2948 WARNING: Please make sure that this value is a multiple of
2949 the Linux page size (normally 4k). If this is not the case,
2950 then the end address of the Linux memory will be located at a
2951 non page size aligned address and this could cause major
2952 problems.
2953
6d0f6bcf 2954- CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b
WD
2955 Enable temporary baudrate change while serial download
2956
6d0f6bcf 2957- CONFIG_SYS_SDRAM_BASE:
c609719b
WD
2958 Physical start address of SDRAM. _Must_ be 0 here.
2959
6d0f6bcf 2960- CONFIG_SYS_FLASH_BASE:
c609719b
WD
2961 Physical start address of Flash memory.
2962
6d0f6bcf 2963- CONFIG_SYS_MONITOR_BASE:
c609719b
WD
2964 Physical start address of boot monitor code (set by
2965 make config files to be same as the text base address
14d0a02a 2966 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
6d0f6bcf 2967 CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b 2968
6d0f6bcf 2969- CONFIG_SYS_MONITOR_LEN:
8bde7f77
WD
2970 Size of memory reserved for monitor code, used to
2971 determine _at_compile_time_ (!) if the environment is
2972 embedded within the U-Boot image, or in a separate
2973 flash sector.
c609719b 2974
6d0f6bcf 2975- CONFIG_SYS_MALLOC_LEN:
c609719b
WD
2976 Size of DRAM reserved for malloc() use.
2977
d59476b6
SG
2978- CONFIG_SYS_MALLOC_F_LEN
2979 Size of the malloc() pool for use before relocation. If
2980 this is defined, then a very simple malloc() implementation
2981 will become available before relocation. The address is just
2982 below the global data, and the stack is moved down to make
2983 space.
2984
2985 This feature allocates regions with increasing addresses
2986 within the region. calloc() is supported, but realloc()
2987 is not available. free() is supported but does nothing.
b445bbb4 2988 The memory will be freed (or in fact just forgotten) when
d59476b6
SG
2989 U-Boot relocates itself.
2990
38687ae6
SG
2991- CONFIG_SYS_MALLOC_SIMPLE
2992 Provides a simple and small malloc() and calloc() for those
2993 boards which do not use the full malloc in SPL (which is
2994 enabled with CONFIG_SYS_SPL_MALLOC_START).
2995
1dfdd9ba
TR
2996- CONFIG_SYS_NONCACHED_MEMORY:
2997 Size of non-cached memory area. This area of memory will be
2998 typically located right below the malloc() area and mapped
2999 uncached in the MMU. This is useful for drivers that would
3000 otherwise require a lot of explicit cache maintenance. For
3001 some drivers it's also impossible to properly maintain the
3002 cache. For example if the regions that need to be flushed
3003 are not a multiple of the cache-line size, *and* padding
3004 cannot be allocated between the regions to align them (i.e.
3005 if the HW requires a contiguous array of regions, and the
3006 size of each region is not cache-aligned), then a flush of
3007 one region may result in overwriting data that hardware has
3008 written to another region in the same cache-line. This can
3009 happen for example in network drivers where descriptors for
3010 buffers are typically smaller than the CPU cache-line (e.g.
3011 16 bytes vs. 32 or 64 bytes).
3012
3013 Non-cached memory is only supported on 32-bit ARM at present.
3014
6d0f6bcf 3015- CONFIG_SYS_BOOTM_LEN:
15940c9a
SR
3016 Normally compressed uImages are limited to an
3017 uncompressed size of 8 MBytes. If this is not enough,
6d0f6bcf 3018 you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9a
SR
3019 to adjust this setting to your needs.
3020
6d0f6bcf 3021- CONFIG_SYS_BOOTMAPSZ:
c609719b
WD
3022 Maximum size of memory mapped by the startup code of
3023 the Linux kernel; all data that must be processed by
7d721e34
BS
3024 the Linux kernel (bd_info, boot arguments, FDT blob if
3025 used) must be put below this limit, unless "bootm_low"
1bce2aeb 3026 environment variable is defined and non-zero. In such case
7d721e34 3027 all data for the Linux kernel must be between "bootm_low"
c0f40859 3028 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
c3624e6e
GL
3029 variable "bootm_mapsize" will override the value of
3030 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3031 then the value in "bootm_size" will be used instead.
c609719b 3032
fca43cc8
JR
3033- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3034 Enable initrd_high functionality. If defined then the
3035 initrd_high feature is enabled and the bootm ramdisk subcommand
3036 is enabled.
3037
3038- CONFIG_SYS_BOOT_GET_CMDLINE:
3039 Enables allocating and saving kernel cmdline in space between
3040 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3041
3042- CONFIG_SYS_BOOT_GET_KBD:
3043 Enables allocating and saving a kernel copy of the bd_info in
3044 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3045
6d0f6bcf 3046- CONFIG_SYS_MAX_FLASH_BANKS:
c609719b
WD
3047 Max number of Flash memory banks
3048
6d0f6bcf 3049- CONFIG_SYS_MAX_FLASH_SECT:
c609719b
WD
3050 Max number of sectors on a Flash chip
3051
6d0f6bcf 3052- CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b
WD
3053 Timeout for Flash erase operations (in ms)
3054
6d0f6bcf 3055- CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b
WD
3056 Timeout for Flash write operations (in ms)
3057
6d0f6bcf 3058- CONFIG_SYS_FLASH_LOCK_TOUT
8564acf9
WD
3059 Timeout for Flash set sector lock bit operation (in ms)
3060
6d0f6bcf 3061- CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf9
WD
3062 Timeout for Flash clear lock bits operation (in ms)
3063
6d0f6bcf 3064- CONFIG_SYS_FLASH_PROTECTION
8564acf9
WD
3065 If defined, hardware flash sectors protection is used
3066 instead of U-Boot software protection.
3067
6d0f6bcf 3068- CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b
WD
3069
3070 Enable TFTP transfers directly to flash memory;
3071 without this option such a download has to be
3072 performed in two steps: (1) download to RAM, and (2)
3073 copy from RAM to flash.
3074
3075 The two-step approach is usually more reliable, since
3076 you can check if the download worked before you erase
11ccc33f
MZ
3077 the flash, but in some situations (when system RAM is
3078 too limited to allow for a temporary copy of the
c609719b
WD
3079 downloaded image) this option may be very useful.
3080
6d0f6bcf 3081- CONFIG_SYS_FLASH_CFI:
43d9616c 3082 Define if the flash driver uses extra elements in the
5653fc33
WD
3083 common flash structure for storing flash geometry.
3084
00b1883a 3085- CONFIG_FLASH_CFI_DRIVER
5653fc33
WD
3086 This option also enables the building of the cfi_flash driver
3087 in the drivers directory
c609719b 3088
91809ed5
PZ
3089- CONFIG_FLASH_CFI_MTD
3090 This option enables the building of the cfi_mtd driver
3091 in the drivers directory. The driver exports CFI flash
3092 to the MTD layer.
3093
6d0f6bcf 3094- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f
GL
3095 Use buffered writes to flash.
3096
3097- CONFIG_FLASH_SPANSION_S29WS_N
3098 s29ws-n MirrorBit flash has non-standard addresses for buffered
3099 write commands.
3100
6d0f6bcf 3101- CONFIG_SYS_FLASH_QUIET_TEST
5568e613
SR
3102 If this option is defined, the common CFI flash doesn't
3103 print it's warning upon not recognized FLASH banks. This
3104 is useful, if some of the configured banks are only
3105 optionally available.
3106
9a042e9c
JVB
3107- CONFIG_FLASH_SHOW_PROGRESS
3108 If defined (must be an integer), print out countdown
3109 digits and dots. Recommended value: 45 (9..1) for 80
3110 column displays, 15 (3..1) for 40 column displays.
3111
352ef3f1
SR
3112- CONFIG_FLASH_VERIFY
3113 If defined, the content of the flash (destination) is compared
3114 against the source after the write operation. An error message
3115 will be printed when the contents are not identical.
3116 Please note that this option is useless in nearly all cases,
3117 since such flash programming errors usually are detected earlier
3118 while unprotecting/erasing/programming. Please only enable
3119 this option if you really know what you are doing.
3120
6d0f6bcf 3121- CONFIG_SYS_RX_ETH_BUFFER:
11ccc33f
MZ
3122 Defines the number of Ethernet receive buffers. On some
3123 Ethernet controllers it is recommended to set this value
53cf9435
SR
3124 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3125 buffers can be full shortly after enabling the interface
11ccc33f 3126 on high Ethernet traffic.
53cf9435
SR
3127 Defaults to 4 if not defined.
3128
ea882baf
WD
3129- CONFIG_ENV_MAX_ENTRIES
3130
071bc923
WD
3131 Maximum number of entries in the hash table that is used
3132 internally to store the environment settings. The default
3133 setting is supposed to be generous and should work in most
3134 cases. This setting can be used to tune behaviour; see
3135 lib/hashtable.c for details.
ea882baf 3136
2598090b
JH
3137- CONFIG_ENV_FLAGS_LIST_DEFAULT
3138- CONFIG_ENV_FLAGS_LIST_STATIC
1bce2aeb 3139 Enable validation of the values given to environment variables when
2598090b
JH
3140 calling env set. Variables can be restricted to only decimal,
3141 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3142 the variables can also be restricted to IP address or MAC address.
3143
3144 The format of the list is:
3145 type_attribute = [s|d|x|b|i|m]
b445bbb4
JM
3146 access_attribute = [a|r|o|c]
3147 attributes = type_attribute[access_attribute]
2598090b
JH
3148 entry = variable_name[:attributes]
3149 list = entry[,list]
3150
3151 The type attributes are:
3152 s - String (default)
3153 d - Decimal
3154 x - Hexadecimal
3155 b - Boolean ([1yYtT|0nNfF])
3156 i - IP address
3157 m - MAC address
3158
267541f7
JH
3159 The access attributes are:
3160 a - Any (default)
3161 r - Read-only
3162 o - Write-once
3163 c - Change-default
3164
2598090b
JH
3165 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3166 Define this to a list (string) to define the ".flags"
b445bbb4 3167 environment variable in the default or embedded environment.
2598090b
JH
3168
3169 - CONFIG_ENV_FLAGS_LIST_STATIC
3170 Define this to a list (string) to define validation that
3171 should be done if an entry is not found in the ".flags"
3172 environment variable. To override a setting in the static
3173 list, simply add an entry for the same variable name to the
3174 ".flags" variable.
3175
bdf1fe4e
JH
3176 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3177 regular expression. This allows multiple variables to define the same
3178 flags without explicitly listing them for each variable.
3179
267541f7
JH
3180- CONFIG_ENV_ACCESS_IGNORE_FORCE
3181 If defined, don't allow the -f switch to env set override variable
3182 access flags.
3183
0d296cc2
GB
3184- CONFIG_USE_STDINT
3185 If stdint.h is available with your toolchain you can define this
3186 option to enable it. You can provide option 'USE_STDINT=1' when
3187 building U-Boot to enable this.
3188
c609719b
WD
3189The following definitions that deal with the placement and management
3190of environment data (variable area); in general, we support the
3191following configurations:
3192
c3eb3fe4
MF
3193- CONFIG_BUILD_ENVCRC:
3194
3195 Builds up envcrc with the target environment so that external utils
3196 may easily extract it and embed it in final U-Boot images.
3197
c609719b 3198BE CAREFUL! The first access to the environment happens quite early
b445bbb4 3199in U-Boot initialization (when we try to get the setting of for the
11ccc33f 3200console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b
WD
3201U-Boot will hang.
3202
3203Please note that even with NVRAM we still use a copy of the
3204environment in RAM: we could work on NVRAM directly, but we want to
3205keep settings there always unmodified except somebody uses "saveenv"
3206to save the current settings.
3207
0a85a9e7
LG
3208BE CAREFUL! For some special cases, the local device can not use
3209"saveenv" command. For example, the local device will get the
fc54c7fa
LG
3210environment stored in a remote NOR flash by SRIO or PCIE link,
3211but it can not erase, write this NOR flash by SRIO or PCIE interface.
0a85a9e7 3212
b74ab737
GL
3213- CONFIG_NAND_ENV_DST
3214
3215 Defines address in RAM to which the nand_spl code should copy the
3216 environment. If redundant environment is used, it will be copied to
3217 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3218
e881cb56 3219Please note that the environment is read-only until the monitor
c609719b 3220has been relocated to RAM and a RAM copy of the environment has been
00caae6d 3221created; also, when using EEPROM you will have to use env_get_f()
c609719b
WD
3222until then to read environment variables.
3223
85ec0bcc
WD
3224The environment is protected by a CRC32 checksum. Before the monitor
3225is relocated into RAM, as a result of a bad CRC you will be working
3226with the compiled-in default environment - *silently*!!! [This is
3227necessary, because the first environment variable we need is the
3228"baudrate" setting for the console - if we have a bad CRC, we don't
3229have any device yet where we could complain.]
c609719b
WD
3230
3231Note: once the monitor has been relocated, then it will complain if
3232the default environment is used; a new CRC is computed as soon as you
85ec0bcc 3233use the "saveenv" command to store a valid environment.
c609719b 3234
6d0f6bcf 3235- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
42d1f039 3236 Echo the inverted Ethernet link state to the fault LED.
fc3e2165 3237
6d0f6bcf 3238 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
fc3e2165
WD
3239 also needs to be defined.
3240
6d0f6bcf 3241- CONFIG_SYS_FAULT_MII_ADDR:
42d1f039 3242 MII address of the PHY to check for the Ethernet link state.
c609719b 3243
f5675aa5
RM
3244- CONFIG_NS16550_MIN_FUNCTIONS:
3245 Define this if you desire to only have use of the NS16550_init
3246 and NS16550_putc functions for the serial driver located at
3247 drivers/serial/ns16550.c. This option is useful for saving
3248 space for already greatly restricted images, including but not
3249 limited to NAND_SPL configurations.
3250
b2b92f53
SG
3251- CONFIG_DISPLAY_BOARDINFO
3252 Display information about the board that U-Boot is running on
3253 when U-Boot starts up. The board function checkboard() is called
3254 to do this.
3255
e2e3e2b1
SG
3256- CONFIG_DISPLAY_BOARDINFO_LATE
3257 Similar to the previous option, but display this information
3258 later, once stdio is running and output goes to the LCD, if
3259 present.
3260
feb85801
SS
3261- CONFIG_BOARD_SIZE_LIMIT:
3262 Maximum size of the U-Boot image. When defined, the
3263 build system checks that the actual size does not
3264 exceed it.
3265
c609719b 3266Low Level (hardware related) configuration options:
dc7c9a1a 3267---------------------------------------------------
c609719b 3268
6d0f6bcf 3269- CONFIG_SYS_CACHELINE_SIZE:
c609719b
WD
3270 Cache Line Size of the CPU.
3271
e46fedfe
TT
3272- CONFIG_SYS_CCSRBAR_DEFAULT:
3273 Default (power-on reset) physical address of CCSR on Freescale
3274 PowerPC SOCs.
3275
3276- CONFIG_SYS_CCSRBAR:
3277 Virtual address of CCSR. On a 32-bit build, this is typically
3278 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3279
e46fedfe
TT
3280- CONFIG_SYS_CCSRBAR_PHYS:
3281 Physical address of CCSR. CCSR can be relocated to a new
3282 physical address, if desired. In this case, this macro should
c0f40859 3283 be set to that address. Otherwise, it should be set to the
e46fedfe
TT
3284 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3285 is typically relocated on 36-bit builds. It is recommended
3286 that this macro be defined via the _HIGH and _LOW macros:
3287
3288 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3289 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3290
3291- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4cf2609b
WD
3292 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3293 either 0 (32-bit build) or 0xF (36-bit build). This macro is
e46fedfe
TT
3294 used in assembly code, so it must not contain typecasts or
3295 integer size suffixes (e.g. "ULL").
3296
3297- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3298 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3299 used in assembly code, so it must not contain typecasts or
3300 integer size suffixes (e.g. "ULL").
3301
3302- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3303 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3304 forced to a value that ensures that CCSR is not relocated.
3305
7f6c2cbc 3306- Floppy Disk Support:
6d0f6bcf 3307 CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc
WD
3308
3309 the default drive number (default value 0)
3310
6d0f6bcf 3311 CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc 3312
11ccc33f 3313 defines the spacing between FDC chipset registers
7f6c2cbc
WD
3314 (default value 1)
3315
6d0f6bcf 3316 CONFIG_SYS_ISA_IO_OFFSET
7f6c2cbc 3317
43d9616c
WD
3318 defines the offset of register from address. It
3319 depends on which part of the data bus is connected to
11ccc33f 3320 the FDC chipset. (default value 0)
7f6c2cbc 3321
6d0f6bcf
JCPV
3322 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3323 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
43d9616c 3324 default value.
7f6c2cbc 3325
6d0f6bcf 3326 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43d9616c
WD
3327 fdc_hw_init() is called at the beginning of the FDC
3328 setup. fdc_hw_init() must be provided by the board
b445bbb4 3329 source code. It is used to make hardware-dependent
43d9616c 3330 initializations.
7f6c2cbc 3331
0abddf82
ML
3332- CONFIG_IDE_AHB:
3333 Most IDE controllers were designed to be connected with PCI
3334 interface. Only few of them were designed for AHB interface.
3335 When software is doing ATA command and data transfer to
3336 IDE devices through IDE-AHB controller, some additional
3337 registers accessing to these kind of IDE-AHB controller
b445bbb4 3338 is required.
0abddf82 3339
6d0f6bcf 3340- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
efe2a4d5 3341 DO NOT CHANGE unless you know exactly what you're
907208c4 3342 doing! (11-4) [MPC8xx systems only]
c609719b 3343
6d0f6bcf 3344- CONFIG_SYS_INIT_RAM_ADDR:
c609719b 3345
7152b1d0 3346 Start address of memory area that can be used for
c609719b
WD
3347 initial data and stack; please note that this must be
3348 writable memory that is working WITHOUT special
3349 initialization, i. e. you CANNOT use normal RAM which
3350 will become available only after programming the
3351 memory controller and running certain initialization
3352 sequences.
3353
3354 U-Boot uses the following memory types:
907208c4 3355 - MPC8xx: IMMR (internal memory of the CPU)
c609719b 3356
6d0f6bcf 3357- CONFIG_SYS_GBL_DATA_OFFSET:
c609719b
WD
3358
3359 Offset of the initial data structure in the memory
6d0f6bcf
JCPV
3360 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3361 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b 3362 data is located at the end of the available space
553f0982 3363 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
acd51f9d 3364 GENERATED_GBL_DATA_SIZE), and the initial stack is just
6d0f6bcf
JCPV
3365 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3366 CONFIG_SYS_GBL_DATA_OFFSET) downward.
c609719b
WD
3367
3368 Note:
3369 On the MPC824X (or other systems that use the data
3370 cache for initial memory) the address chosen for
6d0f6bcf 3371 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b
WD
3372 point to an otherwise UNUSED address space between
3373 the top of RAM and the start of the PCI space.
3374
6d0f6bcf 3375- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
c609719b 3376
6d0f6bcf 3377- CONFIG_SYS_OR_TIMING_SDRAM:
c609719b
WD
3378 SDRAM timing
3379
6d0f6bcf 3380- CONFIG_SYS_MAMR_PTA:
c609719b
WD
3381 periodic timer for refresh
3382
6d0f6bcf
JCPV
3383- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3384 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3385 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3386 CONFIG_SYS_BR1_PRELIM:
c609719b
WD
3387 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3388
3389- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
6d0f6bcf
JCPV
3390 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3391 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
c609719b
WD
3392 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3393
69fd2d3b 3394- CONFIG_PCI_ENUM_ONLY
b445bbb4 3395 Only scan through and get the devices on the buses.
69fd2d3b
AS
3396 Don't do any setup work, presumably because someone or
3397 something has already done it, and we don't need to do it
3398 a second time. Useful for platforms that are pre-booted
3399 by coreboot or similar.
3400
842033e6
GJ
3401- CONFIG_PCI_INDIRECT_BRIDGE:
3402 Enable support for indirect PCI bridges.
3403
a09b9b68
KG
3404- CONFIG_SYS_SRIO:
3405 Chip has SRIO or not
3406
3407- CONFIG_SRIO1:
3408 Board has SRIO 1 port available
3409
3410- CONFIG_SRIO2:
3411 Board has SRIO 2 port available
3412
c8b28152
LG
3413- CONFIG_SRIO_PCIE_BOOT_MASTER
3414 Board can support master function for Boot from SRIO and PCIE
3415
a09b9b68
KG
3416- CONFIG_SYS_SRIOn_MEM_VIRT:
3417 Virtual Address of SRIO port 'n' memory region
3418
3419- CONFIG_SYS_SRIOn_MEM_PHYS:
3420 Physical Address of SRIO port 'n' memory region
3421
3422- CONFIG_SYS_SRIOn_MEM_SIZE:
3423 Size of SRIO port 'n' memory region
3424
66bd1846
FE
3425- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3426 Defined to tell the NAND controller that the NAND chip is using
3427 a 16 bit bus.
3428 Not all NAND drivers use this symbol.
a430e916 3429 Example of drivers that use it:
66bd1846 3430 - drivers/mtd/nand/ndfc.c
a430e916 3431 - drivers/mtd/nand/mxc_nand.c
eced4626
AW
3432
3433- CONFIG_SYS_NDFC_EBC0_CFG
3434 Sets the EBC0_CFG register for the NDFC. If not defined
3435 a default value will be used.
3436
bb99ad6d 3437- CONFIG_SPD_EEPROM
218ca724
WD
3438 Get DDR timing information from an I2C EEPROM. Common
3439 with pluggable memory modules such as SODIMMs
3440
bb99ad6d
BW
3441 SPD_EEPROM_ADDRESS
3442 I2C address of the SPD EEPROM
3443
6d0f6bcf 3444- CONFIG_SYS_SPD_BUS_NUM
218ca724
WD
3445 If SPD EEPROM is on an I2C bus other than the first
3446 one, specify here. Note that the value must resolve
3447 to something your driver can deal with.
bb99ad6d 3448
1b3e3c4f
YS
3449- CONFIG_SYS_DDR_RAW_TIMING
3450 Get DDR timing information from other than SPD. Common with
3451 soldered DDR chips onboard without SPD. DDR raw timing
3452 parameters are extracted from datasheet and hard-coded into
3453 header files or board specific files.
3454
6f5e1dc5
YS
3455- CONFIG_FSL_DDR_INTERACTIVE
3456 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3457
e32d59a2
YS
3458- CONFIG_FSL_DDR_SYNC_REFRESH
3459 Enable sync of refresh for multiple controllers.
3460
4516ff81
YS
3461- CONFIG_FSL_DDR_BIST
3462 Enable built-in memory test for Freescale DDR controllers.
3463
6d0f6bcf 3464- CONFIG_SYS_83XX_DDR_USES_CS0
218ca724
WD
3465 Only for 83xx systems. If specified, then DDR should
3466 be configured using CS0 and CS1 instead of CS2 and CS3.
2ad6b513 3467
c26e454d
WD
3468- CONFIG_RMII
3469 Enable RMII mode for all FECs.
3470 Note that this is a global option, we can't
3471 have one FEC in standard MII mode and another in RMII mode.
3472
5cf91d6b
WD
3473- CONFIG_CRC32_VERIFY
3474 Add a verify option to the crc32 command.
3475 The syntax is:
3476
3477 => crc32 -v <address> <count> <crc32>
3478
3479 Where address/count indicate a memory area
3480 and crc32 is the correct crc32 which the
3481 area should have.
3482
56523f12
WD
3483- CONFIG_LOOPW
3484 Add the "loopw" memory command. This only takes effect if
493f420e 3485 the memory commands are activated globally (CONFIG_CMD_MEMORY).
56523f12 3486
7b466641
SR
3487- CONFIG_MX_CYCLIC
3488 Add the "mdc" and "mwc" memory commands. These are cyclic
3489 "md/mw" commands.
3490 Examples:
3491
efe2a4d5 3492 => mdc.b 10 4 500
7b466641
SR
3493 This command will print 4 bytes (10,11,12,13) each 500 ms.
3494
efe2a4d5 3495 => mwc.l 100 12345678 10
7b466641
SR
3496 This command will write 12345678 to address 100 all 10 ms.
3497
efe2a4d5 3498 This only takes effect if the memory commands are activated
493f420e 3499 globally (CONFIG_CMD_MEMORY).
7b466641 3500
8aa1a2d1 3501- CONFIG_SKIP_LOWLEVEL_INIT
3fafced7 3502 [ARM, NDS32, MIPS, RISC-V only] If this variable is defined, then certain
844f07d8
WD
3503 low level initializations (like setting up the memory
3504 controller) are omitted and/or U-Boot does not
3505 relocate itself into RAM.
3506
3507 Normally this variable MUST NOT be defined. The only
3508 exception is when U-Boot is loaded (to RAM) by some
3509 other boot loader or by a debugger which performs
3510 these initializations itself.
8aa1a2d1 3511
b5bd0982
SG
3512- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3513 [ARM926EJ-S only] This allows just the call to lowlevel_init()
90211f77 3514 to be skipped. The normal CP15 init (such as enabling the
b5bd0982
SG
3515 instruction cache) is still performed.
3516
401bb30b 3517- CONFIG_SPL_BUILD
df81238b
ML
3518 Modifies the behaviour of start.S when compiling a loader
3519 that is executed before the actual U-Boot. E.g. when
3520 compiling a NAND SPL.
400558b5 3521
3aa29de0
YZ
3522- CONFIG_TPL_BUILD
3523 Modifies the behaviour of start.S when compiling a loader
3524 that is executed after the SPL and before the actual U-Boot.
3525 It is loaded by the SPL.
3526
5df572f0
YZ
3527- CONFIG_SYS_MPC85XX_NO_RESETVEC
3528 Only for 85xx systems. If this variable is specified, the section
3529 .resetvec is not kept and the section .bootpg is placed in the
3530 previous 4k of the .text section.
3531
4213fc29
SG
3532- CONFIG_ARCH_MAP_SYSMEM
3533 Generally U-Boot (and in particular the md command) uses
3534 effective address. It is therefore not necessary to regard
3535 U-Boot address as virtual addresses that need to be translated
3536 to physical addresses. However, sandbox requires this, since
3537 it maintains its own little RAM buffer which contains all
3538 addressable memory. This option causes some memory accesses
3539 to be mapped through map_sysmem() / unmap_sysmem().
3540
588a13f7
SG
3541- CONFIG_X86_RESET_VECTOR
3542 If defined, the x86 reset vector code is included. This is not
3543 needed when U-Boot is running from Coreboot.
b16f521a 3544
16678eb4
HS
3545- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
3546 Enables the RTC32K OSC on AM33xx based plattforms
3547
999d7d32
KM
3548- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3549 Option to disable subpage write in NAND driver
3550 driver that uses this:
3551 drivers/mtd/nand/davinci_nand.c
3552
f2717b47
TT
3553Freescale QE/FMAN Firmware Support:
3554-----------------------------------
3555
3556The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3557loading of "firmware", which is encoded in the QE firmware binary format.
3558This firmware often needs to be loaded during U-Boot booting, so macros
3559are used to identify the storage device (NOR flash, SPI, etc) and the address
3560within that device.
3561
dcf1d774
ZQ
3562- CONFIG_SYS_FMAN_FW_ADDR
3563 The address in the storage device where the FMAN microcode is located. The
3564 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3565 is also specified.
3566
3567- CONFIG_SYS_QE_FW_ADDR
3568 The address in the storage device where the QE microcode is located. The
f2717b47
TT
3569 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3570 is also specified.
3571
3572- CONFIG_SYS_QE_FMAN_FW_LENGTH
3573 The maximum possible size of the firmware. The firmware binary format
3574 has a field that specifies the actual size of the firmware, but it
3575 might not be possible to read any part of the firmware unless some
3576 local storage is allocated to hold the entire firmware first.
3577
3578- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3579 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3580 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3581 virtual address in NOR flash.
3582
3583- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3584 Specifies that QE/FMAN firmware is located in NAND flash.
3585 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3586
3587- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3588 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3589 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3590
292dc6c5
LG
3591- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3592 Specifies that QE/FMAN firmware is located in the remote (master)
3593 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
fc54c7fa
LG
3594 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3595 window->master inbound window->master LAW->the ucode address in
3596 master's memory space.
f2717b47 3597
b940ca64
GR
3598Freescale Layerscape Management Complex Firmware Support:
3599---------------------------------------------------------
3600The Freescale Layerscape Management Complex (MC) supports the loading of
3601"firmware".
3602This firmware often needs to be loaded during U-Boot booting, so macros
3603are used to identify the storage device (NOR flash, SPI, etc) and the address
3604within that device.
3605
3606- CONFIG_FSL_MC_ENET
3607 Enable the MC driver for Layerscape SoCs.
3608
5c055089
PK
3609Freescale Layerscape Debug Server Support:
3610-------------------------------------------
3611The Freescale Layerscape Debug Server Support supports the loading of
3612"Debug Server firmware" and triggering SP boot-rom.
3613This firmware often needs to be loaded during U-Boot booting.
3614
c0492141
YS
3615- CONFIG_SYS_MC_RSV_MEM_ALIGN
3616 Define alignment of reserved memory MC requires
5c055089 3617
f3f431a7
PK
3618Reproducible builds
3619-------------------
3620
3621In order to achieve reproducible builds, timestamps used in the U-Boot build
3622process have to be set to a fixed value.
3623
3624This is done using the SOURCE_DATE_EPOCH environment variable.
3625SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3626option for U-Boot or an environment variable in U-Boot.
3627
3628SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3629
c609719b
WD
3630Building the Software:
3631======================
3632
218ca724
WD
3633Building U-Boot has been tested in several native build environments
3634and in many different cross environments. Of course we cannot support
3635all possibly existing versions of cross development tools in all
3636(potentially obsolete) versions. In case of tool chain problems we
3637recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3638which is extensively used to build and test U-Boot.
c609719b 3639
218ca724
WD
3640If you are not using a native environment, it is assumed that you
3641have GNU cross compiling tools available in your path. In this case,
3642you must set the environment variable CROSS_COMPILE in your shell.
3643Note that no changes to the Makefile or any other source files are
3644necessary. For example using the ELDK on a 4xx CPU, please enter:
c609719b 3645
218ca724
WD
3646 $ CROSS_COMPILE=ppc_4xx-
3647 $ export CROSS_COMPILE
c609719b 3648
2f8d396b
PT
3649Note: If you wish to generate Windows versions of the utilities in
3650 the tools directory you can use the MinGW toolchain
3651 (http://www.mingw.org). Set your HOST tools to the MinGW
3652 toolchain and execute 'make tools'. For example:
3653
3654 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3655
3656 Binaries such as tools/mkimage.exe will be created which can
3657 be executed on computers running Windows.
3658
218ca724
WD
3659U-Boot is intended to be simple to build. After installing the
3660sources you must configure U-Boot for one specific board type. This
c609719b
WD
3661is done by typing:
3662
ab584d67 3663 make NAME_defconfig
c609719b 3664
ab584d67 3665where "NAME_defconfig" is the name of one of the existing configu-
4d675ae6 3666rations; see boards.cfg for supported names.
db01a2ea 3667
2729af9d
WD
3668Note: for some board special configuration names may exist; check if
3669 additional information is available from the board vendor; for
3670 instance, the TQM823L systems are available without (standard)
3671 or with LCD support. You can select such additional "features"
11ccc33f 3672 when choosing the configuration, i. e.
2729af9d 3673
ab584d67 3674 make TQM823L_defconfig
2729af9d
WD
3675 - will configure for a plain TQM823L, i. e. no LCD support
3676
ab584d67 3677 make TQM823L_LCD_defconfig
2729af9d
WD
3678 - will configure for a TQM823L with U-Boot console on LCD
3679
3680 etc.
3681
3682
3683Finally, type "make all", and you should get some working U-Boot
3684images ready for download to / installation on your system:
3685
3686- "u-boot.bin" is a raw binary image
3687- "u-boot" is an image in ELF binary format
3688- "u-boot.srec" is in Motorola S-Record format
3689
baf31249
MB
3690By default the build is performed locally and the objects are saved
3691in the source directory. One of the two methods can be used to change
3692this behavior and build U-Boot to some external directory:
3693
36941. Add O= to the make command line invocations:
3695
3696 make O=/tmp/build distclean
ab584d67 3697 make O=/tmp/build NAME_defconfig
baf31249
MB
3698 make O=/tmp/build all
3699
adbba996 37002. Set environment variable KBUILD_OUTPUT to point to the desired location:
baf31249 3701
adbba996 3702 export KBUILD_OUTPUT=/tmp/build
baf31249 3703 make distclean
ab584d67 3704 make NAME_defconfig
baf31249
MB
3705 make all
3706
adbba996 3707Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
baf31249
MB
3708variable.
3709
215bb1c1
DS
3710User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
3711setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
3712For example to treat all compiler warnings as errors:
3713
3714 make KCFLAGS=-Werror
2729af9d
WD
3715
3716Please be aware that the Makefiles assume you are using GNU make, so
3717for instance on NetBSD you might need to use "gmake" instead of
3718native "make".
3719
3720
3721If the system board that you have is not listed, then you will need
3722to port U-Boot to your hardware platform. To do this, follow these
3723steps:
3724
3c1496cd 37251. Create a new directory to hold your board specific code. Add any
2729af9d 3726 files you need. In your board directory, you will need at least
3c1496cd
PS
3727 the "Makefile" and a "<board>.c".
37282. Create a new configuration file "include/configs/<board>.h" for
3729 your board.
2729af9d
WD
37303. If you're porting U-Boot to a new CPU, then also create a new
3731 directory to hold your CPU specific code. Add any files you need.
ab584d67 37324. Run "make <board>_defconfig" with your new name.
2729af9d
WD
37335. Type "make", and you should get a working "u-boot.srec" file
3734 to be installed on your target system.
37356. Debug and solve any problems that might arise.
3736 [Of course, this last step is much harder than it sounds.]
3737
3738
3739Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3740==============================================================
3741
218ca724
WD
3742If you have modified U-Boot sources (for instance added a new board
3743or support for new devices, a new CPU, etc.) you are expected to
2729af9d
WD
3744provide feedback to the other developers. The feedback normally takes
3745the form of a "patch", i. e. a context diff against a certain (latest
218ca724 3746official or latest in the git repository) version of U-Boot sources.
2729af9d 3747
218ca724
WD
3748But before you submit such a patch, please verify that your modifi-
3749cation did not break existing code. At least make sure that *ALL* of
2729af9d 3750the supported boards compile WITHOUT ANY compiler warnings. To do so,
6de80f21
SG
3751just run the buildman script (tools/buildman/buildman), which will
3752configure and build U-Boot for ALL supported system. Be warned, this
3753will take a while. Please see the buildman README, or run 'buildman -H'
3754for documentation.
baf31249
MB
3755
3756
2729af9d
WD
3757See also "U-Boot Porting Guide" below.
3758
3759
3760Monitor Commands - Overview:
3761============================
3762
3763go - start application at address 'addr'
3764run - run commands in an environment variable
3765bootm - boot application image from memory
3766bootp - boot image via network using BootP/TFTP protocol
44f074c7 3767bootz - boot zImage from memory
2729af9d
WD
3768tftpboot- boot image via network using TFTP protocol
3769 and env variables "ipaddr" and "serverip"
3770 (and eventually "gatewayip")
1fb7cd49 3771tftpput - upload a file via network using TFTP protocol
2729af9d
WD
3772rarpboot- boot image via network using RARP/TFTP protocol
3773diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3774loads - load S-Record file over serial line
3775loadb - load binary file over serial line (kermit mode)
3776md - memory display
3777mm - memory modify (auto-incrementing)
3778nm - memory modify (constant address)
3779mw - memory write (fill)
3780cp - memory copy
3781cmp - memory compare
3782crc32 - checksum calculation
0f89c54b 3783i2c - I2C sub-system
2729af9d
WD
3784sspi - SPI utility commands
3785base - print or set address offset
3786printenv- print environment variables
3787setenv - set environment variables
3788saveenv - save environment variables to persistent storage
3789protect - enable or disable FLASH write protection
3790erase - erase FLASH memory
3791flinfo - print FLASH memory information
10635afa 3792nand - NAND memory operations (see doc/README.nand)
2729af9d
WD
3793bdinfo - print Board Info structure
3794iminfo - print header information for application image
3795coninfo - print console devices and informations
3796ide - IDE sub-system
3797loop - infinite loop on address range
56523f12 3798loopw - infinite write loop on address range
2729af9d
WD
3799mtest - simple RAM test
3800icache - enable or disable instruction cache
3801dcache - enable or disable data cache
3802reset - Perform RESET of the CPU
3803echo - echo args to console
3804version - print monitor version
3805help - print online help
3806? - alias for 'help'
3807
3808
3809Monitor Commands - Detailed Description:
3810========================================
3811
3812TODO.
3813
3814For now: just type "help <command>".
3815
3816
3817Environment Variables:
3818======================
3819
3820U-Boot supports user configuration using Environment Variables which
3821can be made persistent by saving to Flash memory.
c609719b 3822
2729af9d
WD
3823Environment Variables are set using "setenv", printed using
3824"printenv", and saved to Flash using "saveenv". Using "setenv"
3825without a value can be used to delete a variable from the
3826environment. As long as you don't save the environment you are
3827working with an in-memory copy. In case the Flash area containing the
3828environment is erased by accident, a default environment is provided.
c609719b 3829
c96f86ee
WD
3830Some configuration options can be set using Environment Variables.
3831
3832List of environment variables (most likely not complete):
c609719b 3833
2729af9d 3834 baudrate - see CONFIG_BAUDRATE
c609719b 3835
2729af9d 3836 bootdelay - see CONFIG_BOOTDELAY
c609719b 3837
2729af9d 3838 bootcmd - see CONFIG_BOOTCOMMAND
4a6fd34b 3839
2729af9d 3840 bootargs - Boot arguments when booting an RTOS image
c609719b 3841
2729af9d 3842 bootfile - Name of the image to load with TFTP
c609719b 3843
7d721e34
BS
3844 bootm_low - Memory range available for image processing in the bootm
3845 command can be restricted. This variable is given as
3846 a hexadecimal number and defines lowest address allowed
3847 for use by the bootm command. See also "bootm_size"
3848 environment variable. Address defined by "bootm_low" is
3849 also the base of the initial memory mapping for the Linux
c3624e6e
GL
3850 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3851 bootm_mapsize.
3852
c0f40859 3853 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
c3624e6e
GL
3854 This variable is given as a hexadecimal number and it
3855 defines the size of the memory region starting at base
3856 address bootm_low that is accessible by the Linux kernel
3857 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3858 as the default value if it is defined, and bootm_size is
3859 used otherwise.
7d721e34
BS
3860
3861 bootm_size - Memory range available for image processing in the bootm
3862 command can be restricted. This variable is given as
3863 a hexadecimal number and defines the size of the region
3864 allowed for use by the bootm command. See also "bootm_low"
3865 environment variable.
3866
4bae9090
BS
3867 updatefile - Location of the software update file on a TFTP server, used
3868 by the automatic software update feature. Please refer to
3869 documentation in doc/README.update for more details.
3870
2729af9d
WD
3871 autoload - if set to "no" (any string beginning with 'n'),
3872 "bootp" will just load perform a lookup of the
3873 configuration from the BOOTP server, but not try to
3874 load any image using TFTP
c609719b 3875
2729af9d
WD
3876 autostart - if set to "yes", an image loaded using the "bootp",
3877 "rarpboot", "tftpboot" or "diskboot" commands will
3878 be automatically started (by internally calling
3879 "bootm")
38b99261 3880
2729af9d
WD
3881 If set to "no", a standalone image passed to the
3882 "bootm" command will be copied to the load address
3883 (and eventually uncompressed), but NOT be started.
3884 This can be used to load and uncompress arbitrary
3885 data.
c609719b 3886
a28afca5
DL
3887 fdt_high - if set this restricts the maximum address that the
3888 flattened device tree will be copied into upon boot.
fa34f6b2
SG
3889 For example, if you have a system with 1 GB memory
3890 at physical address 0x10000000, while Linux kernel
3891 only recognizes the first 704 MB as low memory, you
3892 may need to set fdt_high as 0x3C000000 to have the
3893 device tree blob be copied to the maximum address
3894 of the 704 MB low memory, so that Linux kernel can
3895 access it during the boot procedure.
3896
a28afca5
DL
3897 If this is set to the special value 0xFFFFFFFF then
3898 the fdt will not be copied at all on boot. For this
3899 to work it must reside in writable memory, have
3900 sufficient padding on the end of it for u-boot to
3901 add the information it needs into it, and the memory
3902 must be accessible by the kernel.
3903
eea63e05
SG
3904 fdtcontroladdr- if set this is the address of the control flattened
3905 device tree used by U-Boot when CONFIG_OF_CONTROL is
3906 defined.
3907
17ea1177
WD
3908 i2cfast - (PPC405GP|PPC405EP only)
3909 if set to 'y' configures Linux I2C driver for fast
3910 mode (400kHZ). This environment variable is used in
3911 initialization code. So, for changes to be effective
3912 it must be saved and board must be reset.
3913
2729af9d
WD
3914 initrd_high - restrict positioning of initrd images:
3915 If this variable is not set, initrd images will be
3916 copied to the highest possible address in RAM; this
3917 is usually what you want since it allows for
3918 maximum initrd size. If for some reason you want to
3919 make sure that the initrd image is loaded below the
6d0f6bcf 3920 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d
WD
3921 variable to a value of "no" or "off" or "0".
3922 Alternatively, you can set it to a maximum upper
3923 address to use (U-Boot will still check that it
3924 does not overwrite the U-Boot stack and data).
c609719b 3925
2729af9d
WD
3926 For instance, when you have a system with 16 MB
3927 RAM, and want to reserve 4 MB from use by Linux,
3928 you can do this by adding "mem=12M" to the value of
3929 the "bootargs" variable. However, now you must make
3930 sure that the initrd image is placed in the first
3931 12 MB as well - this can be done with
c609719b 3932
2729af9d 3933 setenv initrd_high 00c00000
c609719b 3934
2729af9d
WD
3935 If you set initrd_high to 0xFFFFFFFF, this is an
3936 indication to U-Boot that all addresses are legal
3937 for the Linux kernel, including addresses in flash
3938 memory. In this case U-Boot will NOT COPY the
3939 ramdisk at all. This may be useful to reduce the
3940 boot time on your system, but requires that this
3941 feature is supported by your Linux kernel.
c609719b 3942
2729af9d 3943 ipaddr - IP address; needed for tftpboot command
c609719b 3944
2729af9d
WD
3945 loadaddr - Default load address for commands like "bootp",
3946 "rarpboot", "tftpboot", "loadb" or "diskboot"
c609719b 3947
2729af9d 3948 loads_echo - see CONFIG_LOADS_ECHO
a3d991bd 3949
2729af9d 3950 serverip - TFTP server IP address; needed for tftpboot command
a3d991bd 3951
2729af9d 3952 bootretry - see CONFIG_BOOT_RETRY_TIME
a3d991bd 3953
2729af9d 3954 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
a3d991bd 3955
2729af9d 3956 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
c609719b 3957
e2a53458 3958 ethprime - controls which interface is used first.
c609719b 3959
e2a53458
MF
3960 ethact - controls which interface is currently active.
3961 For example you can do the following
c609719b 3962
48690d80
HS
3963 => setenv ethact FEC
3964 => ping 192.168.0.1 # traffic sent on FEC
3965 => setenv ethact SCC
3966 => ping 10.0.0.1 # traffic sent on SCC
c609719b 3967
e1692577
MF
3968 ethrotate - When set to "no" U-Boot does not go through all
3969 available network interfaces.
3970 It just stays at the currently selected interface.
3971
c96f86ee 3972 netretry - When set to "no" each network operation will
2729af9d
WD
3973 either succeed or fail without retrying.
3974 When set to "once" the network operation will
3975 fail when all the available network interfaces
3976 are tried once without success.
3977 Useful on scripts which control the retry operation
3978 themselves.
c609719b 3979
b4e2f89d 3980 npe_ucode - set load address for the NPE microcode
a1cf027a 3981
b445bbb4 3982 silent_linux - If set then Linux will be told to boot silently, by
8d51aacd
SG
3983 changing the console to be empty. If "yes" it will be
3984 made silent. If "no" it will not be made silent. If
3985 unset, then it will be made silent if the U-Boot console
3986 is silent.
3987
f5fb7346 3988 tftpsrcp - If this is set, the value is used for TFTP's
ecb0ccd9
WD
3989 UDP source port.
3990
f5fb7346 3991 tftpdstp - If this is set, the value is used for TFTP's UDP
28cb9375
WD
3992 destination port instead of the Well Know Port 69.
3993
c96f86ee
WD
3994 tftpblocksize - Block size to use for TFTP transfers; if not set,
3995 we use the TFTP server's default block size
3996
3997 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3998 seconds, minimum value is 1000 = 1 second). Defines
3999 when a packet is considered to be lost so it has to
4000 be retransmitted. The default is 5000 = 5 seconds.
4001 Lowering this value may make downloads succeed
4002 faster in networks with high packet loss rates or
4003 with unreliable TFTP servers.
4004
f5fb7346
AA
4005 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4006 unit, minimum value = 0). Defines how many timeouts
4007 can happen during a single file transfer before that
4008 transfer is aborted. The default is 10, and 0 means
4009 'no timeouts allowed'. Increasing this value may help
4010 downloads succeed with high packet loss rates, or with
4011 unreliable TFTP servers or client hardware.
4012
c96f86ee 4013 vlan - When set to a value < 4095 the traffic over
11ccc33f 4014 Ethernet is encapsulated/received over 802.1q
2729af9d 4015 VLAN tagged frames.
c609719b 4016
50768f5b
AM
4017 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4018 Unsigned value, in milliseconds. If not set, the period will
4019 be either the default (28000), or a value based on
4020 CONFIG_NET_RETRY_COUNT, if defined. This value has
4021 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4022
dc0b7b0e
JH
4023The following image location variables contain the location of images
4024used in booting. The "Image" column gives the role of the image and is
4025not an environment variable name. The other columns are environment
4026variable names. "File Name" gives the name of the file on a TFTP
4027server, "RAM Address" gives the location in RAM the image will be
4028loaded to, and "Flash Location" gives the image's address in NOR
4029flash or offset in NAND flash.
4030
4031*Note* - these variables don't have to be defined for all boards, some
aed9fed9 4032boards currently use other variables for these purposes, and some
dc0b7b0e
JH
4033boards use these variables for other purposes.
4034
c0f40859
WD
4035Image File Name RAM Address Flash Location
4036----- --------- ----------- --------------
4037u-boot u-boot u-boot_addr_r u-boot_addr
4038Linux kernel bootfile kernel_addr_r kernel_addr
4039device tree blob fdtfile fdt_addr_r fdt_addr
4040ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
dc0b7b0e 4041
2729af9d
WD
4042The following environment variables may be used and automatically
4043updated by the network boot commands ("bootp" and "rarpboot"),
4044depending the information provided by your boot server:
c609719b 4045
2729af9d
WD
4046 bootfile - see above
4047 dnsip - IP address of your Domain Name Server
4048 dnsip2 - IP address of your secondary Domain Name Server
4049 gatewayip - IP address of the Gateway (Router) to use
4050 hostname - Target hostname
4051 ipaddr - see above
4052 netmask - Subnet Mask
4053 rootpath - Pathname of the root filesystem on the NFS server
4054 serverip - see above
c1551ea8 4055
c1551ea8 4056
2729af9d 4057There are two special Environment Variables:
c1551ea8 4058
2729af9d
WD
4059 serial# - contains hardware identification information such
4060 as type string and/or serial number
4061 ethaddr - Ethernet address
c609719b 4062
2729af9d
WD
4063These variables can be set only once (usually during manufacturing of
4064the board). U-Boot refuses to delete or overwrite these variables
4065once they have been set once.
c609719b 4066
f07771cc 4067
2729af9d 4068Further special Environment Variables:
f07771cc 4069
2729af9d
WD
4070 ver - Contains the U-Boot version string as printed
4071 with the "version" command. This variable is
4072 readonly (see CONFIG_VERSION_VARIABLE).
f07771cc 4073
f07771cc 4074
2729af9d
WD
4075Please note that changes to some configuration parameters may take
4076only effect after the next boot (yes, that's just like Windoze :-).
f07771cc 4077
f07771cc 4078
170ab110
JH
4079Callback functions for environment variables:
4080---------------------------------------------
4081
4082For some environment variables, the behavior of u-boot needs to change
b445bbb4 4083when their values are changed. This functionality allows functions to
170ab110
JH
4084be associated with arbitrary variables. On creation, overwrite, or
4085deletion, the callback will provide the opportunity for some side
4086effect to happen or for the change to be rejected.
4087
4088The callbacks are named and associated with a function using the
4089U_BOOT_ENV_CALLBACK macro in your board or driver code.
4090
4091These callbacks are associated with variables in one of two ways. The
4092static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4093in the board configuration to a string that defines a list of
4094associations. The list must be in the following format:
4095
4096 entry = variable_name[:callback_name]
4097 list = entry[,list]
4098
4099If the callback name is not specified, then the callback is deleted.
4100Spaces are also allowed anywhere in the list.
4101
4102Callbacks can also be associated by defining the ".callbacks" variable
4103with the same list format above. Any association in ".callbacks" will
4104override any association in the static list. You can define
4105CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
b445bbb4 4106".callbacks" environment variable in the default or embedded environment.
170ab110 4107
bdf1fe4e
JH
4108If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4109regular expression. This allows multiple variables to be connected to
4110the same callback without explicitly listing them all out.
4111
170ab110 4112
2729af9d
WD
4113Command Line Parsing:
4114=====================
f07771cc 4115
2729af9d
WD
4116There are two different command line parsers available with U-Boot:
4117the old "simple" one, and the much more powerful "hush" shell:
c609719b 4118
2729af9d
WD
4119Old, simple command line parser:
4120--------------------------------
c609719b 4121
2729af9d
WD
4122- supports environment variables (through setenv / saveenv commands)
4123- several commands on one line, separated by ';'
fe126d8b 4124- variable substitution using "... ${name} ..." syntax
2729af9d
WD
4125- special characters ('$', ';') can be escaped by prefixing with '\',
4126 for example:
fe126d8b 4127 setenv bootcmd bootm \${address}
2729af9d
WD
4128- You can also escape text by enclosing in single apostrophes, for example:
4129 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
c609719b 4130
2729af9d
WD
4131Hush shell:
4132-----------
c609719b 4133
2729af9d
WD
4134- similar to Bourne shell, with control structures like
4135 if...then...else...fi, for...do...done; while...do...done,
4136 until...do...done, ...
4137- supports environment ("global") variables (through setenv / saveenv
4138 commands) and local shell variables (through standard shell syntax
4139 "name=value"); only environment variables can be used with "run"
4140 command
4141
4142General rules:
4143--------------
c609719b 4144
2729af9d
WD
4145(1) If a command line (or an environment variable executed by a "run"
4146 command) contains several commands separated by semicolon, and
4147 one of these commands fails, then the remaining commands will be
4148 executed anyway.
c609719b 4149
2729af9d 4150(2) If you execute several variables with one call to run (i. e.
11ccc33f 4151 calling run with a list of variables as arguments), any failing
2729af9d
WD
4152 command will cause "run" to terminate, i. e. the remaining
4153 variables are not executed.
c609719b 4154
2729af9d
WD
4155Note for Redundant Ethernet Interfaces:
4156=======================================
c609719b 4157
11ccc33f 4158Some boards come with redundant Ethernet interfaces; U-Boot supports
2729af9d
WD
4159such configurations and is capable of automatic selection of a
4160"working" interface when needed. MAC assignment works as follows:
c609719b 4161
2729af9d
WD
4162Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4163MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4164"eth1addr" (=>eth1), "eth2addr", ...
c609719b 4165
2729af9d
WD
4166If the network interface stores some valid MAC address (for instance
4167in SROM), this is used as default address if there is NO correspon-
4168ding setting in the environment; if the corresponding environment
4169variable is set, this overrides the settings in the card; that means:
c609719b 4170
2729af9d
WD
4171o If the SROM has a valid MAC address, and there is no address in the
4172 environment, the SROM's address is used.
c609719b 4173
2729af9d
WD
4174o If there is no valid address in the SROM, and a definition in the
4175 environment exists, then the value from the environment variable is
4176 used.
c609719b 4177
2729af9d
WD
4178o If both the SROM and the environment contain a MAC address, and
4179 both addresses are the same, this MAC address is used.
c609719b 4180
2729af9d
WD
4181o If both the SROM and the environment contain a MAC address, and the
4182 addresses differ, the value from the environment is used and a
4183 warning is printed.
c609719b 4184
2729af9d 4185o If neither SROM nor the environment contain a MAC address, an error
bef1014b
JH
4186 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4187 a random, locally-assigned MAC is used.
c609719b 4188
ecee9324 4189If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859 4190will be programmed into hardware as part of the initialization process. This
ecee9324
BW
4191may be skipped by setting the appropriate 'ethmacskip' environment variable.
4192The naming convention is as follows:
4193"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
c609719b 4194
2729af9d
WD
4195Image Formats:
4196==============
c609719b 4197
3310c549
MB
4198U-Boot is capable of booting (and performing other auxiliary operations on)
4199images in two formats:
4200
4201New uImage format (FIT)
4202-----------------------
4203
4204Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4205to Flattened Device Tree). It allows the use of images with multiple
4206components (several kernels, ramdisks, etc.), with contents protected by
4207SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4208
4209
4210Old uImage format
4211-----------------
4212
4213Old image format is based on binary files which can be basically anything,
4214preceded by a special header; see the definitions in include/image.h for
4215details; basically, the header defines the following image properties:
c609719b 4216
2729af9d
WD
4217* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4218 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
f5ed9e39
PT
4219 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4220 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4221 INTEGRITY).
daab59ac 4222* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
afc1ce82 4223 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
daab59ac 4224 Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2729af9d
WD
4225* Compression Type (uncompressed, gzip, bzip2)
4226* Load Address
4227* Entry Point
4228* Image Name
4229* Image Timestamp
c609719b 4230
2729af9d
WD
4231The header is marked by a special Magic Number, and both the header
4232and the data portions of the image are secured against corruption by
4233CRC32 checksums.
c609719b
WD
4234
4235
2729af9d
WD
4236Linux Support:
4237==============
c609719b 4238
2729af9d
WD
4239Although U-Boot should support any OS or standalone application
4240easily, the main focus has always been on Linux during the design of
4241U-Boot.
c609719b 4242
2729af9d
WD
4243U-Boot includes many features that so far have been part of some
4244special "boot loader" code within the Linux kernel. Also, any
4245"initrd" images to be used are no longer part of one big Linux image;
4246instead, kernel and "initrd" are separate images. This implementation
4247serves several purposes:
c609719b 4248
2729af9d
WD
4249- the same features can be used for other OS or standalone
4250 applications (for instance: using compressed images to reduce the
4251 Flash memory footprint)
c609719b 4252
2729af9d
WD
4253- it becomes much easier to port new Linux kernel versions because
4254 lots of low-level, hardware dependent stuff are done by U-Boot
c609719b 4255
2729af9d
WD
4256- the same Linux kernel image can now be used with different "initrd"
4257 images; of course this also means that different kernel images can
4258 be run with the same "initrd". This makes testing easier (you don't
4259 have to build a new "zImage.initrd" Linux image when you just
4260 change a file in your "initrd"). Also, a field-upgrade of the
4261 software is easier now.
c609719b 4262
c609719b 4263
2729af9d
WD
4264Linux HOWTO:
4265============
c609719b 4266
2729af9d
WD
4267Porting Linux to U-Boot based systems:
4268---------------------------------------
c609719b 4269
2729af9d
WD
4270U-Boot cannot save you from doing all the necessary modifications to
4271configure the Linux device drivers for use with your target hardware
4272(no, we don't intend to provide a full virtual machine interface to
4273Linux :-).
c609719b 4274
a47a12be 4275But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
24ee89b9 4276
2729af9d
WD
4277Just make sure your machine specific header file (for instance
4278include/asm-ppc/tqm8xx.h) includes the same definition of the Board
1dc30693
MH
4279Information structure as we define in include/asm-<arch>/u-boot.h,
4280and make sure that your definition of IMAP_ADDR uses the same value
6d0f6bcf 4281as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b9 4282
2eb31b13
SG
4283Note that U-Boot now has a driver model, a unified model for drivers.
4284If you are adding a new driver, plumb it into driver model. If there
4285is no uclass available, you are encouraged to create one. See
4286doc/driver-model.
4287
c609719b 4288
2729af9d
WD
4289Configuring the Linux kernel:
4290-----------------------------
c609719b 4291
2729af9d
WD
4292No specific requirements for U-Boot. Make sure you have some root
4293device (initial ramdisk, NFS) for your target system.
4294
4295
4296Building a Linux Image:
4297-----------------------
c609719b 4298
2729af9d
WD
4299With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4300not used. If you use recent kernel source, a new build target
4301"uImage" will exist which automatically builds an image usable by
4302U-Boot. Most older kernels also have support for a "pImage" target,
4303which was introduced for our predecessor project PPCBoot and uses a
4304100% compatible format.
4305
4306Example:
4307
ab584d67 4308 make TQM850L_defconfig
2729af9d
WD
4309 make oldconfig
4310 make dep
4311 make uImage
4312
4313The "uImage" build target uses a special tool (in 'tools/mkimage') to
4314encapsulate a compressed Linux kernel image with header information,
4315CRC32 checksum etc. for use with U-Boot. This is what we are doing:
4316
4317* build a standard "vmlinux" kernel image (in ELF binary format):
4318
4319* convert the kernel into a raw binary image:
4320
4321 ${CROSS_COMPILE}-objcopy -O binary \
4322 -R .note -R .comment \
4323 -S vmlinux linux.bin
4324
4325* compress the binary image:
4326
4327 gzip -9 linux.bin
4328
4329* package compressed binary image for U-Boot:
4330
4331 mkimage -A ppc -O linux -T kernel -C gzip \
4332 -a 0 -e 0 -n "Linux Kernel Image" \
4333 -d linux.bin.gz uImage
c609719b 4334
c609719b 4335
2729af9d
WD
4336The "mkimage" tool can also be used to create ramdisk images for use
4337with U-Boot, either separated from the Linux kernel image, or
4338combined into one file. "mkimage" encapsulates the images with a 64
4339byte header containing information about target architecture,
4340operating system, image type, compression method, entry points, time
4341stamp, CRC32 checksums, etc.
4342
4343"mkimage" can be called in two ways: to verify existing images and
4344print the header information, or to build new images.
4345
4346In the first form (with "-l" option) mkimage lists the information
4347contained in the header of an existing U-Boot image; this includes
4348checksum verification:
c609719b 4349
2729af9d
WD
4350 tools/mkimage -l image
4351 -l ==> list image header information
4352
4353The second form (with "-d" option) is used to build a U-Boot image
4354from a "data file" which is used as image payload:
4355
4356 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4357 -n name -d data_file image
4358 -A ==> set architecture to 'arch'
4359 -O ==> set operating system to 'os'
4360 -T ==> set image type to 'type'
4361 -C ==> set compression type 'comp'
4362 -a ==> set load address to 'addr' (hex)
4363 -e ==> set entry point to 'ep' (hex)
4364 -n ==> set image name to 'name'
4365 -d ==> use image data from 'datafile'
4366
69459791
WD
4367Right now, all Linux kernels for PowerPC systems use the same load
4368address (0x00000000), but the entry point address depends on the
4369kernel version:
2729af9d
WD
4370
4371- 2.2.x kernels have the entry point at 0x0000000C,
4372- 2.3.x and later kernels have the entry point at 0x00000000.
4373
4374So a typical call to build a U-Boot image would read:
4375
4376 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4377 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
a47a12be 4378 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d
WD
4379 > examples/uImage.TQM850L
4380 Image Name: 2.4.4 kernel for TQM850L
4381 Created: Wed Jul 19 02:34:59 2000
4382 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4383 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4384 Load Address: 0x00000000
4385 Entry Point: 0x00000000
4386
4387To verify the contents of the image (or check for corruption):
4388
4389 -> tools/mkimage -l examples/uImage.TQM850L
4390 Image Name: 2.4.4 kernel for TQM850L
4391 Created: Wed Jul 19 02:34:59 2000
4392 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4393 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4394 Load Address: 0x00000000
4395 Entry Point: 0x00000000
4396
4397NOTE: for embedded systems where boot time is critical you can trade
4398speed for memory and install an UNCOMPRESSED image instead: this
4399needs more space in Flash, but boots much faster since it does not
4400need to be uncompressed:
4401
a47a12be 4402 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d
WD
4403 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4404 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
a47a12be 4405 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d
WD
4406 > examples/uImage.TQM850L-uncompressed
4407 Image Name: 2.4.4 kernel for TQM850L
4408 Created: Wed Jul 19 02:34:59 2000
4409 Image Type: PowerPC Linux Kernel Image (uncompressed)
4410 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4411 Load Address: 0x00000000
4412 Entry Point: 0x00000000
4413
4414
4415Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4416when your kernel is intended to use an initial ramdisk:
4417
4418 -> tools/mkimage -n 'Simple Ramdisk Image' \
4419 > -A ppc -O linux -T ramdisk -C gzip \
4420 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4421 Image Name: Simple Ramdisk Image
4422 Created: Wed Jan 12 14:01:50 2000
4423 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4424 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4425 Load Address: 0x00000000
4426 Entry Point: 0x00000000
4427
a804b5ce
GMF
4428The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4429option performs the converse operation of the mkimage's second form (the "-d"
4430option). Given an image built by mkimage, the dumpimage extracts a "data file"
4431from the image:
4432
f41f5b7c
GMF
4433 tools/dumpimage -i image -T type -p position data_file
4434 -i ==> extract from the 'image' a specific 'data_file'
4435 -T ==> set image type to 'type'
4436 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
a804b5ce 4437
2729af9d
WD
4438
4439Installing a Linux Image:
4440-------------------------
4441
4442To downloading a U-Boot image over the serial (console) interface,
4443you must convert the image to S-Record format:
4444
4445 objcopy -I binary -O srec examples/image examples/image.srec
4446
4447The 'objcopy' does not understand the information in the U-Boot
4448image header, so the resulting S-Record file will be relative to
4449address 0x00000000. To load it to a given address, you need to
4450specify the target address as 'offset' parameter with the 'loads'
4451command.
4452
4453Example: install the image to address 0x40100000 (which on the
4454TQM8xxL is in the first Flash bank):
4455
4456 => erase 40100000 401FFFFF
4457
4458 .......... done
4459 Erased 8 sectors
4460
4461 => loads 40100000
4462 ## Ready for S-Record download ...
4463 ~>examples/image.srec
4464 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4465 ...
4466 15989 15990 15991 15992
4467 [file transfer complete]
4468 [connected]
4469 ## Start Addr = 0x00000000
4470
4471
4472You can check the success of the download using the 'iminfo' command;
218ca724 4473this includes a checksum verification so you can be sure no data
2729af9d
WD
4474corruption happened:
4475
4476 => imi 40100000
4477
4478 ## Checking Image at 40100000 ...
4479 Image Name: 2.2.13 for initrd on TQM850L
4480 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4481 Data Size: 335725 Bytes = 327 kB = 0 MB
4482 Load Address: 00000000
4483 Entry Point: 0000000c
4484 Verifying Checksum ... OK
4485
4486
4487Boot Linux:
4488-----------
4489
4490The "bootm" command is used to boot an application that is stored in
4491memory (RAM or Flash). In case of a Linux kernel image, the contents
4492of the "bootargs" environment variable is passed to the kernel as
4493parameters. You can check and modify this variable using the
4494"printenv" and "setenv" commands:
4495
4496
4497 => printenv bootargs
4498 bootargs=root=/dev/ram
4499
4500 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4501
4502 => printenv bootargs
4503 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4504
4505 => bootm 40020000
4506 ## Booting Linux kernel at 40020000 ...
4507 Image Name: 2.2.13 for NFS on TQM850L
4508 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4509 Data Size: 381681 Bytes = 372 kB = 0 MB
4510 Load Address: 00000000
4511 Entry Point: 0000000c
4512 Verifying Checksum ... OK
4513 Uncompressing Kernel Image ... OK
4514 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000
4515 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4516 time_init: decrementer frequency = 187500000/60
4517 Calibrating delay loop... 49.77 BogoMIPS
4518 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4519 ...
4520
11ccc33f 4521If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d
WD
4522the memory addresses of both the kernel and the initrd image (PPBCOOT
4523format!) to the "bootm" command:
4524
4525 => imi 40100000 40200000
4526
4527 ## Checking Image at 40100000 ...
4528 Image Name: 2.2.13 for initrd on TQM850L
4529 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4530 Data Size: 335725 Bytes = 327 kB = 0 MB
4531 Load Address: 00000000
4532 Entry Point: 0000000c
4533 Verifying Checksum ... OK
4534
4535 ## Checking Image at 40200000 ...
4536 Image Name: Simple Ramdisk Image
4537 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4538 Data Size: 566530 Bytes = 553 kB = 0 MB
4539 Load Address: 00000000
4540 Entry Point: 00000000
4541 Verifying Checksum ... OK
4542
4543 => bootm 40100000 40200000
4544 ## Booting Linux kernel at 40100000 ...
4545 Image Name: 2.2.13 for initrd on TQM850L
4546 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4547 Data Size: 335725 Bytes = 327 kB = 0 MB
4548 Load Address: 00000000
4549 Entry Point: 0000000c
4550 Verifying Checksum ... OK
4551 Uncompressing Kernel Image ... OK
4552 ## Loading RAMDisk Image at 40200000 ...
4553 Image Name: Simple Ramdisk Image
4554 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4555 Data Size: 566530 Bytes = 553 kB = 0 MB
4556 Load Address: 00000000
4557 Entry Point: 00000000
4558 Verifying Checksum ... OK
4559 Loading Ramdisk ... OK
4560 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
4561 Boot arguments: root=/dev/ram
4562 time_init: decrementer frequency = 187500000/60
4563 Calibrating delay loop... 49.77 BogoMIPS
4564 ...
4565 RAMDISK: Compressed image found at block 0
4566 VFS: Mounted root (ext2 filesystem).
4567
4568 bash#
4569
0267768e
MM
4570Boot Linux and pass a flat device tree:
4571-----------
4572
4573First, U-Boot must be compiled with the appropriate defines. See the section
4574titled "Linux Kernel Interface" above for a more in depth explanation. The
4575following is an example of how to start a kernel and pass an updated
4576flat device tree:
4577
4578=> print oftaddr
4579oftaddr=0x300000
4580=> print oft
4581oft=oftrees/mpc8540ads.dtb
4582=> tftp $oftaddr $oft
4583Speed: 1000, full duplex
4584Using TSEC0 device
4585TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4586Filename 'oftrees/mpc8540ads.dtb'.
4587Load address: 0x300000
4588Loading: #
4589done
4590Bytes transferred = 4106 (100a hex)
4591=> tftp $loadaddr $bootfile
4592Speed: 1000, full duplex
4593Using TSEC0 device
4594TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4595Filename 'uImage'.
4596Load address: 0x200000
4597Loading:############
4598done
4599Bytes transferred = 1029407 (fb51f hex)
4600=> print loadaddr
4601loadaddr=200000
4602=> print oftaddr
4603oftaddr=0x300000
4604=> bootm $loadaddr - $oftaddr
4605## Booting image at 00200000 ...
a9398e01
WD
4606 Image Name: Linux-2.6.17-dirty
4607 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4608 Data Size: 1029343 Bytes = 1005.2 kB
0267768e 4609 Load Address: 00000000
a9398e01 4610 Entry Point: 00000000
0267768e
MM
4611 Verifying Checksum ... OK
4612 Uncompressing Kernel Image ... OK
4613Booting using flat device tree at 0x300000
4614Using MPC85xx ADS machine description
4615Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4616[snip]
4617
4618
2729af9d
WD
4619More About U-Boot Image Types:
4620------------------------------
4621
4622U-Boot supports the following image types:
4623
4624 "Standalone Programs" are directly runnable in the environment
4625 provided by U-Boot; it is expected that (if they behave
4626 well) you can continue to work in U-Boot after return from
4627 the Standalone Program.
4628 "OS Kernel Images" are usually images of some Embedded OS which
4629 will take over control completely. Usually these programs
4630 will install their own set of exception handlers, device
4631 drivers, set up the MMU, etc. - this means, that you cannot
4632 expect to re-enter U-Boot except by resetting the CPU.
4633 "RAMDisk Images" are more or less just data blocks, and their
4634 parameters (address, size) are passed to an OS kernel that is
4635 being started.
4636 "Multi-File Images" contain several images, typically an OS
4637 (Linux) kernel image and one or more data images like
4638 RAMDisks. This construct is useful for instance when you want
4639 to boot over the network using BOOTP etc., where the boot
4640 server provides just a single image file, but you want to get
4641 for instance an OS kernel and a RAMDisk image.
4642
4643 "Multi-File Images" start with a list of image sizes, each
4644 image size (in bytes) specified by an "uint32_t" in network
4645 byte order. This list is terminated by an "(uint32_t)0".
4646 Immediately after the terminating 0 follow the images, one by
4647 one, all aligned on "uint32_t" boundaries (size rounded up to
4648 a multiple of 4 bytes).
4649
4650 "Firmware Images" are binary images containing firmware (like
4651 U-Boot or FPGA images) which usually will be programmed to
4652 flash memory.
4653
4654 "Script files" are command sequences that will be executed by
4655 U-Boot's command interpreter; this feature is especially
4656 useful when you configure U-Boot to use a real shell (hush)
4657 as command interpreter.
4658
44f074c7
MV
4659Booting the Linux zImage:
4660-------------------------
4661
4662On some platforms, it's possible to boot Linux zImage. This is done
4663using the "bootz" command. The syntax of "bootz" command is the same
4664as the syntax of "bootm" command.
4665
8ac28563 4666Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
017e1f3f
MV
4667kernel with raw initrd images. The syntax is slightly different, the
4668address of the initrd must be augmented by it's size, in the following
4669format: "<initrd addres>:<initrd size>".
4670
2729af9d
WD
4671
4672Standalone HOWTO:
4673=================
4674
4675One of the features of U-Boot is that you can dynamically load and
4676run "standalone" applications, which can use some resources of
4677U-Boot like console I/O functions or interrupt services.
4678
4679Two simple examples are included with the sources:
4680
4681"Hello World" Demo:
4682-------------------
4683
4684'examples/hello_world.c' contains a small "Hello World" Demo
4685application; it is automatically compiled when you build U-Boot.
4686It's configured to run at address 0x00040004, so you can play with it
4687like that:
4688
4689 => loads
4690 ## Ready for S-Record download ...
4691 ~>examples/hello_world.srec
4692 1 2 3 4 5 6 7 8 9 10 11 ...
4693 [file transfer complete]
4694 [connected]
4695 ## Start Addr = 0x00040004
4696
4697 => go 40004 Hello World! This is a test.
4698 ## Starting application at 0x00040004 ...
4699 Hello World
4700 argc = 7
4701 argv[0] = "40004"
4702 argv[1] = "Hello"
4703 argv[2] = "World!"
4704 argv[3] = "This"
4705 argv[4] = "is"
4706 argv[5] = "a"
4707 argv[6] = "test."
4708 argv[7] = "<NULL>"
4709 Hit any key to exit ...
4710
4711 ## Application terminated, rc = 0x0
4712
4713Another example, which demonstrates how to register a CPM interrupt
4714handler with the U-Boot code, can be found in 'examples/timer.c'.
4715Here, a CPM timer is set up to generate an interrupt every second.
4716The interrupt service routine is trivial, just printing a '.'
4717character, but this is just a demo program. The application can be
4718controlled by the following keys:
4719
4720 ? - print current values og the CPM Timer registers
4721 b - enable interrupts and start timer
4722 e - stop timer and disable interrupts
4723 q - quit application
4724
4725 => loads
4726 ## Ready for S-Record download ...
4727 ~>examples/timer.srec
4728 1 2 3 4 5 6 7 8 9 10 11 ...
4729 [file transfer complete]
4730 [connected]
4731 ## Start Addr = 0x00040004
4732
4733 => go 40004
4734 ## Starting application at 0x00040004 ...
4735 TIMERS=0xfff00980
4736 Using timer 1
4737 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4738
4739Hit 'b':
4740 [q, b, e, ?] Set interval 1000000 us
4741 Enabling timer
4742Hit '?':
4743 [q, b, e, ?] ........
4744 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4745Hit '?':
4746 [q, b, e, ?] .
4747 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4748Hit '?':
4749 [q, b, e, ?] .
4750 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4751Hit '?':
4752 [q, b, e, ?] .
4753 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4754Hit 'e':
4755 [q, b, e, ?] ...Stopping timer
4756Hit 'q':
4757 [q, b, e, ?] ## Application terminated, rc = 0x0
4758
4759
4760Minicom warning:
4761================
4762
4763Over time, many people have reported problems when trying to use the
4764"minicom" terminal emulation program for serial download. I (wd)
4765consider minicom to be broken, and recommend not to use it. Under
4766Unix, I recommend to use C-Kermit for general purpose use (and
4767especially for kermit binary protocol download ("loadb" command), and
e53515a2
KP
4768use "cu" for S-Record download ("loads" command). See
4769http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4770for help with kermit.
4771
2729af9d
WD
4772
4773Nevertheless, if you absolutely want to use it try adding this
4774configuration to your "File transfer protocols" section:
4775
4776 Name Program Name U/D FullScr IO-Red. Multi
4777 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4778 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
4779
4780
4781NetBSD Notes:
4782=============
4783
4784Starting at version 0.9.2, U-Boot supports NetBSD both as host
4785(build U-Boot) and target system (boots NetBSD/mpc8xx).
4786
4787Building requires a cross environment; it is known to work on
4788NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4789need gmake since the Makefiles are not compatible with BSD make).
4790Note that the cross-powerpc package does not install include files;
4791attempting to build U-Boot will fail because <machine/ansi.h> is
4792missing. This file has to be installed and patched manually:
4793
4794 # cd /usr/pkg/cross/powerpc-netbsd/include
4795 # mkdir powerpc
4796 # ln -s powerpc machine
4797 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4798 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
4799
4800Native builds *don't* work due to incompatibilities between native
4801and U-Boot include files.
4802
4803Booting assumes that (the first part of) the image booted is a
4804stage-2 loader which in turn loads and then invokes the kernel
4805proper. Loader sources will eventually appear in the NetBSD source
4806tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2a8af187 4807meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d
WD
4808
4809
4810Implementation Internals:
4811=========================
4812
4813The following is not intended to be a complete description of every
4814implementation detail. However, it should help to understand the
4815inner workings of U-Boot and make it easier to port it to custom
4816hardware.
4817
4818
4819Initial Stack, Global Data:
4820---------------------------
4821
4822The implementation of U-Boot is complicated by the fact that U-Boot
4823starts running out of ROM (flash memory), usually without access to
4824system RAM (because the memory controller is not initialized yet).
4825This means that we don't have writable Data or BSS segments, and BSS
4826is not initialized as zero. To be able to get a C environment working
4827at all, we have to allocate at least a minimal stack. Implementation
4828options for this are defined and restricted by the CPU used: Some CPU
4829models provide on-chip memory (like the IMMR area on MPC8xx and
4830MPC826x processors), on others (parts of) the data cache can be
4831locked as (mis-) used as memory, etc.
4832
218ca724 4833 Chris Hallinan posted a good summary of these issues to the
0668236b 4834 U-Boot mailing list:
2729af9d
WD
4835
4836 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4837 From: "Chris Hallinan" <clh@net1plus.com>
4838 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4839 ...
4840
4841 Correct me if I'm wrong, folks, but the way I understand it
4842 is this: Using DCACHE as initial RAM for Stack, etc, does not
4843 require any physical RAM backing up the cache. The cleverness
4844 is that the cache is being used as a temporary supply of
4845 necessary storage before the SDRAM controller is setup. It's
11ccc33f 4846 beyond the scope of this list to explain the details, but you
2729af9d
WD
4847 can see how this works by studying the cache architecture and
4848 operation in the architecture and processor-specific manuals.
4849
4850 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4851 is another option for the system designer to use as an
11ccc33f 4852 initial stack/RAM area prior to SDRAM being available. Either
2729af9d
WD
4853 option should work for you. Using CS 4 should be fine if your
4854 board designers haven't used it for something that would
4855 cause you grief during the initial boot! It is frequently not
4856 used.
4857
6d0f6bcf 4858 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d
WD
4859 with your processor/board/system design. The default value
4860 you will find in any recent u-boot distribution in
8a316c9b 4861 walnut.h should work for you. I'd set it to a value larger
2729af9d
WD
4862 than your SDRAM module. If you have a 64MB SDRAM module, set
4863 it above 400_0000. Just make sure your board has no resources
4864 that are supposed to respond to that address! That code in
4865 start.S has been around a while and should work as is when
4866 you get the config right.
4867
4868 -Chris Hallinan
4869 DS4.COM, Inc.
4870
4871It is essential to remember this, since it has some impact on the C
4872code for the initialization procedures:
4873
4874* Initialized global data (data segment) is read-only. Do not attempt
4875 to write it.
4876
b445bbb4 4877* Do not use any uninitialized global data (or implicitly initialized
2729af9d
WD
4878 as zero data - BSS segment) at all - this is undefined, initiali-
4879 zation is performed later (when relocating to RAM).
4880
4881* Stack space is very limited. Avoid big data buffers or things like
4882 that.
4883
4884Having only the stack as writable memory limits means we cannot use
b445bbb4 4885normal global data to share information between the code. But it
2729af9d
WD
4886turned out that the implementation of U-Boot can be greatly
4887simplified by making a global data structure (gd_t) available to all
4888functions. We could pass a pointer to this data as argument to _all_
4889functions, but this would bloat the code. Instead we use a feature of
4890the GCC compiler (Global Register Variables) to share the data: we
4891place a pointer (gd) to the global data into a register which we
4892reserve for this purpose.
4893
4894When choosing a register for such a purpose we are restricted by the
4895relevant (E)ABI specifications for the current architecture, and by
4896GCC's implementation.
4897
4898For PowerPC, the following registers have specific use:
4899 R1: stack pointer
e7670f6c 4900 R2: reserved for system use
2729af9d
WD
4901 R3-R4: parameter passing and return values
4902 R5-R10: parameter passing
4903 R13: small data area pointer
4904 R30: GOT pointer
4905 R31: frame pointer
4906
e6bee808
JT
4907 (U-Boot also uses R12 as internal GOT pointer. r12
4908 is a volatile register so r12 needs to be reset when
4909 going back and forth between asm and C)
2729af9d 4910
e7670f6c 4911 ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d
WD
4912
4913 Note: on PPC, we could use a static initializer (since the
4914 address of the global data structure is known at compile time),
4915 but it turned out that reserving a register results in somewhat
4916 smaller code - although the code savings are not that big (on
4917 average for all boards 752 bytes for the whole U-Boot image,
4918 624 text + 127 data).
4919
4920On ARM, the following registers are used:
4921
4922 R0: function argument word/integer result
4923 R1-R3: function argument word
12eba1b4
JH
4924 R9: platform specific
4925 R10: stack limit (used only if stack checking is enabled)
2729af9d
WD
4926 R11: argument (frame) pointer
4927 R12: temporary workspace
4928 R13: stack pointer
4929 R14: link register
4930 R15: program counter
4931
12eba1b4
JH
4932 ==> U-Boot will use R9 to hold a pointer to the global data
4933
4934 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
2729af9d 4935
0df01fd3
TC
4936On Nios II, the ABI is documented here:
4937 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4938
4939 ==> U-Boot will use gp to hold a pointer to the global data
4940
4941 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4942 to access small data sections, so gp is free.
4943
afc1ce82
ML
4944On NDS32, the following registers are used:
4945
4946 R0-R1: argument/return
4947 R2-R5: argument
4948 R15: temporary register for assembler
4949 R16: trampoline register
4950 R28: frame pointer (FP)
4951 R29: global pointer (GP)
4952 R30: link register (LP)
4953 R31: stack pointer (SP)
4954 PC: program counter (PC)
4955
4956 ==> U-Boot will use R10 to hold a pointer to the global data
4957
d87080b7
WD
4958NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4959or current versions of GCC may "optimize" the code too much.
2729af9d 4960
3fafced7
RC
4961On RISC-V, the following registers are used:
4962
4963 x0: hard-wired zero (zero)
4964 x1: return address (ra)
4965 x2: stack pointer (sp)
4966 x3: global pointer (gp)
4967 x4: thread pointer (tp)
4968 x5: link register (t0)
4969 x8: frame pointer (fp)
4970 x10-x11: arguments/return values (a0-1)
4971 x12-x17: arguments (a2-7)
4972 x28-31: temporaries (t3-6)
4973 pc: program counter (pc)
4974
4975 ==> U-Boot will use gp to hold a pointer to the global data
4976
2729af9d
WD
4977Memory Management:
4978------------------
4979
4980U-Boot runs in system state and uses physical addresses, i.e. the
4981MMU is not used either for address mapping nor for memory protection.
4982
4983The available memory is mapped to fixed addresses using the memory
4984controller. In this process, a contiguous block is formed for each
4985memory type (Flash, SDRAM, SRAM), even when it consists of several
4986physical memory banks.
4987
4988U-Boot is installed in the first 128 kB of the first Flash bank (on
4989TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4990booting and sizing and initializing DRAM, the code relocates itself
4991to the upper end of DRAM. Immediately below the U-Boot code some
6d0f6bcf 4992memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d
WD
4993configuration setting]. Below that, a structure with global Board
4994Info data is placed, followed by the stack (growing downward).
4995
4996Additionally, some exception handler code is copied to the low 8 kB
4997of DRAM (0x00000000 ... 0x00001FFF).
4998
4999So a typical memory configuration with 16 MB of DRAM could look like
5000this:
5001
5002 0x0000 0000 Exception Vector code
5003 :
5004 0x0000 1FFF
5005 0x0000 2000 Free for Application Use
5006 :
5007 :
5008
5009 :
5010 :
5011 0x00FB FF20 Monitor Stack (Growing downward)
5012 0x00FB FFAC Board Info Data and permanent copy of global data
5013 0x00FC 0000 Malloc Arena
5014 :
5015 0x00FD FFFF
5016 0x00FE 0000 RAM Copy of Monitor Code
5017 ... eventually: LCD or video framebuffer
5018 ... eventually: pRAM (Protected RAM - unchanged by reset)
5019 0x00FF FFFF [End of RAM]
5020
5021
5022System Initialization:
5023----------------------
c609719b 5024
2729af9d 5025In the reset configuration, U-Boot starts at the reset entry point
11ccc33f 5026(on most PowerPC systems at address 0x00000100). Because of the reset
b445bbb4 5027configuration for CS0# this is a mirror of the on board Flash memory.
2729af9d
WD
5028To be able to re-map memory U-Boot then jumps to its link address.
5029To be able to implement the initialization code in C, a (small!)
5030initial stack is set up in the internal Dual Ported RAM (in case CPUs
2eb48ff7
HS
5031which provide such a feature like), or in a locked part of the data
5032cache. After that, U-Boot initializes the CPU core, the caches and
5033the SIU.
2729af9d
WD
5034
5035Next, all (potentially) available memory banks are mapped using a
5036preliminary mapping. For example, we put them on 512 MB boundaries
5037(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5038on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5039programmed for SDRAM access. Using the temporary configuration, a
5040simple memory test is run that determines the size of the SDRAM
5041banks.
5042
5043When there is more than one SDRAM bank, and the banks are of
5044different size, the largest is mapped first. For equal size, the first
5045bank (CS2#) is mapped first. The first mapping is always for address
50460x00000000, with any additional banks following immediately to create
5047contiguous memory starting from 0.
5048
5049Then, the monitor installs itself at the upper end of the SDRAM area
5050and allocates memory for use by malloc() and for the global Board
5051Info data; also, the exception vector code is copied to the low RAM
5052pages, and the final stack is set up.
5053
5054Only after this relocation will you have a "normal" C environment;
5055until that you are restricted in several ways, mostly because you are
5056running from ROM, and because the code will have to be relocated to a
5057new address in RAM.
5058
5059
5060U-Boot Porting Guide:
5061----------------------
c609719b 5062
2729af9d
WD
5063[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5064list, October 2002]
c609719b
WD
5065
5066
6c3fef28 5067int main(int argc, char *argv[])
2729af9d
WD
5068{
5069 sighandler_t no_more_time;
c609719b 5070
6c3fef28
JVB
5071 signal(SIGALRM, no_more_time);
5072 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
c609719b 5073
2729af9d 5074 if (available_money > available_manpower) {
6c3fef28 5075 Pay consultant to port U-Boot;
c609719b
WD
5076 return 0;
5077 }
5078
2729af9d
WD
5079 Download latest U-Boot source;
5080
0668236b 5081 Subscribe to u-boot mailing list;
2729af9d 5082
6c3fef28
JVB
5083 if (clueless)
5084 email("Hi, I am new to U-Boot, how do I get started?");
2729af9d
WD
5085
5086 while (learning) {
5087 Read the README file in the top level directory;
6c3fef28
JVB
5088 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5089 Read applicable doc/*.README;
2729af9d 5090 Read the source, Luke;
6c3fef28 5091 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d
WD
5092 }
5093
6c3fef28
JVB
5094 if (available_money > toLocalCurrency ($2500))
5095 Buy a BDI3000;
5096 else
2729af9d 5097 Add a lot of aggravation and time;
2729af9d 5098
6c3fef28
JVB
5099 if (a similar board exists) { /* hopefully... */
5100 cp -a board/<similar> board/<myboard>
5101 cp include/configs/<similar>.h include/configs/<myboard>.h
5102 } else {
5103 Create your own board support subdirectory;
5104 Create your own board include/configs/<myboard>.h file;
5105 }
5106 Edit new board/<myboard> files
5107 Edit new include/configs/<myboard>.h
5108
5109 while (!accepted) {
5110 while (!running) {
5111 do {
5112 Add / modify source code;
5113 } until (compiles);
5114 Debug;
5115 if (clueless)
5116 email("Hi, I am having problems...");
5117 }
5118 Send patch file to the U-Boot email list;
5119 if (reasonable critiques)
5120 Incorporate improvements from email list code review;
5121 else
5122 Defend code as written;
2729af9d 5123 }
2729af9d
WD
5124
5125 return 0;
5126}
5127
5128void no_more_time (int sig)
5129{
5130 hire_a_guru();
5131}
5132
c609719b 5133
2729af9d
WD
5134Coding Standards:
5135-----------------
c609719b 5136
2729af9d 5137All contributions to U-Boot should conform to the Linux kernel
659208da
BS
5138coding style; see the kernel coding style guide at
5139https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
5140script "scripts/Lindent" in your Linux kernel source directory.
2c051651
DZ
5141
5142Source files originating from a different project (for example the
5143MTD subsystem) are generally exempt from these guidelines and are not
b445bbb4 5144reformatted to ease subsequent migration to newer versions of those
2c051651
DZ
5145sources.
5146
5147Please note that U-Boot is implemented in C (and to some small parts in
5148Assembler); no C++ is used, so please do not use C++ style comments (//)
5149in your code.
c609719b 5150
2729af9d
WD
5151Please also stick to the following formatting rules:
5152- remove any trailing white space
7ca9296e 5153- use TAB characters for indentation and vertical alignment, not spaces
2729af9d 5154- make sure NOT to use DOS '\r\n' line feeds
7ca9296e 5155- do not add more than 2 consecutive empty lines to source files
2729af9d 5156- do not add trailing empty lines to source files
180d3f74 5157
2729af9d
WD
5158Submissions which do not conform to the standards may be returned
5159with a request to reformat the changes.
c609719b
WD
5160
5161
2729af9d
WD
5162Submitting Patches:
5163-------------------
c609719b 5164
2729af9d
WD
5165Since the number of patches for U-Boot is growing, we need to
5166establish some rules. Submissions which do not conform to these rules
5167may be rejected, even when they contain important and valuable stuff.
c609719b 5168
0d28f34b 5169Please see http://www.denx.de/wiki/U-Boot/Patches for details.
218ca724 5170
0668236b 5171Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
1dade18e 5172see https://lists.denx.de/listinfo/u-boot
0668236b 5173
2729af9d
WD
5174When you send a patch, please include the following information with
5175it:
c609719b 5176
2729af9d
WD
5177* For bug fixes: a description of the bug and how your patch fixes
5178 this bug. Please try to include a way of demonstrating that the
5179 patch actually fixes something.
c609719b 5180
2729af9d
WD
5181* For new features: a description of the feature and your
5182 implementation.
c609719b 5183
2729af9d 5184* A CHANGELOG entry as plaintext (separate from the patch)
c609719b 5185
7207b366
RD
5186* For major contributions, add a MAINTAINERS file with your
5187 information and associated file and directory references.
c609719b 5188
27af930e
AA
5189* When you add support for a new board, don't forget to add a
5190 maintainer e-mail address to the boards.cfg file, too.
c609719b 5191
2729af9d
WD
5192* If your patch adds new configuration options, don't forget to
5193 document these in the README file.
c609719b 5194
218ca724
WD
5195* The patch itself. If you are using git (which is *strongly*
5196 recommended) you can easily generate the patch using the
7ca9296e 5197 "git format-patch". If you then use "git send-email" to send it to
218ca724
WD
5198 the U-Boot mailing list, you will avoid most of the common problems
5199 with some other mail clients.
5200
5201 If you cannot use git, use "diff -purN OLD NEW". If your version of
5202 diff does not support these options, then get the latest version of
5203 GNU diff.
c609719b 5204
218ca724
WD
5205 The current directory when running this command shall be the parent
5206 directory of the U-Boot source tree (i. e. please make sure that
5207 your patch includes sufficient directory information for the
5208 affected files).
6dff5529 5209
218ca724
WD
5210 We prefer patches as plain text. MIME attachments are discouraged,
5211 and compressed attachments must not be used.
c609719b 5212
2729af9d
WD
5213* If one logical set of modifications affects or creates several
5214 files, all these changes shall be submitted in a SINGLE patch file.
52f52c14 5215
2729af9d
WD
5216* Changesets that contain different, unrelated modifications shall be
5217 submitted as SEPARATE patches, one patch per changeset.
8bde7f77 5218
52f52c14 5219
2729af9d 5220Notes:
c609719b 5221
6de80f21 5222* Before sending the patch, run the buildman script on your patched
2729af9d
WD
5223 source tree and make sure that no errors or warnings are reported
5224 for any of the boards.
c609719b 5225
2729af9d
WD
5226* Keep your modifications to the necessary minimum: A patch
5227 containing several unrelated changes or arbitrary reformats will be
5228 returned with a request to re-formatting / split it.
c609719b 5229
2729af9d
WD
5230* If you modify existing code, make sure that your new code does not
5231 add to the memory footprint of the code ;-) Small is beautiful!
5232 When adding new features, these should compile conditionally only
5233 (using #ifdef), and the resulting code with the new feature
5234 disabled must not need more memory than the old code without your
5235 modification.
90dc6704 5236
0668236b
WD
5237* Remember that there is a size limit of 100 kB per message on the
5238 u-boot mailing list. Bigger patches will be moderated. If they are
5239 reasonable and not too big, they will be acknowledged. But patches
5240 bigger than the size limit should be avoided.