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