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