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