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