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