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