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