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