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