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