]> Git Repo - u-boot.git/blame - README
mmc: fsl_esdhc: Add new config option for default fallback mode
[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
a3bbd0b9
HS
61https://source.denx.de/u-boot/u-boot.git ; you can browse it online at
62https://source.denx.de/u-boot/u-boot
218ca724 63
c4bd51e2 64The "Tags" links on this page allow you to download tarballs of
11ccc33f 65any version you might be interested in. Official releases are also
c4bd51e2
NH
66available from the DENX file server through HTTPS or FTP.
67https://ftp.denx.de/pub/u-boot/
68ftp://ftp.denx.de/pub/u-boot/
218ca724
WD
69
70
c609719b
WD
71Where we come from:
72===================
73
74- start from 8xxrom sources
047f6ec0 75- create PPCBoot project (https://sourceforge.net/projects/ppcboot)
c609719b
WD
76- clean up code
77- make it easier to add custom boards
78- make it possible to add other [PowerPC] CPUs
79- extend functions, especially:
80 * Provide extended interface to Linux boot loader
81 * S-Record download
82 * network boot
9e5616de 83 * ATA disk / SCSI ... boot
047f6ec0 84- create ARMBoot project (https://sourceforge.net/projects/armboot)
c609719b 85- add other CPU families (starting with ARM)
047f6ec0
NH
86- create U-Boot project (https://sourceforge.net/projects/u-boot)
87- current project page: see https://www.denx.de/wiki/U-Boot
24ee89b9
WD
88
89
90Names and Spelling:
91===================
92
93The "official" name of this project is "Das U-Boot". The spelling
94"U-Boot" shall be used in all written text (documentation, comments
95in source files etc.). Example:
96
97 This is the README file for the U-Boot project.
98
99File names etc. shall be based on the string "u-boot". Examples:
100
101 include/asm-ppc/u-boot.h
102
103 #include <asm/u-boot.h>
104
105Variable names, preprocessor constants etc. shall be either based on
106the string "u_boot" or on "U_BOOT". Example:
107
108 U_BOOT_VERSION u_boot_logo
109 IH_OS_U_BOOT u_boot_hush_start
c609719b
WD
110
111
93f19cc0
WD
112Versioning:
113===========
114
360d883a
TW
115Starting with the release in October 2008, the names of the releases
116were changed from numerical release numbers without deeper meaning
117into a time stamp based numbering. Regular releases are identified by
118names consisting of the calendar year and month of the release date.
119Additional fields (if present) indicate release candidates or bug fix
120releases in "stable" maintenance trees.
121
122Examples:
c0f40859 123 U-Boot v2009.11 - Release November 2009
360d883a 124 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
0de21ecb 125 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
93f19cc0
WD
126
127
c609719b
WD
128Directory Hierarchy:
129====================
130
6e73ed00 131/arch Architecture-specific files
6eae68e4 132 /arc Files generic to ARC architecture
8d321b81 133 /arm Files generic to ARM architecture
8d321b81 134 /m68k Files generic to m68k architecture
8d321b81 135 /microblaze Files generic to microblaze architecture
8d321b81 136 /mips Files generic to MIPS architecture
8d321b81 137 /nios2 Files generic to Altera NIOS2 architecture
a47a12be 138 /powerpc Files generic to PowerPC architecture
3fafced7 139 /riscv Files generic to RISC-V architecture
7207b366 140 /sandbox Files generic to HW-independent "sandbox"
8d321b81 141 /sh Files generic to SH architecture
33c7731b 142 /x86 Files generic to x86 architecture
e4eb313a 143 /xtensa Files generic to Xtensa architecture
6e73ed00
SG
144/api Machine/arch-independent API for external apps
145/board Board-dependent files
19a91f24 146/boot Support for images and booting
740f7e5c 147/cmd U-Boot commands functions
6e73ed00 148/common Misc architecture-independent functions
7207b366 149/configs Board default configuration files
8d321b81 150/disk Code for disk drive partition handling
6e73ed00
SG
151/doc Documentation (a mix of ReST and READMEs)
152/drivers Device drivers
153/dts Makefile for building internal U-Boot fdt.
154/env Environment support
8d321b81
PT
155/examples Example code for standalone applications, etc.
156/fs Filesystem code (cramfs, ext2, jffs2, etc.)
157/include Header Files
7207b366
RD
158/lib Library routines generic to all architectures
159/Licenses Various license files
8d321b81
PT
160/net Networking code
161/post Power On Self Test
7207b366
RD
162/scripts Various build scripts and Makefiles
163/test Various unit test files
6e73ed00 164/tools Tools to build and sign FIT images, etc.
c609719b 165
c609719b
WD
166Software Configuration:
167=======================
168
169Configuration is usually done using C preprocessor defines; the
170rationale behind that is to avoid dead code whenever possible.
171
172There are two classes of configuration variables:
173
174* Configuration _OPTIONS_:
175 These are selectable by the user and have names beginning with
176 "CONFIG_".
177
178* Configuration _SETTINGS_:
179 These depend on the hardware etc. and should not be meddled with if
180 you don't know what you're doing; they have names beginning with
6d0f6bcf 181 "CONFIG_SYS_".
c609719b 182
7207b366
RD
183Previously, all configuration was done by hand, which involved creating
184symbolic links and editing configuration files manually. More recently,
185U-Boot has added the Kbuild infrastructure used by the Linux kernel,
186allowing you to use the "make menuconfig" command to configure your
187build.
c609719b
WD
188
189
190Selection of Processor Architecture and Board Type:
191---------------------------------------------------
192
193For all supported boards there are ready-to-use default
ab584d67 194configurations available; just type "make <board_name>_defconfig".
c609719b
WD
195
196Example: For a TQM823L module type:
197
198 cd u-boot
ab584d67 199 make TQM823L_defconfig
c609719b 200
7207b366
RD
201Note: If you're looking for the default configuration file for a board
202you're sure used to be there but is now missing, check the file
203doc/README.scrapyard for a list of no longer supported boards.
c609719b 204
75b3c3aa
SG
205Sandbox Environment:
206--------------------
207
208U-Boot can be built natively to run on a Linux host using the 'sandbox'
209board. This allows feature development which is not board- or architecture-
210specific to be undertaken on a native platform. The sandbox is also used to
211run some of U-Boot's tests.
212
bbb140ed 213See doc/arch/sandbox.rst for more details.
75b3c3aa
SG
214
215
db910353
SG
216Board Initialisation Flow:
217--------------------------
218
219This is the intended start-up flow for boards. This should apply for both
7207b366
RD
220SPL and U-Boot proper (i.e. they both follow the same rules).
221
222Note: "SPL" stands for "Secondary Program Loader," which is explained in
223more detail later in this file.
224
225At present, SPL mostly uses a separate code path, but the function names
226and roles of each function are the same. Some boards or architectures
227may not conform to this. At least most ARM boards which use
228CONFIG_SPL_FRAMEWORK conform to this.
229
230Execution typically starts with an architecture-specific (and possibly
231CPU-specific) start.S file, such as:
232
233 - arch/arm/cpu/armv7/start.S
234 - arch/powerpc/cpu/mpc83xx/start.S
235 - arch/mips/cpu/start.S
db910353 236
7207b366
RD
237and so on. From there, three functions are called; the purpose and
238limitations of each of these functions are described below.
db910353
SG
239
240lowlevel_init():
241 - purpose: essential init to permit execution to reach board_init_f()
242 - no global_data or BSS
243 - there is no stack (ARMv7 may have one but it will soon be removed)
244 - must not set up SDRAM or use console
245 - must only do the bare minimum to allow execution to continue to
246 board_init_f()
247 - this is almost never needed
248 - return normally from this function
249
250board_init_f():
251 - purpose: set up the machine ready for running board_init_r():
252 i.e. SDRAM and serial UART
253 - global_data is available
254 - stack is in SRAM
255 - BSS is not available, so you cannot use global/static variables,
256 only stack variables and global_data
257
258 Non-SPL-specific notes:
259 - dram_init() is called to set up DRAM. If already done in SPL this
260 can do nothing
261
262 SPL-specific notes:
263 - you can override the entire board_init_f() function with your own
264 version as needed.
265 - preloader_console_init() can be called here in extremis
266 - should set up SDRAM, and anything needed to make the UART work
499696e4 267 - there is no need to clear BSS, it will be done by crt0.S
1425465a
AD
268 - for specific scenarios on certain architectures an early BSS *can*
269 be made available (via CONFIG_SPL_EARLY_BSS by moving the clearing
270 of BSS prior to entering board_init_f()) but doing so is discouraged.
271 Instead it is strongly recommended to architect any code changes
272 or additions such to not depend on the availability of BSS during
273 board_init_f() as indicated in other sections of this README to
274 maintain compatibility and consistency across the entire code base.
db910353
SG
275 - must return normally from this function (don't call board_init_r()
276 directly)
277
278Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
279this point the stack and global_data are relocated to below
280CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
281memory.
282
283board_init_r():
284 - purpose: main execution, common code
285 - global_data is available
286 - SDRAM is available
287 - BSS is available, all static/global variables can be used
288 - execution eventually continues to main_loop()
289
290 Non-SPL-specific notes:
291 - U-Boot is relocated to the top of memory and is now running from
292 there.
293
294 SPL-specific notes:
295 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
63b2316c
AK
296 CONFIG_SYS_FSL_HAS_CCI400
297
298 Defined For SoC that has cache coherent interconnect
299 CCN-400
7f6c2cbc 300
c055cee1
AK
301 CONFIG_SYS_FSL_HAS_CCN504
302
303 Defined for SoC that has cache coherent interconnect CCN-504
304
c609719b
WD
305The following options need to be configured:
306
2628114e
KP
307- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
308
309- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec449 310
66412c63 311- 85xx CPU Options:
ffd06e02
YS
312 CONFIG_SYS_PPC64
313
314 Specifies that the core is a 64-bit PowerPC implementation (implements
315 the "64" category of the Power ISA). This is necessary for ePAPR
316 compliance, among other possible reasons.
317
66412c63
KG
318 CONFIG_SYS_FSL_TBCLK_DIV
319
320 Defines the core time base clock divider ratio compared to the
321 system clock. On most PQ3 devices this is 8, on newer QorIQ
322 devices it can be 16 or 32. The ratio varies from SoC to Soc.
323
8f29084a
KG
324 CONFIG_SYS_FSL_PCIE_COMPAT
325
326 Defines the string to utilize when trying to match PCIe device
327 tree nodes for the given platform.
328
33eee330
SW
329 CONFIG_SYS_FSL_ERRATUM_A004510
330
331 Enables a workaround for erratum A004510. If set,
332 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
333 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
334
335 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
336 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
337
338 Defines one or two SoC revisions (low 8 bits of SVR)
339 for which the A004510 workaround should be applied.
340
341 The rest of SVR is either not relevant to the decision
342 of whether the erratum is present (e.g. p2040 versus
343 p2041) or is implied by the build target, which controls
344 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
345
346 See Freescale App Note 4493 for more information about
347 this erratum.
348
349 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
350
351 This is the value to write into CCSR offset 0x18600
352 according to the A004510 workaround.
353
64501c66
PJ
354 CONFIG_SYS_FSL_DSP_DDR_ADDR
355 This value denotes start offset of DDR memory which is
356 connected exclusively to the DSP cores.
357
765b0bdb
PJ
358 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
359 This value denotes start offset of M2 memory
360 which is directly connected to the DSP core.
361
64501c66
PJ
362 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
363 This value denotes start offset of M3 memory which is directly
364 connected to the DSP core.
365
765b0bdb
PJ
366 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
367 This value denotes start offset of DSP CCSR space.
368
b135991a
PJ
369 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
370 Single Source Clock is clocking mode present in some of FSL SoC's.
371 In this mode, a single differential clock is used to supply
372 clocks to the sysclock, ddrclock and usbclock.
373
fb4a2409
AB
374 CONFIG_SYS_CPC_REINIT_F
375 This CONFIG is defined when the CPC is configured as SRAM at the
a187559e 376 time of U-Boot entry and is required to be re-initialized.
fb4a2409 377
6cb461b4
DS
378- Generic CPU options:
379 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
380
381 Defines the endianess of the CPU. Implementation of those
382 values is arch specific.
383
5614e71b
YS
384 CONFIG_SYS_FSL_DDR
385 Freescale DDR driver in use. This type of DDR controller is
1c58857a 386 found in mpc83xx, mpc85xx as well as some ARM core SoCs.
5614e71b
YS
387
388 CONFIG_SYS_FSL_DDR_ADDR
389 Freescale DDR memory-mapped register base.
390
391 CONFIG_SYS_FSL_DDR_EMU
392 Specify emulator support for DDR. Some DDR features such as
393 deskew training are not available.
394
395 CONFIG_SYS_FSL_DDRC_GEN1
396 Freescale DDR1 controller.
397
398 CONFIG_SYS_FSL_DDRC_GEN2
399 Freescale DDR2 controller.
400
401 CONFIG_SYS_FSL_DDRC_GEN3
402 Freescale DDR3 controller.
403
34e026f9
YS
404 CONFIG_SYS_FSL_DDRC_GEN4
405 Freescale DDR4 controller.
406
9ac4ffbd
YS
407 CONFIG_SYS_FSL_DDRC_ARM_GEN3
408 Freescale DDR3 controller for ARM-based SoCs.
409
5614e71b
YS
410 CONFIG_SYS_FSL_DDR1
411 Board config to use DDR1. It can be enabled for SoCs with
412 Freescale DDR1 or DDR2 controllers, depending on the board
413 implemetation.
414
415 CONFIG_SYS_FSL_DDR2
62a3b7dd 416 Board config to use DDR2. It can be enabled for SoCs with
5614e71b
YS
417 Freescale DDR2 or DDR3 controllers, depending on the board
418 implementation.
419
420 CONFIG_SYS_FSL_DDR3
421 Board config to use DDR3. It can be enabled for SoCs with
34e026f9
YS
422 Freescale DDR3 or DDR3L controllers.
423
424 CONFIG_SYS_FSL_DDR3L
425 Board config to use DDR3L. It can be enabled for SoCs with
426 DDR3L controllers.
5614e71b 427
1b4175d6
PK
428 CONFIG_SYS_FSL_IFC_BE
429 Defines the IFC controller register space as Big Endian
430
431 CONFIG_SYS_FSL_IFC_LE
432 Defines the IFC controller register space as Little Endian
433
1c40707e
PK
434 CONFIG_SYS_FSL_IFC_CLK_DIV
435 Defines divider of platform clock(clock input to IFC controller).
436
add63f94
PK
437 CONFIG_SYS_FSL_LBC_CLK_DIV
438 Defines divider of platform clock(clock input to eLBC controller).
439
4e5b1bd0
YS
440 CONFIG_SYS_FSL_DDR_BE
441 Defines the DDR controller register space as Big Endian
442
443 CONFIG_SYS_FSL_DDR_LE
444 Defines the DDR controller register space as Little Endian
445
6b9e309a
YS
446 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
447 Physical address from the view of DDR controllers. It is the
448 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
449 it could be different for ARM SoCs.
450
6b1e1254
YS
451 CONFIG_SYS_FSL_DDR_INTLV_256B
452 DDR controller interleaving on 256-byte. This is a special
453 interleaving mode, handled by Dickens for Freescale layerscape
454 SoCs with ARM core.
455
1d71efbb
YS
456 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
457 Number of controllers used as main memory.
458
459 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
460 Number of controllers used for other than main memory.
461
028dbb8d
RG
462 CONFIG_SYS_FSL_SEC_BE
463 Defines the SEC controller register space as Big Endian
464
465 CONFIG_SYS_FSL_SEC_LE
466 Defines the SEC controller register space as Little Endian
467
92bbd64e 468- MIPS CPU options:
92bbd64e
DS
469 CONFIG_XWAY_SWAP_BYTES
470
471 Enable compilation of tools/xway-swap-bytes needed for Lantiq
472 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
473 be swapped if a flash programmer is used.
474
b67d8816
CR
475- ARM options:
476 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
477
478 Select high exception vectors of the ARM core, e.g., do not
479 clear the V bit of the c1 register of CP15.
480
207774b2
YS
481 COUNTER_FREQUENCY
482 Generic timer clock source frequency.
483
484 COUNTER_FREQUENCY_REAL
485 Generic timer clock source frequency if the real clock is
486 different from COUNTER_FREQUENCY, and can only be determined
487 at run time.
488
73c38934
SW
489- Tegra SoC options:
490 CONFIG_TEGRA_SUPPORT_NON_SECURE
491
492 Support executing U-Boot in non-secure (NS) mode. Certain
493 impossible actions will be skipped if the CPU is in NS mode,
494 such as ARM architectural timer initialization.
495
5da627a4 496- Linux Kernel Interface:
5da627a4
WD
497 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
498
b445bbb4 499 When transferring memsize parameter to Linux, some versions
5da627a4
WD
500 expect it to be in bytes, others in MB.
501 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
502
fec6d9ee 503 CONFIG_OF_LIBFDT
f57f70aa
WD
504
505 New kernel versions are expecting firmware settings to be
213bf8c8
GVB
506 passed using flattened device trees (based on open firmware
507 concepts).
508
509 CONFIG_OF_LIBFDT
510 * New libfdt-based support
511 * Adds the "fdt" command
3bb342fc 512 * The bootm command automatically updates the fdt
213bf8c8 513
f57f70aa
WD
514 OF_TBCLK - The timebase frequency.
515
11ccc33f
MZ
516 boards with QUICC Engines require OF_QE to set UCC MAC
517 addresses
3bb342fc 518
3887c3fb
HS
519 CONFIG_OF_IDE_FIXUP
520
521 U-Boot can detect if an IDE device is present or not.
522 If not, and this new config option is activated, U-Boot
523 removes the ATA node from the DTS before booting Linux,
524 so the Linux IDE driver does not probe the device and
525 crash. This is needed for buggy hardware (uc101) where
526 no pull down resistor is connected to the signal IDE5V_DD7.
527
0b2f4eca
NG
528- vxWorks boot parameters:
529
530 bootvx constructs a valid bootline using the following
9e98b7e3
BM
531 environments variables: bootdev, bootfile, ipaddr, netmask,
532 serverip, gatewayip, hostname, othbootargs.
0b2f4eca
NG
533 It loads the vxWorks image pointed bootfile.
534
81a05d9b 535 Note: If a "bootargs" environment is defined, it will override
0b2f4eca
NG
536 the defaults discussed just above.
537
93bc2193
A
538- Cache Configuration for ARM:
539 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
540 controller
541 CONFIG_SYS_PL310_BASE - Physical base address of PL310
542 controller register space
543
6705d81e 544- Serial Ports:
6705d81e
WD
545 CONFIG_PL011_CLOCK
546
547 If you have Amba PrimeCell PL011 UARTs, set this variable to
548 the clock speed of the UARTs.
549
550 CONFIG_PL01x_PORTS
551
552 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
553 define this to a list of base addresses for each (supported)
554 port. See e.g. include/configs/versatile.h
555
d57dee57
KM
556 CONFIG_SERIAL_HW_FLOW_CONTROL
557
558 Define this variable to enable hw flow control in serial driver.
559 Current user of this option is drivers/serial/nsl16550.c driver
6705d81e 560
c609719b
WD
561- Serial Download Echo Mode:
562 CONFIG_LOADS_ECHO
563 If defined to 1, all characters received during a
564 serial download (using the "loads" command) are
565 echoed back. This might be needed by some terminal
566 emulations (like "cu"), but may as well just take
567 time on others. This setting #define's the initial
568 value of the "loads_echo" environment variable.
569
302a6487
SG
570- Removal of commands
571 If no commands are needed to boot, you can disable
572 CONFIG_CMDLINE to remove them. In this case, the command line
573 will not be available, and when U-Boot wants to execute the
574 boot command (on start-up) it will call board_run_command()
575 instead. This can reduce image size significantly for very
576 simple boot procedures.
577
a5ecbe62
WD
578- Regular expression support:
579 CONFIG_REGEX
93e14596
WD
580 If this variable is defined, U-Boot is linked against
581 the SLRE (Super Light Regular Expression) library,
582 which adds regex support to some commands, as for
583 example "env grep" and "setexpr".
a5ecbe62 584
c609719b 585- Watchdog:
933ada56
RV
586 CONFIG_SYS_WATCHDOG_FREQ
587 Some platforms automatically call WATCHDOG_RESET()
588 from the timer interrupt handler every
589 CONFIG_SYS_WATCHDOG_FREQ interrupts. If not set by the
590 board configuration file, a default of CONFIG_SYS_HZ/2
591 (i.e. 500) is used. Setting CONFIG_SYS_WATCHDOG_FREQ
592 to 0 disables calling WATCHDOG_RESET() from the timer
593 interrupt.
594
c609719b
WD
595- Real-Time Clock:
596
602ad3b3 597 When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b
WD
598 has to be selected, too. Define exactly one of the
599 following options:
600
c609719b 601 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
4e8b7544 602 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
c609719b 603 CONFIG_RTC_MC146818 - use MC146818 RTC
1cb8e980 604 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
c609719b 605 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
7f70e853 606 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
412921d2 607 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
3bac3513 608 CONFIG_RTC_DS164x - use Dallas DS164x RTC
9536dfcc 609 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
4c0d4c3b 610 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
2bd3cab3 611 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
71d19f30
HS
612 CONFIG_SYS_RV3029_TCR - enable trickle charger on
613 RV3029 RTC.
c609719b 614
b37c7e5e
WD
615 Note that if the RTC uses I2C, then the I2C interface
616 must also be configured. See I2C Support, below.
617
e92739d3
PT
618- GPIO Support:
619 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
e92739d3 620
5dec49ca
CP
621 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
622 chip-ngpio pairs that tell the PCA953X driver the number of
623 pins supported by a particular chip.
624
e92739d3
PT
625 Note that if the GPIO device uses I2C, then the I2C interface
626 must also be configured. See I2C Support, below.
627
aa53233a
SG
628- I/O tracing:
629 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
630 accesses and can checksum them or write a list of them out
631 to memory. See the 'iotrace' command for details. This is
632 useful for testing device drivers since it can confirm that
633 the driver behaves the same way before and after a code
634 change. Currently this is supported on sandbox and arm. To
635 add support for your architecture, add '#include <iotrace.h>'
636 to the bottom of arch/<arch>/include/asm/io.h and test.
637
638 Example output from the 'iotrace stats' command is below.
639 Note that if the trace buffer is exhausted, the checksum will
640 still continue to operate.
641
642 iotrace is enabled
643 Start: 10000000 (buffer start address)
644 Size: 00010000 (buffer size)
645 Offset: 00000120 (current buffer offset)
646 Output: 10000120 (start + offset)
647 Count: 00000018 (number of trace records)
648 CRC32: 9526fb66 (CRC32 of all trace records)
649
c609719b
WD
650- Timestamp Support:
651
43d9616c
WD
652 When CONFIG_TIMESTAMP is selected, the timestamp
653 (date and time) of an image is printed by image
654 commands like bootm or iminfo. This option is
602ad3b3 655 automatically enabled when you select CONFIG_CMD_DATE .
c609719b 656
923c46f9
KP
657- Partition Labels (disklabels) Supported:
658 Zero or more of the following:
659 CONFIG_MAC_PARTITION Apple's MacOS partition table.
923c46f9
KP
660 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
661 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
662 bootloader. Note 2TB partition limit; see
663 disk/part_efi.c
c649e3c9 664 CONFIG_SCSI) you must configure support for at
923c46f9 665 least one non-MTD partition type as well.
c609719b 666
c40b2956
WD
667- LBA48 Support
668 CONFIG_LBA48
669
670 Set this to enable support for disks larger than 137GB
4b142feb 671 Also look at CONFIG_SYS_64BIT_LBA.
c40b2956
WD
672 Whithout these , LBA48 support uses 32bit variables and will 'only'
673 support disks up to 2.1TB.
674
6d0f6bcf 675 CONFIG_SYS_64BIT_LBA:
c40b2956
WD
676 When enabled, makes the IDE subsystem use 64bit sector addresses.
677 Default is 32bit.
678
c609719b 679- NETWORK Support (PCI):
ce5207e1
KM
680 CONFIG_E1000_SPI
681 Utility code for direct access to the SPI bus on Intel 8257x.
682 This does not do anything useful unless you set at least one
683 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
684
c609719b
WD
685 CONFIG_NATSEMI
686 Support for National dp83815 chips.
687
688 CONFIG_NS8382X
689 Support for National dp8382[01] gigabit chips.
690
45219c46 691- NETWORK Support (other):
efdd7319
RH
692 CONFIG_CALXEDA_XGMAC
693 Support for the Calxeda XGMAC device
694
3bb46d23 695 CONFIG_LAN91C96
45219c46
WD
696 Support for SMSC's LAN91C96 chips.
697
45219c46
WD
698 CONFIG_LAN91C96_USE_32_BIT
699 Define this to enable 32 bit addressing
700
3bb46d23 701 CONFIG_SMC91111
f39748ae
WD
702 Support for SMSC's LAN91C111 chip
703
704 CONFIG_SMC91111_BASE
705 Define this to hold the physical address
706 of the device (I/O space)
707
708 CONFIG_SMC_USE_32_BIT
709 Define this if data bus is 32 bits
710
711 CONFIG_SMC_USE_IOFUNCS
712 Define this to use i/o functions instead of macros
713 (some hardware wont work with macros)
714
dc02bada
HS
715 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
716 Define this if you have more then 3 PHYs.
717
b3dbf4a5
ML
718 CONFIG_FTGMAC100
719 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
720
721 CONFIG_FTGMAC100_EGIGA
722 Define this to use GE link update with gigabit PHY.
723 Define this if FTGMAC100 is connected to gigabit PHY.
724 If your system has 10/100 PHY only, it might not occur
725 wrong behavior. Because PHY usually return timeout or
726 useless data when polling gigabit status and gigabit
727 control registers. This behavior won't affect the
728 correctnessof 10/100 link speed update.
729
3d0075fa
YS
730 CONFIG_SH_ETHER
731 Support for Renesas on-chip Ethernet controller
732
733 CONFIG_SH_ETHER_USE_PORT
734 Define the number of ports to be used
735
736 CONFIG_SH_ETHER_PHY_ADDR
737 Define the ETH PHY's address
738
68260aab
YS
739 CONFIG_SH_ETHER_CACHE_WRITEBACK
740 If this option is set, the driver enables cache flush.
741
5e124724 742- TPM Support:
90899cc0
CC
743 CONFIG_TPM
744 Support TPM devices.
745
0766ad2f
CR
746 CONFIG_TPM_TIS_INFINEON
747 Support for Infineon i2c bus TPM devices. Only one device
1b393db5
TWHT
748 per system is supported at this time.
749
1b393db5
TWHT
750 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
751 Define the burst count bytes upper limit
752
3aa74088
CR
753 CONFIG_TPM_ST33ZP24
754 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
755
756 CONFIG_TPM_ST33ZP24_I2C
757 Support for STMicroelectronics ST33ZP24 I2C devices.
758 Requires TPM_ST33ZP24 and I2C.
759
b75fdc11
CR
760 CONFIG_TPM_ST33ZP24_SPI
761 Support for STMicroelectronics ST33ZP24 SPI devices.
762 Requires TPM_ST33ZP24 and SPI.
763
c01939c7
DE
764 CONFIG_TPM_ATMEL_TWI
765 Support for Atmel TWI TPM device. Requires I2C support.
766
90899cc0 767 CONFIG_TPM_TIS_LPC
5e124724
VB
768 Support for generic parallel port TPM devices. Only one device
769 per system is supported at this time.
770
771 CONFIG_TPM_TIS_BASE_ADDRESS
772 Base address where the generic TPM device is mapped
773 to. Contemporary x86 systems usually map it at
774 0xfed40000.
775
be6c1529
RP
776 CONFIG_TPM
777 Define this to enable the TPM support library which provides
778 functional interfaces to some TPM commands.
779 Requires support for a TPM device.
780
781 CONFIG_TPM_AUTH_SESSIONS
782 Define this to enable authorized functions in the TPM library.
783 Requires CONFIG_TPM and CONFIG_SHA1.
784
c609719b
WD
785- USB Support:
786 At the moment only the UHCI host controller is
064b55cf 787 supported (PIP405, MIP405); define
c609719b
WD
788 CONFIG_USB_UHCI to enable it.
789 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae 790 and define CONFIG_USB_STORAGE to enable the USB
c609719b
WD
791 storage devices.
792 Note:
793 Supported are USB Keyboards and USB Floppy drives
794 (TEAC FD-05PUB).
4d13cbad 795
9ab4ce22
SG
796 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
797 txfilltuning field in the EHCI controller on reset.
798
6e9e0626
OT
799 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
800 HW module registers.
801
16c8d5e7
WD
802- USB Device:
803 Define the below if you wish to use the USB console.
804 Once firmware is rebuilt from a serial console issue the
805 command "setenv stdin usbtty; setenv stdout usbtty" and
11ccc33f 806 attach your USB cable. The Unix command "dmesg" should print
16c8d5e7
WD
807 it has found a new device. The environment variable usbtty
808 can be set to gserial or cdc_acm to enable your device to
386eda02 809 appear to a USB host as a Linux gserial device or a
16c8d5e7
WD
810 Common Device Class Abstract Control Model serial device.
811 If you select usbtty = gserial you should be able to enumerate
812 a Linux host by
813 # modprobe usbserial vendor=0xVendorID product=0xProductID
814 else if using cdc_acm, simply setting the environment
815 variable usbtty to be cdc_acm should suffice. The following
816 might be defined in YourBoardName.h
386eda02 817
16c8d5e7
WD
818 CONFIG_USB_DEVICE
819 Define this to build a UDC device
820
821 CONFIG_USB_TTY
822 Define this to have a tty type of device available to
823 talk to the UDC device
386eda02 824
f9da0f89
VK
825 CONFIG_USBD_HS
826 Define this to enable the high speed support for usb
827 device and usbtty. If this feature is enabled, a routine
828 int is_usbd_high_speed(void)
829 also needs to be defined by the driver to dynamically poll
830 whether the enumeration has succeded at high speed or full
831 speed.
832
386eda02 833 If you have a USB-IF assigned VendorID then you may wish to
16c8d5e7 834 define your own vendor specific values either in BoardName.h
386eda02 835 or directly in usbd_vendor_info.h. If you don't define
16c8d5e7
WD
836 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
837 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
838 should pretend to be a Linux device to it's target host.
839
840 CONFIG_USBD_MANUFACTURER
841 Define this string as the name of your company for
842 - CONFIG_USBD_MANUFACTURER "my company"
386eda02 843
16c8d5e7
WD
844 CONFIG_USBD_PRODUCT_NAME
845 Define this string as the name of your product
846 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
847
848 CONFIG_USBD_VENDORID
849 Define this as your assigned Vendor ID from the USB
850 Implementors Forum. This *must* be a genuine Vendor ID
851 to avoid polluting the USB namespace.
852 - CONFIG_USBD_VENDORID 0xFFFF
386eda02 853
16c8d5e7
WD
854 CONFIG_USBD_PRODUCTID
855 Define this as the unique Product ID
856 for your device
857 - CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad 858
d70a560f
IG
859- ULPI Layer Support:
860 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
861 the generic ULPI layer. The generic layer accesses the ULPI PHY
862 via the platform viewport, so you need both the genric layer and
863 the viewport enabled. Currently only Chipidea/ARC based
864 viewport is supported.
865 To enable the ULPI layer support, define CONFIG_USB_ULPI and
866 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
6d365ea0
LS
867 If your ULPI phy needs a different reference clock than the
868 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
869 the appropriate value in Hz.
c609719b 870
71f95118 871- MMC Support:
8bde7f77
WD
872 The MMC controller on the Intel PXA is supported. To
873 enable this define CONFIG_MMC. The MMC can be
874 accessed from the boot prompt by mapping the device
71f95118 875 to physical memory similar to flash. Command line is
602ad3b3
JL
876 enabled with CONFIG_CMD_MMC. The MMC driver also works with
877 the FAT fs. This is enabled with CONFIG_CMD_FAT.
71f95118 878
afb35666
YS
879 CONFIG_SH_MMCIF
880 Support for Renesas on-chip MMCIF controller
881
882 CONFIG_SH_MMCIF_ADDR
883 Define the base address of MMCIF registers
884
885 CONFIG_SH_MMCIF_CLK
886 Define the clock frequency for MMCIF
887
b3ba6e94 888- USB Device Firmware Update (DFU) class support:
bb4059a5 889 CONFIG_DFU_OVER_USB
b3ba6e94
TR
890 This enables the USB portion of the DFU USB class
891
c6631764
PA
892 CONFIG_DFU_NAND
893 This enables support for exposing NAND devices via DFU.
894
a9479f04
AM
895 CONFIG_DFU_RAM
896 This enables support for exposing RAM via DFU.
897 Note: DFU spec refer to non-volatile memory usage, but
898 allow usages beyond the scope of spec - here RAM usage,
899 one that would help mostly the developer.
900
e7e75c70
HS
901 CONFIG_SYS_DFU_DATA_BUF_SIZE
902 Dfu transfer uses a buffer before writing data to the
903 raw storage device. Make the size (in bytes) of this buffer
904 configurable. The size of this buffer is also configurable
905 through the "dfu_bufsiz" environment variable.
906
ea2453d5
PA
907 CONFIG_SYS_DFU_MAX_FILE_SIZE
908 When updating files rather than the raw storage device,
909 we use a static buffer to copy the file into and then write
910 the buffer once we've been given the whole file. Define
911 this to the maximum filesize (in bytes) for the buffer.
912 Default is 4 MiB if undefined.
913
001a8319
HS
914 DFU_DEFAULT_POLL_TIMEOUT
915 Poll timeout [ms], is the timeout a device can send to the
916 host. The host must wait for this timeout before sending
917 a subsequent DFU_GET_STATUS request to the device.
918
919 DFU_MANIFEST_POLL_TIMEOUT
920 Poll timeout [ms], which the device sends to the host when
921 entering dfuMANIFEST state. Host waits this timeout, before
922 sending again an USB request to the device.
923
6705d81e 924- Journaling Flash filesystem support:
6d0f6bcf
JCPV
925 CONFIG_SYS_JFFS2_FIRST_SECTOR,
926 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e
WD
927 Define these for a default partition on a NOR device
928
c609719b 929- Keyboard Support:
39f615ed
SG
930 See Kconfig help for available keyboard drivers.
931
c609719b
WD
932- LCD Support: CONFIG_LCD
933
934 Define this to enable LCD support (for output to LCD
935 display); also select one of the supported displays
936 by defining one of these:
937
fd3103bb 938 CONFIG_NEC_NL6448AC33:
c609719b 939
fd3103bb 940 NEC NL6448AC33-18. Active, color, single scan.
c609719b 941
fd3103bb 942 CONFIG_NEC_NL6448BC20
c609719b 943
fd3103bb
WD
944 NEC NL6448BC20-08. 6.5", 640x480.
945 Active, color, single scan.
946
947 CONFIG_NEC_NL6448BC33_54
948
949 NEC NL6448BC33-54. 10.4", 640x480.
c609719b
WD
950 Active, color, single scan.
951
952 CONFIG_SHARP_16x9
953
954 Sharp 320x240. Active, color, single scan.
955 It isn't 16x9, and I am not sure what it is.
956
957 CONFIG_SHARP_LQ64D341
958
959 Sharp LQ64D341 display, 640x480.
960 Active, color, single scan.
961
962 CONFIG_HLD1045
963
964 HLD1045 display, 640x480.
965 Active, color, single scan.
966
967 CONFIG_OPTREX_BW
968
969 Optrex CBL50840-2 NF-FW 99 22 M5
970 or
971 Hitachi LMG6912RPFC-00T
972 or
973 Hitachi SP14Q002
974
975 320x240. Black & white.
976
676d319e
SG
977 CONFIG_LCD_ALIGNMENT
978
b445bbb4 979 Normally the LCD is page-aligned (typically 4KB). If this is
676d319e
SG
980 defined then the LCD will be aligned to this value instead.
981 For ARM it is sometimes useful to use MMU_SECTION_SIZE
982 here, since it is cheaper to change data cache settings on
983 a per-section basis.
984
985
604c7d4a
HP
986 CONFIG_LCD_ROTATION
987
988 Sometimes, for example if the display is mounted in portrait
989 mode or even if it's mounted landscape but rotated by 180degree,
990 we need to rotate our content of the display relative to the
991 framebuffer, so that user can read the messages which are
992 printed out.
993 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
994 initialized with a given rotation from "vl_rot" out of
995 "vidinfo_t" which is provided by the board specific code.
996 The value for vl_rot is coded as following (matching to
997 fbcon=rotate:<n> linux-kernel commandline):
998 0 = no rotation respectively 0 degree
999 1 = 90 degree rotation
1000 2 = 180 degree rotation
1001 3 = 270 degree rotation
1002
1003 If CONFIG_LCD_ROTATION is not defined, the console will be
1004 initialized with 0degree rotation.
1005
17ea1177 1006- MII/PHY support:
17ea1177
WD
1007 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1008
1009 The clock frequency of the MII bus
1010
17ea1177
WD
1011 CONFIG_PHY_CMD_DELAY (ppc4xx)
1012
1013 Some PHY like Intel LXT971A need extra delay after
1014 command issued before MII status register can be read
1015
c609719b
WD
1016- IP address:
1017 CONFIG_IPADDR
1018
1019 Define a default value for the IP address to use for
11ccc33f 1020 the default Ethernet interface, in case this is not
c609719b 1021 determined through e.g. bootp.
1ebcd654 1022 (Environment variable "ipaddr")
c609719b
WD
1023
1024- Server IP address:
1025 CONFIG_SERVERIP
1026
11ccc33f 1027 Defines a default value for the IP address of a TFTP
c609719b 1028 server to contact when using the "tftboot" command.
1ebcd654 1029 (Environment variable "serverip")
c609719b 1030
1ebcd654
WD
1031- Gateway IP address:
1032 CONFIG_GATEWAYIP
1033
1034 Defines a default value for the IP address of the
1035 default router where packets to other networks are
1036 sent to.
1037 (Environment variable "gatewayip")
1038
1039- Subnet mask:
1040 CONFIG_NETMASK
1041
1042 Defines a default value for the subnet mask (or
1043 routing prefix) which is used to determine if an IP
1044 address belongs to the local subnet or needs to be
1045 forwarded through a router.
1046 (Environment variable "netmask")
1047
c609719b
WD
1048- BOOTP Recovery Mode:
1049 CONFIG_BOOTP_RANDOM_DELAY
1050
1051 If you have many targets in a network that try to
1052 boot using BOOTP, you may want to avoid that all
1053 systems send out BOOTP requests at precisely the same
1054 moment (which would happen for instance at recovery
1055 from a power failure, when all systems will try to
1056 boot, thus flooding the BOOTP server. Defining
1057 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1058 inserted before sending out BOOTP requests. The
6c33c785 1059 following delays are inserted then:
c609719b
WD
1060
1061 1st BOOTP request: delay 0 ... 1 sec
1062 2nd BOOTP request: delay 0 ... 2 sec
1063 3rd BOOTP request: delay 0 ... 4 sec
1064 4th and following
1065 BOOTP requests: delay 0 ... 8 sec
1066
92ac8acc
TR
1067 CONFIG_BOOTP_ID_CACHE_SIZE
1068
1069 BOOTP packets are uniquely identified using a 32-bit ID. The
1070 server will copy the ID from client requests to responses and
1071 U-Boot will use this to determine if it is the destination of
1072 an incoming response. Some servers will check that addresses
1073 aren't in use before handing them out (usually using an ARP
1074 ping) and therefore take up to a few hundred milliseconds to
1075 respond. Network congestion may also influence the time it
1076 takes for a response to make it back to the client. If that
1077 time is too long, U-Boot will retransmit requests. In order
1078 to allow earlier responses to still be accepted after these
1079 retransmissions, U-Boot's BOOTP client keeps a small cache of
1080 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1081 cache. The default is to keep IDs for up to four outstanding
1082 requests. Increasing this will allow U-Boot to accept offers
1083 from a BOOTP client in networks with unusually high latency.
1084
fe389a82 1085- DHCP Advanced Options:
2c00e099 1086
d22c338e
JH
1087 - Link-local IP address negotiation:
1088 Negotiate with other link-local clients on the local network
1089 for an address that doesn't require explicit configuration.
1090 This is especially useful if a DHCP server cannot be guaranteed
1091 to exist in all environments that the device must operate.
1092
1093 See doc/README.link-local for more information.
1094
24acb83d
PK
1095 - MAC address from environment variables
1096
1097 FDT_SEQ_MACADDR_FROM_ENV
1098
1099 Fix-up device tree with MAC addresses fetched sequentially from
1100 environment variables. This config work on assumption that
1101 non-usable ethernet node of device-tree are either not present
1102 or their status has been marked as "disabled".
1103
a3d991bd 1104 - CDP Options:
6e592385 1105 CONFIG_CDP_DEVICE_ID
a3d991bd
WD
1106
1107 The device id used in CDP trigger frames.
1108
1109 CONFIG_CDP_DEVICE_ID_PREFIX
1110
1111 A two character string which is prefixed to the MAC address
1112 of the device.
1113
1114 CONFIG_CDP_PORT_ID
1115
1116 A printf format string which contains the ascii name of
1117 the port. Normally is set to "eth%d" which sets
11ccc33f 1118 eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd
WD
1119
1120 CONFIG_CDP_CAPABILITIES
1121
1122 A 32bit integer which indicates the device capabilities;
1123 0x00000010 for a normal host which does not forwards.
1124
1125 CONFIG_CDP_VERSION
1126
1127 An ascii string containing the version of the software.
1128
1129 CONFIG_CDP_PLATFORM
1130
1131 An ascii string containing the name of the platform.
1132
1133 CONFIG_CDP_TRIGGER
1134
1135 A 32bit integer sent on the trigger.
1136
1137 CONFIG_CDP_POWER_CONSUMPTION
1138
1139 A 16bit integer containing the power consumption of the
1140 device in .1 of milliwatts.
1141
1142 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1143
1144 A byte containing the id of the VLAN.
1145
79267edd 1146- Status LED: CONFIG_LED_STATUS
c609719b
WD
1147
1148 Several configurations allow to display the current
1149 status using a LED. For instance, the LED will blink
1150 fast while running U-Boot code, stop blinking as
1151 soon as a reply to a BOOTP request was received, and
1152 start blinking slow once the Linux kernel is running
1153 (supported by a status LED driver in the Linux
79267edd 1154 kernel). Defining CONFIG_LED_STATUS enables this
c609719b
WD
1155 feature in U-Boot.
1156
1df7bbba
IG
1157 Additional options:
1158
79267edd 1159 CONFIG_LED_STATUS_GPIO
1df7bbba
IG
1160 The status LED can be connected to a GPIO pin.
1161 In such cases, the gpio_led driver can be used as a
79267edd 1162 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1df7bbba
IG
1163 to include the gpio_led driver in the U-Boot binary.
1164
9dfdcdfe
IG
1165 CONFIG_GPIO_LED_INVERTED_TABLE
1166 Some GPIO connected LEDs may have inverted polarity in which
1167 case the GPIO high value corresponds to LED off state and
1168 GPIO low value corresponds to LED on state.
1169 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1170 with a list of GPIO LEDs that have inverted polarity.
1171
55dabcc8 1172- I2C Support:
3f4978c7 1173 CONFIG_SYS_NUM_I2C_BUSES
945a18e6 1174 Hold the number of i2c buses you want to use.
3f4978c7
HS
1175
1176 CONFIG_SYS_I2C_DIRECT_BUS
1177 define this, if you don't use i2c muxes on your hardware.
1178 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1179 omit this define.
1180
1181 CONFIG_SYS_I2C_MAX_HOPS
1182 define how many muxes are maximal consecutively connected
1183 on one i2c bus. If you not use i2c muxes, omit this
1184 define.
1185
1186 CONFIG_SYS_I2C_BUSES
b445bbb4 1187 hold a list of buses you want to use, only used if
3f4978c7
HS
1188 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1189 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1190 CONFIG_SYS_NUM_I2C_BUSES = 9:
1191
1192 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1193 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1194 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1195 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1196 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1197 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1198 {1, {I2C_NULL_HOP}}, \
1199 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1200 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1201 }
1202
1203 which defines
1204 bus 0 on adapter 0 without a mux
ea818dbb
HS
1205 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1206 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1207 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1208 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1209 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
3f4978c7 1210 bus 6 on adapter 1 without a mux
ea818dbb
HS
1211 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1212 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
3f4978c7
HS
1213
1214 If you do not have i2c muxes on your board, omit this define.
1215
ce3b5d69 1216- Legacy I2C Support:
ea818dbb 1217 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
b37c7e5e
WD
1218 then the following macros need to be defined (examples are
1219 from include/configs/lwmon.h):
c609719b
WD
1220
1221 I2C_INIT
1222
b37c7e5e 1223 (Optional). Any commands necessary to enable the I2C
43d9616c 1224 controller or configure ports.
c609719b 1225
ba56f625 1226 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
b37c7e5e 1227
c609719b
WD
1228 I2C_ACTIVE
1229
1230 The code necessary to make the I2C data line active
1231 (driven). If the data line is open collector, this
1232 define can be null.
1233
b37c7e5e
WD
1234 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1235
c609719b
WD
1236 I2C_TRISTATE
1237
1238 The code necessary to make the I2C data line tri-stated
1239 (inactive). If the data line is open collector, this
1240 define can be null.
1241
b37c7e5e
WD
1242 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1243
c609719b
WD
1244 I2C_READ
1245
472d5460
YS
1246 Code that returns true if the I2C data line is high,
1247 false if it is low.
c609719b 1248
b37c7e5e
WD
1249 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1250
c609719b
WD
1251 I2C_SDA(bit)
1252
472d5460
YS
1253 If <bit> is true, sets the I2C data line high. If it
1254 is false, it clears it (low).
c609719b 1255
b37c7e5e 1256 eg: #define I2C_SDA(bit) \
2535d602 1257 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
ba56f625 1258 else immr->im_cpm.cp_pbdat &= ~PB_SDA
b37c7e5e 1259
c609719b
WD
1260 I2C_SCL(bit)
1261
472d5460
YS
1262 If <bit> is true, sets the I2C clock line high. If it
1263 is false, it clears it (low).
c609719b 1264
b37c7e5e 1265 eg: #define I2C_SCL(bit) \
2535d602 1266 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
ba56f625 1267 else immr->im_cpm.cp_pbdat &= ~PB_SCL
b37c7e5e 1268
c609719b
WD
1269 I2C_DELAY
1270
1271 This delay is invoked four times per clock cycle so this
1272 controls the rate of data transfer. The data rate thus
b37c7e5e 1273 is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d7
WD
1274 like:
1275
b37c7e5e 1276 #define I2C_DELAY udelay(2)
c609719b 1277
793b5726
MF
1278 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1279
1280 If your arch supports the generic GPIO framework (asm/gpio.h),
1281 then you may alternatively define the two GPIOs that are to be
1282 used as SCL / SDA. Any of the previous I2C_xxx macros will
1283 have GPIO-based defaults assigned to them as appropriate.
1284
1285 You should define these to the GPIO value as given directly to
1286 the generic GPIO functions.
1287
6d0f6bcf 1288 CONFIG_SYS_I2C_INIT_BOARD
47cd00fa 1289
8bde7f77
WD
1290 When a board is reset during an i2c bus transfer
1291 chips might think that the current transfer is still
1292 in progress. On some boards it is possible to access
1293 the i2c SCLK line directly, either by using the
1294 processor pin as a GPIO or by having a second pin
1295 connected to the bus. If this option is defined a
1296 custom i2c_init_board() routine in boards/xxx/board.c
1297 is run early in the boot sequence.
47cd00fa 1298
bb99ad6d
BW
1299 CONFIG_I2C_MULTI_BUS
1300
1301 This option allows the use of multiple I2C buses, each of which
c0f40859
WD
1302 must have a controller. At any point in time, only one bus is
1303 active. To switch to a different bus, use the 'i2c dev' command.
bb99ad6d
BW
1304 Note that bus numbering is zero-based.
1305
6d0f6bcf 1306 CONFIG_SYS_I2C_NOPROBES
bb99ad6d
BW
1307
1308 This option specifies a list of I2C devices that will be skipped
c0f40859 1309 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
0f89c54b
PT
1310 is set, specify a list of bus-device pairs. Otherwise, specify
1311 a 1D array of device addresses
bb99ad6d
BW
1312
1313 e.g.
1314 #undef CONFIG_I2C_MULTI_BUS
c0f40859 1315 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d
BW
1316
1317 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1318
c0f40859 1319 #define CONFIG_I2C_MULTI_BUS
945a18e6 1320 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d
BW
1321
1322 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1323
6d0f6bcf 1324 CONFIG_SYS_SPD_BUS_NUM
be5e6181
TT
1325
1326 If defined, then this indicates the I2C bus number for DDR SPD.
1327 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1328
6d0f6bcf 1329 CONFIG_SYS_RTC_BUS_NUM
0dc018ec
SR
1330
1331 If defined, then this indicates the I2C bus number for the RTC.
1332 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1333
2ac6985a
AD
1334 CONFIG_SOFT_I2C_READ_REPEATED_START
1335
1336 defining this will force the i2c_read() function in
1337 the soft_i2c driver to perform an I2C repeated start
1338 between writing the address pointer and reading the
1339 data. If this define is omitted the default behaviour
1340 of doing a stop-start sequence will be used. Most I2C
1341 devices can use either method, but some require one or
1342 the other.
be5e6181 1343
c609719b
WD
1344- SPI Support: CONFIG_SPI
1345
1346 Enables SPI driver (so far only tested with
1347 SPI EEPROM, also an instance works with Crystal A/D and
1348 D/As on the SACSng board)
1349
f659b573
HS
1350 CONFIG_SYS_SPI_MXC_WAIT
1351 Timeout for waiting until spi transfer completed.
1352 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1353
0133502e 1354- FPGA Support: CONFIG_FPGA
c609719b 1355
0133502e
MF
1356 Enables FPGA subsystem.
1357
1358 CONFIG_FPGA_<vendor>
1359
1360 Enables support for specific chip vendors.
1361 (ALTERA, XILINX)
c609719b 1362
0133502e 1363 CONFIG_FPGA_<family>
c609719b 1364
0133502e
MF
1365 Enables support for FPGA family.
1366 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1367
1368 CONFIG_FPGA_COUNT
1369
1370 Specify the number of FPGA devices to support.
c609719b 1371
6d0f6bcf 1372 CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b 1373
8bde7f77 1374 Enable printing of hash marks during FPGA configuration.
c609719b 1375
6d0f6bcf 1376 CONFIG_SYS_FPGA_CHECK_BUSY
c609719b 1377
43d9616c
WD
1378 Enable checks on FPGA configuration interface busy
1379 status by the configuration function. This option
1380 will require a board or device specific function to
1381 be written.
c609719b
WD
1382
1383 CONFIG_FPGA_DELAY
1384
1385 If defined, a function that provides delays in the FPGA
1386 configuration driver.
1387
6d0f6bcf 1388 CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b
WD
1389 Allow Control-C to interrupt FPGA configuration
1390
6d0f6bcf 1391 CONFIG_SYS_FPGA_CHECK_ERROR
c609719b 1392
43d9616c
WD
1393 Check for configuration errors during FPGA bitfile
1394 loading. For example, abort during Virtex II
1395 configuration if the INIT_B line goes low (which
1396 indicated a CRC error).
c609719b 1397
6d0f6bcf 1398 CONFIG_SYS_FPGA_WAIT_INIT
c609719b 1399
b445bbb4
JM
1400 Maximum time to wait for the INIT_B line to de-assert
1401 after PROB_B has been de-asserted during a Virtex II
43d9616c 1402 FPGA configuration sequence. The default time is 500
11ccc33f 1403 ms.
c609719b 1404
6d0f6bcf 1405 CONFIG_SYS_FPGA_WAIT_BUSY
c609719b 1406
b445bbb4 1407 Maximum time to wait for BUSY to de-assert during
11ccc33f 1408 Virtex II FPGA configuration. The default is 5 ms.
c609719b 1409
6d0f6bcf 1410 CONFIG_SYS_FPGA_WAIT_CONFIG
c609719b 1411
43d9616c 1412 Time to wait after FPGA configuration. The default is
11ccc33f 1413 200 ms.
c609719b 1414
c609719b
WD
1415- Vendor Parameter Protection:
1416
43d9616c
WD
1417 U-Boot considers the values of the environment
1418 variables "serial#" (Board Serial Number) and
7152b1d0 1419 "ethaddr" (Ethernet Address) to be parameters that
43d9616c
WD
1420 are set once by the board vendor / manufacturer, and
1421 protects these variables from casual modification by
1422 the user. Once set, these variables are read-only,
1423 and write or delete attempts are rejected. You can
11ccc33f 1424 change this behaviour:
c609719b
WD
1425
1426 If CONFIG_ENV_OVERWRITE is #defined in your config
1427 file, the write protection for vendor parameters is
47cd00fa 1428 completely disabled. Anybody can change or delete
c609719b
WD
1429 these parameters.
1430
92ac5208
JH
1431 Alternatively, if you define _both_ an ethaddr in the
1432 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33f 1433 Ethernet address is installed in the environment,
c609719b
WD
1434 which can be changed exactly ONCE by the user. [The
1435 serial# is unaffected by this, i. e. it remains
1436 read-only.]
1437
2598090b
JH
1438 The same can be accomplished in a more flexible way
1439 for any variable by configuring the type of access
1440 to allow for those variables in the ".flags" variable
1441 or define CONFIG_ENV_FLAGS_LIST_STATIC.
1442
c609719b
WD
1443- Protected RAM:
1444 CONFIG_PRAM
1445
1446 Define this variable to enable the reservation of
1447 "protected RAM", i. e. RAM which is not overwritten
1448 by U-Boot. Define CONFIG_PRAM to hold the number of
1449 kB you want to reserve for pRAM. You can overwrite
1450 this default value by defining an environment
1451 variable "pram" to the number of kB you want to
1452 reserve. Note that the board info structure will
1453 still show the full amount of RAM. If pRAM is
1454 reserved, a new environment variable "mem" will
1455 automatically be defined to hold the amount of
1456 remaining RAM in a form that can be passed as boot
1457 argument to Linux, for instance like that:
1458
fe126d8b 1459 setenv bootargs ... mem=\${mem}
c609719b
WD
1460 saveenv
1461
1462 This way you can tell Linux not to use this memory,
1463 either, which results in a memory region that will
1464 not be affected by reboots.
1465
1466 *WARNING* If your board configuration uses automatic
1467 detection of the RAM size, you must make sure that
1468 this memory test is non-destructive. So far, the
1469 following board configurations are known to be
1470 "pRAM-clean":
1471
5b8e76c3 1472 IVMS8, IVML24, SPD8xx,
1b0757ec 1473 HERMES, IP860, RPXlite, LWMON,
2eb48ff7 1474 FLAGADM
c609719b
WD
1475
1476- Error Recovery:
c609719b
WD
1477 Note:
1478
8bde7f77
WD
1479 In the current implementation, the local variables
1480 space and global environment variables space are
1481 separated. Local variables are those you define by
1482 simply typing `name=value'. To access a local
1483 variable later on, you have write `$name' or
1484 `${name}'; to execute the contents of a variable
1485 directly type `$name' at the command prompt.
c609719b 1486
43d9616c
WD
1487 Global environment variables are those you use
1488 setenv/printenv to work with. To run a command stored
1489 in such a variable, you need to use the run command,
1490 and you must not use the '$' sign to access them.
c609719b
WD
1491
1492 To store commands and special characters in a
1493 variable, please use double quotation marks
1494 surrounding the whole text of the variable, instead
1495 of the backslashes before semicolons and special
1496 symbols.
1497
a8c7c708 1498- Default Environment:
c609719b
WD
1499 CONFIG_EXTRA_ENV_SETTINGS
1500
43d9616c
WD
1501 Define this to contain any number of null terminated
1502 strings (variable = value pairs) that will be part of
7152b1d0 1503 the default environment compiled into the boot image.
2262cfee 1504
43d9616c
WD
1505 For example, place something like this in your
1506 board's config file:
c609719b
WD
1507
1508 #define CONFIG_EXTRA_ENV_SETTINGS \
1509 "myvar1=value1\0" \
1510 "myvar2=value2\0"
1511
43d9616c
WD
1512 Warning: This method is based on knowledge about the
1513 internal format how the environment is stored by the
1514 U-Boot code. This is NOT an official, exported
1515 interface! Although it is unlikely that this format
7152b1d0 1516 will change soon, there is no guarantee either.
c609719b
WD
1517 You better know what you are doing here.
1518
43d9616c
WD
1519 Note: overly (ab)use of the default environment is
1520 discouraged. Make sure to check other ways to preset
74de7aef 1521 the environment like the "source" command or the
43d9616c 1522 boot command first.
c609719b 1523
06fd8538
SG
1524 CONFIG_DELAY_ENVIRONMENT
1525
1526 Normally the environment is loaded when the board is
b445bbb4 1527 initialised so that it is available to U-Boot. This inhibits
06fd8538
SG
1528 that so that the environment is not available until
1529 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
1530 this is instead controlled by the value of
1531 /config/load-environment.
1532
4cf2609b
WD
1533 CONFIG_STANDALONE_LOAD_ADDR
1534
6feff899
WD
1535 This option defines a board specific value for the
1536 address where standalone program gets loaded, thus
1537 overwriting the architecture dependent default
4cf2609b
WD
1538 settings.
1539
1540- Frame Buffer Address:
1541 CONFIG_FB_ADDR
1542
1543 Define CONFIG_FB_ADDR if you want to use specific
44a53b57
WD
1544 address for frame buffer. This is typically the case
1545 when using a graphics controller has separate video
1546 memory. U-Boot will then place the frame buffer at
1547 the given address instead of dynamically reserving it
1548 in system RAM by calling lcd_setmem(), which grabs
1549 the memory for the frame buffer depending on the
1550 configured panel size.
4cf2609b
WD
1551
1552 Please see board_init_f function.
1553
cccfc2ab
DZ
1554- Automatic software updates via TFTP server
1555 CONFIG_UPDATE_TFTP
1556 CONFIG_UPDATE_TFTP_CNT_MAX
1557 CONFIG_UPDATE_TFTP_MSEC_MAX
1558
1559 These options enable and control the auto-update feature;
1560 for a more detailed description refer to doc/README.update.
1561
1562- MTD Support (mtdparts command, UBI support)
ff94bc40
HS
1563 CONFIG_MTD_UBI_WL_THRESHOLD
1564 This parameter defines the maximum difference between the highest
1565 erase counter value and the lowest erase counter value of eraseblocks
1566 of UBI devices. When this threshold is exceeded, UBI starts performing
1567 wear leveling by means of moving data from eraseblock with low erase
1568 counter to eraseblocks with high erase counter.
1569
1570 The default value should be OK for SLC NAND flashes, NOR flashes and
1571 other flashes which have eraseblock life-cycle 100000 or more.
1572 However, in case of MLC NAND flashes which typically have eraseblock
1573 life-cycle less than 10000, the threshold should be lessened (e.g.,
1574 to 128 or 256, although it does not have to be power of 2).
1575
1576 default: 4096
c654b517 1577
ff94bc40
HS
1578 CONFIG_MTD_UBI_BEB_LIMIT
1579 This option specifies the maximum bad physical eraseblocks UBI
1580 expects on the MTD device (per 1024 eraseblocks). If the
1581 underlying flash does not admit of bad eraseblocks (e.g. NOR
1582 flash), this value is ignored.
1583
1584 NAND datasheets often specify the minimum and maximum NVM
1585 (Number of Valid Blocks) for the flashes' endurance lifetime.
1586 The maximum expected bad eraseblocks per 1024 eraseblocks
1587 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
1588 which gives 20 for most NANDs (MaxNVB is basically the total
1589 count of eraseblocks on the chip).
1590
1591 To put it differently, if this value is 20, UBI will try to
1592 reserve about 1.9% of physical eraseblocks for bad blocks
1593 handling. And that will be 1.9% of eraseblocks on the entire
1594 NAND chip, not just the MTD partition UBI attaches. This means
1595 that if you have, say, a NAND flash chip admits maximum 40 bad
1596 eraseblocks, and it is split on two MTD partitions of the same
1597 size, UBI will reserve 40 eraseblocks when attaching a
1598 partition.
1599
1600 default: 20
1601
1602 CONFIG_MTD_UBI_FASTMAP
1603 Fastmap is a mechanism which allows attaching an UBI device
1604 in nearly constant time. Instead of scanning the whole MTD device it
1605 only has to locate a checkpoint (called fastmap) on the device.
1606 The on-flash fastmap contains all information needed to attach
1607 the device. Using fastmap makes only sense on large devices where
1608 attaching by scanning takes long. UBI will not automatically install
1609 a fastmap on old images, but you can set the UBI parameter
1610 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
1611 that fastmap-enabled images are still usable with UBI implementations
1612 without fastmap support. On typical flash devices the whole fastmap
1613 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
1614
1615 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
1616 Set this parameter to enable fastmap automatically on images
1617 without a fastmap.
1618 default: 0
1619
0195a7bb
HS
1620 CONFIG_MTD_UBI_FM_DEBUG
1621 Enable UBI fastmap debug
1622 default: 0
1623
6a11cf48 1624- SPL framework
04e5ae79
WD
1625 CONFIG_SPL
1626 Enable building of SPL globally.
6a11cf48 1627
8c80eb3b
AA
1628 CONFIG_SPL_PANIC_ON_RAW_IMAGE
1629 When defined, SPL will panic() if the image it has
1630 loaded does not have a signature.
1631 Defining this is useful when code which loads images
1632 in SPL cannot guarantee that absolutely all read errors
1633 will be caught.
1634 An example is the LPC32XX MLC NAND driver, which will
1635 consider that a completely unreadable NAND block is bad,
1636 and thus should be skipped silently.
1637
861a86f4
TR
1638 CONFIG_SPL_DISPLAY_PRINT
1639 For ARM, enable an optional function to print more information
1640 about the running system.
1641
06f60ae3
SW
1642 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
1643 Set this for NAND SPL on PPC mpc83xx targets, so that
1644 start.S waits for the rest of the SPL to load before
1645 continuing (the hardware starts execution after just
1646 loading the first page rather than the full 4K).
1647
6f4e7d3c
TG
1648 CONFIG_SPL_UBI
1649 Support for a lightweight UBI (fastmap) scanner and
1650 loader
1651
95579793
TR
1652 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
1653 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
1654 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
1655 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
1656 CONFIG_SYS_NAND_ECCBYTES
1657 Defines the size and behavior of the NAND that SPL uses
7d4b7955 1658 to read U-Boot
95579793 1659
7d4b7955
SW
1660 CONFIG_SYS_NAND_U_BOOT_DST
1661 Location in memory to load U-Boot to
1662
1663 CONFIG_SYS_NAND_U_BOOT_SIZE
1664 Size of image to load
95579793
TR
1665
1666 CONFIG_SYS_NAND_U_BOOT_START
7d4b7955 1667 Entry point in loaded image to jump to
95579793
TR
1668
1669 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
1670 Define this if you need to first read the OOB and then the
b445bbb4 1671 data. This is used, for example, on davinci platforms.
95579793 1672
c57b953d
PM
1673 CONFIG_SPL_RAM_DEVICE
1674 Support for running image already present in ram, in SPL binary
6a11cf48 1675
b527b9c6 1676 CONFIG_SPL_FIT_PRINT
87ebee39
SG
1677 Printing information about a FIT image adds quite a bit of
1678 code to SPL. So this is normally disabled in SPL. Use this
1679 option to re-enable it. This will affect the output of the
1680 bootm command when booting a FIT image.
1681
a8c7c708
WD
1682- Interrupt support (PPC):
1683
d4ca31c4
WD
1684 There are common interrupt_init() and timer_interrupt()
1685 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33f 1686 for CPU specific initialization. interrupt_init_cpu()
d4ca31c4 1687 should set decrementer_count to appropriate value. If
11ccc33f 1688 CPU resets decrementer automatically after interrupt
d4ca31c4 1689 (ppc4xx) it should set decrementer_count to zero.
11ccc33f 1690 timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c4
WD
1691 specific handling. If board has watchdog / status_led
1692 / other_activity_monitor it works automatically from
1693 general timer_interrupt().
a8c7c708 1694
c609719b 1695
9660e442
HR
1696Board initialization settings:
1697------------------------------
1698
1699During Initialization u-boot calls a number of board specific functions
1700to allow the preparation of board specific prerequisites, e.g. pin setup
1701before drivers are initialized. To enable these callbacks the
1702following configuration macros have to be defined. Currently this is
1703architecture specific, so please check arch/your_architecture/lib/board.c
1704typically in board_init_f() and board_init_r().
1705
1706- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
1707- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
1708- CONFIG_BOARD_LATE_INIT: Call board_late_init()
c609719b 1709
c609719b
WD
1710Configuration Settings:
1711-----------------------
1712
4d979bfd 1713- MEM_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
4d1fd7f1
YS
1714 Optionally it can be defined to support 64-bit memory commands.
1715
6d0f6bcf 1716- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b
WD
1717 undefine this when you're short of memory.
1718
2fb2604d
PT
1719- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
1720 width of the commands listed in the 'help' command output.
1721
6d0f6bcf 1722- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
c609719b
WD
1723 prompt for user input.
1724
6d0f6bcf 1725- CONFIG_SYS_BAUDRATE_TABLE:
c609719b
WD
1726 List of legal baudrate settings for this board.
1727
e8149522 1728- CONFIG_SYS_MEM_RESERVE_SECURE
e61a7534 1729 Only implemented for ARMv8 for now.
e8149522
YS
1730 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
1731 is substracted from total RAM and won't be reported to OS.
1732 This memory can be used as secure memory. A variable
e61a7534 1733 gd->arch.secure_ram is used to track the location. In systems
e8149522
YS
1734 the RAM base is not zero, or RAM is divided into banks,
1735 this variable needs to be recalcuated to get the address.
1736
6d0f6bcf 1737- CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b
WD
1738 Enable temporary baudrate change while serial download
1739
6d0f6bcf 1740- CONFIG_SYS_SDRAM_BASE:
c609719b
WD
1741 Physical start address of SDRAM. _Must_ be 0 here.
1742
6d0f6bcf 1743- CONFIG_SYS_FLASH_BASE:
c609719b
WD
1744 Physical start address of Flash memory.
1745
6d0f6bcf 1746- CONFIG_SYS_MONITOR_LEN:
8bde7f77
WD
1747 Size of memory reserved for monitor code, used to
1748 determine _at_compile_time_ (!) if the environment is
1749 embedded within the U-Boot image, or in a separate
1750 flash sector.
c609719b 1751
6d0f6bcf 1752- CONFIG_SYS_MALLOC_LEN:
c609719b
WD
1753 Size of DRAM reserved for malloc() use.
1754
d59476b6
SG
1755- CONFIG_SYS_MALLOC_F_LEN
1756 Size of the malloc() pool for use before relocation. If
1757 this is defined, then a very simple malloc() implementation
1758 will become available before relocation. The address is just
1759 below the global data, and the stack is moved down to make
1760 space.
1761
1762 This feature allocates regions with increasing addresses
1763 within the region. calloc() is supported, but realloc()
1764 is not available. free() is supported but does nothing.
b445bbb4 1765 The memory will be freed (or in fact just forgotten) when
d59476b6
SG
1766 U-Boot relocates itself.
1767
38687ae6
SG
1768- CONFIG_SYS_MALLOC_SIMPLE
1769 Provides a simple and small malloc() and calloc() for those
1770 boards which do not use the full malloc in SPL (which is
10f6e4dc 1771 enabled with CONFIG_SYS_SPL_MALLOC).
38687ae6 1772
1dfdd9ba
TR
1773- CONFIG_SYS_NONCACHED_MEMORY:
1774 Size of non-cached memory area. This area of memory will be
1775 typically located right below the malloc() area and mapped
1776 uncached in the MMU. This is useful for drivers that would
1777 otherwise require a lot of explicit cache maintenance. For
1778 some drivers it's also impossible to properly maintain the
1779 cache. For example if the regions that need to be flushed
1780 are not a multiple of the cache-line size, *and* padding
1781 cannot be allocated between the regions to align them (i.e.
1782 if the HW requires a contiguous array of regions, and the
1783 size of each region is not cache-aligned), then a flush of
1784 one region may result in overwriting data that hardware has
1785 written to another region in the same cache-line. This can
1786 happen for example in network drivers where descriptors for
1787 buffers are typically smaller than the CPU cache-line (e.g.
1788 16 bytes vs. 32 or 64 bytes).
1789
1790 Non-cached memory is only supported on 32-bit ARM at present.
1791
6d0f6bcf 1792- CONFIG_SYS_BOOTM_LEN:
15940c9a
SR
1793 Normally compressed uImages are limited to an
1794 uncompressed size of 8 MBytes. If this is not enough,
6d0f6bcf 1795 you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9a
SR
1796 to adjust this setting to your needs.
1797
6d0f6bcf 1798- CONFIG_SYS_BOOTMAPSZ:
c609719b
WD
1799 Maximum size of memory mapped by the startup code of
1800 the Linux kernel; all data that must be processed by
7d721e34
BS
1801 the Linux kernel (bd_info, boot arguments, FDT blob if
1802 used) must be put below this limit, unless "bootm_low"
1bce2aeb 1803 environment variable is defined and non-zero. In such case
7d721e34 1804 all data for the Linux kernel must be between "bootm_low"
c0f40859 1805 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
c3624e6e
GL
1806 variable "bootm_mapsize" will override the value of
1807 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
1808 then the value in "bootm_size" will be used instead.
c609719b 1809
fca43cc8
JR
1810- CONFIG_SYS_BOOT_RAMDISK_HIGH:
1811 Enable initrd_high functionality. If defined then the
1812 initrd_high feature is enabled and the bootm ramdisk subcommand
1813 is enabled.
1814
1815- CONFIG_SYS_BOOT_GET_CMDLINE:
1816 Enables allocating and saving kernel cmdline in space between
1817 "bootm_low" and "bootm_low" + BOOTMAPSZ.
1818
1819- CONFIG_SYS_BOOT_GET_KBD:
1820 Enables allocating and saving a kernel copy of the bd_info in
1821 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
1822
6d0f6bcf 1823- CONFIG_SYS_MAX_FLASH_SECT:
c609719b
WD
1824 Max number of sectors on a Flash chip
1825
6d0f6bcf 1826- CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b
WD
1827 Timeout for Flash erase operations (in ms)
1828
6d0f6bcf 1829- CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b
WD
1830 Timeout for Flash write operations (in ms)
1831
6d0f6bcf 1832- CONFIG_SYS_FLASH_LOCK_TOUT
8564acf9
WD
1833 Timeout for Flash set sector lock bit operation (in ms)
1834
6d0f6bcf 1835- CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf9
WD
1836 Timeout for Flash clear lock bits operation (in ms)
1837
6d0f6bcf 1838- CONFIG_SYS_FLASH_PROTECTION
8564acf9
WD
1839 If defined, hardware flash sectors protection is used
1840 instead of U-Boot software protection.
1841
6d0f6bcf 1842- CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b
WD
1843
1844 Enable TFTP transfers directly to flash memory;
1845 without this option such a download has to be
1846 performed in two steps: (1) download to RAM, and (2)
1847 copy from RAM to flash.
1848
1849 The two-step approach is usually more reliable, since
1850 you can check if the download worked before you erase
11ccc33f
MZ
1851 the flash, but in some situations (when system RAM is
1852 too limited to allow for a temporary copy of the
c609719b
WD
1853 downloaded image) this option may be very useful.
1854
6d0f6bcf 1855- CONFIG_SYS_FLASH_CFI:
43d9616c 1856 Define if the flash driver uses extra elements in the
5653fc33
WD
1857 common flash structure for storing flash geometry.
1858
00b1883a 1859- CONFIG_FLASH_CFI_DRIVER
5653fc33
WD
1860 This option also enables the building of the cfi_flash driver
1861 in the drivers directory
c609719b 1862
91809ed5
PZ
1863- CONFIG_FLASH_CFI_MTD
1864 This option enables the building of the cfi_mtd driver
1865 in the drivers directory. The driver exports CFI flash
1866 to the MTD layer.
1867
6d0f6bcf 1868- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f
GL
1869 Use buffered writes to flash.
1870
1871- CONFIG_FLASH_SPANSION_S29WS_N
1872 s29ws-n MirrorBit flash has non-standard addresses for buffered
1873 write commands.
1874
6d0f6bcf 1875- CONFIG_SYS_FLASH_QUIET_TEST
5568e613
SR
1876 If this option is defined, the common CFI flash doesn't
1877 print it's warning upon not recognized FLASH banks. This
1878 is useful, if some of the configured banks are only
1879 optionally available.
1880
9a042e9c
JVB
1881- CONFIG_FLASH_SHOW_PROGRESS
1882 If defined (must be an integer), print out countdown
1883 digits and dots. Recommended value: 45 (9..1) for 80
1884 column displays, 15 (3..1) for 40 column displays.
1885
352ef3f1
SR
1886- CONFIG_FLASH_VERIFY
1887 If defined, the content of the flash (destination) is compared
1888 against the source after the write operation. An error message
1889 will be printed when the contents are not identical.
1890 Please note that this option is useless in nearly all cases,
1891 since such flash programming errors usually are detected earlier
1892 while unprotecting/erasing/programming. Please only enable
1893 this option if you really know what you are doing.
1894
ea882baf
WD
1895- CONFIG_ENV_MAX_ENTRIES
1896
071bc923
WD
1897 Maximum number of entries in the hash table that is used
1898 internally to store the environment settings. The default
1899 setting is supposed to be generous and should work in most
1900 cases. This setting can be used to tune behaviour; see
1901 lib/hashtable.c for details.
ea882baf 1902
2598090b
JH
1903- CONFIG_ENV_FLAGS_LIST_DEFAULT
1904- CONFIG_ENV_FLAGS_LIST_STATIC
1bce2aeb 1905 Enable validation of the values given to environment variables when
2598090b
JH
1906 calling env set. Variables can be restricted to only decimal,
1907 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
1908 the variables can also be restricted to IP address or MAC address.
1909
1910 The format of the list is:
1911 type_attribute = [s|d|x|b|i|m]
b445bbb4
JM
1912 access_attribute = [a|r|o|c]
1913 attributes = type_attribute[access_attribute]
2598090b
JH
1914 entry = variable_name[:attributes]
1915 list = entry[,list]
1916
1917 The type attributes are:
1918 s - String (default)
1919 d - Decimal
1920 x - Hexadecimal
1921 b - Boolean ([1yYtT|0nNfF])
1922 i - IP address
1923 m - MAC address
1924
267541f7
JH
1925 The access attributes are:
1926 a - Any (default)
1927 r - Read-only
1928 o - Write-once
1929 c - Change-default
1930
2598090b
JH
1931 - CONFIG_ENV_FLAGS_LIST_DEFAULT
1932 Define this to a list (string) to define the ".flags"
b445bbb4 1933 environment variable in the default or embedded environment.
2598090b
JH
1934
1935 - CONFIG_ENV_FLAGS_LIST_STATIC
1936 Define this to a list (string) to define validation that
1937 should be done if an entry is not found in the ".flags"
1938 environment variable. To override a setting in the static
1939 list, simply add an entry for the same variable name to the
1940 ".flags" variable.
1941
bdf1fe4e
JH
1942 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
1943 regular expression. This allows multiple variables to define the same
1944 flags without explicitly listing them for each variable.
1945
c609719b
WD
1946The following definitions that deal with the placement and management
1947of environment data (variable area); in general, we support the
1948following configurations:
1949
c3eb3fe4
MF
1950- CONFIG_BUILD_ENVCRC:
1951
1952 Builds up envcrc with the target environment so that external utils
1953 may easily extract it and embed it in final U-Boot images.
1954
c609719b 1955BE CAREFUL! The first access to the environment happens quite early
b445bbb4 1956in U-Boot initialization (when we try to get the setting of for the
11ccc33f 1957console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b
WD
1958U-Boot will hang.
1959
1960Please note that even with NVRAM we still use a copy of the
1961environment in RAM: we could work on NVRAM directly, but we want to
1962keep settings there always unmodified except somebody uses "saveenv"
1963to save the current settings.
1964
0a85a9e7
LG
1965BE CAREFUL! For some special cases, the local device can not use
1966"saveenv" command. For example, the local device will get the
fc54c7fa
LG
1967environment stored in a remote NOR flash by SRIO or PCIE link,
1968but it can not erase, write this NOR flash by SRIO or PCIE interface.
0a85a9e7 1969
b74ab737
GL
1970- CONFIG_NAND_ENV_DST
1971
1972 Defines address in RAM to which the nand_spl code should copy the
1973 environment. If redundant environment is used, it will be copied to
1974 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
1975
e881cb56 1976Please note that the environment is read-only until the monitor
c609719b 1977has been relocated to RAM and a RAM copy of the environment has been
00caae6d 1978created; also, when using EEPROM you will have to use env_get_f()
c609719b
WD
1979until then to read environment variables.
1980
85ec0bcc
WD
1981The environment is protected by a CRC32 checksum. Before the monitor
1982is relocated into RAM, as a result of a bad CRC you will be working
1983with the compiled-in default environment - *silently*!!! [This is
1984necessary, because the first environment variable we need is the
1985"baudrate" setting for the console - if we have a bad CRC, we don't
1986have any device yet where we could complain.]
c609719b
WD
1987
1988Note: once the monitor has been relocated, then it will complain if
1989the default environment is used; a new CRC is computed as soon as you
85ec0bcc 1990use the "saveenv" command to store a valid environment.
c609719b 1991
6d0f6bcf 1992- CONFIG_SYS_FAULT_MII_ADDR:
42d1f039 1993 MII address of the PHY to check for the Ethernet link state.
c609719b 1994
f5675aa5
RM
1995- CONFIG_NS16550_MIN_FUNCTIONS:
1996 Define this if you desire to only have use of the NS16550_init
1997 and NS16550_putc functions for the serial driver located at
1998 drivers/serial/ns16550.c. This option is useful for saving
1999 space for already greatly restricted images, including but not
2000 limited to NAND_SPL configurations.
2001
b2b92f53
SG
2002- CONFIG_DISPLAY_BOARDINFO
2003 Display information about the board that U-Boot is running on
2004 when U-Boot starts up. The board function checkboard() is called
2005 to do this.
2006
e2e3e2b1
SG
2007- CONFIG_DISPLAY_BOARDINFO_LATE
2008 Similar to the previous option, but display this information
2009 later, once stdio is running and output goes to the LCD, if
2010 present.
2011
c609719b 2012Low Level (hardware related) configuration options:
dc7c9a1a 2013---------------------------------------------------
c609719b 2014
6d0f6bcf 2015- CONFIG_SYS_CACHELINE_SIZE:
c609719b
WD
2016 Cache Line Size of the CPU.
2017
e46fedfe
TT
2018- CONFIG_SYS_CCSRBAR_DEFAULT:
2019 Default (power-on reset) physical address of CCSR on Freescale
2020 PowerPC SOCs.
2021
2022- CONFIG_SYS_CCSRBAR:
2023 Virtual address of CCSR. On a 32-bit build, this is typically
2024 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2025
e46fedfe
TT
2026- CONFIG_SYS_CCSRBAR_PHYS:
2027 Physical address of CCSR. CCSR can be relocated to a new
2028 physical address, if desired. In this case, this macro should
c0f40859 2029 be set to that address. Otherwise, it should be set to the
e46fedfe
TT
2030 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
2031 is typically relocated on 36-bit builds. It is recommended
2032 that this macro be defined via the _HIGH and _LOW macros:
2033
2034 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2035 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2036
2037- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4cf2609b
WD
2038 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
2039 either 0 (32-bit build) or 0xF (36-bit build). This macro is
e46fedfe
TT
2040 used in assembly code, so it must not contain typecasts or
2041 integer size suffixes (e.g. "ULL").
2042
2043- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2044 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
2045 used in assembly code, so it must not contain typecasts or
2046 integer size suffixes (e.g. "ULL").
2047
6d0f6bcf 2048- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
efe2a4d5 2049 DO NOT CHANGE unless you know exactly what you're
907208c4 2050 doing! (11-4) [MPC8xx systems only]
c609719b 2051
6d0f6bcf 2052- CONFIG_SYS_INIT_RAM_ADDR:
c609719b 2053
7152b1d0 2054 Start address of memory area that can be used for
c609719b
WD
2055 initial data and stack; please note that this must be
2056 writable memory that is working WITHOUT special
2057 initialization, i. e. you CANNOT use normal RAM which
2058 will become available only after programming the
2059 memory controller and running certain initialization
2060 sequences.
2061
2062 U-Boot uses the following memory types:
907208c4 2063 - MPC8xx: IMMR (internal memory of the CPU)
c609719b 2064
6d0f6bcf 2065- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
c609719b 2066
6d0f6bcf 2067- CONFIG_SYS_OR_TIMING_SDRAM:
c609719b
WD
2068 SDRAM timing
2069
6d0f6bcf 2070- CONFIG_SYS_MAMR_PTA:
c609719b
WD
2071 periodic timer for refresh
2072
a09b9b68
KG
2073- CONFIG_SYS_SRIO:
2074 Chip has SRIO or not
2075
2076- CONFIG_SRIO1:
2077 Board has SRIO 1 port available
2078
2079- CONFIG_SRIO2:
2080 Board has SRIO 2 port available
2081
c8b28152
LG
2082- CONFIG_SRIO_PCIE_BOOT_MASTER
2083 Board can support master function for Boot from SRIO and PCIE
2084
a09b9b68
KG
2085- CONFIG_SYS_SRIOn_MEM_VIRT:
2086 Virtual Address of SRIO port 'n' memory region
2087
62f9b654 2088- CONFIG_SYS_SRIOn_MEM_PHYxS:
a09b9b68
KG
2089 Physical Address of SRIO port 'n' memory region
2090
2091- CONFIG_SYS_SRIOn_MEM_SIZE:
2092 Size of SRIO port 'n' memory region
2093
66bd1846
FE
2094- CONFIG_SYS_NAND_BUSWIDTH_16BIT
2095 Defined to tell the NAND controller that the NAND chip is using
2096 a 16 bit bus.
2097 Not all NAND drivers use this symbol.
a430e916 2098 Example of drivers that use it:
a430fa06
MR
2099 - drivers/mtd/nand/raw/ndfc.c
2100 - drivers/mtd/nand/raw/mxc_nand.c
eced4626
AW
2101
2102- CONFIG_SYS_NDFC_EBC0_CFG
2103 Sets the EBC0_CFG register for the NDFC. If not defined
2104 a default value will be used.
2105
bb99ad6d 2106- CONFIG_SPD_EEPROM
218ca724
WD
2107 Get DDR timing information from an I2C EEPROM. Common
2108 with pluggable memory modules such as SODIMMs
2109
bb99ad6d
BW
2110 SPD_EEPROM_ADDRESS
2111 I2C address of the SPD EEPROM
2112
6d0f6bcf 2113- CONFIG_SYS_SPD_BUS_NUM
218ca724
WD
2114 If SPD EEPROM is on an I2C bus other than the first
2115 one, specify here. Note that the value must resolve
2116 to something your driver can deal with.
bb99ad6d 2117
1b3e3c4f
YS
2118- CONFIG_SYS_DDR_RAW_TIMING
2119 Get DDR timing information from other than SPD. Common with
2120 soldered DDR chips onboard without SPD. DDR raw timing
2121 parameters are extracted from datasheet and hard-coded into
2122 header files or board specific files.
2123
6f5e1dc5
YS
2124- CONFIG_FSL_DDR_INTERACTIVE
2125 Enable interactive DDR debugging. See doc/README.fsl-ddr.
2126
e32d59a2
YS
2127- CONFIG_FSL_DDR_SYNC_REFRESH
2128 Enable sync of refresh for multiple controllers.
2129
4516ff81
YS
2130- CONFIG_FSL_DDR_BIST
2131 Enable built-in memory test for Freescale DDR controllers.
2132
6d0f6bcf 2133- CONFIG_SYS_83XX_DDR_USES_CS0
218ca724
WD
2134 Only for 83xx systems. If specified, then DDR should
2135 be configured using CS0 and CS1 instead of CS2 and CS3.
2ad6b513 2136
c26e454d
WD
2137- CONFIG_RMII
2138 Enable RMII mode for all FECs.
2139 Note that this is a global option, we can't
2140 have one FEC in standard MII mode and another in RMII mode.
2141
5cf91d6b
WD
2142- CONFIG_CRC32_VERIFY
2143 Add a verify option to the crc32 command.
2144 The syntax is:
2145
2146 => crc32 -v <address> <count> <crc32>
2147
2148 Where address/count indicate a memory area
2149 and crc32 is the correct crc32 which the
2150 area should have.
2151
56523f12
WD
2152- CONFIG_LOOPW
2153 Add the "loopw" memory command. This only takes effect if
493f420e 2154 the memory commands are activated globally (CONFIG_CMD_MEMORY).
56523f12 2155
72732318 2156- CONFIG_CMD_MX_CYCLIC
7b466641
SR
2157 Add the "mdc" and "mwc" memory commands. These are cyclic
2158 "md/mw" commands.
2159 Examples:
2160
efe2a4d5 2161 => mdc.b 10 4 500
7b466641
SR
2162 This command will print 4 bytes (10,11,12,13) each 500 ms.
2163
efe2a4d5 2164 => mwc.l 100 12345678 10
7b466641
SR
2165 This command will write 12345678 to address 100 all 10 ms.
2166
efe2a4d5 2167 This only takes effect if the memory commands are activated
493f420e 2168 globally (CONFIG_CMD_MEMORY).
7b466641 2169
401bb30b 2170- CONFIG_SPL_BUILD
32f2ca2a
TH
2171 Set when the currently-running compilation is for an artifact
2172 that will end up in the SPL (as opposed to the TPL or U-Boot
2173 proper). Code that needs stage-specific behavior should check
2174 this.
400558b5 2175
3aa29de0 2176- CONFIG_TPL_BUILD
32f2ca2a
TH
2177 Set when the currently-running compilation is for an artifact
2178 that will end up in the TPL (as opposed to the SPL or U-Boot
2179 proper). Code that needs stage-specific behavior should check
2180 this.
3aa29de0 2181
5df572f0
YZ
2182- CONFIG_SYS_MPC85XX_NO_RESETVEC
2183 Only for 85xx systems. If this variable is specified, the section
2184 .resetvec is not kept and the section .bootpg is placed in the
2185 previous 4k of the .text section.
2186
4213fc29
SG
2187- CONFIG_ARCH_MAP_SYSMEM
2188 Generally U-Boot (and in particular the md command) uses
2189 effective address. It is therefore not necessary to regard
2190 U-Boot address as virtual addresses that need to be translated
2191 to physical addresses. However, sandbox requires this, since
2192 it maintains its own little RAM buffer which contains all
2193 addressable memory. This option causes some memory accesses
2194 to be mapped through map_sysmem() / unmap_sysmem().
2195
588a13f7
SG
2196- CONFIG_X86_RESET_VECTOR
2197 If defined, the x86 reset vector code is included. This is not
2198 needed when U-Boot is running from Coreboot.
b16f521a 2199
999d7d32
KM
2200- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
2201 Option to disable subpage write in NAND driver
2202 driver that uses this:
a430fa06 2203 drivers/mtd/nand/raw/davinci_nand.c
999d7d32 2204
f2717b47
TT
2205Freescale QE/FMAN Firmware Support:
2206-----------------------------------
2207
2208The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
2209loading of "firmware", which is encoded in the QE firmware binary format.
2210This firmware often needs to be loaded during U-Boot booting, so macros
2211are used to identify the storage device (NOR flash, SPI, etc) and the address
2212within that device.
2213
dcf1d774
ZQ
2214- CONFIG_SYS_FMAN_FW_ADDR
2215 The address in the storage device where the FMAN microcode is located. The
cc1e98b5 2216 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
dcf1d774
ZQ
2217 is also specified.
2218
2219- CONFIG_SYS_QE_FW_ADDR
2220 The address in the storage device where the QE microcode is located. The
cc1e98b5 2221 meaning of this address depends on which CONFIG_SYS_QE_FMAN_FW_IN_xxx macro
f2717b47
TT
2222 is also specified.
2223
2224- CONFIG_SYS_QE_FMAN_FW_LENGTH
2225 The maximum possible size of the firmware. The firmware binary format
2226 has a field that specifies the actual size of the firmware, but it
2227 might not be possible to read any part of the firmware unless some
2228 local storage is allocated to hold the entire firmware first.
2229
2230- CONFIG_SYS_QE_FMAN_FW_IN_NOR
2231 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
2232 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
2233 virtual address in NOR flash.
2234
2235- CONFIG_SYS_QE_FMAN_FW_IN_NAND
2236 Specifies that QE/FMAN firmware is located in NAND flash.
2237 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
2238
2239- CONFIG_SYS_QE_FMAN_FW_IN_MMC
2240 Specifies that QE/FMAN firmware is located on the primary SD/MMC
2241 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
2242
292dc6c5
LG
2243- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
2244 Specifies that QE/FMAN firmware is located in the remote (master)
2245 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
fc54c7fa
LG
2246 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
2247 window->master inbound window->master LAW->the ucode address in
2248 master's memory space.
f2717b47 2249
b940ca64
GR
2250Freescale Layerscape Management Complex Firmware Support:
2251---------------------------------------------------------
2252The Freescale Layerscape Management Complex (MC) supports the loading of
2253"firmware".
2254This firmware often needs to be loaded during U-Boot booting, so macros
2255are used to identify the storage device (NOR flash, SPI, etc) and the address
2256within that device.
2257
2258- CONFIG_FSL_MC_ENET
2259 Enable the MC driver for Layerscape SoCs.
2260
5c055089
PK
2261Freescale Layerscape Debug Server Support:
2262-------------------------------------------
2263The Freescale Layerscape Debug Server Support supports the loading of
2264"Debug Server firmware" and triggering SP boot-rom.
2265This firmware often needs to be loaded during U-Boot booting.
2266
c0492141
YS
2267- CONFIG_SYS_MC_RSV_MEM_ALIGN
2268 Define alignment of reserved memory MC requires
5c055089 2269
f3f431a7
PK
2270Reproducible builds
2271-------------------
2272
2273In order to achieve reproducible builds, timestamps used in the U-Boot build
2274process have to be set to a fixed value.
2275
2276This is done using the SOURCE_DATE_EPOCH environment variable.
2277SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
2278option for U-Boot or an environment variable in U-Boot.
2279
2280SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
2281
c609719b
WD
2282Building the Software:
2283======================
2284
218ca724
WD
2285Building U-Boot has been tested in several native build environments
2286and in many different cross environments. Of course we cannot support
2287all possibly existing versions of cross development tools in all
2288(potentially obsolete) versions. In case of tool chain problems we
047f6ec0 2289recommend to use the ELDK (see https://www.denx.de/wiki/DULG/ELDK)
218ca724 2290which is extensively used to build and test U-Boot.
c609719b 2291
218ca724
WD
2292If you are not using a native environment, it is assumed that you
2293have GNU cross compiling tools available in your path. In this case,
2294you must set the environment variable CROSS_COMPILE in your shell.
2295Note that no changes to the Makefile or any other source files are
2296necessary. For example using the ELDK on a 4xx CPU, please enter:
c609719b 2297
218ca724
WD
2298 $ CROSS_COMPILE=ppc_4xx-
2299 $ export CROSS_COMPILE
c609719b 2300
218ca724
WD
2301U-Boot is intended to be simple to build. After installing the
2302sources you must configure U-Boot for one specific board type. This
c609719b
WD
2303is done by typing:
2304
ab584d67 2305 make NAME_defconfig
c609719b 2306
ab584d67 2307where "NAME_defconfig" is the name of one of the existing configu-
ecb3a0a1 2308rations; see configs/*_defconfig for supported names.
db01a2ea 2309
ecb3a0a1 2310Note: for some boards special configuration names may exist; check if
2729af9d
WD
2311 additional information is available from the board vendor; for
2312 instance, the TQM823L systems are available without (standard)
2313 or with LCD support. You can select such additional "features"
11ccc33f 2314 when choosing the configuration, i. e.
2729af9d 2315
ab584d67 2316 make TQM823L_defconfig
2729af9d
WD
2317 - will configure for a plain TQM823L, i. e. no LCD support
2318
ab584d67 2319 make TQM823L_LCD_defconfig
2729af9d
WD
2320 - will configure for a TQM823L with U-Boot console on LCD
2321
2322 etc.
2323
2324
2325Finally, type "make all", and you should get some working U-Boot
2326images ready for download to / installation on your system:
2327
2328- "u-boot.bin" is a raw binary image
2329- "u-boot" is an image in ELF binary format
2330- "u-boot.srec" is in Motorola S-Record format
2331
baf31249
MB
2332By default the build is performed locally and the objects are saved
2333in the source directory. One of the two methods can be used to change
2334this behavior and build U-Boot to some external directory:
2335
23361. Add O= to the make command line invocations:
2337
2338 make O=/tmp/build distclean
ab584d67 2339 make O=/tmp/build NAME_defconfig
baf31249
MB
2340 make O=/tmp/build all
2341
adbba996 23422. Set environment variable KBUILD_OUTPUT to point to the desired location:
baf31249 2343
adbba996 2344 export KBUILD_OUTPUT=/tmp/build
baf31249 2345 make distclean
ab584d67 2346 make NAME_defconfig
baf31249
MB
2347 make all
2348
adbba996 2349Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
baf31249
MB
2350variable.
2351
215bb1c1
DS
2352User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
2353setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
2354For example to treat all compiler warnings as errors:
2355
2356 make KCFLAGS=-Werror
2729af9d
WD
2357
2358Please be aware that the Makefiles assume you are using GNU make, so
2359for instance on NetBSD you might need to use "gmake" instead of
2360native "make".
2361
2362
2363If the system board that you have is not listed, then you will need
2364to port U-Boot to your hardware platform. To do this, follow these
2365steps:
2366
3c1496cd 23671. Create a new directory to hold your board specific code. Add any
2729af9d 2368 files you need. In your board directory, you will need at least
3c1496cd
PS
2369 the "Makefile" and a "<board>.c".
23702. Create a new configuration file "include/configs/<board>.h" for
2371 your board.
2729af9d
WD
23723. If you're porting U-Boot to a new CPU, then also create a new
2373 directory to hold your CPU specific code. Add any files you need.
ab584d67 23744. Run "make <board>_defconfig" with your new name.
2729af9d
WD
23755. Type "make", and you should get a working "u-boot.srec" file
2376 to be installed on your target system.
23776. Debug and solve any problems that might arise.
2378 [Of course, this last step is much harder than it sounds.]
2379
2380
2381Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2382==============================================================
2383
218ca724
WD
2384If you have modified U-Boot sources (for instance added a new board
2385or support for new devices, a new CPU, etc.) you are expected to
2729af9d 2386provide feedback to the other developers. The feedback normally takes
32f2ca2a 2387the form of a "patch", i.e. a context diff against a certain (latest
218ca724 2388official or latest in the git repository) version of U-Boot sources.
2729af9d 2389
218ca724
WD
2390But before you submit such a patch, please verify that your modifi-
2391cation did not break existing code. At least make sure that *ALL* of
2729af9d 2392the supported boards compile WITHOUT ANY compiler warnings. To do so,
6de80f21
SG
2393just run the buildman script (tools/buildman/buildman), which will
2394configure and build U-Boot for ALL supported system. Be warned, this
2395will take a while. Please see the buildman README, or run 'buildman -H'
2396for documentation.
baf31249
MB
2397
2398
2729af9d
WD
2399See also "U-Boot Porting Guide" below.
2400
2401
2402Monitor Commands - Overview:
2403============================
2404
2405go - start application at address 'addr'
2406run - run commands in an environment variable
2407bootm - boot application image from memory
2408bootp - boot image via network using BootP/TFTP protocol
44f074c7 2409bootz - boot zImage from memory
2729af9d
WD
2410tftpboot- boot image via network using TFTP protocol
2411 and env variables "ipaddr" and "serverip"
2412 (and eventually "gatewayip")
1fb7cd49 2413tftpput - upload a file via network using TFTP protocol
2729af9d
WD
2414rarpboot- boot image via network using RARP/TFTP protocol
2415diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2416loads - load S-Record file over serial line
2417loadb - load binary file over serial line (kermit mode)
2418md - memory display
2419mm - memory modify (auto-incrementing)
2420nm - memory modify (constant address)
2421mw - memory write (fill)
bdded201 2422ms - memory search
2729af9d
WD
2423cp - memory copy
2424cmp - memory compare
2425crc32 - checksum calculation
0f89c54b 2426i2c - I2C sub-system
2729af9d
WD
2427sspi - SPI utility commands
2428base - print or set address offset
2429printenv- print environment variables
9e9a530a 2430pwm - control pwm channels
2729af9d
WD
2431setenv - set environment variables
2432saveenv - save environment variables to persistent storage
2433protect - enable or disable FLASH write protection
2434erase - erase FLASH memory
2435flinfo - print FLASH memory information
10635afa 2436nand - NAND memory operations (see doc/README.nand)
2729af9d
WD
2437bdinfo - print Board Info structure
2438iminfo - print header information for application image
2439coninfo - print console devices and informations
2440ide - IDE sub-system
2441loop - infinite loop on address range
56523f12 2442loopw - infinite write loop on address range
2729af9d
WD
2443mtest - simple RAM test
2444icache - enable or disable instruction cache
2445dcache - enable or disable data cache
2446reset - Perform RESET of the CPU
2447echo - echo args to console
2448version - print monitor version
2449help - print online help
2450? - alias for 'help'
2451
2452
2453Monitor Commands - Detailed Description:
2454========================================
2455
2456TODO.
2457
2458For now: just type "help <command>".
2459
2460
2729af9d
WD
2461Note for Redundant Ethernet Interfaces:
2462=======================================
c609719b 2463
11ccc33f 2464Some boards come with redundant Ethernet interfaces; U-Boot supports
2729af9d
WD
2465such configurations and is capable of automatic selection of a
2466"working" interface when needed. MAC assignment works as follows:
c609719b 2467
2729af9d
WD
2468Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
2469MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2470"eth1addr" (=>eth1), "eth2addr", ...
c609719b 2471
2729af9d
WD
2472If the network interface stores some valid MAC address (for instance
2473in SROM), this is used as default address if there is NO correspon-
2474ding setting in the environment; if the corresponding environment
2475variable is set, this overrides the settings in the card; that means:
c609719b 2476
2729af9d
WD
2477o If the SROM has a valid MAC address, and there is no address in the
2478 environment, the SROM's address is used.
c609719b 2479
2729af9d
WD
2480o If there is no valid address in the SROM, and a definition in the
2481 environment exists, then the value from the environment variable is
2482 used.
c609719b 2483
2729af9d
WD
2484o If both the SROM and the environment contain a MAC address, and
2485 both addresses are the same, this MAC address is used.
c609719b 2486
2729af9d
WD
2487o If both the SROM and the environment contain a MAC address, and the
2488 addresses differ, the value from the environment is used and a
2489 warning is printed.
c609719b 2490
2729af9d 2491o If neither SROM nor the environment contain a MAC address, an error
bef1014b
JH
2492 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
2493 a random, locally-assigned MAC is used.
c609719b 2494
ecee9324 2495If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859 2496will be programmed into hardware as part of the initialization process. This
ecee9324
BW
2497may be skipped by setting the appropriate 'ethmacskip' environment variable.
2498The naming convention is as follows:
2499"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
c609719b 2500
2729af9d
WD
2501Image Formats:
2502==============
c609719b 2503
3310c549
MB
2504U-Boot is capable of booting (and performing other auxiliary operations on)
2505images in two formats:
2506
2507New uImage format (FIT)
2508-----------------------
2509
2510Flexible and powerful format based on Flattened Image Tree -- FIT (similar
2511to Flattened Device Tree). It allows the use of images with multiple
2512components (several kernels, ramdisks, etc.), with contents protected by
2513SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
2514
2515
2516Old uImage format
2517-----------------
2518
2519Old image format is based on binary files which can be basically anything,
2520preceded by a special header; see the definitions in include/image.h for
2521details; basically, the header defines the following image properties:
c609719b 2522
2729af9d
WD
2523* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2524 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
f5ed9e39 2525 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
0797e736 2526 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, INTEGRITY).
daab59ac 2527* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
11232139
TR
2528 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2529 Currently supported: ARM, Intel x86, MIPS, Nios II, PowerPC).
2729af9d
WD
2530* Compression Type (uncompressed, gzip, bzip2)
2531* Load Address
2532* Entry Point
2533* Image Name
2534* Image Timestamp
c609719b 2535
2729af9d
WD
2536The header is marked by a special Magic Number, and both the header
2537and the data portions of the image are secured against corruption by
2538CRC32 checksums.
c609719b
WD
2539
2540
2729af9d
WD
2541Linux Support:
2542==============
c609719b 2543
2729af9d
WD
2544Although U-Boot should support any OS or standalone application
2545easily, the main focus has always been on Linux during the design of
2546U-Boot.
c609719b 2547
2729af9d
WD
2548U-Boot includes many features that so far have been part of some
2549special "boot loader" code within the Linux kernel. Also, any
2550"initrd" images to be used are no longer part of one big Linux image;
2551instead, kernel and "initrd" are separate images. This implementation
2552serves several purposes:
c609719b 2553
2729af9d
WD
2554- the same features can be used for other OS or standalone
2555 applications (for instance: using compressed images to reduce the
2556 Flash memory footprint)
c609719b 2557
2729af9d
WD
2558- it becomes much easier to port new Linux kernel versions because
2559 lots of low-level, hardware dependent stuff are done by U-Boot
c609719b 2560
2729af9d
WD
2561- the same Linux kernel image can now be used with different "initrd"
2562 images; of course this also means that different kernel images can
2563 be run with the same "initrd". This makes testing easier (you don't
2564 have to build a new "zImage.initrd" Linux image when you just
2565 change a file in your "initrd"). Also, a field-upgrade of the
2566 software is easier now.
c609719b 2567
c609719b 2568
2729af9d
WD
2569Linux HOWTO:
2570============
c609719b 2571
2729af9d
WD
2572Porting Linux to U-Boot based systems:
2573---------------------------------------
c609719b 2574
2729af9d
WD
2575U-Boot cannot save you from doing all the necessary modifications to
2576configure the Linux device drivers for use with your target hardware
2577(no, we don't intend to provide a full virtual machine interface to
2578Linux :-).
c609719b 2579
a47a12be 2580But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
24ee89b9 2581
2729af9d
WD
2582Just make sure your machine specific header file (for instance
2583include/asm-ppc/tqm8xx.h) includes the same definition of the Board
1dc30693
MH
2584Information structure as we define in include/asm-<arch>/u-boot.h,
2585and make sure that your definition of IMAP_ADDR uses the same value
6d0f6bcf 2586as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b9 2587
2eb31b13
SG
2588Note that U-Boot now has a driver model, a unified model for drivers.
2589If you are adding a new driver, plumb it into driver model. If there
2590is no uclass available, you are encouraged to create one. See
2591doc/driver-model.
2592
c609719b 2593
2729af9d
WD
2594Configuring the Linux kernel:
2595-----------------------------
c609719b 2596
2729af9d
WD
2597No specific requirements for U-Boot. Make sure you have some root
2598device (initial ramdisk, NFS) for your target system.
2599
2600
2601Building a Linux Image:
2602-----------------------
c609719b 2603
2729af9d
WD
2604With U-Boot, "normal" build targets like "zImage" or "bzImage" are
2605not used. If you use recent kernel source, a new build target
2606"uImage" will exist which automatically builds an image usable by
2607U-Boot. Most older kernels also have support for a "pImage" target,
2608which was introduced for our predecessor project PPCBoot and uses a
2609100% compatible format.
2610
2611Example:
2612
ab584d67 2613 make TQM850L_defconfig
2729af9d
WD
2614 make oldconfig
2615 make dep
2616 make uImage
2617
2618The "uImage" build target uses a special tool (in 'tools/mkimage') to
2619encapsulate a compressed Linux kernel image with header information,
2620CRC32 checksum etc. for use with U-Boot. This is what we are doing:
2621
2622* build a standard "vmlinux" kernel image (in ELF binary format):
2623
2624* convert the kernel into a raw binary image:
2625
2626 ${CROSS_COMPILE}-objcopy -O binary \
2627 -R .note -R .comment \
2628 -S vmlinux linux.bin
2629
2630* compress the binary image:
2631
2632 gzip -9 linux.bin
2633
2634* package compressed binary image for U-Boot:
2635
2636 mkimage -A ppc -O linux -T kernel -C gzip \
2637 -a 0 -e 0 -n "Linux Kernel Image" \
2638 -d linux.bin.gz uImage
c609719b 2639
c609719b 2640
2729af9d
WD
2641The "mkimage" tool can also be used to create ramdisk images for use
2642with U-Boot, either separated from the Linux kernel image, or
2643combined into one file. "mkimage" encapsulates the images with a 64
2644byte header containing information about target architecture,
2645operating system, image type, compression method, entry points, time
2646stamp, CRC32 checksums, etc.
2647
2648"mkimage" can be called in two ways: to verify existing images and
2649print the header information, or to build new images.
2650
2651In the first form (with "-l" option) mkimage lists the information
2652contained in the header of an existing U-Boot image; this includes
2653checksum verification:
c609719b 2654
2729af9d
WD
2655 tools/mkimage -l image
2656 -l ==> list image header information
2657
2658The second form (with "-d" option) is used to build a U-Boot image
2659from a "data file" which is used as image payload:
2660
2661 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2662 -n name -d data_file image
2663 -A ==> set architecture to 'arch'
2664 -O ==> set operating system to 'os'
2665 -T ==> set image type to 'type'
2666 -C ==> set compression type 'comp'
2667 -a ==> set load address to 'addr' (hex)
2668 -e ==> set entry point to 'ep' (hex)
2669 -n ==> set image name to 'name'
2670 -d ==> use image data from 'datafile'
2671
69459791
WD
2672Right now, all Linux kernels for PowerPC systems use the same load
2673address (0x00000000), but the entry point address depends on the
2674kernel version:
2729af9d
WD
2675
2676- 2.2.x kernels have the entry point at 0x0000000C,
2677- 2.3.x and later kernels have the entry point at 0x00000000.
2678
2679So a typical call to build a U-Boot image would read:
2680
2681 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2682 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
a47a12be 2683 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d
WD
2684 > examples/uImage.TQM850L
2685 Image Name: 2.4.4 kernel for TQM850L
2686 Created: Wed Jul 19 02:34:59 2000
2687 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2688 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2689 Load Address: 0x00000000
2690 Entry Point: 0x00000000
2691
2692To verify the contents of the image (or check for corruption):
2693
2694 -> tools/mkimage -l examples/uImage.TQM850L
2695 Image Name: 2.4.4 kernel for TQM850L
2696 Created: Wed Jul 19 02:34:59 2000
2697 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2698 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
2699 Load Address: 0x00000000
2700 Entry Point: 0x00000000
2701
2702NOTE: for embedded systems where boot time is critical you can trade
2703speed for memory and install an UNCOMPRESSED image instead: this
2704needs more space in Flash, but boots much faster since it does not
2705need to be uncompressed:
2706
a47a12be 2707 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d
WD
2708 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
2709 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
a47a12be 2710 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d
WD
2711 > examples/uImage.TQM850L-uncompressed
2712 Image Name: 2.4.4 kernel for TQM850L
2713 Created: Wed Jul 19 02:34:59 2000
2714 Image Type: PowerPC Linux Kernel Image (uncompressed)
2715 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
2716 Load Address: 0x00000000
2717 Entry Point: 0x00000000
2718
2719
2720Similar you can build U-Boot images from a 'ramdisk.image.gz' file
2721when your kernel is intended to use an initial ramdisk:
2722
2723 -> tools/mkimage -n 'Simple Ramdisk Image' \
2724 > -A ppc -O linux -T ramdisk -C gzip \
2725 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2726 Image Name: Simple Ramdisk Image
2727 Created: Wed Jan 12 14:01:50 2000
2728 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2729 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
2730 Load Address: 0x00000000
2731 Entry Point: 0x00000000
2732
e157a111
TH
2733The "dumpimage" tool can be used to disassemble or list the contents of images
2734built by mkimage. See dumpimage's help output (-h) for details.
2729af9d
WD
2735
2736Installing a Linux Image:
2737-------------------------
2738
2739To downloading a U-Boot image over the serial (console) interface,
2740you must convert the image to S-Record format:
2741
2742 objcopy -I binary -O srec examples/image examples/image.srec
2743
2744The 'objcopy' does not understand the information in the U-Boot
2745image header, so the resulting S-Record file will be relative to
2746address 0x00000000. To load it to a given address, you need to
2747specify the target address as 'offset' parameter with the 'loads'
2748command.
2749
2750Example: install the image to address 0x40100000 (which on the
2751TQM8xxL is in the first Flash bank):
2752
2753 => erase 40100000 401FFFFF
2754
2755 .......... done
2756 Erased 8 sectors
2757
2758 => loads 40100000
2759 ## Ready for S-Record download ...
2760 ~>examples/image.srec
2761 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2762 ...
2763 15989 15990 15991 15992
2764 [file transfer complete]
2765 [connected]
2766 ## Start Addr = 0x00000000
2767
2768
2769You can check the success of the download using the 'iminfo' command;
218ca724 2770this includes a checksum verification so you can be sure no data
2729af9d
WD
2771corruption happened:
2772
2773 => imi 40100000
2774
2775 ## Checking Image at 40100000 ...
2776 Image Name: 2.2.13 for initrd on TQM850L
2777 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2778 Data Size: 335725 Bytes = 327 kB = 0 MB
2779 Load Address: 00000000
2780 Entry Point: 0000000c
2781 Verifying Checksum ... OK
2782
2783
2784Boot Linux:
2785-----------
2786
2787The "bootm" command is used to boot an application that is stored in
2788memory (RAM or Flash). In case of a Linux kernel image, the contents
2789of the "bootargs" environment variable is passed to the kernel as
2790parameters. You can check and modify this variable using the
2791"printenv" and "setenv" commands:
2792
2793
2794 => printenv bootargs
2795 bootargs=root=/dev/ram
2796
2797 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2798
2799 => printenv bootargs
2800 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2801
2802 => bootm 40020000
2803 ## Booting Linux kernel at 40020000 ...
2804 Image Name: 2.2.13 for NFS on TQM850L
2805 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2806 Data Size: 381681 Bytes = 372 kB = 0 MB
2807 Load Address: 00000000
2808 Entry Point: 0000000c
2809 Verifying Checksum ... OK
2810 Uncompressing Kernel Image ... OK
2811 Linux version 2.2.13 ([email protected]) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000
2812 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2813 time_init: decrementer frequency = 187500000/60
2814 Calibrating delay loop... 49.77 BogoMIPS
2815 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2816 ...
2817
11ccc33f 2818If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d
WD
2819the memory addresses of both the kernel and the initrd image (PPBCOOT
2820format!) to the "bootm" command:
2821
2822 => imi 40100000 40200000
2823
2824 ## Checking Image at 40100000 ...
2825 Image Name: 2.2.13 for initrd on TQM850L
2826 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2827 Data Size: 335725 Bytes = 327 kB = 0 MB
2828 Load Address: 00000000
2829 Entry Point: 0000000c
2830 Verifying Checksum ... OK
2831
2832 ## Checking Image at 40200000 ...
2833 Image Name: Simple Ramdisk Image
2834 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2835 Data Size: 566530 Bytes = 553 kB = 0 MB
2836 Load Address: 00000000
2837 Entry Point: 00000000
2838 Verifying Checksum ... OK
2839
2840 => bootm 40100000 40200000
2841 ## Booting Linux kernel at 40100000 ...
2842 Image Name: 2.2.13 for initrd on TQM850L
2843 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2844 Data Size: 335725 Bytes = 327 kB = 0 MB
2845 Load Address: 00000000
2846 Entry Point: 0000000c
2847 Verifying Checksum ... OK
2848 Uncompressing Kernel Image ... OK
2849 ## Loading RAMDisk Image at 40200000 ...
2850 Image Name: Simple Ramdisk Image
2851 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
2852 Data Size: 566530 Bytes = 553 kB = 0 MB
2853 Load Address: 00000000
2854 Entry Point: 00000000
2855 Verifying Checksum ... OK
2856 Loading Ramdisk ... OK
2857 Linux version 2.2.13 ([email protected]) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
2858 Boot arguments: root=/dev/ram
2859 time_init: decrementer frequency = 187500000/60
2860 Calibrating delay loop... 49.77 BogoMIPS
2861 ...
2862 RAMDISK: Compressed image found at block 0
2863 VFS: Mounted root (ext2 filesystem).
2864
2865 bash#
2866
0267768e
MM
2867Boot Linux and pass a flat device tree:
2868-----------
2869
2870First, U-Boot must be compiled with the appropriate defines. See the section
2871titled "Linux Kernel Interface" above for a more in depth explanation. The
2872following is an example of how to start a kernel and pass an updated
2873flat device tree:
2874
2875=> print oftaddr
2876oftaddr=0x300000
2877=> print oft
2878oft=oftrees/mpc8540ads.dtb
2879=> tftp $oftaddr $oft
2880Speed: 1000, full duplex
2881Using TSEC0 device
2882TFTP from server 192.168.1.1; our IP address is 192.168.1.101
2883Filename 'oftrees/mpc8540ads.dtb'.
2884Load address: 0x300000
2885Loading: #
2886done
2887Bytes transferred = 4106 (100a hex)
2888=> tftp $loadaddr $bootfile
2889Speed: 1000, full duplex
2890Using TSEC0 device
2891TFTP from server 192.168.1.1; our IP address is 192.168.1.2
2892Filename 'uImage'.
2893Load address: 0x200000
2894Loading:############
2895done
2896Bytes transferred = 1029407 (fb51f hex)
2897=> print loadaddr
2898loadaddr=200000
2899=> print oftaddr
2900oftaddr=0x300000
2901=> bootm $loadaddr - $oftaddr
2902## Booting image at 00200000 ...
a9398e01
WD
2903 Image Name: Linux-2.6.17-dirty
2904 Image Type: PowerPC Linux Kernel Image (gzip compressed)
2905 Data Size: 1029343 Bytes = 1005.2 kB
0267768e 2906 Load Address: 00000000
a9398e01 2907 Entry Point: 00000000
0267768e
MM
2908 Verifying Checksum ... OK
2909 Uncompressing Kernel Image ... OK
2910Booting using flat device tree at 0x300000
2911Using MPC85xx ADS machine description
2912Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
2913[snip]
2914
2915
2729af9d
WD
2916More About U-Boot Image Types:
2917------------------------------
2918
2919U-Boot supports the following image types:
2920
2921 "Standalone Programs" are directly runnable in the environment
2922 provided by U-Boot; it is expected that (if they behave
2923 well) you can continue to work in U-Boot after return from
2924 the Standalone Program.
2925 "OS Kernel Images" are usually images of some Embedded OS which
2926 will take over control completely. Usually these programs
2927 will install their own set of exception handlers, device
2928 drivers, set up the MMU, etc. - this means, that you cannot
2929 expect to re-enter U-Boot except by resetting the CPU.
2930 "RAMDisk Images" are more or less just data blocks, and their
2931 parameters (address, size) are passed to an OS kernel that is
2932 being started.
2933 "Multi-File Images" contain several images, typically an OS
2934 (Linux) kernel image and one or more data images like
2935 RAMDisks. This construct is useful for instance when you want
2936 to boot over the network using BOOTP etc., where the boot
2937 server provides just a single image file, but you want to get
2938 for instance an OS kernel and a RAMDisk image.
2939
2940 "Multi-File Images" start with a list of image sizes, each
2941 image size (in bytes) specified by an "uint32_t" in network
2942 byte order. This list is terminated by an "(uint32_t)0".
2943 Immediately after the terminating 0 follow the images, one by
2944 one, all aligned on "uint32_t" boundaries (size rounded up to
2945 a multiple of 4 bytes).
2946
2947 "Firmware Images" are binary images containing firmware (like
2948 U-Boot or FPGA images) which usually will be programmed to
2949 flash memory.
2950
2951 "Script files" are command sequences that will be executed by
2952 U-Boot's command interpreter; this feature is especially
2953 useful when you configure U-Boot to use a real shell (hush)
2954 as command interpreter.
2955
44f074c7
MV
2956Booting the Linux zImage:
2957-------------------------
2958
2959On some platforms, it's possible to boot Linux zImage. This is done
2960using the "bootz" command. The syntax of "bootz" command is the same
2961as the syntax of "bootm" command.
2962
8ac28563 2963Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
017e1f3f
MV
2964kernel with raw initrd images. The syntax is slightly different, the
2965address of the initrd must be augmented by it's size, in the following
2966format: "<initrd addres>:<initrd size>".
2967
2729af9d
WD
2968
2969Standalone HOWTO:
2970=================
2971
2972One of the features of U-Boot is that you can dynamically load and
2973run "standalone" applications, which can use some resources of
2974U-Boot like console I/O functions or interrupt services.
2975
2976Two simple examples are included with the sources:
2977
2978"Hello World" Demo:
2979-------------------
2980
2981'examples/hello_world.c' contains a small "Hello World" Demo
2982application; it is automatically compiled when you build U-Boot.
2983It's configured to run at address 0x00040004, so you can play with it
2984like that:
2985
2986 => loads
2987 ## Ready for S-Record download ...
2988 ~>examples/hello_world.srec
2989 1 2 3 4 5 6 7 8 9 10 11 ...
2990 [file transfer complete]
2991 [connected]
2992 ## Start Addr = 0x00040004
2993
2994 => go 40004 Hello World! This is a test.
2995 ## Starting application at 0x00040004 ...
2996 Hello World
2997 argc = 7
2998 argv[0] = "40004"
2999 argv[1] = "Hello"
3000 argv[2] = "World!"
3001 argv[3] = "This"
3002 argv[4] = "is"
3003 argv[5] = "a"
3004 argv[6] = "test."
3005 argv[7] = "<NULL>"
3006 Hit any key to exit ...
3007
3008 ## Application terminated, rc = 0x0
3009
3010Another example, which demonstrates how to register a CPM interrupt
3011handler with the U-Boot code, can be found in 'examples/timer.c'.
3012Here, a CPM timer is set up to generate an interrupt every second.
3013The interrupt service routine is trivial, just printing a '.'
3014character, but this is just a demo program. The application can be
3015controlled by the following keys:
3016
3017 ? - print current values og the CPM Timer registers
3018 b - enable interrupts and start timer
3019 e - stop timer and disable interrupts
3020 q - quit application
3021
3022 => loads
3023 ## Ready for S-Record download ...
3024 ~>examples/timer.srec
3025 1 2 3 4 5 6 7 8 9 10 11 ...
3026 [file transfer complete]
3027 [connected]
3028 ## Start Addr = 0x00040004
3029
3030 => go 40004
3031 ## Starting application at 0x00040004 ...
3032 TIMERS=0xfff00980
3033 Using timer 1
3034 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3035
3036Hit 'b':
3037 [q, b, e, ?] Set interval 1000000 us
3038 Enabling timer
3039Hit '?':
3040 [q, b, e, ?] ........
3041 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3042Hit '?':
3043 [q, b, e, ?] .
3044 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3045Hit '?':
3046 [q, b, e, ?] .
3047 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3048Hit '?':
3049 [q, b, e, ?] .
3050 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3051Hit 'e':
3052 [q, b, e, ?] ...Stopping timer
3053Hit 'q':
3054 [q, b, e, ?] ## Application terminated, rc = 0x0
3055
3056
3057Minicom warning:
3058================
3059
3060Over time, many people have reported problems when trying to use the
3061"minicom" terminal emulation program for serial download. I (wd)
3062consider minicom to be broken, and recommend not to use it. Under
3063Unix, I recommend to use C-Kermit for general purpose use (and
3064especially for kermit binary protocol download ("loadb" command), and
e53515a2 3065use "cu" for S-Record download ("loads" command). See
047f6ec0 3066https://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
e53515a2
KP
3067for help with kermit.
3068
2729af9d
WD
3069
3070Nevertheless, if you absolutely want to use it try adding this
3071configuration to your "File transfer protocols" section:
3072
3073 Name Program Name U/D FullScr IO-Red. Multi
3074 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3075 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
3076
3077
3078NetBSD Notes:
3079=============
3080
3081Starting at version 0.9.2, U-Boot supports NetBSD both as host
3082(build U-Boot) and target system (boots NetBSD/mpc8xx).
3083
3084Building requires a cross environment; it is known to work on
3085NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3086need gmake since the Makefiles are not compatible with BSD make).
3087Note that the cross-powerpc package does not install include files;
3088attempting to build U-Boot will fail because <machine/ansi.h> is
3089missing. This file has to be installed and patched manually:
3090
3091 # cd /usr/pkg/cross/powerpc-netbsd/include
3092 # mkdir powerpc
3093 # ln -s powerpc machine
3094 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3095 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
3096
3097Native builds *don't* work due to incompatibilities between native
3098and U-Boot include files.
3099
3100Booting assumes that (the first part of) the image booted is a
3101stage-2 loader which in turn loads and then invokes the kernel
3102proper. Loader sources will eventually appear in the NetBSD source
3103tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2a8af187 3104meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d
WD
3105
3106
3107Implementation Internals:
3108=========================
3109
3110The following is not intended to be a complete description of every
3111implementation detail. However, it should help to understand the
3112inner workings of U-Boot and make it easier to port it to custom
3113hardware.
3114
3115
3116Initial Stack, Global Data:
3117---------------------------
3118
3119The implementation of U-Boot is complicated by the fact that U-Boot
3120starts running out of ROM (flash memory), usually without access to
3121system RAM (because the memory controller is not initialized yet).
3122This means that we don't have writable Data or BSS segments, and BSS
3123is not initialized as zero. To be able to get a C environment working
3124at all, we have to allocate at least a minimal stack. Implementation
3125options for this are defined and restricted by the CPU used: Some CPU
3126models provide on-chip memory (like the IMMR area on MPC8xx and
3127MPC826x processors), on others (parts of) the data cache can be
3128locked as (mis-) used as memory, etc.
3129
218ca724 3130 Chris Hallinan posted a good summary of these issues to the
0668236b 3131 U-Boot mailing list:
2729af9d
WD
3132
3133 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3134 From: "Chris Hallinan" <[email protected]>
3135 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3136 ...
3137
3138 Correct me if I'm wrong, folks, but the way I understand it
3139 is this: Using DCACHE as initial RAM for Stack, etc, does not
3140 require any physical RAM backing up the cache. The cleverness
3141 is that the cache is being used as a temporary supply of
3142 necessary storage before the SDRAM controller is setup. It's
11ccc33f 3143 beyond the scope of this list to explain the details, but you
2729af9d
WD
3144 can see how this works by studying the cache architecture and
3145 operation in the architecture and processor-specific manuals.
3146
3147 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3148 is another option for the system designer to use as an
11ccc33f 3149 initial stack/RAM area prior to SDRAM being available. Either
2729af9d
WD
3150 option should work for you. Using CS 4 should be fine if your
3151 board designers haven't used it for something that would
3152 cause you grief during the initial boot! It is frequently not
3153 used.
3154
6d0f6bcf 3155 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d
WD
3156 with your processor/board/system design. The default value
3157 you will find in any recent u-boot distribution in
8a316c9b 3158 walnut.h should work for you. I'd set it to a value larger
2729af9d
WD
3159 than your SDRAM module. If you have a 64MB SDRAM module, set
3160 it above 400_0000. Just make sure your board has no resources
3161 that are supposed to respond to that address! That code in
3162 start.S has been around a while and should work as is when
3163 you get the config right.
3164
3165 -Chris Hallinan
3166 DS4.COM, Inc.
3167
3168It is essential to remember this, since it has some impact on the C
3169code for the initialization procedures:
3170
3171* Initialized global data (data segment) is read-only. Do not attempt
3172 to write it.
3173
b445bbb4 3174* Do not use any uninitialized global data (or implicitly initialized
2729af9d
WD
3175 as zero data - BSS segment) at all - this is undefined, initiali-
3176 zation is performed later (when relocating to RAM).
3177
3178* Stack space is very limited. Avoid big data buffers or things like
3179 that.
3180
3181Having only the stack as writable memory limits means we cannot use
b445bbb4 3182normal global data to share information between the code. But it
2729af9d
WD
3183turned out that the implementation of U-Boot can be greatly
3184simplified by making a global data structure (gd_t) available to all
3185functions. We could pass a pointer to this data as argument to _all_
3186functions, but this would bloat the code. Instead we use a feature of
3187the GCC compiler (Global Register Variables) to share the data: we
3188place a pointer (gd) to the global data into a register which we
3189reserve for this purpose.
3190
3191When choosing a register for such a purpose we are restricted by the
3192relevant (E)ABI specifications for the current architecture, and by
3193GCC's implementation.
3194
3195For PowerPC, the following registers have specific use:
3196 R1: stack pointer
e7670f6c 3197 R2: reserved for system use
2729af9d
WD
3198 R3-R4: parameter passing and return values
3199 R5-R10: parameter passing
3200 R13: small data area pointer
3201 R30: GOT pointer
3202 R31: frame pointer
3203
e6bee808
JT
3204 (U-Boot also uses R12 as internal GOT pointer. r12
3205 is a volatile register so r12 needs to be reset when
3206 going back and forth between asm and C)
2729af9d 3207
e7670f6c 3208 ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d
WD
3209
3210 Note: on PPC, we could use a static initializer (since the
3211 address of the global data structure is known at compile time),
3212 but it turned out that reserving a register results in somewhat
3213 smaller code - although the code savings are not that big (on
3214 average for all boards 752 bytes for the whole U-Boot image,
3215 624 text + 127 data).
3216
3217On ARM, the following registers are used:
3218
3219 R0: function argument word/integer result
3220 R1-R3: function argument word
12eba1b4
JH
3221 R9: platform specific
3222 R10: stack limit (used only if stack checking is enabled)
2729af9d
WD
3223 R11: argument (frame) pointer
3224 R12: temporary workspace
3225 R13: stack pointer
3226 R14: link register
3227 R15: program counter
3228
12eba1b4
JH
3229 ==> U-Boot will use R9 to hold a pointer to the global data
3230
3231 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
2729af9d 3232
0df01fd3 3233On Nios II, the ABI is documented here:
047f6ec0 3234 https://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
0df01fd3
TC
3235
3236 ==> U-Boot will use gp to hold a pointer to the global data
3237
3238 Note: on Nios II, we give "-G0" option to gcc and don't use gp
3239 to access small data sections, so gp is free.
3240
3fafced7
RC
3241On RISC-V, the following registers are used:
3242
3243 x0: hard-wired zero (zero)
3244 x1: return address (ra)
3245 x2: stack pointer (sp)
3246 x3: global pointer (gp)
3247 x4: thread pointer (tp)
3248 x5: link register (t0)
3249 x8: frame pointer (fp)
3250 x10-x11: arguments/return values (a0-1)
3251 x12-x17: arguments (a2-7)
3252 x28-31: temporaries (t3-6)
3253 pc: program counter (pc)
3254
3255 ==> U-Boot will use gp to hold a pointer to the global data
3256
2729af9d
WD
3257Memory Management:
3258------------------
3259
3260U-Boot runs in system state and uses physical addresses, i.e. the
3261MMU is not used either for address mapping nor for memory protection.
3262
3263The available memory is mapped to fixed addresses using the memory
3264controller. In this process, a contiguous block is formed for each
3265memory type (Flash, SDRAM, SRAM), even when it consists of several
3266physical memory banks.
3267
3268U-Boot is installed in the first 128 kB of the first Flash bank (on
3269TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3270booting and sizing and initializing DRAM, the code relocates itself
3271to the upper end of DRAM. Immediately below the U-Boot code some
6d0f6bcf 3272memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d
WD
3273configuration setting]. Below that, a structure with global Board
3274Info data is placed, followed by the stack (growing downward).
3275
3276Additionally, some exception handler code is copied to the low 8 kB
3277of DRAM (0x00000000 ... 0x00001FFF).
3278
3279So a typical memory configuration with 16 MB of DRAM could look like
3280this:
3281
3282 0x0000 0000 Exception Vector code
3283 :
3284 0x0000 1FFF
3285 0x0000 2000 Free for Application Use
3286 :
3287 :
3288
3289 :
3290 :
3291 0x00FB FF20 Monitor Stack (Growing downward)
3292 0x00FB FFAC Board Info Data and permanent copy of global data
3293 0x00FC 0000 Malloc Arena
3294 :
3295 0x00FD FFFF
3296 0x00FE 0000 RAM Copy of Monitor Code
3297 ... eventually: LCD or video framebuffer
3298 ... eventually: pRAM (Protected RAM - unchanged by reset)
3299 0x00FF FFFF [End of RAM]
3300
3301
3302System Initialization:
3303----------------------
c609719b 3304
2729af9d 3305In the reset configuration, U-Boot starts at the reset entry point
11ccc33f 3306(on most PowerPC systems at address 0x00000100). Because of the reset
b445bbb4 3307configuration for CS0# this is a mirror of the on board Flash memory.
2729af9d
WD
3308To be able to re-map memory U-Boot then jumps to its link address.
3309To be able to implement the initialization code in C, a (small!)
3310initial stack is set up in the internal Dual Ported RAM (in case CPUs
2eb48ff7
HS
3311which provide such a feature like), or in a locked part of the data
3312cache. After that, U-Boot initializes the CPU core, the caches and
3313the SIU.
2729af9d
WD
3314
3315Next, all (potentially) available memory banks are mapped using a
3316preliminary mapping. For example, we put them on 512 MB boundaries
3317(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3318on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3319programmed for SDRAM access. Using the temporary configuration, a
3320simple memory test is run that determines the size of the SDRAM
3321banks.
3322
3323When there is more than one SDRAM bank, and the banks are of
3324different size, the largest is mapped first. For equal size, the first
3325bank (CS2#) is mapped first. The first mapping is always for address
33260x00000000, with any additional banks following immediately to create
3327contiguous memory starting from 0.
3328
3329Then, the monitor installs itself at the upper end of the SDRAM area
3330and allocates memory for use by malloc() and for the global Board
3331Info data; also, the exception vector code is copied to the low RAM
3332pages, and the final stack is set up.
3333
3334Only after this relocation will you have a "normal" C environment;
3335until that you are restricted in several ways, mostly because you are
3336running from ROM, and because the code will have to be relocated to a
3337new address in RAM.
3338
3339
3340U-Boot Porting Guide:
3341----------------------
c609719b 3342
2729af9d
WD
3343[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
3344list, October 2002]
c609719b
WD
3345
3346
6c3fef28 3347int main(int argc, char *argv[])
2729af9d
WD
3348{
3349 sighandler_t no_more_time;
c609719b 3350
6c3fef28
JVB
3351 signal(SIGALRM, no_more_time);
3352 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
c609719b 3353
2729af9d 3354 if (available_money > available_manpower) {
6c3fef28 3355 Pay consultant to port U-Boot;
c609719b
WD
3356 return 0;
3357 }
3358
2729af9d
WD
3359 Download latest U-Boot source;
3360
0668236b 3361 Subscribe to u-boot mailing list;
2729af9d 3362
6c3fef28
JVB
3363 if (clueless)
3364 email("Hi, I am new to U-Boot, how do I get started?");
2729af9d
WD
3365
3366 while (learning) {
3367 Read the README file in the top level directory;
047f6ec0 3368 Read https://www.denx.de/wiki/bin/view/DULG/Manual;
24bcaec7 3369 Read applicable doc/README.*;
2729af9d 3370 Read the source, Luke;
6c3fef28 3371 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d
WD
3372 }
3373
6c3fef28
JVB
3374 if (available_money > toLocalCurrency ($2500))
3375 Buy a BDI3000;
3376 else
2729af9d 3377 Add a lot of aggravation and time;
2729af9d 3378
6c3fef28
JVB
3379 if (a similar board exists) { /* hopefully... */
3380 cp -a board/<similar> board/<myboard>
3381 cp include/configs/<similar>.h include/configs/<myboard>.h
3382 } else {
3383 Create your own board support subdirectory;
3384 Create your own board include/configs/<myboard>.h file;
3385 }
3386 Edit new board/<myboard> files
3387 Edit new include/configs/<myboard>.h
3388
3389 while (!accepted) {
3390 while (!running) {
3391 do {
3392 Add / modify source code;
3393 } until (compiles);
3394 Debug;
3395 if (clueless)
3396 email("Hi, I am having problems...");
3397 }
3398 Send patch file to the U-Boot email list;
3399 if (reasonable critiques)
3400 Incorporate improvements from email list code review;
3401 else
3402 Defend code as written;
2729af9d 3403 }
2729af9d
WD
3404
3405 return 0;
3406}
3407
3408void no_more_time (int sig)
3409{
3410 hire_a_guru();
3411}
3412
c609719b 3413
2729af9d
WD
3414Coding Standards:
3415-----------------
c609719b 3416
2729af9d 3417All contributions to U-Boot should conform to the Linux kernel
659208da
BS
3418coding style; see the kernel coding style guide at
3419https://www.kernel.org/doc/html/latest/process/coding-style.html, and the
3420script "scripts/Lindent" in your Linux kernel source directory.
2c051651
DZ
3421
3422Source files originating from a different project (for example the
3423MTD subsystem) are generally exempt from these guidelines and are not
b445bbb4 3424reformatted to ease subsequent migration to newer versions of those
2c051651
DZ
3425sources.
3426
3427Please note that U-Boot is implemented in C (and to some small parts in
3428Assembler); no C++ is used, so please do not use C++ style comments (//)
3429in your code.
c609719b 3430
2729af9d
WD
3431Please also stick to the following formatting rules:
3432- remove any trailing white space
7ca9296e 3433- use TAB characters for indentation and vertical alignment, not spaces
2729af9d 3434- make sure NOT to use DOS '\r\n' line feeds
7ca9296e 3435- do not add more than 2 consecutive empty lines to source files
2729af9d 3436- do not add trailing empty lines to source files
180d3f74 3437
2729af9d
WD
3438Submissions which do not conform to the standards may be returned
3439with a request to reformat the changes.
c609719b
WD
3440
3441
2729af9d
WD
3442Submitting Patches:
3443-------------------
c609719b 3444
2729af9d
WD
3445Since the number of patches for U-Boot is growing, we need to
3446establish some rules. Submissions which do not conform to these rules
3447may be rejected, even when they contain important and valuable stuff.
c609719b 3448
047f6ec0 3449Please see https://www.denx.de/wiki/U-Boot/Patches for details.
218ca724 3450
0668236b 3451Patches shall be sent to the u-boot mailing list <[email protected]>;
1dade18e 3452see https://lists.denx.de/listinfo/u-boot
0668236b 3453
2729af9d
WD
3454When you send a patch, please include the following information with
3455it:
c609719b 3456
2729af9d
WD
3457* For bug fixes: a description of the bug and how your patch fixes
3458 this bug. Please try to include a way of demonstrating that the
3459 patch actually fixes something.
c609719b 3460
2729af9d
WD
3461* For new features: a description of the feature and your
3462 implementation.
c609719b 3463
7207b366
RD
3464* For major contributions, add a MAINTAINERS file with your
3465 information and associated file and directory references.
c609719b 3466
27af930e
AA
3467* When you add support for a new board, don't forget to add a
3468 maintainer e-mail address to the boards.cfg file, too.
c609719b 3469
2729af9d
WD
3470* If your patch adds new configuration options, don't forget to
3471 document these in the README file.
c609719b 3472
218ca724
WD
3473* The patch itself. If you are using git (which is *strongly*
3474 recommended) you can easily generate the patch using the
7ca9296e 3475 "git format-patch". If you then use "git send-email" to send it to
218ca724
WD
3476 the U-Boot mailing list, you will avoid most of the common problems
3477 with some other mail clients.
3478
3479 If you cannot use git, use "diff -purN OLD NEW". If your version of
3480 diff does not support these options, then get the latest version of
3481 GNU diff.
c609719b 3482
218ca724
WD
3483 The current directory when running this command shall be the parent
3484 directory of the U-Boot source tree (i. e. please make sure that
3485 your patch includes sufficient directory information for the
3486 affected files).
6dff5529 3487
218ca724
WD
3488 We prefer patches as plain text. MIME attachments are discouraged,
3489 and compressed attachments must not be used.
c609719b 3490
2729af9d
WD
3491* If one logical set of modifications affects or creates several
3492 files, all these changes shall be submitted in a SINGLE patch file.
52f52c14 3493
2729af9d
WD
3494* Changesets that contain different, unrelated modifications shall be
3495 submitted as SEPARATE patches, one patch per changeset.
8bde7f77 3496
52f52c14 3497
2729af9d 3498Notes:
c609719b 3499
6de80f21 3500* Before sending the patch, run the buildman script on your patched
2729af9d
WD
3501 source tree and make sure that no errors or warnings are reported
3502 for any of the boards.
c609719b 3503
2729af9d
WD
3504* Keep your modifications to the necessary minimum: A patch
3505 containing several unrelated changes or arbitrary reformats will be
3506 returned with a request to re-formatting / split it.
c609719b 3507
2729af9d
WD
3508* If you modify existing code, make sure that your new code does not
3509 add to the memory footprint of the code ;-) Small is beautiful!
3510 When adding new features, these should compile conditionally only
3511 (using #ifdef), and the resulting code with the new feature
3512 disabled must not need more memory than the old code without your
3513 modification.
90dc6704 3514
0668236b
WD
3515* Remember that there is a size limit of 100 kB per message on the
3516 u-boot mailing list. Bigger patches will be moderated. If they are
3517 reasonable and not too big, they will be acknowledged. But patches
3518 bigger than the size limit should be avoided.
This page took 1.554226 seconds and 4 git commands to generate.