]> git.ipfire.org Git - people/ms/u-boot.git/blame - README
driver/ddr/fsl: Fix driver to support empty first slot
[people/ms/u-boot.git] / README
CommitLineData
c609719b 1#
eca3aeb3 2# (C) Copyright 2000 - 2013
c609719b
WD
3# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
eca3aeb3 5# SPDX-License-Identifier: GPL-2.0+
c609719b
WD
6#
7
8Summary:
9========
10
24ee89b9 11This directory contains the source code for U-Boot, a boot loader for
e86e5a07
WD
12Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
c609719b
WD
16
17The development of U-Boot is closely related to Linux: some parts of
24ee89b9
WD
18the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
c609719b
WD
20support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
24ee89b9 34Makefile have been tested to some extent and can be considered
c609719b
WD
35"working". In fact, many of them are used in production systems.
36
24ee89b9 37In case of problems see the CHANGELOG and CREDITS files to find out
27af930e 38who contributed the specific port. The boards.cfg file lists board
218ca724 39maintainers.
c609719b 40
adb9d851
RD
41Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
c609719b
WD
46
47Where to get help:
48==================
49
24ee89b9
WD
50In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
0c32565f
PT
52<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
c609719b
WD
56
57
218ca724
WD
58Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
11ccc33f 66any version you might be interested in. Official releases are also
218ca724
WD
67available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
d4ee711d 70Pre-built (and tested) images are available from
218ca724
WD
71ftp://ftp.denx.de/pub/u-boot/images/
72
73
c609719b
WD
74Where we come from:
75===================
76
77- start from 8xxrom sources
24ee89b9 78- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
c609719b
WD
79- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
11ccc33f 86 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
24ee89b9 87- create ARMBoot project (http://sourceforge.net/projects/armboot)
c609719b 88- add other CPU families (starting with ARM)
24ee89b9 89- create U-Boot project (http://sourceforge.net/projects/u-boot)
0d28f34b 90- current project page: see http://www.denx.de/wiki/U-Boot
24ee89b9
WD
91
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
c609719b
WD
113
114
93f19cc0
WD
115Versioning:
116===========
117
360d883a
TW
118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
124
125Examples:
c0f40859 126 U-Boot v2009.11 - Release November 2009
360d883a
TW
127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
93f19cc0
WD
129
130
c609719b
WD
131Directory Hierarchy:
132====================
133
8d321b81 134/arch Architecture specific files
6eae68e4
MY
135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
8d321b81
PT
139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
6eb0921a 143 /at91 Files specific to Atmel AT91RM9200 CPU
a9046b9e
WD
144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
8d321b81
PT
146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
8d321b81 148 /pxa Files specific to Intel XScale PXA CPUs
8d321b81
PT
149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
8d321b81
PT
157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
92bbd64e 170 /mips32 Files specific to MIPS32 CPUs
6eae68e4 171 /mips64 Files specific to MIPS64 CPUs
8d321b81 172 /lib Architecture specific library files
afc1ce82
ML
173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
8d321b81
PT
177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
33c7731b
RD
180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
a47a12be 183 /powerpc Files generic to PowerPC architecture
8d321b81 184 /cpu CPU specific files
8d321b81
PT
185 /mpc5xx Files specific to Freescale MPC5xx CPUs
186 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
187 /mpc8xx Files specific to Freescale MPC8xx CPUs
8d321b81
PT
188 /mpc8260 Files specific to Freescale MPC8260 CPUs
189 /mpc85xx Files specific to Freescale MPC85xx CPUs
190 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
191 /lib Architecture specific library files
192 /sh Files generic to SH architecture
193 /cpu CPU specific files
194 /sh2 Files specific to sh2 CPUs
195 /sh3 Files specific to sh3 CPUs
196 /sh4 Files specific to sh4 CPUs
197 /lib Architecture specific library files
198 /sparc Files generic to SPARC architecture
199 /cpu CPU specific files
200 /leon2 Files specific to Gaisler LEON2 SPARC CPU
201 /leon3 Files specific to Gaisler LEON3 SPARC CPU
202 /lib Architecture specific library files
33c7731b
RD
203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
8d321b81
PT
206/api Machine/arch independent API for external apps
207/board Board dependent files
208/common Misc architecture independent functions
209/disk Code for disk drive partition handling
210/doc Documentation (don't expect too much)
211/drivers Commonly used device drivers
33c7731b 212/dts Contains Makefile for building internal U-Boot fdt.
8d321b81
PT
213/examples Example code for standalone applications, etc.
214/fs Filesystem code (cramfs, ext2, jffs2, etc.)
215/include Header Files
216/lib Files generic to all architectures
217 /libfdt Library files to support flattened device trees
218 /lzma Library files to support LZMA decompression
219 /lzo Library files to support LZO decompression
220/net Networking code
221/post Power On Self Test
33c7731b 222/spl Secondary Program Loader framework
8d321b81 223/tools Tools to build S-Record or U-Boot images, etc.
c609719b 224
c609719b
WD
225Software Configuration:
226=======================
227
228Configuration is usually done using C preprocessor defines; the
229rationale behind that is to avoid dead code whenever possible.
230
231There are two classes of configuration variables:
232
233* Configuration _OPTIONS_:
234 These are selectable by the user and have names beginning with
235 "CONFIG_".
236
237* Configuration _SETTINGS_:
238 These depend on the hardware etc. and should not be meddled with if
239 you don't know what you're doing; they have names beginning with
6d0f6bcf 240 "CONFIG_SYS_".
c609719b
WD
241
242Later we will add a configuration tool - probably similar to or even
243identical to what's used for the Linux kernel. Right now, we have to
244do the configuration by hand, which means creating some symbolic
245links and editing some configuration files. We use the TQM8xxL boards
246as an example here.
247
248
249Selection of Processor Architecture and Board Type:
250---------------------------------------------------
251
252For all supported boards there are ready-to-use default
ab584d67 253configurations available; just type "make <board_name>_defconfig".
c609719b
WD
254
255Example: For a TQM823L module type:
256
257 cd u-boot
ab584d67 258 make TQM823L_defconfig
c609719b 259
11ccc33f 260For the Cogent platform, you need to specify the CPU type as well;
ab584d67 261e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
c609719b
WD
262directory according to the instructions in cogent/README.
263
264
75b3c3aa
SG
265Sandbox Environment:
266--------------------
267
268U-Boot can be built natively to run on a Linux host using the 'sandbox'
269board. This allows feature development which is not board- or architecture-
270specific to be undertaken on a native platform. The sandbox is also used to
271run some of U-Boot's tests.
272
6b1978f8 273See board/sandbox/README.sandbox for more details.
75b3c3aa
SG
274
275
db910353
SG
276Board Initialisation Flow:
277--------------------------
278
279This is the intended start-up flow for boards. This should apply for both
280SPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
281mostly uses a separate code path, but the funtion names and roles of each
282function are the same. Some boards or architectures may not conform to this.
283At least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.
284
285Execution starts with start.S with three functions called during init after
286that. The purpose and limitations of each is described below.
287
288lowlevel_init():
289 - purpose: essential init to permit execution to reach board_init_f()
290 - no global_data or BSS
291 - there is no stack (ARMv7 may have one but it will soon be removed)
292 - must not set up SDRAM or use console
293 - must only do the bare minimum to allow execution to continue to
294 board_init_f()
295 - this is almost never needed
296 - return normally from this function
297
298board_init_f():
299 - purpose: set up the machine ready for running board_init_r():
300 i.e. SDRAM and serial UART
301 - global_data is available
302 - stack is in SRAM
303 - BSS is not available, so you cannot use global/static variables,
304 only stack variables and global_data
305
306 Non-SPL-specific notes:
307 - dram_init() is called to set up DRAM. If already done in SPL this
308 can do nothing
309
310 SPL-specific notes:
311 - you can override the entire board_init_f() function with your own
312 version as needed.
313 - preloader_console_init() can be called here in extremis
314 - should set up SDRAM, and anything needed to make the UART work
315 - these is no need to clear BSS, it will be done by crt0.S
316 - must return normally from this function (don't call board_init_r()
317 directly)
318
319Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
320this point the stack and global_data are relocated to below
321CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
322memory.
323
324board_init_r():
325 - purpose: main execution, common code
326 - global_data is available
327 - SDRAM is available
328 - BSS is available, all static/global variables can be used
329 - execution eventually continues to main_loop()
330
331 Non-SPL-specific notes:
332 - U-Boot is relocated to the top of memory and is now running from
333 there.
334
335 SPL-specific notes:
336 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
337 CONFIG_SPL_STACK_R_ADDR points into SDRAM
338 - preloader_console_init() can be called here - typically this is
339 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
340 spl_board_init() function containing this call
341 - loads U-Boot or (in falcon mode) Linux
342
343
344
c609719b
WD
345Configuration Options:
346----------------------
347
348Configuration depends on the combination of board and CPU type; all
349such information is kept in a configuration file
350"include/configs/<board_name>.h".
351
352Example: For a TQM823L module, all configuration settings are in
353"include/configs/TQM823L.h".
354
355
7f6c2cbc
WD
356Many of the options are named exactly as the corresponding Linux
357kernel configuration options. The intention is to make it easier to
358build a config tool - later.
359
360
c609719b
WD
361The following options need to be configured:
362
2628114e
KP
363- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
364
365- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
6ccec449
WD
366
367- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
09ea0de0 368 Define exactly one, e.g. CONFIG_ATSTK1002
c609719b
WD
369
370- CPU Module Type: (if CONFIG_COGENT is defined)
371 Define exactly one of
372 CONFIG_CMA286_60_OLD
373--- FIXME --- not tested yet:
374 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
375 CONFIG_CMA287_23, CONFIG_CMA287_50
376
377- Motherboard Type: (if CONFIG_COGENT is defined)
378 Define exactly one of
379 CONFIG_CMA101, CONFIG_CMA102
380
381- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
382 Define one or more of
383 CONFIG_CMA302
384
385- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
386 Define one or more of
387 CONFIG_LCD_HEARTBEAT - update a character position on
11ccc33f 388 the LCD display every second with
c609719b
WD
389 a "rotator" |\-/|\-/
390
cf946c6d
LW
391- Marvell Family Member
392 CONFIG_SYS_MVFS - define it if you want to enable
393 multiple fs option at one time
394 for marvell soc family
395
11ccc33f 396- 8xx CPU Options: (if using an MPC8xx CPU)
66ca92a5
WD
397 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
398 get_gclk_freq() cannot work
5da627a4
WD
399 e.g. if there is no 32KHz
400 reference PIT/RTC clock
66ca92a5
WD
401 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
402 or XTAL/EXTAL)
c609719b 403
66ca92a5 404- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
6d0f6bcf
JCPV
405 CONFIG_SYS_8xx_CPUCLK_MIN
406 CONFIG_SYS_8xx_CPUCLK_MAX
66ca92a5 407 CONFIG_8xx_CPUCLK_DEFAULT
75d1ea7f
WD
408 See doc/README.MPC866
409
6d0f6bcf 410 CONFIG_SYS_MEASURE_CPUCLK
75d1ea7f 411
ba56f625
WD
412 Define this to measure the actual CPU clock instead
413 of relying on the correctness of the configured
414 values. Mostly useful for board bringup to make sure
415 the PLL is locked at the intended frequency. Note
416 that this requires a (stable) reference clock (32 kHz
6d0f6bcf 417 RTC clock or CONFIG_SYS_8XX_XIN)
75d1ea7f 418
506f3918
HS
419 CONFIG_SYS_DELAYED_ICACHE
420
421 Define this option if you want to enable the
422 ICache only when Code runs from RAM.
423
66412c63 424- 85xx CPU Options:
ffd06e02
YS
425 CONFIG_SYS_PPC64
426
427 Specifies that the core is a 64-bit PowerPC implementation (implements
428 the "64" category of the Power ISA). This is necessary for ePAPR
429 compliance, among other possible reasons.
430
66412c63
KG
431 CONFIG_SYS_FSL_TBCLK_DIV
432
433 Defines the core time base clock divider ratio compared to the
434 system clock. On most PQ3 devices this is 8, on newer QorIQ
435 devices it can be 16 or 32. The ratio varies from SoC to Soc.
436
8f29084a
KG
437 CONFIG_SYS_FSL_PCIE_COMPAT
438
439 Defines the string to utilize when trying to match PCIe device
440 tree nodes for the given platform.
441
afa6b551
PK
442 CONFIG_SYS_PPC_E500_DEBUG_TLB
443
444 Enables a temporary TLB entry to be used during boot to work
445 around limitations in e500v1 and e500v2 external debugger
446 support. This reduces the portions of the boot code where
447 breakpoints and single stepping do not work. The value of this
448 symbol should be set to the TLB1 entry to be used for this
449 purpose.
450
33eee330
SW
451 CONFIG_SYS_FSL_ERRATUM_A004510
452
453 Enables a workaround for erratum A004510. If set,
454 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
455 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
456
457 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
458 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
459
460 Defines one or two SoC revisions (low 8 bits of SVR)
461 for which the A004510 workaround should be applied.
462
463 The rest of SVR is either not relevant to the decision
464 of whether the erratum is present (e.g. p2040 versus
465 p2041) or is implied by the build target, which controls
466 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
467
468 See Freescale App Note 4493 for more information about
469 this erratum.
470
74fa22ed
PK
471 CONFIG_A003399_NOR_WORKAROUND
472 Enables a workaround for IFC erratum A003399. It is only
b445bbb4 473 required during NOR boot.
74fa22ed 474
9f074e67
PK
475 CONFIG_A008044_WORKAROUND
476 Enables a workaround for T1040/T1042 erratum A008044. It is only
b445bbb4 477 required during NAND boot and valid for Rev 1.0 SoC revision
9f074e67 478
33eee330
SW
479 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
480
481 This is the value to write into CCSR offset 0x18600
482 according to the A004510 workaround.
483
64501c66
PJ
484 CONFIG_SYS_FSL_DSP_DDR_ADDR
485 This value denotes start offset of DDR memory which is
486 connected exclusively to the DSP cores.
487
765b0bdb
PJ
488 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
489 This value denotes start offset of M2 memory
490 which is directly connected to the DSP core.
491
64501c66
PJ
492 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
493 This value denotes start offset of M3 memory which is directly
494 connected to the DSP core.
495
765b0bdb
PJ
496 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497 This value denotes start offset of DSP CCSR space.
498
b135991a
PJ
499 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
500 Single Source Clock is clocking mode present in some of FSL SoC's.
501 In this mode, a single differential clock is used to supply
502 clocks to the sysclock, ddrclock and usbclock.
503
fb4a2409
AB
504 CONFIG_SYS_CPC_REINIT_F
505 This CONFIG is defined when the CPC is configured as SRAM at the
506 time of U-boot entry and is required to be re-initialized.
507
aade2004 508 CONFIG_DEEP_SLEEP
b445bbb4 509 Indicates this SoC supports deep sleep feature. If deep sleep is
aade2004
TY
510 supported, core will start to execute uboot when wakes up.
511
6cb461b4 512- Generic CPU options:
2a1680e3
YS
513 CONFIG_SYS_GENERIC_GLOBAL_DATA
514 Defines global data is initialized in generic board board_init_f().
515 If this macro is defined, global data is created and cleared in
516 generic board board_init_f(). Without this macro, architecture/board
517 should initialize global data before calling board_init_f().
518
6cb461b4
DS
519 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
520
521 Defines the endianess of the CPU. Implementation of those
522 values is arch specific.
523
5614e71b
YS
524 CONFIG_SYS_FSL_DDR
525 Freescale DDR driver in use. This type of DDR controller is
526 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
527 SoCs.
528
529 CONFIG_SYS_FSL_DDR_ADDR
530 Freescale DDR memory-mapped register base.
531
532 CONFIG_SYS_FSL_DDR_EMU
533 Specify emulator support for DDR. Some DDR features such as
534 deskew training are not available.
535
536 CONFIG_SYS_FSL_DDRC_GEN1
537 Freescale DDR1 controller.
538
539 CONFIG_SYS_FSL_DDRC_GEN2
540 Freescale DDR2 controller.
541
542 CONFIG_SYS_FSL_DDRC_GEN3
543 Freescale DDR3 controller.
544
34e026f9
YS
545 CONFIG_SYS_FSL_DDRC_GEN4
546 Freescale DDR4 controller.
547
9ac4ffbd
YS
548 CONFIG_SYS_FSL_DDRC_ARM_GEN3
549 Freescale DDR3 controller for ARM-based SoCs.
550
5614e71b
YS
551 CONFIG_SYS_FSL_DDR1
552 Board config to use DDR1. It can be enabled for SoCs with
553 Freescale DDR1 or DDR2 controllers, depending on the board
554 implemetation.
555
556 CONFIG_SYS_FSL_DDR2
557 Board config to use DDR2. It can be eanbeld for SoCs with
558 Freescale DDR2 or DDR3 controllers, depending on the board
559 implementation.
560
561 CONFIG_SYS_FSL_DDR3
562 Board config to use DDR3. It can be enabled for SoCs with
34e026f9
YS
563 Freescale DDR3 or DDR3L controllers.
564
565 CONFIG_SYS_FSL_DDR3L
566 Board config to use DDR3L. It can be enabled for SoCs with
567 DDR3L controllers.
568
569 CONFIG_SYS_FSL_DDR4
570 Board config to use DDR4. It can be enabled for SoCs with
571 DDR4 controllers.
5614e71b 572
1b4175d6
PK
573 CONFIG_SYS_FSL_IFC_BE
574 Defines the IFC controller register space as Big Endian
575
576 CONFIG_SYS_FSL_IFC_LE
577 Defines the IFC controller register space as Little Endian
578
690e4258
PK
579 CONFIG_SYS_FSL_PBL_PBI
580 It enables addition of RCW (Power on reset configuration) in built image.
581 Please refer doc/README.pblimage for more details
582
583 CONFIG_SYS_FSL_PBL_RCW
584 It adds PBI(pre-boot instructions) commands in u-boot build image.
585 PBI commands can be used to configure SoC before it starts the execution.
586 Please refer doc/README.pblimage for more details
587
89ad7be8
PK
588 CONFIG_SPL_FSL_PBL
589 It adds a target to create boot binary having SPL binary in PBI format
590 concatenated with u-boot binary.
591
4e5b1bd0
YS
592 CONFIG_SYS_FSL_DDR_BE
593 Defines the DDR controller register space as Big Endian
594
595 CONFIG_SYS_FSL_DDR_LE
596 Defines the DDR controller register space as Little Endian
597
6b9e309a
YS
598 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
599 Physical address from the view of DDR controllers. It is the
600 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
601 it could be different for ARM SoCs.
602
6b1e1254
YS
603 CONFIG_SYS_FSL_DDR_INTLV_256B
604 DDR controller interleaving on 256-byte. This is a special
605 interleaving mode, handled by Dickens for Freescale layerscape
606 SoCs with ARM core.
607
1d71efbb
YS
608 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
609 Number of controllers used as main memory.
610
611 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
612 Number of controllers used for other than main memory.
613
028dbb8d
RG
614 CONFIG_SYS_FSL_SEC_BE
615 Defines the SEC controller register space as Big Endian
616
617 CONFIG_SYS_FSL_SEC_LE
618 Defines the SEC controller register space as Little Endian
619
0b953ffc 620- Intel Monahans options:
6d0f6bcf 621 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
0b953ffc
MK
622
623 Defines the Monahans run mode to oscillator
624 ratio. Valid values are 8, 16, 24, 31. The core
625 frequency is this value multiplied by 13 MHz.
626
6d0f6bcf 627 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
cf48eb9a 628
0b953ffc
MK
629 Defines the Monahans turbo mode to oscillator
630 ratio. Valid values are 1 (default if undefined) and
cf48eb9a 631 2. The core frequency as calculated above is multiplied
0b953ffc 632 by this value.
cf48eb9a 633
92bbd64e
DS
634- MIPS CPU options:
635 CONFIG_SYS_INIT_SP_OFFSET
636
637 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
638 pointer. This is needed for the temporary stack before
639 relocation.
640
641 CONFIG_SYS_MIPS_CACHE_MODE
642
643 Cache operation mode for the MIPS CPU.
644 See also arch/mips/include/asm/mipsregs.h.
645 Possible values are:
646 CONF_CM_CACHABLE_NO_WA
647 CONF_CM_CACHABLE_WA
648 CONF_CM_UNCACHED
649 CONF_CM_CACHABLE_NONCOHERENT
650 CONF_CM_CACHABLE_CE
651 CONF_CM_CACHABLE_COW
652 CONF_CM_CACHABLE_CUW
653 CONF_CM_CACHABLE_ACCELERATED
654
655 CONFIG_SYS_XWAY_EBU_BOOTCFG
656
657 Special option for Lantiq XWAY SoCs for booting from NOR flash.
658 See also arch/mips/cpu/mips32/start.S.
659
660 CONFIG_XWAY_SWAP_BYTES
661
662 Enable compilation of tools/xway-swap-bytes needed for Lantiq
663 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
664 be swapped if a flash programmer is used.
665
b67d8816
CR
666- ARM options:
667 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
668
669 Select high exception vectors of the ARM core, e.g., do not
670 clear the V bit of the c1 register of CP15.
671
5356f545
A
672 CONFIG_SYS_THUMB_BUILD
673
674 Use this flag to build U-Boot using the Thumb instruction
675 set for ARM architectures. Thumb instruction set provides
676 better code density. For ARM architectures that support
677 Thumb2 this flag will result in Thumb2 code generated by
678 GCC.
679
c5d4752c 680 CONFIG_ARM_ERRATA_716044
0678587f
SW
681 CONFIG_ARM_ERRATA_742230
682 CONFIG_ARM_ERRATA_743622
683 CONFIG_ARM_ERRATA_751472
f71cbfe3 684 CONFIG_ARM_ERRATA_794072
b7588e3b 685 CONFIG_ARM_ERRATA_761320
0678587f
SW
686
687 If set, the workarounds for these ARM errata are applied early
688 during U-Boot startup. Note that these options force the
689 workarounds to be applied; no CPU-type/version detection
690 exists, unlike the similar options in the Linux kernel. Do not
691 set these options unless they apply!
692
c616a0df
NM
693 NOTE: The following can be machine specific errata. These
694 do have ability to provide rudimentary version and machine
695 specific checks, but expect no product checks.
5902f4ce 696 CONFIG_ARM_ERRATA_430973
b45c48a7 697 CONFIG_ARM_ERRATA_454179
9b4d65f9 698 CONFIG_ARM_ERRATA_621766
c616a0df
NM
699 CONFIG_ARM_ERRATA_798870
700
73c38934
SW
701- Tegra SoC options:
702 CONFIG_TEGRA_SUPPORT_NON_SECURE
703
704 Support executing U-Boot in non-secure (NS) mode. Certain
705 impossible actions will be skipped if the CPU is in NS mode,
706 such as ARM architectural timer initialization.
707
5da627a4 708- Linux Kernel Interface:
c609719b
WD
709 CONFIG_CLOCKS_IN_MHZ
710
711 U-Boot stores all clock information in Hz
712 internally. For binary compatibility with older Linux
713 kernels (which expect the clocks passed in the
714 bd_info data to be in MHz) the environment variable
715 "clocks_in_mhz" can be defined so that U-Boot
716 converts clock data to MHZ before passing it to the
717 Linux kernel.
c609719b 718 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
218ca724 719 "clocks_in_mhz=1" is automatically included in the
c609719b
WD
720 default environment.
721
5da627a4
WD
722 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
723
b445bbb4 724 When transferring memsize parameter to Linux, some versions
5da627a4
WD
725 expect it to be in bytes, others in MB.
726 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
727
fec6d9ee 728 CONFIG_OF_LIBFDT
f57f70aa
WD
729
730 New kernel versions are expecting firmware settings to be
213bf8c8
GVB
731 passed using flattened device trees (based on open firmware
732 concepts).
733
734 CONFIG_OF_LIBFDT
735 * New libfdt-based support
736 * Adds the "fdt" command
3bb342fc 737 * The bootm command automatically updates the fdt
213bf8c8 738
b55ae402
MZ
739 OF_CPU - The proper name of the cpus node (only required for
740 MPC512X and MPC5xxx based boards).
741 OF_SOC - The proper name of the soc node (only required for
742 MPC512X and MPC5xxx based boards).
f57f70aa 743 OF_TBCLK - The timebase frequency.
c2871f03 744 OF_STDOUT_PATH - The path to the console device
f57f70aa 745
11ccc33f
MZ
746 boards with QUICC Engines require OF_QE to set UCC MAC
747 addresses
3bb342fc 748
4e253137
KG
749 CONFIG_OF_BOARD_SETUP
750
751 Board code has addition modification that it wants to make
752 to the flat device tree before handing it off to the kernel
f57f70aa 753
c654b517
SG
754 CONFIG_OF_SYSTEM_SETUP
755
756 Other code has addition modification that it wants to make
757 to the flat device tree before handing it off to the kernel.
758 This causes ft_system_setup() to be called before booting
759 the kernel.
760
0267768e
MM
761 CONFIG_OF_BOOT_CPU
762
11ccc33f 763 This define fills in the correct boot CPU in the boot
0267768e
MM
764 param header, the default value is zero if undefined.
765
3887c3fb
HS
766 CONFIG_OF_IDE_FIXUP
767
768 U-Boot can detect if an IDE device is present or not.
769 If not, and this new config option is activated, U-Boot
770 removes the ATA node from the DTS before booting Linux,
771 so the Linux IDE driver does not probe the device and
772 crash. This is needed for buggy hardware (uc101) where
773 no pull down resistor is connected to the signal IDE5V_DD7.
774
7eb29398
IG
775 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
776
777 This setting is mandatory for all boards that have only one
778 machine type and must be used to specify the machine type
779 number as it appears in the ARM machine registry
780 (see http://www.arm.linux.org.uk/developer/machines/).
781 Only boards that have multiple machine types supported
782 in a single configuration file and the machine type is
783 runtime discoverable, do not have to use this setting.
784
0b2f4eca
NG
785- vxWorks boot parameters:
786
787 bootvx constructs a valid bootline using the following
788 environments variables: bootfile, ipaddr, serverip, hostname.
789 It loads the vxWorks image pointed bootfile.
790
791 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
792 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
793 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
794 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
795
796 CONFIG_SYS_VXWORKS_ADD_PARAMS
797
798 Add it at the end of the bootline. E.g "u=username pw=secret"
799
800 Note: If a "bootargs" environment is defined, it will overwride
801 the defaults discussed just above.
802
2c451f78
A
803- Cache Configuration:
804 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
805 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
806 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
807
93bc2193
A
808- Cache Configuration for ARM:
809 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
810 controller
811 CONFIG_SYS_PL310_BASE - Physical base address of PL310
812 controller register space
813
6705d81e 814- Serial Ports:
48d0192f 815 CONFIG_PL010_SERIAL
6705d81e
WD
816
817 Define this if you want support for Amba PrimeCell PL010 UARTs.
818
48d0192f 819 CONFIG_PL011_SERIAL
6705d81e
WD
820
821 Define this if you want support for Amba PrimeCell PL011 UARTs.
822
823 CONFIG_PL011_CLOCK
824
825 If you have Amba PrimeCell PL011 UARTs, set this variable to
826 the clock speed of the UARTs.
827
828 CONFIG_PL01x_PORTS
829
830 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
831 define this to a list of base addresses for each (supported)
832 port. See e.g. include/configs/versatile.h
833
910f1ae3
JR
834 CONFIG_PL011_SERIAL_RLCR
835
836 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
837 have separate receive and transmit line control registers. Set
838 this variable to initialize the extra register.
839
840 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
841
842 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
843 boot loader that has already initialized the UART. Define this
844 variable to flush the UART at init time.
845
d57dee57
KM
846 CONFIG_SERIAL_HW_FLOW_CONTROL
847
848 Define this variable to enable hw flow control in serial driver.
849 Current user of this option is drivers/serial/nsl16550.c driver
6705d81e 850
c609719b 851- Console Interface:
43d9616c
WD
852 Depending on board, define exactly one serial port
853 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
854 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
855 console by defining CONFIG_8xx_CONS_NONE
c609719b
WD
856
857 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
858 port routines must be defined elsewhere
859 (i.e. serial_init(), serial_getc(), ...)
860
861 CONFIG_CFB_CONSOLE
862 Enables console device for a color framebuffer. Needs following
c53043b7 863 defines (cf. smiLynxEM, i8042)
c609719b
WD
864 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
865 (default big endian)
866 VIDEO_HW_RECTFILL graphic chip supports
867 rectangle fill
868 (cf. smiLynxEM)
869 VIDEO_HW_BITBLT graphic chip supports
870 bit-blit (cf. smiLynxEM)
871 VIDEO_VISIBLE_COLS visible pixel columns
872 (cols=pitch)
ba56f625
WD
873 VIDEO_VISIBLE_ROWS visible pixel rows
874 VIDEO_PIXEL_SIZE bytes per pixel
c609719b
WD
875 VIDEO_DATA_FORMAT graphic data format
876 (0-5, cf. cfb_console.c)
ba56f625 877 VIDEO_FB_ADRS framebuffer address
c609719b
WD
878 VIDEO_KBD_INIT_FCT keyboard int fct
879 (i.e. i8042_kbd_init())
880 VIDEO_TSTC_FCT test char fct
881 (i.e. i8042_tstc)
882 VIDEO_GETC_FCT get char fct
883 (i.e. i8042_getc)
884 CONFIG_CONSOLE_CURSOR cursor drawing on/off
885 (requires blink timer
886 cf. i8042.c)
6d0f6bcf 887 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
c609719b
WD
888 CONFIG_CONSOLE_TIME display time/date info in
889 upper right corner
602ad3b3 890 (requires CONFIG_CMD_DATE)
c609719b
WD
891 CONFIG_VIDEO_LOGO display Linux logo in
892 upper left corner
a6c7ad2f
WD
893 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
894 linux_logo.h for logo.
895 Requires CONFIG_VIDEO_LOGO
c609719b 896 CONFIG_CONSOLE_EXTRA_INFO
11ccc33f 897 additional board info beside
c609719b
WD
898 the logo
899
33a35bbb
PR
900 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
901 a limited number of ANSI escape sequences (cursor control,
902 erase functions and limited graphics rendition control).
903
43d9616c
WD
904 When CONFIG_CFB_CONSOLE is defined, video console is
905 default i/o. Serial console can be forced with
906 environment 'console=serial'.
c609719b 907
d4ca31c4
WD
908 When CONFIG_SILENT_CONSOLE is defined, all console
909 messages (by U-Boot and Linux!) can be silenced with
910 the "silent" environment variable. See
911 doc/README.silent for more information.
a3ad8e26 912
45ae2546
HS
913 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
914 is 0x00.
915 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
916 is 0xa0.
917
c609719b
WD
918- Console Baudrate:
919 CONFIG_BAUDRATE - in bps
920 Select one of the baudrates listed in
6d0f6bcf
JCPV
921 CONFIG_SYS_BAUDRATE_TABLE, see below.
922 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
c609719b 923
c92fac91
HS
924- Console Rx buffer length
925 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
926 the maximum receive buffer length for the SMC.
2b3f12c2 927 This option is actual only for 82xx and 8xx possible.
c92fac91
HS
928 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
929 must be defined, to setup the maximum idle timeout for
930 the SMC.
931
9558b48a 932- Pre-Console Buffer:
4cf2609b
WD
933 Prior to the console being initialised (i.e. serial UART
934 initialised etc) all console output is silently discarded.
935 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
936 buffer any console messages prior to the console being
937 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
938 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
939 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6feff899 940 bytes are output before the console is initialised, the
4cf2609b
WD
941 earlier bytes are discarded.
942
943 'Sane' compilers will generate smaller code if
944 CONFIG_PRE_CON_BUF_SZ is a power of 2
9558b48a 945
046a37bd
SR
946- Safe printf() functions
947 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
948 the printf() functions. These are defined in
949 include/vsprintf.h and include snprintf(), vsnprintf() and
950 so on. Code size increase is approximately 300-500 bytes.
951 If this option is not given then these functions will
952 silently discard their buffer size argument - this means
953 you are not getting any overflow checking in this case.
954
c609719b
WD
955- Boot Delay: CONFIG_BOOTDELAY - in seconds
956 Delay before automatically booting the default image;
957 set to -1 to disable autoboot.
93d7212f
JH
958 set to -2 to autoboot with no delay and not check for abort
959 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
c609719b
WD
960
961 See doc/README.autoboot for these options that
962 work with CONFIG_BOOTDELAY. None are required.
963 CONFIG_BOOT_RETRY_TIME
964 CONFIG_BOOT_RETRY_MIN
965 CONFIG_AUTOBOOT_KEYED
966 CONFIG_AUTOBOOT_PROMPT
967 CONFIG_AUTOBOOT_DELAY_STR
968 CONFIG_AUTOBOOT_STOP_STR
969 CONFIG_AUTOBOOT_DELAY_STR2
970 CONFIG_AUTOBOOT_STOP_STR2
971 CONFIG_ZERO_BOOTDELAY_CHECK
972 CONFIG_RESET_TO_RETRY
973
974- Autoboot Command:
975 CONFIG_BOOTCOMMAND
976 Only needed when CONFIG_BOOTDELAY is enabled;
977 define a command string that is automatically executed
978 when no character is read on the console interface
979 within "Boot Delay" after reset.
980
981 CONFIG_BOOTARGS
43d9616c
WD
982 This can be used to pass arguments to the bootm
983 command. The value of CONFIG_BOOTARGS goes into the
984 environment value "bootargs".
c609719b
WD
985
986 CONFIG_RAMBOOT and CONFIG_NFSBOOT
43d9616c
WD
987 The value of these goes into the environment as
988 "ramboot" and "nfsboot" respectively, and can be used
989 as a convenience, when switching between booting from
11ccc33f 990 RAM and NFS.
c609719b 991
eda0ba38
HS
992- Bootcount:
993 CONFIG_BOOTCOUNT_LIMIT
994 Implements a mechanism for detecting a repeating reboot
995 cycle, see:
996 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
997
998 CONFIG_BOOTCOUNT_ENV
999 If no softreset save registers are found on the hardware
1000 "bootcount" is stored in the environment. To prevent a
1001 saveenv on all reboots, the environment variable
1002 "upgrade_available" is used. If "upgrade_available" is
1003 0, "bootcount" is always 0, if "upgrade_available" is
1004 1 "bootcount" is incremented in the environment.
1005 So the Userspace Applikation must set the "upgrade_available"
1006 and "bootcount" variable to 0, if a boot was successfully.
1007
c609719b
WD
1008- Pre-Boot Commands:
1009 CONFIG_PREBOOT
1010
1011 When this option is #defined, the existence of the
1012 environment variable "preboot" will be checked
1013 immediately before starting the CONFIG_BOOTDELAY
1014 countdown and/or running the auto-boot command resp.
1015 entering interactive mode.
1016
1017 This feature is especially useful when "preboot" is
1018 automatically generated or modified. For an example
1019 see the LWMON board specific code: here "preboot" is
1020 modified when the user holds down a certain
1021 combination of keys on the (special) keyboard when
1022 booting the systems
1023
1024- Serial Download Echo Mode:
1025 CONFIG_LOADS_ECHO
1026 If defined to 1, all characters received during a
1027 serial download (using the "loads" command) are
1028 echoed back. This might be needed by some terminal
1029 emulations (like "cu"), but may as well just take
1030 time on others. This setting #define's the initial
1031 value of the "loads_echo" environment variable.
1032
602ad3b3 1033- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
c609719b
WD
1034 CONFIG_KGDB_BAUDRATE
1035 Select one of the baudrates listed in
6d0f6bcf 1036 CONFIG_SYS_BAUDRATE_TABLE, see below.
c609719b
WD
1037
1038- Monitor Functions:
602ad3b3
JL
1039 Monitor commands can be included or excluded
1040 from the build by using the #include files
c6c621bd
SW
1041 <config_cmd_all.h> and #undef'ing unwanted
1042 commands, or using <config_cmd_default.h>
602ad3b3
JL
1043 and augmenting with additional #define's
1044 for wanted commands.
1045
1046 The default command configuration includes all commands
1047 except those marked below with a "*".
1048
b401b73d 1049 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
602ad3b3 1050 CONFIG_CMD_ASKENV * ask for env variable
602ad3b3
JL
1051 CONFIG_CMD_BDI bdinfo
1052 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1053 CONFIG_CMD_BMP * BMP support
1054 CONFIG_CMD_BSP * Board specific commands
1055 CONFIG_CMD_BOOTD bootd
d2b2ffe3 1056 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
602ad3b3 1057 CONFIG_CMD_CACHE * icache, dcache
08d0d6f3 1058 CONFIG_CMD_CLK * clock command support
602ad3b3 1059 CONFIG_CMD_CONSOLE coninfo
710b9938 1060 CONFIG_CMD_CRC32 * crc32
602ad3b3
JL
1061 CONFIG_CMD_DATE * support for RTC, date/time...
1062 CONFIG_CMD_DHCP * DHCP support
1063 CONFIG_CMD_DIAG * Diagnostics
a7c93104
PT
1064 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1065 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1066 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1067 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
602ad3b3
JL
1068 CONFIG_CMD_DTT * Digital Therm and Thermostat
1069 CONFIG_CMD_ECHO echo arguments
246c6922 1070 CONFIG_CMD_EDITENV edit env variable
602ad3b3
JL
1071 CONFIG_CMD_EEPROM * EEPROM read/write support
1072 CONFIG_CMD_ELF * bootelf, bootvx
5e2b3e0c 1073 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
fffad71b 1074 CONFIG_CMD_ENV_FLAGS * display details about env flags
88733e2c 1075 CONFIG_CMD_ENV_EXISTS * check existence of env variable
0c79cda0 1076 CONFIG_CMD_EXPORTENV * export the environment
03e2ecf6
SW
1077 CONFIG_CMD_EXT2 * ext2 command support
1078 CONFIG_CMD_EXT4 * ext4 command support
16f4d933
SW
1079 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1080 that work for multiple fs types
59e890ef 1081 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
bdab39d3 1082 CONFIG_CMD_SAVEENV saveenv
602ad3b3 1083 CONFIG_CMD_FDC * Floppy Disk Support
03e2ecf6 1084 CONFIG_CMD_FAT * FAT command support
602ad3b3
JL
1085 CONFIG_CMD_FLASH flinfo, erase, protect
1086 CONFIG_CMD_FPGA FPGA device initialization support
4d98b5c8 1087 CONFIG_CMD_FUSE * Device fuse support
53fdc7ef 1088 CONFIG_CMD_GETTIME * Get time since boot
a641b979 1089 CONFIG_CMD_GO * the 'go' command (exec code)
a000b795 1090 CONFIG_CMD_GREPENV * search environment
bf36c5d5 1091 CONFIG_CMD_HASH * calculate hash / digest
602ad3b3
JL
1092 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1093 CONFIG_CMD_I2C * I2C serial bus support
1094 CONFIG_CMD_IDE * IDE harddisk support
1095 CONFIG_CMD_IMI iminfo
8fdf1e0f 1096 CONFIG_CMD_IMLS List all images found in NOR flash
4d98b5c8 1097 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
602ad3b3 1098 CONFIG_CMD_IMMAP * IMMR dump support
aa53233a 1099 CONFIG_CMD_IOTRACE * I/O tracing for debugging
0c79cda0 1100 CONFIG_CMD_IMPORTENV * import an environment
c167cc02 1101 CONFIG_CMD_INI * import data from an ini file into the env
602ad3b3
JL
1102 CONFIG_CMD_IRQ * irqinfo
1103 CONFIG_CMD_ITEST Integer/string test of 2 values
1104 CONFIG_CMD_JFFS2 * JFFS2 Support
1105 CONFIG_CMD_KGDB * kgdb
4d98b5c8 1106 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
d22c338e
JH
1107 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1108 (169.254.*.*)
602ad3b3
JL
1109 CONFIG_CMD_LOADB loadb
1110 CONFIG_CMD_LOADS loads
4d98b5c8 1111 CONFIG_CMD_MD5SUM * print md5 message digest
02c9aa1d 1112 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
15a33e49 1113 CONFIG_CMD_MEMINFO * Display detailed memory information
602ad3b3 1114 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
a2681707 1115 loop, loopw
4d98b5c8 1116 CONFIG_CMD_MEMTEST * mtest
602ad3b3
JL
1117 CONFIG_CMD_MISC Misc functions like sleep etc
1118 CONFIG_CMD_MMC * MMC memory mapped support
1119 CONFIG_CMD_MII * MII utility commands
68d7d651 1120 CONFIG_CMD_MTDPARTS * MTD partition support
602ad3b3
JL
1121 CONFIG_CMD_NAND * NAND support
1122 CONFIG_CMD_NET bootp, tftpboot, rarpboot
4d98b5c8 1123 CONFIG_CMD_NFS NFS support
e92739d3 1124 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
c0f40859 1125 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
602ad3b3
JL
1126 CONFIG_CMD_PCI * pciinfo
1127 CONFIG_CMD_PCMCIA * PCMCIA support
1128 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1129 host
1130 CONFIG_CMD_PORTIO * Port I/O
ff048ea9 1131 CONFIG_CMD_READ * Read raw data from partition
602ad3b3
JL
1132 CONFIG_CMD_REGINFO * Register dump
1133 CONFIG_CMD_RUN run command in env variable
d304931f 1134 CONFIG_CMD_SANDBOX * sb command to access sandbox features
602ad3b3
JL
1135 CONFIG_CMD_SAVES * save S record dump
1136 CONFIG_CMD_SCSI * SCSI Support
1137 CONFIG_CMD_SDRAM * print SDRAM configuration information
1138 (requires CONFIG_CMD_I2C)
1139 CONFIG_CMD_SETGETDCR Support for DCR Register access
1140 (4xx only)
f61ec45e 1141 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
4d98b5c8 1142 CONFIG_CMD_SHA1SUM * print sha1 memory digest
02c9aa1d 1143 (requires CONFIG_CMD_MEMORY)
7d861d95 1144 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
74de7aef 1145 CONFIG_CMD_SOURCE "source" command Support
602ad3b3 1146 CONFIG_CMD_SPI * SPI serial bus support
7a83af07 1147 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
1fb7cd49 1148 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
da83bcd7
JH
1149 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1150 CONFIG_CMD_TIMER * access to the system tick timer
602ad3b3 1151 CONFIG_CMD_USB * USB support
602ad3b3 1152 CONFIG_CMD_CDP * Cisco Discover Protocol support
c8339f51 1153 CONFIG_CMD_MFSL * Microblaze FSL support
4d98b5c8 1154 CONFIG_CMD_XIMG Load part of Multi Image
89c8230d 1155 CONFIG_CMD_UUID * Generate random UUID or GUID string
c609719b
WD
1156
1157 EXAMPLE: If you want all functions except of network
1158 support you can write:
1159
602ad3b3
JL
1160 #include "config_cmd_all.h"
1161 #undef CONFIG_CMD_NET
c609719b 1162
213bf8c8
GVB
1163 Other Commands:
1164 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
c609719b
WD
1165
1166 Note: Don't enable the "icache" and "dcache" commands
602ad3b3 1167 (configuration option CONFIG_CMD_CACHE) unless you know
43d9616c
WD
1168 what you (and your U-Boot users) are doing. Data
1169 cache cannot be enabled on systems like the 8xx or
1170 8260 (where accesses to the IMMR region must be
1171 uncached), and it cannot be disabled on all other
1172 systems where we (mis-) use the data cache to hold an
1173 initial stack and some data.
c609719b
WD
1174
1175
1176 XXX - this list needs to get updated!
1177
a5ecbe62
WD
1178- Regular expression support:
1179 CONFIG_REGEX
93e14596
WD
1180 If this variable is defined, U-Boot is linked against
1181 the SLRE (Super Light Regular Expression) library,
1182 which adds regex support to some commands, as for
1183 example "env grep" and "setexpr".
a5ecbe62 1184
45ba8077
SG
1185- Device tree:
1186 CONFIG_OF_CONTROL
1187 If this variable is defined, U-Boot will use a device tree
1188 to configure its devices, instead of relying on statically
1189 compiled #defines in the board file. This option is
1190 experimental and only available on a few boards. The device
1191 tree is available in the global data as gd->fdt_blob.
1192
2c0f79e4
SG
1193 U-Boot needs to get its device tree from somewhere. This can
1194 be done using one of the two options below:
bbb0b128
SG
1195
1196 CONFIG_OF_EMBED
1197 If this variable is defined, U-Boot will embed a device tree
1198 binary in its image. This device tree file should be in the
1199 board directory and called <soc>-<board>.dts. The binary file
1200 is then picked up in board_init_f() and made available through
1201 the global data structure as gd->blob.
45ba8077 1202
2c0f79e4
SG
1203 CONFIG_OF_SEPARATE
1204 If this variable is defined, U-Boot will build a device tree
1205 binary. It will be called u-boot.dtb. Architecture-specific
1206 code will locate it at run-time. Generally this works by:
1207
1208 cat u-boot.bin u-boot.dtb >image.bin
1209
1210 and in fact, U-Boot does this for you, creating a file called
1211 u-boot-dtb.bin which is useful in the common case. You can
1212 still use the individual files if you need something more
1213 exotic.
1214
c609719b
WD
1215- Watchdog:
1216 CONFIG_WATCHDOG
1217 If this variable is defined, it enables watchdog
6abe6fb6
DZ
1218 support for the SoC. There must be support in the SoC
1219 specific code for a watchdog. For the 8xx and 8260
1220 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1221 register. When supported for a specific SoC is
1222 available, then no further board specific code should
1223 be needed to use it.
1224
1225 CONFIG_HW_WATCHDOG
1226 When using a watchdog circuitry external to the used
1227 SoC, then define this variable and provide board
1228 specific code for the "hw_watchdog_reset" function.
c609719b 1229
7bae0d6f
HS
1230 CONFIG_AT91_HW_WDT_TIMEOUT
1231 specify the timeout in seconds. default 2 seconds.
1232
c1551ea8
SR
1233- U-Boot Version:
1234 CONFIG_VERSION_VARIABLE
1235 If this variable is defined, an environment variable
1236 named "ver" is created by U-Boot showing the U-Boot
1237 version as printed by the "version" command.
a1ea8e51
BT
1238 Any change to this variable will be reverted at the
1239 next reset.
c1551ea8 1240
c609719b
WD
1241- Real-Time Clock:
1242
602ad3b3 1243 When CONFIG_CMD_DATE is selected, the type of the RTC
c609719b
WD
1244 has to be selected, too. Define exactly one of the
1245 following options:
1246
1247 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1248 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
4e8b7544 1249 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
c609719b 1250 CONFIG_RTC_MC146818 - use MC146818 RTC
1cb8e980 1251 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
c609719b 1252 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
7f70e853 1253 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
412921d2 1254 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
3bac3513 1255 CONFIG_RTC_DS164x - use Dallas DS164x RTC
9536dfcc 1256 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
4c0d4c3b 1257 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
6d0f6bcf 1258 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
71d19f30
HS
1259 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1260 RV3029 RTC.
c609719b 1261
b37c7e5e
WD
1262 Note that if the RTC uses I2C, then the I2C interface
1263 must also be configured. See I2C Support, below.
1264
e92739d3
PT
1265- GPIO Support:
1266 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
e92739d3 1267
5dec49ca
CP
1268 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1269 chip-ngpio pairs that tell the PCA953X driver the number of
1270 pins supported by a particular chip.
1271
e92739d3
PT
1272 Note that if the GPIO device uses I2C, then the I2C interface
1273 must also be configured. See I2C Support, below.
1274
aa53233a
SG
1275- I/O tracing:
1276 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1277 accesses and can checksum them or write a list of them out
1278 to memory. See the 'iotrace' command for details. This is
1279 useful for testing device drivers since it can confirm that
1280 the driver behaves the same way before and after a code
1281 change. Currently this is supported on sandbox and arm. To
1282 add support for your architecture, add '#include <iotrace.h>'
1283 to the bottom of arch/<arch>/include/asm/io.h and test.
1284
1285 Example output from the 'iotrace stats' command is below.
1286 Note that if the trace buffer is exhausted, the checksum will
1287 still continue to operate.
1288
1289 iotrace is enabled
1290 Start: 10000000 (buffer start address)
1291 Size: 00010000 (buffer size)
1292 Offset: 00000120 (current buffer offset)
1293 Output: 10000120 (start + offset)
1294 Count: 00000018 (number of trace records)
1295 CRC32: 9526fb66 (CRC32 of all trace records)
1296
c609719b
WD
1297- Timestamp Support:
1298
43d9616c
WD
1299 When CONFIG_TIMESTAMP is selected, the timestamp
1300 (date and time) of an image is printed by image
1301 commands like bootm or iminfo. This option is
602ad3b3 1302 automatically enabled when you select CONFIG_CMD_DATE .
c609719b 1303
923c46f9
KP
1304- Partition Labels (disklabels) Supported:
1305 Zero or more of the following:
1306 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1307 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1308 Intel architecture, USB sticks, etc.
1309 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1310 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1311 bootloader. Note 2TB partition limit; see
1312 disk/part_efi.c
1313 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
c609719b 1314
218ca724
WD
1315 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1316 CONFIG_CMD_SCSI) you must configure support for at
923c46f9 1317 least one non-MTD partition type as well.
c609719b
WD
1318
1319- IDE Reset method:
4d13cbad
WD
1320 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1321 board configurations files but used nowhere!
c609719b 1322
4d13cbad
WD
1323 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1324 be performed by calling the function
1325 ide_set_reset(int reset)
1326 which has to be defined in a board specific file
c609719b
WD
1327
1328- ATAPI Support:
1329 CONFIG_ATAPI
1330
1331 Set this to enable ATAPI support.
1332
c40b2956
WD
1333- LBA48 Support
1334 CONFIG_LBA48
1335
1336 Set this to enable support for disks larger than 137GB
4b142feb 1337 Also look at CONFIG_SYS_64BIT_LBA.
c40b2956
WD
1338 Whithout these , LBA48 support uses 32bit variables and will 'only'
1339 support disks up to 2.1TB.
1340
6d0f6bcf 1341 CONFIG_SYS_64BIT_LBA:
c40b2956
WD
1342 When enabled, makes the IDE subsystem use 64bit sector addresses.
1343 Default is 32bit.
1344
c609719b
WD
1345- SCSI Support:
1346 At the moment only there is only support for the
1347 SYM53C8XX SCSI controller; define
1348 CONFIG_SCSI_SYM53C8XX to enable it.
1349
6d0f6bcf
JCPV
1350 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1351 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1352 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
c609719b
WD
1353 maximum numbers of LUNs, SCSI ID's and target
1354 devices.
6d0f6bcf 1355 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
c609719b 1356
93e14596
WD
1357 The environment variable 'scsidevs' is set to the number of
1358 SCSI devices found during the last scan.
447c031b 1359
c609719b 1360- NETWORK Support (PCI):
682011ff 1361 CONFIG_E1000
ce5207e1
KM
1362 Support for Intel 8254x/8257x gigabit chips.
1363
1364 CONFIG_E1000_SPI
1365 Utility code for direct access to the SPI bus on Intel 8257x.
1366 This does not do anything useful unless you set at least one
1367 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1368
1369 CONFIG_E1000_SPI_GENERIC
1370 Allow generic access to the SPI bus on the Intel 8257x, for
1371 example with the "sspi" command.
1372
1373 CONFIG_CMD_E1000
1374 Management command for E1000 devices. When used on devices
1375 with SPI support you can reprogram the EEPROM from U-Boot.
53cf9435 1376
ac3315c2 1377 CONFIG_E1000_FALLBACK_MAC
11ccc33f 1378 default MAC for empty EEPROM after production.
ac3315c2 1379
c609719b
WD
1380 CONFIG_EEPRO100
1381 Support for Intel 82557/82559/82559ER chips.
11ccc33f 1382 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
c609719b
WD
1383 write routine for first time initialisation.
1384
1385 CONFIG_TULIP
1386 Support for Digital 2114x chips.
1387 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1388 modem chip initialisation (KS8761/QS6611).
1389
1390 CONFIG_NATSEMI
1391 Support for National dp83815 chips.
1392
1393 CONFIG_NS8382X
1394 Support for National dp8382[01] gigabit chips.
1395
45219c46
WD
1396- NETWORK Support (other):
1397
c041e9d2
JS
1398 CONFIG_DRIVER_AT91EMAC
1399 Support for AT91RM9200 EMAC.
1400
1401 CONFIG_RMII
1402 Define this to use reduced MII inteface
1403
1404 CONFIG_DRIVER_AT91EMAC_QUIET
1405 If this defined, the driver is quiet.
1406 The driver doen't show link status messages.
1407
efdd7319
RH
1408 CONFIG_CALXEDA_XGMAC
1409 Support for the Calxeda XGMAC device
1410
3bb46d23 1411 CONFIG_LAN91C96
45219c46
WD
1412 Support for SMSC's LAN91C96 chips.
1413
1414 CONFIG_LAN91C96_BASE
1415 Define this to hold the physical address
1416 of the LAN91C96's I/O space
1417
1418 CONFIG_LAN91C96_USE_32_BIT
1419 Define this to enable 32 bit addressing
1420
3bb46d23 1421 CONFIG_SMC91111
f39748ae
WD
1422 Support for SMSC's LAN91C111 chip
1423
1424 CONFIG_SMC91111_BASE
1425 Define this to hold the physical address
1426 of the device (I/O space)
1427
1428 CONFIG_SMC_USE_32_BIT
1429 Define this if data bus is 32 bits
1430
1431 CONFIG_SMC_USE_IOFUNCS
1432 Define this to use i/o functions instead of macros
1433 (some hardware wont work with macros)
1434
dc02bada
HS
1435 CONFIG_DRIVER_TI_EMAC
1436 Support for davinci emac
1437
1438 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1439 Define this if you have more then 3 PHYs.
1440
b3dbf4a5
ML
1441 CONFIG_FTGMAC100
1442 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1443
1444 CONFIG_FTGMAC100_EGIGA
1445 Define this to use GE link update with gigabit PHY.
1446 Define this if FTGMAC100 is connected to gigabit PHY.
1447 If your system has 10/100 PHY only, it might not occur
1448 wrong behavior. Because PHY usually return timeout or
1449 useless data when polling gigabit status and gigabit
1450 control registers. This behavior won't affect the
1451 correctnessof 10/100 link speed update.
1452
c2fff331 1453 CONFIG_SMC911X
557b377d
JG
1454 Support for SMSC's LAN911x and LAN921x chips
1455
c2fff331 1456 CONFIG_SMC911X_BASE
557b377d
JG
1457 Define this to hold the physical address
1458 of the device (I/O space)
1459
c2fff331 1460 CONFIG_SMC911X_32_BIT
557b377d
JG
1461 Define this if data bus is 32 bits
1462
c2fff331 1463 CONFIG_SMC911X_16_BIT
557b377d
JG
1464 Define this if data bus is 16 bits. If your processor
1465 automatically converts one 32 bit word to two 16 bit
c2fff331 1466 words you may also try CONFIG_SMC911X_32_BIT.
557b377d 1467
3d0075fa
YS
1468 CONFIG_SH_ETHER
1469 Support for Renesas on-chip Ethernet controller
1470
1471 CONFIG_SH_ETHER_USE_PORT
1472 Define the number of ports to be used
1473
1474 CONFIG_SH_ETHER_PHY_ADDR
1475 Define the ETH PHY's address
1476
68260aab
YS
1477 CONFIG_SH_ETHER_CACHE_WRITEBACK
1478 If this option is set, the driver enables cache flush.
1479
b2f97cf2
HS
1480- PWM Support:
1481 CONFIG_PWM_IMX
1482 Support for PWM modul on the imx6.
1483
5e124724 1484- TPM Support:
90899cc0
CC
1485 CONFIG_TPM
1486 Support TPM devices.
1487
1b393db5
TWHT
1488 CONFIG_TPM_TIS_I2C
1489 Support for i2c bus TPM devices. Only one device
1490 per system is supported at this time.
1491
1492 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1493 Define the the i2c bus number for the TPM device
1494
1495 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1496 Define the TPM's address on the i2c bus
1497
1498 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1499 Define the burst count bytes upper limit
1500
c01939c7
DE
1501 CONFIG_TPM_ATMEL_TWI
1502 Support for Atmel TWI TPM device. Requires I2C support.
1503
90899cc0 1504 CONFIG_TPM_TIS_LPC
5e124724
VB
1505 Support for generic parallel port TPM devices. Only one device
1506 per system is supported at this time.
1507
1508 CONFIG_TPM_TIS_BASE_ADDRESS
1509 Base address where the generic TPM device is mapped
1510 to. Contemporary x86 systems usually map it at
1511 0xfed40000.
1512
be6c1529
RP
1513 CONFIG_CMD_TPM
1514 Add tpm monitor functions.
1515 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1516 provides monitor access to authorized functions.
1517
1518 CONFIG_TPM
1519 Define this to enable the TPM support library which provides
1520 functional interfaces to some TPM commands.
1521 Requires support for a TPM device.
1522
1523 CONFIG_TPM_AUTH_SESSIONS
1524 Define this to enable authorized functions in the TPM library.
1525 Requires CONFIG_TPM and CONFIG_SHA1.
1526
c609719b
WD
1527- USB Support:
1528 At the moment only the UHCI host controller is
4d13cbad 1529 supported (PIP405, MIP405, MPC5200); define
c609719b
WD
1530 CONFIG_USB_UHCI to enable it.
1531 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
30d56fae 1532 and define CONFIG_USB_STORAGE to enable the USB
c609719b
WD
1533 storage devices.
1534 Note:
1535 Supported are USB Keyboards and USB Floppy drives
1536 (TEAC FD-05PUB).
4d13cbad
WD
1537 MPC5200 USB requires additional defines:
1538 CONFIG_USB_CLOCK
1539 for 528 MHz Clock: 0x0001bbbb
307ecb6d
EM
1540 CONFIG_PSC3_USB
1541 for USB on PSC3
4d13cbad
WD
1542 CONFIG_USB_CONFIG
1543 for differential drivers: 0x00001000
1544 for single ended drivers: 0x00005000
307ecb6d
EM
1545 for differential drivers on PSC3: 0x00000100
1546 for single ended drivers on PSC3: 0x00004100
6d0f6bcf 1547 CONFIG_SYS_USB_EVENT_POLL
fdcfaa1b
ZW
1548 May be defined to allow interrupt polling
1549 instead of using asynchronous interrupts
4d13cbad 1550
9ab4ce22
SG
1551 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1552 txfilltuning field in the EHCI controller on reset.
1553
6e9e0626
OT
1554 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1555 HW module registers.
1556
16c8d5e7
WD
1557- USB Device:
1558 Define the below if you wish to use the USB console.
1559 Once firmware is rebuilt from a serial console issue the
1560 command "setenv stdin usbtty; setenv stdout usbtty" and
11ccc33f 1561 attach your USB cable. The Unix command "dmesg" should print
16c8d5e7
WD
1562 it has found a new device. The environment variable usbtty
1563 can be set to gserial or cdc_acm to enable your device to
386eda02 1564 appear to a USB host as a Linux gserial device or a
16c8d5e7
WD
1565 Common Device Class Abstract Control Model serial device.
1566 If you select usbtty = gserial you should be able to enumerate
1567 a Linux host by
1568 # modprobe usbserial vendor=0xVendorID product=0xProductID
1569 else if using cdc_acm, simply setting the environment
1570 variable usbtty to be cdc_acm should suffice. The following
1571 might be defined in YourBoardName.h
386eda02 1572
16c8d5e7
WD
1573 CONFIG_USB_DEVICE
1574 Define this to build a UDC device
1575
1576 CONFIG_USB_TTY
1577 Define this to have a tty type of device available to
1578 talk to the UDC device
386eda02 1579
f9da0f89
VK
1580 CONFIG_USBD_HS
1581 Define this to enable the high speed support for usb
1582 device and usbtty. If this feature is enabled, a routine
1583 int is_usbd_high_speed(void)
1584 also needs to be defined by the driver to dynamically poll
1585 whether the enumeration has succeded at high speed or full
1586 speed.
1587
6d0f6bcf 1588 CONFIG_SYS_CONSOLE_IS_IN_ENV
16c8d5e7
WD
1589 Define this if you want stdin, stdout &/or stderr to
1590 be set to usbtty.
1591
1592 mpc8xx:
6d0f6bcf 1593 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
16c8d5e7 1594 Derive USB clock from external clock "blah"
6d0f6bcf 1595 - CONFIG_SYS_USB_EXTC_CLK 0x02
386eda02 1596
6d0f6bcf 1597 CONFIG_SYS_USB_BRG_CLK 0xBLAH
16c8d5e7 1598 Derive USB clock from brgclk
6d0f6bcf 1599 - CONFIG_SYS_USB_BRG_CLK 0x04
16c8d5e7 1600
386eda02 1601 If you have a USB-IF assigned VendorID then you may wish to
16c8d5e7 1602 define your own vendor specific values either in BoardName.h
386eda02 1603 or directly in usbd_vendor_info.h. If you don't define
16c8d5e7
WD
1604 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1605 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1606 should pretend to be a Linux device to it's target host.
1607
1608 CONFIG_USBD_MANUFACTURER
1609 Define this string as the name of your company for
1610 - CONFIG_USBD_MANUFACTURER "my company"
386eda02 1611
16c8d5e7
WD
1612 CONFIG_USBD_PRODUCT_NAME
1613 Define this string as the name of your product
1614 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1615
1616 CONFIG_USBD_VENDORID
1617 Define this as your assigned Vendor ID from the USB
1618 Implementors Forum. This *must* be a genuine Vendor ID
1619 to avoid polluting the USB namespace.
1620 - CONFIG_USBD_VENDORID 0xFFFF
386eda02 1621
16c8d5e7
WD
1622 CONFIG_USBD_PRODUCTID
1623 Define this as the unique Product ID
1624 for your device
1625 - CONFIG_USBD_PRODUCTID 0xFFFF
4d13cbad 1626
d70a560f
IG
1627- ULPI Layer Support:
1628 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1629 the generic ULPI layer. The generic layer accesses the ULPI PHY
1630 via the platform viewport, so you need both the genric layer and
1631 the viewport enabled. Currently only Chipidea/ARC based
1632 viewport is supported.
1633 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1634 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
6d365ea0
LS
1635 If your ULPI phy needs a different reference clock than the
1636 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1637 the appropriate value in Hz.
c609719b 1638
71f95118 1639- MMC Support:
8bde7f77
WD
1640 The MMC controller on the Intel PXA is supported. To
1641 enable this define CONFIG_MMC. The MMC can be
1642 accessed from the boot prompt by mapping the device
71f95118 1643 to physical memory similar to flash. Command line is
602ad3b3
JL
1644 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1645 the FAT fs. This is enabled with CONFIG_CMD_FAT.
71f95118 1646
afb35666
YS
1647 CONFIG_SH_MMCIF
1648 Support for Renesas on-chip MMCIF controller
1649
1650 CONFIG_SH_MMCIF_ADDR
1651 Define the base address of MMCIF registers
1652
1653 CONFIG_SH_MMCIF_CLK
1654 Define the clock frequency for MMCIF
1655
1fd93c6e
PA
1656 CONFIG_GENERIC_MMC
1657 Enable the generic MMC driver
1658
1659 CONFIG_SUPPORT_EMMC_BOOT
1660 Enable some additional features of the eMMC boot partitions.
1661
1662 CONFIG_SUPPORT_EMMC_RPMB
1663 Enable the commands for reading, writing and programming the
1664 key for the Replay Protection Memory Block partition in eMMC.
1665
b3ba6e94
TR
1666- USB Device Firmware Update (DFU) class support:
1667 CONFIG_DFU_FUNCTION
1668 This enables the USB portion of the DFU USB class
1669
1670 CONFIG_CMD_DFU
1671 This enables the command "dfu" which is used to have
1672 U-Boot create a DFU class device via USB. This command
1673 requires that the "dfu_alt_info" environment variable be
1674 set and define the alt settings to expose to the host.
1675
1676 CONFIG_DFU_MMC
1677 This enables support for exposing (e)MMC devices via DFU.
1678
c6631764
PA
1679 CONFIG_DFU_NAND
1680 This enables support for exposing NAND devices via DFU.
1681
a9479f04
AM
1682 CONFIG_DFU_RAM
1683 This enables support for exposing RAM via DFU.
1684 Note: DFU spec refer to non-volatile memory usage, but
1685 allow usages beyond the scope of spec - here RAM usage,
1686 one that would help mostly the developer.
1687
e7e75c70
HS
1688 CONFIG_SYS_DFU_DATA_BUF_SIZE
1689 Dfu transfer uses a buffer before writing data to the
1690 raw storage device. Make the size (in bytes) of this buffer
1691 configurable. The size of this buffer is also configurable
1692 through the "dfu_bufsiz" environment variable.
1693
ea2453d5
PA
1694 CONFIG_SYS_DFU_MAX_FILE_SIZE
1695 When updating files rather than the raw storage device,
1696 we use a static buffer to copy the file into and then write
1697 the buffer once we've been given the whole file. Define
1698 this to the maximum filesize (in bytes) for the buffer.
1699 Default is 4 MiB if undefined.
1700
001a8319
HS
1701 DFU_DEFAULT_POLL_TIMEOUT
1702 Poll timeout [ms], is the timeout a device can send to the
1703 host. The host must wait for this timeout before sending
1704 a subsequent DFU_GET_STATUS request to the device.
1705
1706 DFU_MANIFEST_POLL_TIMEOUT
1707 Poll timeout [ms], which the device sends to the host when
1708 entering dfuMANIFEST state. Host waits this timeout, before
1709 sending again an USB request to the device.
1710
3aab70af
SS
1711- USB Device Android Fastboot support:
1712 CONFIG_CMD_FASTBOOT
1713 This enables the command "fastboot" which enables the Android
1714 fastboot mode for the platform's USB device. Fastboot is a USB
1715 protocol for downloading images, flashing and device control
1716 used on Android devices.
1717 See doc/README.android-fastboot for more information.
1718
1719 CONFIG_ANDROID_BOOT_IMAGE
1720 This enables support for booting images which use the Android
1721 image format header.
1722
1723 CONFIG_USB_FASTBOOT_BUF_ADDR
1724 The fastboot protocol requires a large memory buffer for
1725 downloads. Define this to the starting RAM address to use for
1726 downloaded images.
1727
1728 CONFIG_USB_FASTBOOT_BUF_SIZE
1729 The fastboot protocol requires a large memory buffer for
1730 downloads. This buffer should be as large as possible for a
1731 platform. Define this to the size available RAM for fastboot.
d1b5ed07
SR
1732
1733 CONFIG_FASTBOOT_FLASH
1734 The fastboot protocol includes a "flash" command for writing
1735 the downloaded image to a non-volatile storage device. Define
1736 this to enable the "fastboot flash" command.
1737
1738 CONFIG_FASTBOOT_FLASH_MMC_DEV
1739 The fastboot "flash" command requires additional information
1740 regarding the non-volatile storage device. Define this to
1741 the eMMC device that fastboot should use to store the image.
3aab70af 1742
0ff7e585
SR
1743 CONFIG_FASTBOOT_GPT_NAME
1744 The fastboot "flash" command supports writing the downloaded
1745 image to the Protective MBR and the Primary GUID Partition
1746 Table. (Additionally, this downloaded image is post-processed
1747 to generate and write the Backup GUID Partition Table.)
1748 This occurs when the specified "partition name" on the
1749 "fastboot flash" command line matches this value.
1750 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1751
6705d81e
WD
1752- Journaling Flash filesystem support:
1753 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1754 CONFIG_JFFS2_NAND_DEV
1755 Define these for a default partition on a NAND device
1756
6d0f6bcf
JCPV
1757 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1758 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
6705d81e
WD
1759 Define these for a default partition on a NOR device
1760
6d0f6bcf 1761 CONFIG_SYS_JFFS_CUSTOM_PART
6705d81e
WD
1762 Define this to create an own partition. You have to provide a
1763 function struct part_info* jffs2_part_info(int part_num)
1764
1765 If you define only one JFFS2 partition you may also want to
6d0f6bcf 1766 #define CONFIG_SYS_JFFS_SINGLE_PART 1
6705d81e
WD
1767 to disable the command chpart. This is the default when you
1768 have not defined a custom partition
1769
c30a15e5
DK
1770- FAT(File Allocation Table) filesystem write function support:
1771 CONFIG_FAT_WRITE
656f4c65
DK
1772
1773 Define this to enable support for saving memory data as a
1774 file in FAT formatted partition.
1775
1776 This will also enable the command "fatwrite" enabling the
1777 user to write files to FAT.
c30a15e5 1778
84cd9327
GB
1779CBFS (Coreboot Filesystem) support
1780 CONFIG_CMD_CBFS
1781
1782 Define this to enable support for reading from a Coreboot
1783 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1784 and cbfsload.
1785
4f0d1a2a
SDPP
1786- FAT(File Allocation Table) filesystem cluster size:
1787 CONFIG_FS_FAT_MAX_CLUSTSIZE
1788
1789 Define the max cluster size for fat operations else
1790 a default value of 65536 will be defined.
1791
c609719b
WD
1792- Keyboard Support:
1793 CONFIG_ISA_KEYBOARD
1794
1795 Define this to enable standard (PC-Style) keyboard
1796 support
1797
1798 CONFIG_I8042_KBD
1799 Standard PC keyboard driver with US (is default) and
1800 GERMAN key layout (switch via environment 'keymap=de') support.
1801 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1802 for cfb_console. Supports cursor blinking.
1803
713cb680
HT
1804 CONFIG_CROS_EC_KEYB
1805 Enables a Chrome OS keyboard using the CROS_EC interface.
1806 This uses CROS_EC to communicate with a second microcontroller
1807 which provides key scans on request.
1808
c609719b
WD
1809- Video support:
1810 CONFIG_VIDEO
1811
1812 Define this to enable video support (for output to
1813 video).
1814
1815 CONFIG_VIDEO_CT69000
1816
1817 Enable Chips & Technologies 69000 Video chip
1818
1819 CONFIG_VIDEO_SMI_LYNXEM
b79a11cc 1820 Enable Silicon Motion SMI 712/710/810 Video chip. The
eeb1b77b
WD
1821 video output is selected via environment 'videoout'
1822 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1823 assumed.
1824
b79a11cc 1825 For the CT69000 and SMI_LYNXEM drivers, videomode is
11ccc33f 1826 selected via environment 'videomode'. Two different ways
eeb1b77b
WD
1827 are possible:
1828 - "videomode=num" 'num' is a standard LiLo mode numbers.
6e592385 1829 Following standard modes are supported (* is default):
eeb1b77b
WD
1830
1831 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1832 -------------+---------------------------------------------
1833 8 bits | 0x301* 0x303 0x305 0x161 0x307
1834 15 bits | 0x310 0x313 0x316 0x162 0x319
1835 16 bits | 0x311 0x314 0x317 0x163 0x31A
1836 24 bits | 0x312 0x315 0x318 ? 0x31B
1837 -------------+---------------------------------------------
c609719b
WD
1838 (i.e. setenv videomode 317; saveenv; reset;)
1839
b79a11cc 1840 - "videomode=bootargs" all the video parameters are parsed
7817cb20 1841 from the bootargs. (See drivers/video/videomodes.c)
eeb1b77b
WD
1842
1843
c1551ea8 1844 CONFIG_VIDEO_SED13806
43d9616c 1845 Enable Epson SED13806 driver. This driver supports 8bpp
a6c7ad2f
WD
1846 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1847 or CONFIG_VIDEO_SED13806_16BPP
1848
7d3053fb 1849 CONFIG_FSL_DIU_FB
04e5ae79 1850 Enable the Freescale DIU video driver. Reference boards for
7d3053fb
TT
1851 SOCs that have a DIU should define this macro to enable DIU
1852 support, and should also define these other macros:
1853
1854 CONFIG_SYS_DIU_ADDR
1855 CONFIG_VIDEO
1856 CONFIG_CMD_BMP
1857 CONFIG_CFB_CONSOLE
1858 CONFIG_VIDEO_SW_CURSOR
1859 CONFIG_VGA_AS_SINGLE_DEVICE
1860 CONFIG_VIDEO_LOGO
1861 CONFIG_VIDEO_BMP_LOGO
1862
ba8e76bd
TT
1863 The DIU driver will look for the 'video-mode' environment
1864 variable, and if defined, enable the DIU as a console during
1865 boot. See the documentation file README.video for a
1866 description of this variable.
7d3053fb 1867
058d59b0
SG
1868 CONFIG_VIDEO_VGA
1869
1870 Enable the VGA video / BIOS for x86. The alternative if you
1871 are using coreboot is to use the coreboot frame buffer
1872 driver.
1873
1874
682011ff 1875- Keyboard Support:
8bde7f77 1876 CONFIG_KEYBOARD
682011ff 1877
8bde7f77
WD
1878 Define this to enable a custom keyboard support.
1879 This simply calls drv_keyboard_init() which must be
1880 defined in your board-specific files.
1881 The only board using this so far is RBC823.
a6c7ad2f 1882
c609719b
WD
1883- LCD Support: CONFIG_LCD
1884
1885 Define this to enable LCD support (for output to LCD
1886 display); also select one of the supported displays
1887 by defining one of these:
1888
39cf4804
SP
1889 CONFIG_ATMEL_LCD:
1890
1891 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1892
fd3103bb 1893 CONFIG_NEC_NL6448AC33:
c609719b 1894
fd3103bb 1895 NEC NL6448AC33-18. Active, color, single scan.
c609719b 1896
fd3103bb 1897 CONFIG_NEC_NL6448BC20
c609719b 1898
fd3103bb
WD
1899 NEC NL6448BC20-08. 6.5", 640x480.
1900 Active, color, single scan.
1901
1902 CONFIG_NEC_NL6448BC33_54
1903
1904 NEC NL6448BC33-54. 10.4", 640x480.
c609719b
WD
1905 Active, color, single scan.
1906
1907 CONFIG_SHARP_16x9
1908
1909 Sharp 320x240. Active, color, single scan.
1910 It isn't 16x9, and I am not sure what it is.
1911
1912 CONFIG_SHARP_LQ64D341
1913
1914 Sharp LQ64D341 display, 640x480.
1915 Active, color, single scan.
1916
1917 CONFIG_HLD1045
1918
1919 HLD1045 display, 640x480.
1920 Active, color, single scan.
1921
1922 CONFIG_OPTREX_BW
1923
1924 Optrex CBL50840-2 NF-FW 99 22 M5
1925 or
1926 Hitachi LMG6912RPFC-00T
1927 or
1928 Hitachi SP14Q002
1929
1930 320x240. Black & white.
1931
1932 Normally display is black on white background; define
6d0f6bcf 1933 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
c609719b 1934
676d319e
SG
1935 CONFIG_LCD_ALIGNMENT
1936
b445bbb4 1937 Normally the LCD is page-aligned (typically 4KB). If this is
676d319e
SG
1938 defined then the LCD will be aligned to this value instead.
1939 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1940 here, since it is cheaper to change data cache settings on
1941 a per-section basis.
1942
0d89efef
SG
1943 CONFIG_CONSOLE_SCROLL_LINES
1944
1945 When the console need to be scrolled, this is the number of
1946 lines to scroll by. It defaults to 1. Increasing this makes
1947 the console jump but can help speed up operation when scrolling
1948 is slow.
676d319e 1949
604c7d4a
HP
1950 CONFIG_LCD_ROTATION
1951
1952 Sometimes, for example if the display is mounted in portrait
1953 mode or even if it's mounted landscape but rotated by 180degree,
1954 we need to rotate our content of the display relative to the
1955 framebuffer, so that user can read the messages which are
1956 printed out.
1957 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1958 initialized with a given rotation from "vl_rot" out of
1959 "vidinfo_t" which is provided by the board specific code.
1960 The value for vl_rot is coded as following (matching to
1961 fbcon=rotate:<n> linux-kernel commandline):
1962 0 = no rotation respectively 0 degree
1963 1 = 90 degree rotation
1964 2 = 180 degree rotation
1965 3 = 270 degree rotation
1966
1967 If CONFIG_LCD_ROTATION is not defined, the console will be
1968 initialized with 0degree rotation.
1969
45d7f525
TWHT
1970 CONFIG_LCD_BMP_RLE8
1971
1972 Support drawing of RLE8-compressed bitmaps on the LCD.
1973
735987c5
TWHT
1974 CONFIG_I2C_EDID
1975
1976 Enables an 'i2c edid' command which can read EDID
1977 information over I2C from an attached LCD display.
1978
7152b1d0 1979- Splash Screen Support: CONFIG_SPLASH_SCREEN
d791b1dc 1980
8bde7f77
WD
1981 If this option is set, the environment is checked for
1982 a variable "splashimage". If found, the usual display
1983 of logo, copyright and system information on the LCD
e94d2cd9 1984 is suppressed and the BMP image at the address
8bde7f77
WD
1985 specified in "splashimage" is loaded instead. The
1986 console is redirected to the "nulldev", too. This
1987 allows for a "silent" boot where a splash screen is
1988 loaded very quickly after power-on.
d791b1dc 1989
c0880485
NK
1990 CONFIG_SPLASHIMAGE_GUARD
1991
1992 If this option is set, then U-Boot will prevent the environment
1993 variable "splashimage" from being set to a problematic address
1551df35 1994 (see README.displaying-bmps).
c0880485
NK
1995 This option is useful for targets where, due to alignment
1996 restrictions, an improperly aligned BMP image will cause a data
1997 abort. If you think you will not have problems with unaligned
1998 accesses (for example because your toolchain prevents them)
1999 there is no need to set this option.
2000
1ca298ce
MW
2001 CONFIG_SPLASH_SCREEN_ALIGN
2002
2003 If this option is set the splash image can be freely positioned
2004 on the screen. Environment variable "splashpos" specifies the
2005 position as "x,y". If a positive number is given it is used as
2006 number of pixel from left/top. If a negative number is given it
2007 is used as number of pixel from right/bottom. You can also
2008 specify 'm' for centering the image.
2009
2010 Example:
2011 setenv splashpos m,m
2012 => image at center of screen
2013
2014 setenv splashpos 30,20
2015 => image at x = 30 and y = 20
2016
2017 setenv splashpos -10,m
2018 => vertically centered image
2019 at x = dspWidth - bmpWidth - 9
2020
98f4a3df
SR
2021- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2022
2023 If this option is set, additionally to standard BMP
2024 images, gzipped BMP images can be displayed via the
2025 splashscreen support or the bmp command.
2026
d5011762
AG
2027- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2028
2029 If this option is set, 8-bit RLE compressed BMP images
2030 can be displayed via the splashscreen support or the
2031 bmp command.
2032
b445bbb4 2033- Do compressing for memory range:
f2b96dfb
LW
2034 CONFIG_CMD_ZIP
2035
2036 If this option is set, it would use zlib deflate method
2037 to compress the specified memory at its best effort.
2038
c29fdfc1 2039- Compression support:
8ef70478
KC
2040 CONFIG_GZIP
2041
2042 Enabled by default to support gzip compressed images.
2043
c29fdfc1
WD
2044 CONFIG_BZIP2
2045
2046 If this option is set, support for bzip2 compressed
2047 images is included. If not, only uncompressed and gzip
2048 compressed images are supported.
2049
42d1f039 2050 NOTE: the bzip2 algorithm requires a lot of RAM, so
6d0f6bcf 2051 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
42d1f039 2052 be at least 4MB.
d791b1dc 2053
fc9c1727
LCM
2054 CONFIG_LZMA
2055
2056 If this option is set, support for lzma compressed
2057 images is included.
2058
2059 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2060 requires an amount of dynamic memory that is given by the
2061 formula:
2062
2063 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2064
2065 Where lc and lp stand for, respectively, Literal context bits
2066 and Literal pos bits.
2067
2068 This value is upper-bounded by 14MB in the worst case. Anyway,
2069 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2070 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2071 a very small buffer.
2072
2073 Use the lzmainfo tool to determinate the lc and lp values and
2074 then calculate the amount of needed dynamic memory (ensuring
6d0f6bcf 2075 the appropriate CONFIG_SYS_MALLOC_LEN value).
fc9c1727 2076
8ef70478
KC
2077 CONFIG_LZO
2078
2079 If this option is set, support for LZO compressed images
2080 is included.
2081
17ea1177
WD
2082- MII/PHY support:
2083 CONFIG_PHY_ADDR
2084
2085 The address of PHY on MII bus.
2086
2087 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2088
2089 The clock frequency of the MII bus
2090
2091 CONFIG_PHY_GIGE
2092
2093 If this option is set, support for speed/duplex
11ccc33f 2094 detection of gigabit PHY is included.
17ea1177
WD
2095
2096 CONFIG_PHY_RESET_DELAY
2097
2098 Some PHY like Intel LXT971A need extra delay after
2099 reset before any MII register access is possible.
2100 For such PHY, set this option to the usec delay
2101 required. (minimum 300usec for LXT971A)
2102
2103 CONFIG_PHY_CMD_DELAY (ppc4xx)
2104
2105 Some PHY like Intel LXT971A need extra delay after
2106 command issued before MII status register can be read
2107
c609719b
WD
2108- Ethernet address:
2109 CONFIG_ETHADDR
c68a05fe 2110 CONFIG_ETH1ADDR
c609719b
WD
2111 CONFIG_ETH2ADDR
2112 CONFIG_ETH3ADDR
c68a05fe 2113 CONFIG_ETH4ADDR
2114 CONFIG_ETH5ADDR
c609719b 2115
11ccc33f
MZ
2116 Define a default value for Ethernet address to use
2117 for the respective Ethernet interface, in case this
c609719b
WD
2118 is not determined automatically.
2119
2120- IP address:
2121 CONFIG_IPADDR
2122
2123 Define a default value for the IP address to use for
11ccc33f 2124 the default Ethernet interface, in case this is not
c609719b 2125 determined through e.g. bootp.
1ebcd654 2126 (Environment variable "ipaddr")
c609719b
WD
2127
2128- Server IP address:
2129 CONFIG_SERVERIP
2130
11ccc33f 2131 Defines a default value for the IP address of a TFTP
c609719b 2132 server to contact when using the "tftboot" command.
1ebcd654 2133 (Environment variable "serverip")
c609719b 2134
97cfe861
RG
2135 CONFIG_KEEP_SERVERADDR
2136
2137 Keeps the server's MAC address, in the env 'serveraddr'
2138 for passing to bootargs (like Linux's netconsole option)
2139
1ebcd654
WD
2140- Gateway IP address:
2141 CONFIG_GATEWAYIP
2142
2143 Defines a default value for the IP address of the
2144 default router where packets to other networks are
2145 sent to.
2146 (Environment variable "gatewayip")
2147
2148- Subnet mask:
2149 CONFIG_NETMASK
2150
2151 Defines a default value for the subnet mask (or
2152 routing prefix) which is used to determine if an IP
2153 address belongs to the local subnet or needs to be
2154 forwarded through a router.
2155 (Environment variable "netmask")
2156
53a5c424
DU
2157- Multicast TFTP Mode:
2158 CONFIG_MCAST_TFTP
2159
2160 Defines whether you want to support multicast TFTP as per
2161 rfc-2090; for example to work with atftp. Lets lots of targets
11ccc33f 2162 tftp down the same boot image concurrently. Note: the Ethernet
53a5c424
DU
2163 driver in use must provide a function: mcast() to join/leave a
2164 multicast group.
2165
c609719b
WD
2166- BOOTP Recovery Mode:
2167 CONFIG_BOOTP_RANDOM_DELAY
2168
2169 If you have many targets in a network that try to
2170 boot using BOOTP, you may want to avoid that all
2171 systems send out BOOTP requests at precisely the same
2172 moment (which would happen for instance at recovery
2173 from a power failure, when all systems will try to
2174 boot, thus flooding the BOOTP server. Defining
2175 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2176 inserted before sending out BOOTP requests. The
6c33c785 2177 following delays are inserted then:
c609719b
WD
2178
2179 1st BOOTP request: delay 0 ... 1 sec
2180 2nd BOOTP request: delay 0 ... 2 sec
2181 3rd BOOTP request: delay 0 ... 4 sec
2182 4th and following
2183 BOOTP requests: delay 0 ... 8 sec
2184
92ac8acc
TR
2185 CONFIG_BOOTP_ID_CACHE_SIZE
2186
2187 BOOTP packets are uniquely identified using a 32-bit ID. The
2188 server will copy the ID from client requests to responses and
2189 U-Boot will use this to determine if it is the destination of
2190 an incoming response. Some servers will check that addresses
2191 aren't in use before handing them out (usually using an ARP
2192 ping) and therefore take up to a few hundred milliseconds to
2193 respond. Network congestion may also influence the time it
2194 takes for a response to make it back to the client. If that
2195 time is too long, U-Boot will retransmit requests. In order
2196 to allow earlier responses to still be accepted after these
2197 retransmissions, U-Boot's BOOTP client keeps a small cache of
2198 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2199 cache. The default is to keep IDs for up to four outstanding
2200 requests. Increasing this will allow U-Boot to accept offers
2201 from a BOOTP client in networks with unusually high latency.
2202
fe389a82 2203- DHCP Advanced Options:
1fe80d79
JL
2204 You can fine tune the DHCP functionality by defining
2205 CONFIG_BOOTP_* symbols:
2206
2207 CONFIG_BOOTP_SUBNETMASK
2208 CONFIG_BOOTP_GATEWAY
2209 CONFIG_BOOTP_HOSTNAME
2210 CONFIG_BOOTP_NISDOMAIN
2211 CONFIG_BOOTP_BOOTPATH
2212 CONFIG_BOOTP_BOOTFILESIZE
2213 CONFIG_BOOTP_DNS
2214 CONFIG_BOOTP_DNS2
2215 CONFIG_BOOTP_SEND_HOSTNAME
2216 CONFIG_BOOTP_NTPSERVER
2217 CONFIG_BOOTP_TIMEOFFSET
2218 CONFIG_BOOTP_VENDOREX
2c00e099 2219 CONFIG_BOOTP_MAY_FAIL
fe389a82 2220
5d110f0a
WC
2221 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2222 environment variable, not the BOOTP server.
fe389a82 2223
2c00e099
JH
2224 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2225 after the configured retry count, the call will fail
2226 instead of starting over. This can be used to fail over
2227 to Link-local IP address configuration if the DHCP server
2228 is not available.
2229
fe389a82
SR
2230 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2231 serverip from a DHCP server, it is possible that more
2232 than one DNS serverip is offered to the client.
2233 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2234 serverip will be stored in the additional environment
2235 variable "dnsip2". The first DNS serverip is always
2236 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1fe80d79 2237 is defined.
fe389a82
SR
2238
2239 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2240 to do a dynamic update of a DNS server. To do this, they
2241 need the hostname of the DHCP requester.
5d110f0a 2242 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1fe80d79
JL
2243 of the "hostname" environment variable is passed as
2244 option 12 to the DHCP server.
fe389a82 2245
d9a2f416
AV
2246 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2247
2248 A 32bit value in microseconds for a delay between
2249 receiving a "DHCP Offer" and sending the "DHCP Request".
2250 This fixes a problem with certain DHCP servers that don't
2251 respond 100% of the time to a "DHCP request". E.g. On an
2252 AT91RM9200 processor running at 180MHz, this delay needed
2253 to be *at least* 15,000 usec before a Windows Server 2003
2254 DHCP server would reply 100% of the time. I recommend at
2255 least 50,000 usec to be safe. The alternative is to hope
2256 that one of the retries will be successful but note that
2257 the DHCP timeout and retry process takes a longer than
2258 this delay.
2259
d22c338e
JH
2260 - Link-local IP address negotiation:
2261 Negotiate with other link-local clients on the local network
2262 for an address that doesn't require explicit configuration.
2263 This is especially useful if a DHCP server cannot be guaranteed
2264 to exist in all environments that the device must operate.
2265
2266 See doc/README.link-local for more information.
2267
a3d991bd 2268 - CDP Options:
6e592385 2269 CONFIG_CDP_DEVICE_ID
a3d991bd
WD
2270
2271 The device id used in CDP trigger frames.
2272
2273 CONFIG_CDP_DEVICE_ID_PREFIX
2274
2275 A two character string which is prefixed to the MAC address
2276 of the device.
2277
2278 CONFIG_CDP_PORT_ID
2279
2280 A printf format string which contains the ascii name of
2281 the port. Normally is set to "eth%d" which sets
11ccc33f 2282 eth0 for the first Ethernet, eth1 for the second etc.
a3d991bd
WD
2283
2284 CONFIG_CDP_CAPABILITIES
2285
2286 A 32bit integer which indicates the device capabilities;
2287 0x00000010 for a normal host which does not forwards.
2288
2289 CONFIG_CDP_VERSION
2290
2291 An ascii string containing the version of the software.
2292
2293 CONFIG_CDP_PLATFORM
2294
2295 An ascii string containing the name of the platform.
2296
2297 CONFIG_CDP_TRIGGER
2298
2299 A 32bit integer sent on the trigger.
2300
2301 CONFIG_CDP_POWER_CONSUMPTION
2302
2303 A 16bit integer containing the power consumption of the
2304 device in .1 of milliwatts.
2305
2306 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2307
2308 A byte containing the id of the VLAN.
2309
c609719b
WD
2310- Status LED: CONFIG_STATUS_LED
2311
2312 Several configurations allow to display the current
2313 status using a LED. For instance, the LED will blink
2314 fast while running U-Boot code, stop blinking as
2315 soon as a reply to a BOOTP request was received, and
2316 start blinking slow once the Linux kernel is running
2317 (supported by a status LED driver in the Linux
2318 kernel). Defining CONFIG_STATUS_LED enables this
2319 feature in U-Boot.
2320
1df7bbba
IG
2321 Additional options:
2322
2323 CONFIG_GPIO_LED
2324 The status LED can be connected to a GPIO pin.
2325 In such cases, the gpio_led driver can be used as a
2326 status LED backend implementation. Define CONFIG_GPIO_LED
2327 to include the gpio_led driver in the U-Boot binary.
2328
9dfdcdfe
IG
2329 CONFIG_GPIO_LED_INVERTED_TABLE
2330 Some GPIO connected LEDs may have inverted polarity in which
2331 case the GPIO high value corresponds to LED off state and
2332 GPIO low value corresponds to LED on state.
2333 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2334 with a list of GPIO LEDs that have inverted polarity.
2335
c609719b
WD
2336- CAN Support: CONFIG_CAN_DRIVER
2337
2338 Defining CONFIG_CAN_DRIVER enables CAN driver support
2339 on those systems that support this (optional)
2340 feature, like the TQM8xxL modules.
2341
3f4978c7
HS
2342- I2C Support: CONFIG_SYS_I2C
2343
2344 This enable the NEW i2c subsystem, and will allow you to use
2345 i2c commands at the u-boot command line (as long as you set
2346 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2347 based realtime clock chips or other i2c devices. See
2348 common/cmd_i2c.c for a description of the command line
2349 interface.
2350
2351 ported i2c driver to the new framework:
ea818dbb
HS
2352 - drivers/i2c/soft_i2c.c:
2353 - activate first bus with CONFIG_SYS_I2C_SOFT define
2354 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2355 for defining speed and slave address
2356 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2357 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2358 for defining speed and slave address
2359 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2360 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2361 for defining speed and slave address
2362 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2363 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2364 for defining speed and slave address
3f4978c7 2365
00f792e0
HS
2366 - drivers/i2c/fsl_i2c.c:
2367 - activate i2c driver with CONFIG_SYS_I2C_FSL
2368 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2369 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2370 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2371 bus.
93e14596 2372 - If your board supports a second fsl i2c bus, define
00f792e0
HS
2373 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2374 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2375 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2376 second bus.
2377
1f2ba722 2378 - drivers/i2c/tegra_i2c.c:
10cee516
NI
2379 - activate this driver with CONFIG_SYS_I2C_TEGRA
2380 - This driver adds 4 i2c buses with a fix speed from
2381 100000 and the slave addr 0!
1f2ba722 2382
880540de
DE
2383 - drivers/i2c/ppc4xx_i2c.c
2384 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2385 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2386 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2387
fac96408 2388 - drivers/i2c/i2c_mxc.c
2389 - activate this driver with CONFIG_SYS_I2C_MXC
2390 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2391 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2392 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2393 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2394 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2395 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
b445bbb4 2396 If those defines are not set, default value is 100000
fac96408 2397 for speed, and 0 for slave.
f8cb101e
YS
2398 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2399 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
fac96408 2400
1086bfa9
NI
2401 - drivers/i2c/rcar_i2c.c:
2402 - activate this driver with CONFIG_SYS_I2C_RCAR
2403 - This driver adds 4 i2c buses
2404
2405 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2406 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2407 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2408 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2409 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2410 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2411 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2412 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2413 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2414
2035d77d
NI
2415 - drivers/i2c/sh_i2c.c:
2416 - activate this driver with CONFIG_SYS_I2C_SH
2417 - This driver adds from 2 to 5 i2c buses
2418
2419 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2420 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2421 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2422 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2423 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2424 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2425 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2426 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2427 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2428 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2429 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2430 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
b445bbb4 2431 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
2035d77d 2432
6789e84e
HS
2433 - drivers/i2c/omap24xx_i2c.c
2434 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2435 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2436 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2437 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2438 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2439 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2440 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2441 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2442 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2443 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2444 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2445
0bdffe71
HS
2446 - drivers/i2c/zynq_i2c.c
2447 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2448 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2449 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2450
e717fc6d
NKC
2451 - drivers/i2c/s3c24x0_i2c.c:
2452 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2453 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2454 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2455 with a fix speed from 100000 and the slave addr 0!
2456
b46226bd
DE
2457 - drivers/i2c/ihs_i2c.c
2458 - activate this driver with CONFIG_SYS_I2C_IHS
2459 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2460 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2461 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2462 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2463 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2464 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2465 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2466 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2467 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2468 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2469 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2470 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2471
3f4978c7
HS
2472 additional defines:
2473
2474 CONFIG_SYS_NUM_I2C_BUSES
b445bbb4 2475 Hold the number of i2c buses you want to use. If you
3f4978c7
HS
2476 don't use/have i2c muxes on your i2c bus, this
2477 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2478 omit this define.
2479
2480 CONFIG_SYS_I2C_DIRECT_BUS
2481 define this, if you don't use i2c muxes on your hardware.
2482 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2483 omit this define.
2484
2485 CONFIG_SYS_I2C_MAX_HOPS
2486 define how many muxes are maximal consecutively connected
2487 on one i2c bus. If you not use i2c muxes, omit this
2488 define.
2489
2490 CONFIG_SYS_I2C_BUSES
b445bbb4 2491 hold a list of buses you want to use, only used if
3f4978c7
HS
2492 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2493 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2494 CONFIG_SYS_NUM_I2C_BUSES = 9:
2495
2496 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2497 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2498 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2499 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2500 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2501 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2502 {1, {I2C_NULL_HOP}}, \
2503 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2504 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2505 }
2506
2507 which defines
2508 bus 0 on adapter 0 without a mux
ea818dbb
HS
2509 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2510 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2511 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2512 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2513 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
3f4978c7 2514 bus 6 on adapter 1 without a mux
ea818dbb
HS
2515 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2516 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
3f4978c7
HS
2517
2518 If you do not have i2c muxes on your board, omit this define.
2519
ea818dbb 2520- Legacy I2C Support: CONFIG_HARD_I2C
3f4978c7
HS
2521
2522 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2523 provides the following compelling advantages:
2524
2525 - more than one i2c adapter is usable
2526 - approved multibus support
2527 - better i2c mux support
2528
2529 ** Please consider updating your I2C driver now. **
2530
ea818dbb
HS
2531 These enable legacy I2C serial bus commands. Defining
2532 CONFIG_HARD_I2C will include the appropriate I2C driver
2533 for the selected CPU.
c609719b 2534
945af8d7 2535 This will allow you to use i2c commands at the u-boot
602ad3b3 2536 command line (as long as you set CONFIG_CMD_I2C in
b37c7e5e
WD
2537 CONFIG_COMMANDS) and communicate with i2c based realtime
2538 clock chips. See common/cmd_i2c.c for a description of the
43d9616c 2539 command line interface.
c609719b 2540
bb99ad6d 2541 CONFIG_HARD_I2C selects a hardware I2C controller.
b37c7e5e 2542
945af8d7 2543 There are several other quantities that must also be
ea818dbb 2544 defined when you define CONFIG_HARD_I2C.
c609719b 2545
6d0f6bcf 2546 In both cases you will need to define CONFIG_SYS_I2C_SPEED
945af8d7 2547 to be the frequency (in Hz) at which you wish your i2c bus
6d0f6bcf 2548 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
11ccc33f 2549 the CPU's i2c node address).
945af8d7 2550
8d321b81 2551 Now, the u-boot i2c code for the mpc8xx
a47a12be 2552 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
8d321b81
PT
2553 and so its address should therefore be cleared to 0 (See,
2554 eg, MPC823e User's Manual p.16-473). So, set
2555 CONFIG_SYS_I2C_SLAVE to 0.
c609719b 2556
5da71efa
EM
2557 CONFIG_SYS_I2C_INIT_MPC5XXX
2558
2559 When a board is reset during an i2c bus transfer
2560 chips might think that the current transfer is still
2561 in progress. Reset the slave devices by sending start
2562 commands until the slave device responds.
2563
945af8d7 2564 That's all that's required for CONFIG_HARD_I2C.
c609719b 2565
ea818dbb 2566 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
b37c7e5e
WD
2567 then the following macros need to be defined (examples are
2568 from include/configs/lwmon.h):
c609719b
WD
2569
2570 I2C_INIT
2571
b37c7e5e 2572 (Optional). Any commands necessary to enable the I2C
43d9616c 2573 controller or configure ports.
c609719b 2574
ba56f625 2575 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
b37c7e5e 2576
c609719b
WD
2577 I2C_PORT
2578
43d9616c
WD
2579 (Only for MPC8260 CPU). The I/O port to use (the code
2580 assumes both bits are on the same port). Valid values
2581 are 0..3 for ports A..D.
c609719b
WD
2582
2583 I2C_ACTIVE
2584
2585 The code necessary to make the I2C data line active
2586 (driven). If the data line is open collector, this
2587 define can be null.
2588
b37c7e5e
WD
2589 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2590
c609719b
WD
2591 I2C_TRISTATE
2592
2593 The code necessary to make the I2C data line tri-stated
2594 (inactive). If the data line is open collector, this
2595 define can be null.
2596
b37c7e5e
WD
2597 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2598
c609719b
WD
2599 I2C_READ
2600
472d5460
YS
2601 Code that returns true if the I2C data line is high,
2602 false if it is low.
c609719b 2603
b37c7e5e
WD
2604 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2605
c609719b
WD
2606 I2C_SDA(bit)
2607
472d5460
YS
2608 If <bit> is true, sets the I2C data line high. If it
2609 is false, it clears it (low).
c609719b 2610
b37c7e5e 2611 eg: #define I2C_SDA(bit) \
2535d602 2612 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
ba56f625 2613 else immr->im_cpm.cp_pbdat &= ~PB_SDA
b37c7e5e 2614
c609719b
WD
2615 I2C_SCL(bit)
2616
472d5460
YS
2617 If <bit> is true, sets the I2C clock line high. If it
2618 is false, it clears it (low).
c609719b 2619
b37c7e5e 2620 eg: #define I2C_SCL(bit) \
2535d602 2621 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
ba56f625 2622 else immr->im_cpm.cp_pbdat &= ~PB_SCL
b37c7e5e 2623
c609719b
WD
2624 I2C_DELAY
2625
2626 This delay is invoked four times per clock cycle so this
2627 controls the rate of data transfer. The data rate thus
b37c7e5e 2628 is 1 / (I2C_DELAY * 4). Often defined to be something
945af8d7
WD
2629 like:
2630
b37c7e5e 2631 #define I2C_DELAY udelay(2)
c609719b 2632
793b5726
MF
2633 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2634
2635 If your arch supports the generic GPIO framework (asm/gpio.h),
2636 then you may alternatively define the two GPIOs that are to be
2637 used as SCL / SDA. Any of the previous I2C_xxx macros will
2638 have GPIO-based defaults assigned to them as appropriate.
2639
2640 You should define these to the GPIO value as given directly to
2641 the generic GPIO functions.
2642
6d0f6bcf 2643 CONFIG_SYS_I2C_INIT_BOARD
47cd00fa 2644
8bde7f77
WD
2645 When a board is reset during an i2c bus transfer
2646 chips might think that the current transfer is still
2647 in progress. On some boards it is possible to access
2648 the i2c SCLK line directly, either by using the
2649 processor pin as a GPIO or by having a second pin
2650 connected to the bus. If this option is defined a
2651 custom i2c_init_board() routine in boards/xxx/board.c
2652 is run early in the boot sequence.
47cd00fa 2653
26a33504
RR
2654 CONFIG_SYS_I2C_BOARD_LATE_INIT
2655
2656 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2657 defined a custom i2c_board_late_init() routine in
2658 boards/xxx/board.c is run AFTER the operations in i2c_init()
2659 is completed. This callpoint can be used to unreset i2c bus
2660 using CPU i2c controller register accesses for CPUs whose i2c
2661 controller provide such a method. It is called at the end of
2662 i2c_init() to allow i2c_init operations to setup the i2c bus
2663 controller on the CPU (e.g. setting bus speed & slave address).
2664
17ea1177
WD
2665 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2666
2667 This option enables configuration of bi_iic_fast[] flags
2668 in u-boot bd_info structure based on u-boot environment
2669 variable "i2cfast". (see also i2cfast)
2670
bb99ad6d
BW
2671 CONFIG_I2C_MULTI_BUS
2672
2673 This option allows the use of multiple I2C buses, each of which
c0f40859
WD
2674 must have a controller. At any point in time, only one bus is
2675 active. To switch to a different bus, use the 'i2c dev' command.
bb99ad6d
BW
2676 Note that bus numbering is zero-based.
2677
6d0f6bcf 2678 CONFIG_SYS_I2C_NOPROBES
bb99ad6d
BW
2679
2680 This option specifies a list of I2C devices that will be skipped
c0f40859 2681 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
0f89c54b
PT
2682 is set, specify a list of bus-device pairs. Otherwise, specify
2683 a 1D array of device addresses
bb99ad6d
BW
2684
2685 e.g.
2686 #undef CONFIG_I2C_MULTI_BUS
c0f40859 2687 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
bb99ad6d
BW
2688
2689 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2690
c0f40859 2691 #define CONFIG_I2C_MULTI_BUS
6d0f6bcf 2692 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
bb99ad6d
BW
2693
2694 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2695
6d0f6bcf 2696 CONFIG_SYS_SPD_BUS_NUM
be5e6181
TT
2697
2698 If defined, then this indicates the I2C bus number for DDR SPD.
2699 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2700
6d0f6bcf 2701 CONFIG_SYS_RTC_BUS_NUM
0dc018ec
SR
2702
2703 If defined, then this indicates the I2C bus number for the RTC.
2704 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2705
6d0f6bcf 2706 CONFIG_SYS_DTT_BUS_NUM
0dc018ec
SR
2707
2708 If defined, then this indicates the I2C bus number for the DTT.
2709 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2710
6d0f6bcf 2711 CONFIG_SYS_I2C_DTT_ADDR:
9ebbb54f
VG
2712
2713 If defined, specifies the I2C address of the DTT device.
2714 If not defined, then U-Boot uses predefined value for
2715 specified DTT device.
2716
2ac6985a
AD
2717 CONFIG_SOFT_I2C_READ_REPEATED_START
2718
2719 defining this will force the i2c_read() function in
2720 the soft_i2c driver to perform an I2C repeated start
2721 between writing the address pointer and reading the
2722 data. If this define is omitted the default behaviour
2723 of doing a stop-start sequence will be used. Most I2C
2724 devices can use either method, but some require one or
2725 the other.
be5e6181 2726
c609719b
WD
2727- SPI Support: CONFIG_SPI
2728
2729 Enables SPI driver (so far only tested with
2730 SPI EEPROM, also an instance works with Crystal A/D and
2731 D/As on the SACSng board)
2732
6639562e
YS
2733 CONFIG_SH_SPI
2734
2735 Enables the driver for SPI controller on SuperH. Currently
2736 only SH7757 is supported.
2737
c609719b
WD
2738 CONFIG_SPI_X
2739
2740 Enables extended (16-bit) SPI EEPROM addressing.
2741 (symmetrical to CONFIG_I2C_X)
2742
2743 CONFIG_SOFT_SPI
2744
43d9616c
WD
2745 Enables a software (bit-bang) SPI driver rather than
2746 using hardware support. This is a general purpose
2747 driver that only requires three general I/O port pins
2748 (two outputs, one input) to function. If this is
2749 defined, the board configuration must define several
2750 SPI configuration items (port pins to use, etc). For
2751 an example, see include/configs/sacsng.h.
c609719b 2752
04a9e118
BW
2753 CONFIG_HARD_SPI
2754
2755 Enables a hardware SPI driver for general-purpose reads
2756 and writes. As with CONFIG_SOFT_SPI, the board configuration
2757 must define a list of chip-select function pointers.
c0f40859 2758 Currently supported on some MPC8xxx processors. For an
04a9e118
BW
2759 example, see include/configs/mpc8349emds.h.
2760
38254f45
GL
2761 CONFIG_MXC_SPI
2762
2763 Enables the driver for the SPI controllers on i.MX and MXC
2e3cd1cd 2764 SoCs. Currently i.MX31/35/51 are supported.
38254f45 2765
f659b573
HS
2766 CONFIG_SYS_SPI_MXC_WAIT
2767 Timeout for waiting until spi transfer completed.
2768 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2769
0133502e 2770- FPGA Support: CONFIG_FPGA
c609719b 2771
0133502e
MF
2772 Enables FPGA subsystem.
2773
2774 CONFIG_FPGA_<vendor>
2775
2776 Enables support for specific chip vendors.
2777 (ALTERA, XILINX)
c609719b 2778
0133502e 2779 CONFIG_FPGA_<family>
c609719b 2780
0133502e
MF
2781 Enables support for FPGA family.
2782 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2783
2784 CONFIG_FPGA_COUNT
2785
2786 Specify the number of FPGA devices to support.
c609719b 2787
64e809af
SDPP
2788 CONFIG_CMD_FPGA_LOADMK
2789
2790 Enable support for fpga loadmk command
2791
67193864
MS
2792 CONFIG_CMD_FPGA_LOADP
2793
2794 Enable support for fpga loadp command - load partial bitstream
2795
2796 CONFIG_CMD_FPGA_LOADBP
2797
2798 Enable support for fpga loadbp command - load partial bitstream
2799 (Xilinx only)
2800
6d0f6bcf 2801 CONFIG_SYS_FPGA_PROG_FEEDBACK
c609719b 2802
8bde7f77 2803 Enable printing of hash marks during FPGA configuration.
c609719b 2804
6d0f6bcf 2805 CONFIG_SYS_FPGA_CHECK_BUSY
c609719b 2806
43d9616c
WD
2807 Enable checks on FPGA configuration interface busy
2808 status by the configuration function. This option
2809 will require a board or device specific function to
2810 be written.
c609719b
WD
2811
2812 CONFIG_FPGA_DELAY
2813
2814 If defined, a function that provides delays in the FPGA
2815 configuration driver.
2816
6d0f6bcf 2817 CONFIG_SYS_FPGA_CHECK_CTRLC
c609719b
WD
2818 Allow Control-C to interrupt FPGA configuration
2819
6d0f6bcf 2820 CONFIG_SYS_FPGA_CHECK_ERROR
c609719b 2821
43d9616c
WD
2822 Check for configuration errors during FPGA bitfile
2823 loading. For example, abort during Virtex II
2824 configuration if the INIT_B line goes low (which
2825 indicated a CRC error).
c609719b 2826
6d0f6bcf 2827 CONFIG_SYS_FPGA_WAIT_INIT
c609719b 2828
b445bbb4
JM
2829 Maximum time to wait for the INIT_B line to de-assert
2830 after PROB_B has been de-asserted during a Virtex II
43d9616c 2831 FPGA configuration sequence. The default time is 500
11ccc33f 2832 ms.
c609719b 2833
6d0f6bcf 2834 CONFIG_SYS_FPGA_WAIT_BUSY
c609719b 2835
b445bbb4 2836 Maximum time to wait for BUSY to de-assert during
11ccc33f 2837 Virtex II FPGA configuration. The default is 5 ms.
c609719b 2838
6d0f6bcf 2839 CONFIG_SYS_FPGA_WAIT_CONFIG
c609719b 2840
43d9616c 2841 Time to wait after FPGA configuration. The default is
11ccc33f 2842 200 ms.
c609719b
WD
2843
2844- Configuration Management:
b2b8a696
SR
2845 CONFIG_BUILD_TARGET
2846
2847 Some SoCs need special image types (e.g. U-Boot binary
2848 with a special header) as build targets. By defining
2849 CONFIG_BUILD_TARGET in the SoC / board header, this
2850 special image will be automatically built upon calling
2851 make / MAKEALL.
2852
c609719b
WD
2853 CONFIG_IDENT_STRING
2854
43d9616c
WD
2855 If defined, this string will be added to the U-Boot
2856 version information (U_BOOT_VERSION)
c609719b
WD
2857
2858- Vendor Parameter Protection:
2859
43d9616c
WD
2860 U-Boot considers the values of the environment
2861 variables "serial#" (Board Serial Number) and
7152b1d0 2862 "ethaddr" (Ethernet Address) to be parameters that
43d9616c
WD
2863 are set once by the board vendor / manufacturer, and
2864 protects these variables from casual modification by
2865 the user. Once set, these variables are read-only,
2866 and write or delete attempts are rejected. You can
11ccc33f 2867 change this behaviour:
c609719b
WD
2868
2869 If CONFIG_ENV_OVERWRITE is #defined in your config
2870 file, the write protection for vendor parameters is
47cd00fa 2871 completely disabled. Anybody can change or delete
c609719b
WD
2872 these parameters.
2873
2874 Alternatively, if you #define _both_ CONFIG_ETHADDR
2875 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
11ccc33f 2876 Ethernet address is installed in the environment,
c609719b
WD
2877 which can be changed exactly ONCE by the user. [The
2878 serial# is unaffected by this, i. e. it remains
2879 read-only.]
2880
2598090b
JH
2881 The same can be accomplished in a more flexible way
2882 for any variable by configuring the type of access
2883 to allow for those variables in the ".flags" variable
2884 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2885
c609719b
WD
2886- Protected RAM:
2887 CONFIG_PRAM
2888
2889 Define this variable to enable the reservation of
2890 "protected RAM", i. e. RAM which is not overwritten
2891 by U-Boot. Define CONFIG_PRAM to hold the number of
2892 kB you want to reserve for pRAM. You can overwrite
2893 this default value by defining an environment
2894 variable "pram" to the number of kB you want to
2895 reserve. Note that the board info structure will
2896 still show the full amount of RAM. If pRAM is
2897 reserved, a new environment variable "mem" will
2898 automatically be defined to hold the amount of
2899 remaining RAM in a form that can be passed as boot
2900 argument to Linux, for instance like that:
2901
fe126d8b 2902 setenv bootargs ... mem=\${mem}
c609719b
WD
2903 saveenv
2904
2905 This way you can tell Linux not to use this memory,
2906 either, which results in a memory region that will
2907 not be affected by reboots.
2908
2909 *WARNING* If your board configuration uses automatic
2910 detection of the RAM size, you must make sure that
2911 this memory test is non-destructive. So far, the
2912 following board configurations are known to be
2913 "pRAM-clean":
2914
1b0757ec
WD
2915 IVMS8, IVML24, SPD8xx, TQM8xxL,
2916 HERMES, IP860, RPXlite, LWMON,
544d97e9 2917 FLAGADM, TQM8260
c609719b 2918
40fef049
GB
2919- Access to physical memory region (> 4GB)
2920 Some basic support is provided for operations on memory not
2921 normally accessible to U-Boot - e.g. some architectures
2922 support access to more than 4GB of memory on 32-bit
2923 machines using physical address extension or similar.
2924 Define CONFIG_PHYSMEM to access this basic support, which
2925 currently only supports clearing the memory.
2926
c609719b
WD
2927- Error Recovery:
2928 CONFIG_PANIC_HANG
2929
2930 Define this variable to stop the system in case of a
2931 fatal error, so that you have to reset it manually.
2932 This is probably NOT a good idea for an embedded
11ccc33f 2933 system where you want the system to reboot
c609719b
WD
2934 automatically as fast as possible, but it may be
2935 useful during development since you can try to debug
2936 the conditions that lead to the situation.
2937
2938 CONFIG_NET_RETRY_COUNT
2939
43d9616c
WD
2940 This variable defines the number of retries for
2941 network operations like ARP, RARP, TFTP, or BOOTP
2942 before giving up the operation. If not defined, a
2943 default value of 5 is used.
c609719b 2944
40cb90ee
GL
2945 CONFIG_ARP_TIMEOUT
2946
2947 Timeout waiting for an ARP reply in milliseconds.
2948
48a3e999
TK
2949 CONFIG_NFS_TIMEOUT
2950
2951 Timeout in milliseconds used in NFS protocol.
2952 If you encounter "ERROR: Cannot umount" in nfs command,
2953 try longer timeout such as
2954 #define CONFIG_NFS_TIMEOUT 10000UL
2955
c609719b 2956- Command Interpreter:
8078f1a5 2957 CONFIG_AUTO_COMPLETE
04a85b3b
WD
2958
2959 Enable auto completion of commands using TAB.
2960
6d0f6bcf 2961 CONFIG_SYS_PROMPT_HUSH_PS2
c609719b
WD
2962
2963 This defines the secondary prompt string, which is
2964 printed when the command interpreter needs more input
2965 to complete a command. Usually "> ".
2966
2967 Note:
2968
8bde7f77
WD
2969 In the current implementation, the local variables
2970 space and global environment variables space are
2971 separated. Local variables are those you define by
2972 simply typing `name=value'. To access a local
2973 variable later on, you have write `$name' or
2974 `${name}'; to execute the contents of a variable
2975 directly type `$name' at the command prompt.
c609719b 2976
43d9616c
WD
2977 Global environment variables are those you use
2978 setenv/printenv to work with. To run a command stored
2979 in such a variable, you need to use the run command,
2980 and you must not use the '$' sign to access them.
c609719b
WD
2981
2982 To store commands and special characters in a
2983 variable, please use double quotation marks
2984 surrounding the whole text of the variable, instead
2985 of the backslashes before semicolons and special
2986 symbols.
2987
b445bbb4 2988- Command Line Editing and History:
aa0c71ac
WD
2989 CONFIG_CMDLINE_EDITING
2990
11ccc33f 2991 Enable editing and History functions for interactive
b445bbb4 2992 command line input operations
aa0c71ac 2993
a8c7c708 2994- Default Environment:
c609719b
WD
2995 CONFIG_EXTRA_ENV_SETTINGS
2996
43d9616c
WD
2997 Define this to contain any number of null terminated
2998 strings (variable = value pairs) that will be part of
7152b1d0 2999 the default environment compiled into the boot image.
2262cfee 3000
43d9616c
WD
3001 For example, place something like this in your
3002 board's config file:
c609719b
WD
3003
3004 #define CONFIG_EXTRA_ENV_SETTINGS \
3005 "myvar1=value1\0" \
3006 "myvar2=value2\0"
3007
43d9616c
WD
3008 Warning: This method is based on knowledge about the
3009 internal format how the environment is stored by the
3010 U-Boot code. This is NOT an official, exported
3011 interface! Although it is unlikely that this format
7152b1d0 3012 will change soon, there is no guarantee either.
c609719b
WD
3013 You better know what you are doing here.
3014
43d9616c
WD
3015 Note: overly (ab)use of the default environment is
3016 discouraged. Make sure to check other ways to preset
74de7aef 3017 the environment like the "source" command or the
43d9616c 3018 boot command first.
c609719b 3019
5e724ca2
SW
3020 CONFIG_ENV_VARS_UBOOT_CONFIG
3021
3022 Define this in order to add variables describing the
3023 U-Boot build configuration to the default environment.
3024 These will be named arch, cpu, board, vendor, and soc.
3025
3026 Enabling this option will cause the following to be defined:
3027
3028 - CONFIG_SYS_ARCH
3029 - CONFIG_SYS_CPU
3030 - CONFIG_SYS_BOARD
3031 - CONFIG_SYS_VENDOR
3032 - CONFIG_SYS_SOC
3033
7e27f89f
TR
3034 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
3035
3036 Define this in order to add variables describing certain
3037 run-time determined information about the hardware to the
3038 environment. These will be named board_name, board_rev.
3039
06fd8538
SG
3040 CONFIG_DELAY_ENVIRONMENT
3041
3042 Normally the environment is loaded when the board is
b445bbb4 3043 initialised so that it is available to U-Boot. This inhibits
06fd8538
SG
3044 that so that the environment is not available until
3045 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
3046 this is instead controlled by the value of
3047 /config/load-environment.
3048
a8c7c708 3049- DataFlash Support:
2abbe075
WD
3050 CONFIG_HAS_DATAFLASH
3051
8bde7f77
WD
3052 Defining this option enables DataFlash features and
3053 allows to read/write in Dataflash via the standard
3054 commands cp, md...
2abbe075 3055
f61ec45e
EN
3056- Serial Flash support
3057 CONFIG_CMD_SF
3058
3059 Defining this option enables SPI flash commands
3060 'sf probe/read/write/erase/update'.
3061
3062 Usage requires an initial 'probe' to define the serial
3063 flash parameters, followed by read/write/erase/update
3064 commands.
3065
3066 The following defaults may be provided by the platform
3067 to handle the common case when only a single serial
3068 flash is present on the system.
3069
3070 CONFIG_SF_DEFAULT_BUS Bus identifier
3071 CONFIG_SF_DEFAULT_CS Chip-select
3072 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3073 CONFIG_SF_DEFAULT_SPEED in Hz
3074
24007273
SG
3075 CONFIG_CMD_SF_TEST
3076
3077 Define this option to include a destructive SPI flash
3078 test ('sf test').
3079
1dcd6d03
JT
3080 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
3081
3082 Define this option to use the Bank addr/Extended addr
3083 support on SPI flashes which has size > 16Mbytes.
3084
b902e07c
JT
3085 CONFIG_SF_DUAL_FLASH Dual flash memories
3086
3087 Define this option to use dual flash support where two flash
3088 memories can be connected with a given cs line.
b445bbb4 3089 Currently Xilinx Zynq qspi supports these type of connections.
b902e07c 3090
562f8df1
HS
3091 CONFIG_SYS_SPI_ST_ENABLE_WP_PIN
3092 enable the W#/Vpp signal to disable writing to the status
3093 register on ST MICRON flashes like the N25Q128.
3094 The status register write enable/disable bit, combined with
3095 the W#/VPP signal provides hardware data protection for the
3096 device as follows: When the enable/disable bit is set to 1,
3097 and the W#/VPP signal is driven LOW, the status register
3098 nonvolatile bits become read-only and the WRITE STATUS REGISTER
3099 operation will not execute. The only way to exit this
3100 hardware-protected mode is to drive W#/VPP HIGH.
3101
3f85ce27
WD
3102- SystemACE Support:
3103 CONFIG_SYSTEMACE
3104
3105 Adding this option adds support for Xilinx SystemACE
3106 chips attached via some sort of local bus. The address
11ccc33f 3107 of the chip must also be defined in the
6d0f6bcf 3108 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
3f85ce27
WD
3109
3110 #define CONFIG_SYSTEMACE
6d0f6bcf 3111 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
3f85ce27
WD
3112
3113 When SystemACE support is added, the "ace" device type
3114 becomes available to the fat commands, i.e. fatls.
3115
ecb0ccd9
WD
3116- TFTP Fixed UDP Port:
3117 CONFIG_TFTP_PORT
3118
28cb9375 3119 If this is defined, the environment variable tftpsrcp
ecb0ccd9 3120 is used to supply the TFTP UDP source port value.
28cb9375 3121 If tftpsrcp isn't defined, the normal pseudo-random port
ecb0ccd9
WD
3122 number generator is used.
3123
28cb9375
WD
3124 Also, the environment variable tftpdstp is used to supply
3125 the TFTP UDP destination port value. If tftpdstp isn't
3126 defined, the normal port 69 is used.
3127
3128 The purpose for tftpsrcp is to allow a TFTP server to
ecb0ccd9
WD
3129 blindly start the TFTP transfer using the pre-configured
3130 target IP address and UDP port. This has the effect of
3131 "punching through" the (Windows XP) firewall, allowing
3132 the remainder of the TFTP transfer to proceed normally.
3133 A better solution is to properly configure the firewall,
3134 but sometimes that is not allowed.
3135
bf36c5d5
SG
3136- Hashing support:
3137 CONFIG_CMD_HASH
3138
3139 This enables a generic 'hash' command which can produce
3140 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3141
3142 CONFIG_HASH_VERIFY
3143
3144 Enable the hash verify command (hash -v). This adds to code
3145 size a little.
3146
94e3c8c4 3147 CONFIG_SHA1 - This option enables support of hashing using SHA1
3148 algorithm. The hash is calculated in software.
3149 CONFIG_SHA256 - This option enables support of hashing using
3150 SHA256 algorithm. The hash is calculated in software.
3151 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3152 for SHA1/SHA256 hashing.
3153 This affects the 'hash' command and also the
3154 hash_lookup_algo() function.
3155 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3156 hardware-acceleration for SHA1/SHA256 progressive hashing.
3157 Data can be streamed in a block at a time and the hashing
3158 is performed in hardware.
bf36c5d5
SG
3159
3160 Note: There is also a sha1sum command, which should perhaps
3161 be deprecated in favour of 'hash sha1'.
3162
a11f1873
RW
3163- Freescale i.MX specific commands:
3164 CONFIG_CMD_HDMIDETECT
3165 This enables 'hdmidet' command which returns true if an
3166 HDMI monitor is detected. This command is i.MX 6 specific.
3167
3168 CONFIG_CMD_BMODE
3169 This enables the 'bmode' (bootmode) command for forcing
3170 a boot from specific media.
3171
3172 This is useful for forcing the ROM's usb downloader to
3173 activate upon a watchdog reset which is nice when iterating
3174 on U-Boot. Using the reset button or running bmode normal
3175 will set it back to normal. This command currently
3176 supports i.MX53 and i.MX6.
3177
19c402af
SG
3178- Signing support:
3179 CONFIG_RSA
3180
3181 This enables the RSA algorithm used for FIT image verification
8bf2aad7 3182 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
19c402af 3183
c937ff6d
RG
3184 The Modular Exponentiation algorithm in RSA is implemented using
3185 driver model. So CONFIG_DM needs to be enabled by default for this
3186 library to function.
3187
19c402af 3188 The signing part is build into mkimage regardless of this
c937ff6d
RG
3189 option. The software based modular exponentiation is built into
3190 mkimage irrespective of this option.
19c402af 3191
9e50c406
HS
3192- bootcount support:
3193 CONFIG_BOOTCOUNT_LIMIT
3194
3195 This enables the bootcounter support, see:
3196 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3197
3198 CONFIG_AT91SAM9XE
3199 enable special bootcounter support on at91sam9xe based boards.
3200 CONFIG_BLACKFIN
3201 enable special bootcounter support on blackfin based boards.
3202 CONFIG_SOC_DA8XX
3203 enable special bootcounter support on da850 based boards.
3204 CONFIG_BOOTCOUNT_RAM
3205 enable support for the bootcounter in RAM
3206 CONFIG_BOOTCOUNT_I2C
3207 enable support for the bootcounter on an i2c (like RTC) device.
3208 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3209 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3210 the bootcounter.
3211 CONFIG_BOOTCOUNT_ALEN = address len
19c402af 3212
a8c7c708 3213- Show boot progress:
c609719b
WD
3214 CONFIG_SHOW_BOOT_PROGRESS
3215
43d9616c
WD
3216 Defining this option allows to add some board-
3217 specific code (calling a user-provided function
3218 "show_boot_progress(int)") that enables you to show
3219 the system's boot progress on some display (for
3220 example, some LED's) on your board. At the moment,
3221 the following checkpoints are implemented:
c609719b 3222
94fd1316 3223
1372cce2
MB
3224Legacy uImage format:
3225
c609719b
WD
3226 Arg Where When
3227 1 common/cmd_bootm.c before attempting to boot an image
ba56f625 3228 -1 common/cmd_bootm.c Image header has bad magic number
c609719b 3229 2 common/cmd_bootm.c Image header has correct magic number
ba56f625 3230 -2 common/cmd_bootm.c Image header has bad checksum
c609719b 3231 3 common/cmd_bootm.c Image header has correct checksum
ba56f625 3232 -3 common/cmd_bootm.c Image data has bad checksum
c609719b
WD
3233 4 common/cmd_bootm.c Image data has correct checksum
3234 -4 common/cmd_bootm.c Image is for unsupported architecture
3235 5 common/cmd_bootm.c Architecture check OK
1372cce2 3236 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
c609719b
WD
3237 6 common/cmd_bootm.c Image Type check OK
3238 -6 common/cmd_bootm.c gunzip uncompression error
3239 -7 common/cmd_bootm.c Unimplemented compression type
3240 7 common/cmd_bootm.c Uncompression OK
1372cce2 3241 8 common/cmd_bootm.c No uncompress/copy overwrite error
c609719b 3242 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1372cce2
MB
3243
3244 9 common/image.c Start initial ramdisk verification
3245 -10 common/image.c Ramdisk header has bad magic number
3246 -11 common/image.c Ramdisk header has bad checksum
3247 10 common/image.c Ramdisk header is OK
3248 -12 common/image.c Ramdisk data has bad checksum
3249 11 common/image.c Ramdisk data has correct checksum
3250 12 common/image.c Ramdisk verification complete, start loading
11ccc33f 3251 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1372cce2
MB
3252 13 common/image.c Start multifile image verification
3253 14 common/image.c No initial ramdisk, no multifile, continue.
3254
c0f40859 3255 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
c609719b 3256
a47a12be 3257 -30 arch/powerpc/lib/board.c Fatal error, hang the system
11dadd54
WD
3258 -31 post/post.c POST test failed, detected by post_output_backlog()
3259 -32 post/post.c POST test failed, detected by post_run_single()
63e73c9a 3260
566a494f
HS
3261 34 common/cmd_doc.c before loading a Image from a DOC device
3262 -35 common/cmd_doc.c Bad usage of "doc" command
3263 35 common/cmd_doc.c correct usage of "doc" command
3264 -36 common/cmd_doc.c No boot device
3265 36 common/cmd_doc.c correct boot device
3266 -37 common/cmd_doc.c Unknown Chip ID on boot device
3267 37 common/cmd_doc.c correct chip ID found, device available
3268 -38 common/cmd_doc.c Read Error on boot device
3269 38 common/cmd_doc.c reading Image header from DOC device OK
3270 -39 common/cmd_doc.c Image header has bad magic number
3271 39 common/cmd_doc.c Image header has correct magic number
3272 -40 common/cmd_doc.c Error reading Image from DOC device
3273 40 common/cmd_doc.c Image header has correct magic number
3274 41 common/cmd_ide.c before loading a Image from a IDE device
3275 -42 common/cmd_ide.c Bad usage of "ide" command
3276 42 common/cmd_ide.c correct usage of "ide" command
3277 -43 common/cmd_ide.c No boot device
3278 43 common/cmd_ide.c boot device found
3279 -44 common/cmd_ide.c Device not available
3280 44 common/cmd_ide.c Device available
3281 -45 common/cmd_ide.c wrong partition selected
3282 45 common/cmd_ide.c partition selected
3283 -46 common/cmd_ide.c Unknown partition table
3284 46 common/cmd_ide.c valid partition table found
3285 -47 common/cmd_ide.c Invalid partition type
3286 47 common/cmd_ide.c correct partition type
3287 -48 common/cmd_ide.c Error reading Image Header on boot device
3288 48 common/cmd_ide.c reading Image Header from IDE device OK
3289 -49 common/cmd_ide.c Image header has bad magic number
3290 49 common/cmd_ide.c Image header has correct magic number
3291 -50 common/cmd_ide.c Image header has bad checksum
3292 50 common/cmd_ide.c Image header has correct checksum
3293 -51 common/cmd_ide.c Error reading Image from IDE device
3294 51 common/cmd_ide.c reading Image from IDE device OK
3295 52 common/cmd_nand.c before loading a Image from a NAND device
3296 -53 common/cmd_nand.c Bad usage of "nand" command
3297 53 common/cmd_nand.c correct usage of "nand" command
3298 -54 common/cmd_nand.c No boot device
3299 54 common/cmd_nand.c boot device found
3300 -55 common/cmd_nand.c Unknown Chip ID on boot device
3301 55 common/cmd_nand.c correct chip ID found, device available
3302 -56 common/cmd_nand.c Error reading Image Header on boot device
3303 56 common/cmd_nand.c reading Image Header from NAND device OK
3304 -57 common/cmd_nand.c Image header has bad magic number
3305 57 common/cmd_nand.c Image header has correct magic number
3306 -58 common/cmd_nand.c Error reading Image from NAND device
3307 58 common/cmd_nand.c reading Image from NAND device OK
3308
3309 -60 common/env_common.c Environment has a bad CRC, using default
3310
11ccc33f 3311 64 net/eth.c starting with Ethernet configuration.
566a494f
HS
3312 -64 net/eth.c no Ethernet found.
3313 65 net/eth.c Ethernet found.
3314
3315 -80 common/cmd_net.c usage wrong
bc0571fc
JH
3316 80 common/cmd_net.c before calling net_loop()
3317 -81 common/cmd_net.c some error in net_loop() occurred
3318 81 common/cmd_net.c net_loop() back without error
566a494f
HS
3319 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3320 82 common/cmd_net.c trying automatic boot
74de7aef
WD
3321 83 common/cmd_net.c running "source" command
3322 -83 common/cmd_net.c some error in automatic boot or "source" command
566a494f 3323 84 common/cmd_net.c end without errors
c609719b 3324
1372cce2
MB
3325FIT uImage format:
3326
3327 Arg Where When
3328 100 common/cmd_bootm.c Kernel FIT Image has correct format
3329 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3330 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3331 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3332 102 common/cmd_bootm.c Kernel unit name specified
3333 -103 common/cmd_bootm.c Can't get kernel subimage node offset
f773bea8 3334 103 common/cmd_bootm.c Found configuration node
1372cce2
MB
3335 104 common/cmd_bootm.c Got kernel subimage node offset
3336 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3337 105 common/cmd_bootm.c Kernel subimage hash verification OK
3338 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3339 106 common/cmd_bootm.c Architecture check OK
11ccc33f
MZ
3340 -106 common/cmd_bootm.c Kernel subimage has wrong type
3341 107 common/cmd_bootm.c Kernel subimage type OK
1372cce2
MB
3342 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3343 108 common/cmd_bootm.c Got kernel subimage data/size
3344 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3345 -109 common/cmd_bootm.c Can't get kernel subimage type
3346 -110 common/cmd_bootm.c Can't get kernel subimage comp
3347 -111 common/cmd_bootm.c Can't get kernel subimage os
3348 -112 common/cmd_bootm.c Can't get kernel subimage load address
3349 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3350
3351 120 common/image.c Start initial ramdisk verification
3352 -120 common/image.c Ramdisk FIT image has incorrect format
3353 121 common/image.c Ramdisk FIT image has correct format
11ccc33f 3354 122 common/image.c No ramdisk subimage unit name, using configuration
1372cce2
MB
3355 -122 common/image.c Can't get configuration for ramdisk subimage
3356 123 common/image.c Ramdisk unit name specified
3357 -124 common/image.c Can't get ramdisk subimage node offset
3358 125 common/image.c Got ramdisk subimage node offset
3359 -125 common/image.c Ramdisk subimage hash verification failed
3360 126 common/image.c Ramdisk subimage hash verification OK
3361 -126 common/image.c Ramdisk subimage for unsupported architecture
3362 127 common/image.c Architecture check OK
3363 -127 common/image.c Can't get ramdisk subimage data/size
3364 128 common/image.c Got ramdisk subimage data/size
3365 129 common/image.c Can't get ramdisk load address
3366 -129 common/image.c Got ramdisk load address
3367
11ccc33f 3368 -130 common/cmd_doc.c Incorrect FIT image format
1372cce2
MB
3369 131 common/cmd_doc.c FIT image format OK
3370
11ccc33f 3371 -140 common/cmd_ide.c Incorrect FIT image format
1372cce2
MB
3372 141 common/cmd_ide.c FIT image format OK
3373
11ccc33f 3374 -150 common/cmd_nand.c Incorrect FIT image format
1372cce2
MB
3375 151 common/cmd_nand.c FIT image format OK
3376
21d29f7f
HS
3377- legacy image format:
3378 CONFIG_IMAGE_FORMAT_LEGACY
3379 enables the legacy image format support in U-Boot.
3380
3381 Default:
3382 enabled if CONFIG_FIT_SIGNATURE is not defined.
3383
3384 CONFIG_DISABLE_IMAGE_LEGACY
3385 disable the legacy image format
3386
3387 This define is introduced, as the legacy image format is
3388 enabled per default for backward compatibility.
3389
d95f6ec7
GB
3390- FIT image support:
3391 CONFIG_FIT
3392 Enable support for the FIT uImage format.
3393
3394 CONFIG_FIT_BEST_MATCH
3395 When no configuration is explicitly selected, default to the
3396 one whose fdt's compatibility field best matches that of
3397 U-Boot itself. A match is considered "best" if it matches the
3398 most specific compatibility entry of U-Boot's fdt's root node.
3399 The order of entries in the configuration's fdt is ignored.
3400
3e569a6b
SG
3401 CONFIG_FIT_SIGNATURE
3402 This option enables signature verification of FIT uImages,
94e3c8c4 3403 using a hash signed and verified using RSA. If
3404 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3405 hashing is available using hardware, RSA library will use it.
3406 See doc/uImage.FIT/signature.txt for more details.
3e569a6b 3407
21d29f7f
HS
3408 WARNING: When relying on signed FIT images with required
3409 signature check the legacy image format is default
3410 disabled. If a board need legacy image format support
3411 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3412
9a4f479b
DE
3413 CONFIG_FIT_DISABLE_SHA256
3414 Supporting SHA256 hashes has quite an impact on binary size.
3415 For constrained systems sha256 hash support can be disabled
3416 with this option.
3417
4cf2609b
WD
3418- Standalone program support:
3419 CONFIG_STANDALONE_LOAD_ADDR
3420
6feff899
WD
3421 This option defines a board specific value for the
3422 address where standalone program gets loaded, thus
3423 overwriting the architecture dependent default
4cf2609b
WD
3424 settings.
3425
3426- Frame Buffer Address:
3427 CONFIG_FB_ADDR
3428
3429 Define CONFIG_FB_ADDR if you want to use specific
44a53b57
WD
3430 address for frame buffer. This is typically the case
3431 when using a graphics controller has separate video
3432 memory. U-Boot will then place the frame buffer at
3433 the given address instead of dynamically reserving it
3434 in system RAM by calling lcd_setmem(), which grabs
3435 the memory for the frame buffer depending on the
3436 configured panel size.
4cf2609b
WD
3437
3438 Please see board_init_f function.
3439
cccfc2ab
DZ
3440- Automatic software updates via TFTP server
3441 CONFIG_UPDATE_TFTP
3442 CONFIG_UPDATE_TFTP_CNT_MAX
3443 CONFIG_UPDATE_TFTP_MSEC_MAX
3444
3445 These options enable and control the auto-update feature;
3446 for a more detailed description refer to doc/README.update.
3447
3448- MTD Support (mtdparts command, UBI support)
3449 CONFIG_MTD_DEVICE
3450
3451 Adds the MTD device infrastructure from the Linux kernel.
3452 Needed for mtdparts command support.
3453
3454 CONFIG_MTD_PARTITIONS
3455
3456 Adds the MTD partitioning infrastructure from the Linux
3457 kernel. Needed for UBI support.
3458
70c219cd
JH
3459- UBI support
3460 CONFIG_CMD_UBI
3461
3462 Adds commands for interacting with MTD partitions formatted
3463 with the UBI flash translation layer
3464
3465 Requires also defining CONFIG_RBTREE
3466
147162da
JH
3467 CONFIG_UBI_SILENCE_MSG
3468
3469 Make the verbose messages from UBI stop printing. This leaves
3470 warnings and errors enabled.
3471
ff94bc40
HS
3472
3473 CONFIG_MTD_UBI_WL_THRESHOLD
3474 This parameter defines the maximum difference between the highest
3475 erase counter value and the lowest erase counter value of eraseblocks
3476 of UBI devices. When this threshold is exceeded, UBI starts performing
3477 wear leveling by means of moving data from eraseblock with low erase
3478 counter to eraseblocks with high erase counter.
3479
3480 The default value should be OK for SLC NAND flashes, NOR flashes and
3481 other flashes which have eraseblock life-cycle 100000 or more.
3482 However, in case of MLC NAND flashes which typically have eraseblock
3483 life-cycle less than 10000, the threshold should be lessened (e.g.,
3484 to 128 or 256, although it does not have to be power of 2).
3485
3486 default: 4096
c654b517 3487
ff94bc40
HS
3488 CONFIG_MTD_UBI_BEB_LIMIT
3489 This option specifies the maximum bad physical eraseblocks UBI
3490 expects on the MTD device (per 1024 eraseblocks). If the
3491 underlying flash does not admit of bad eraseblocks (e.g. NOR
3492 flash), this value is ignored.
3493
3494 NAND datasheets often specify the minimum and maximum NVM
3495 (Number of Valid Blocks) for the flashes' endurance lifetime.
3496 The maximum expected bad eraseblocks per 1024 eraseblocks
3497 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3498 which gives 20 for most NANDs (MaxNVB is basically the total
3499 count of eraseblocks on the chip).
3500
3501 To put it differently, if this value is 20, UBI will try to
3502 reserve about 1.9% of physical eraseblocks for bad blocks
3503 handling. And that will be 1.9% of eraseblocks on the entire
3504 NAND chip, not just the MTD partition UBI attaches. This means
3505 that if you have, say, a NAND flash chip admits maximum 40 bad
3506 eraseblocks, and it is split on two MTD partitions of the same
3507 size, UBI will reserve 40 eraseblocks when attaching a
3508 partition.
3509
3510 default: 20
3511
3512 CONFIG_MTD_UBI_FASTMAP
3513 Fastmap is a mechanism which allows attaching an UBI device
3514 in nearly constant time. Instead of scanning the whole MTD device it
3515 only has to locate a checkpoint (called fastmap) on the device.
3516 The on-flash fastmap contains all information needed to attach
3517 the device. Using fastmap makes only sense on large devices where
3518 attaching by scanning takes long. UBI will not automatically install
3519 a fastmap on old images, but you can set the UBI parameter
3520 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3521 that fastmap-enabled images are still usable with UBI implementations
3522 without fastmap support. On typical flash devices the whole fastmap
3523 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3524
3525 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3526 Set this parameter to enable fastmap automatically on images
3527 without a fastmap.
3528 default: 0
3529
70c219cd
JH
3530- UBIFS support
3531 CONFIG_CMD_UBIFS
3532
3533 Adds commands for interacting with UBI volumes formatted as
3534 UBIFS. UBIFS is read-only in u-boot.
3535
3536 Requires UBI support as well as CONFIG_LZO
3537
147162da
JH
3538 CONFIG_UBIFS_SILENCE_MSG
3539
3540 Make the verbose messages from UBIFS stop printing. This leaves
3541 warnings and errors enabled.
3542
6a11cf48 3543- SPL framework
04e5ae79
WD
3544 CONFIG_SPL
3545 Enable building of SPL globally.
6a11cf48 3546
95579793
TR
3547 CONFIG_SPL_LDSCRIPT
3548 LDSCRIPT for linking the SPL binary.
3549
6ebc3461
AA
3550 CONFIG_SPL_MAX_FOOTPRINT
3551 Maximum size in memory allocated to the SPL, BSS included.
3552 When defined, the linker checks that the actual memory
3553 used by SPL from _start to __bss_end does not exceed it.
8960af8b 3554 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc3461
AA
3555 must not be both defined at the same time.
3556
95579793 3557 CONFIG_SPL_MAX_SIZE
6ebc3461
AA
3558 Maximum size of the SPL image (text, data, rodata, and
3559 linker lists sections), BSS excluded.
3560 When defined, the linker checks that the actual size does
3561 not exceed it.
95579793 3562
04e5ae79
WD
3563 CONFIG_SPL_TEXT_BASE
3564 TEXT_BASE for linking the SPL binary.
6a11cf48 3565
94a45bb1
SW
3566 CONFIG_SPL_RELOC_TEXT_BASE
3567 Address to relocate to. If unspecified, this is equal to
3568 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3569
95579793
TR
3570 CONFIG_SPL_BSS_START_ADDR
3571 Link address for the BSS within the SPL binary.
3572
3573 CONFIG_SPL_BSS_MAX_SIZE
6ebc3461
AA
3574 Maximum size in memory allocated to the SPL BSS.
3575 When defined, the linker checks that the actual memory used
3576 by SPL from __bss_start to __bss_end does not exceed it.
8960af8b 3577 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
6ebc3461 3578 must not be both defined at the same time.
95579793
TR
3579
3580 CONFIG_SPL_STACK
3581 Adress of the start of the stack SPL will use
3582
8c80eb3b
AA
3583 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3584 When defined, SPL will panic() if the image it has
3585 loaded does not have a signature.
3586 Defining this is useful when code which loads images
3587 in SPL cannot guarantee that absolutely all read errors
3588 will be caught.
3589 An example is the LPC32XX MLC NAND driver, which will
3590 consider that a completely unreadable NAND block is bad,
3591 and thus should be skipped silently.
3592
94a45bb1
SW
3593 CONFIG_SPL_RELOC_STACK
3594 Adress of the start of the stack SPL will use after
3595 relocation. If unspecified, this is equal to
3596 CONFIG_SPL_STACK.
3597
95579793
TR
3598 CONFIG_SYS_SPL_MALLOC_START
3599 Starting address of the malloc pool used in SPL.
3600
3601 CONFIG_SYS_SPL_MALLOC_SIZE
3602 The size of the malloc pool used in SPL.
6a11cf48 3603
47f7bcae
TR
3604 CONFIG_SPL_FRAMEWORK
3605 Enable the SPL framework under common/. This framework
3606 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3607 NAND loading of the Linux Kernel.
3608
9607faf2
TR
3609 CONFIG_SPL_OS_BOOT
3610 Enable booting directly to an OS from SPL.
3611 See also: doc/README.falcon
3612
861a86f4
TR
3613 CONFIG_SPL_DISPLAY_PRINT
3614 For ARM, enable an optional function to print more information
3615 about the running system.
3616
4b919725
SW
3617 CONFIG_SPL_INIT_MINIMAL
3618 Arch init code should be built for a very small image
3619
04e5ae79
WD
3620 CONFIG_SPL_LIBCOMMON_SUPPORT
3621 Support for common/libcommon.o in SPL binary
6a11cf48 3622
04e5ae79
WD
3623 CONFIG_SPL_LIBDISK_SUPPORT
3624 Support for disk/libdisk.o in SPL binary
6a11cf48 3625
04e5ae79
WD
3626 CONFIG_SPL_I2C_SUPPORT
3627 Support for drivers/i2c/libi2c.o in SPL binary
6a11cf48 3628
04e5ae79
WD
3629 CONFIG_SPL_GPIO_SUPPORT
3630 Support for drivers/gpio/libgpio.o in SPL binary
6a11cf48 3631
04e5ae79
WD
3632 CONFIG_SPL_MMC_SUPPORT
3633 Support for drivers/mmc/libmmc.o in SPL binary
6a11cf48 3634
95579793
TR
3635 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3636 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
e2ccdf89 3637 Address and partition on the MMC to load U-Boot from
95579793
TR
3638 when the MMC is being used in raw mode.
3639
b97300b6
PK
3640 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3641 Partition on the MMC to load U-Boot from when the MMC is being
3642 used in raw mode
3643
2b75b0ad
PK
3644 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3645 Sector to load kernel uImage from when MMC is being
3646 used in raw mode (for Falcon mode)
3647
3648 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3649 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3650 Sector and number of sectors to load kernel argument
3651 parameters from when MMC is being used in raw mode
3652 (for falcon mode)
3653
e2ccdf89
PK
3654 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3655 Partition on the MMC to load U-Boot from when the MMC is being
3656 used in fs mode
3657
95579793
TR
3658 CONFIG_SPL_FAT_SUPPORT
3659 Support for fs/fat/libfat.o in SPL binary
3660
fae81c72
GG
3661 CONFIG_SPL_EXT_SUPPORT
3662 Support for EXT filesystem in SPL binary
95579793 3663
fae81c72
GG
3664 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3665 Filename to read to load U-Boot when reading from filesystem
3666
3667 CONFIG_SPL_FS_LOAD_KERNEL_NAME
7ad2cc79 3668 Filename to read to load kernel uImage when reading
fae81c72 3669 from filesystem (for Falcon mode)
7ad2cc79 3670
fae81c72 3671 CONFIG_SPL_FS_LOAD_ARGS_NAME
7ad2cc79 3672 Filename to read to load kernel argument parameters
fae81c72 3673 when reading from filesystem (for Falcon mode)
7ad2cc79 3674
06f60ae3
SW
3675 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3676 Set this for NAND SPL on PPC mpc83xx targets, so that
3677 start.S waits for the rest of the SPL to load before
3678 continuing (the hardware starts execution after just
3679 loading the first page rather than the full 4K).
3680
651fcf60
PK
3681 CONFIG_SPL_SKIP_RELOCATE
3682 Avoid SPL relocation
3683
6f2f01b9
SW
3684 CONFIG_SPL_NAND_BASE
3685 Include nand_base.c in the SPL. Requires
3686 CONFIG_SPL_NAND_DRIVERS.
3687
3688 CONFIG_SPL_NAND_DRIVERS
3689 SPL uses normal NAND drivers, not minimal drivers.
3690
3691 CONFIG_SPL_NAND_ECC
3692 Include standard software ECC in the SPL
3693
95579793 3694 CONFIG_SPL_NAND_SIMPLE
7d4b7955
SW
3695 Support for NAND boot using simple NAND drivers that
3696 expose the cmd_ctrl() interface.
95579793 3697
6dd3b566
TR
3698 CONFIG_SPL_MTD_SUPPORT
3699 Support for the MTD subsystem within SPL. Useful for
3700 environment on NAND support within SPL.
3701
0c3117b1
HS
3702 CONFIG_SPL_NAND_RAW_ONLY
3703 Support to boot only raw u-boot.bin images. Use this only
3704 if you need to save space.
3705
bb0dc108
YZ
3706 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3707 Set for the SPL on PPC mpc8xxx targets, support for
5614e71b 3708 drivers/ddr/fsl/libddr.o in SPL binary.
bb0dc108 3709
7c8eea59
YZ
3710 CONFIG_SPL_COMMON_INIT_DDR
3711 Set for common ddr init with serial presence detect in
3712 SPL binary.
3713
95579793
TR
3714 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3715 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3716 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3717 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3718 CONFIG_SYS_NAND_ECCBYTES
3719 Defines the size and behavior of the NAND that SPL uses
7d4b7955 3720 to read U-Boot
95579793 3721
fbe76ae4
PK
3722 CONFIG_SPL_NAND_BOOT
3723 Add support NAND boot
3724
95579793 3725 CONFIG_SYS_NAND_U_BOOT_OFFS
7d4b7955
SW
3726 Location in NAND to read U-Boot from
3727
3728 CONFIG_SYS_NAND_U_BOOT_DST
3729 Location in memory to load U-Boot to
3730
3731 CONFIG_SYS_NAND_U_BOOT_SIZE
3732 Size of image to load
95579793
TR
3733
3734 CONFIG_SYS_NAND_U_BOOT_START
7d4b7955 3735 Entry point in loaded image to jump to
95579793
TR
3736
3737 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3738 Define this if you need to first read the OOB and then the
b445bbb4 3739 data. This is used, for example, on davinci platforms.
95579793
TR
3740
3741 CONFIG_SPL_OMAP3_ID_NAND
3742 Support for an OMAP3-specific set of functions to return the
3743 ID and MFR of the first attached NAND chip, if present.
3744
04e5ae79
WD
3745 CONFIG_SPL_SERIAL_SUPPORT
3746 Support for drivers/serial/libserial.o in SPL binary
6a11cf48 3747
04e5ae79
WD
3748 CONFIG_SPL_SPI_FLASH_SUPPORT
3749 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
6a11cf48 3750
04e5ae79
WD
3751 CONFIG_SPL_SPI_SUPPORT
3752 Support for drivers/spi/libspi.o in SPL binary
c57b953d
PM
3753
3754 CONFIG_SPL_RAM_DEVICE
3755 Support for running image already present in ram, in SPL binary
6a11cf48 3756
04e5ae79
WD
3757 CONFIG_SPL_LIBGENERIC_SUPPORT
3758 Support for lib/libgeneric.o in SPL binary
1372cce2 3759
ba1bee43
YZ
3760 CONFIG_SPL_ENV_SUPPORT
3761 Support for the environment operating in SPL binary
3762
3763 CONFIG_SPL_NET_SUPPORT
3764 Support for the net/libnet.o in SPL binary.
3765 It conflicts with SPL env from storage medium specified by
3766 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3767
74752baa 3768 CONFIG_SPL_PAD_TO
6113d3f2
BT
3769 Image offset to which the SPL should be padded before appending
3770 the SPL payload. By default, this is defined as
3771 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3772 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3773 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
74752baa 3774
ca2fca22
SW
3775 CONFIG_SPL_TARGET
3776 Final target image containing SPL and payload. Some SPLs
3777 use an arch-specific makefile fragment instead, for
3778 example if more than one image needs to be produced.
3779
87ebee39
SG
3780 CONFIG_FIT_SPL_PRINT
3781 Printing information about a FIT image adds quite a bit of
3782 code to SPL. So this is normally disabled in SPL. Use this
3783 option to re-enable it. This will affect the output of the
3784 bootm command when booting a FIT image.
3785
3aa29de0
YZ
3786- TPL framework
3787 CONFIG_TPL
3788 Enable building of TPL globally.
3789
3790 CONFIG_TPL_PAD_TO
3791 Image offset to which the TPL should be padded before appending
3792 the TPL payload. By default, this is defined as
93e14596
WD
3793 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3794 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3795 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3aa29de0 3796
c609719b
WD
3797Modem Support:
3798--------------
3799
566e5cf4 3800[so far only for SMDK2400 boards]
c609719b 3801
11ccc33f 3802- Modem support enable:
c609719b
WD
3803 CONFIG_MODEM_SUPPORT
3804
3805- RTS/CTS Flow control enable:
3806 CONFIG_HWFLOW
3807
3808- Modem debug support:
3809 CONFIG_MODEM_SUPPORT_DEBUG
3810
43d9616c
WD
3811 Enables debugging stuff (char screen[1024], dbg())
3812 for modem support. Useful only with BDI2000.
c609719b 3813
a8c7c708
WD
3814- Interrupt support (PPC):
3815
d4ca31c4
WD
3816 There are common interrupt_init() and timer_interrupt()
3817 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
11ccc33f 3818 for CPU specific initialization. interrupt_init_cpu()
d4ca31c4 3819 should set decrementer_count to appropriate value. If
11ccc33f 3820 CPU resets decrementer automatically after interrupt
d4ca31c4 3821 (ppc4xx) it should set decrementer_count to zero.
11ccc33f 3822 timer_interrupt() calls timer_interrupt_cpu() for CPU
d4ca31c4
WD
3823 specific handling. If board has watchdog / status_led
3824 / other_activity_monitor it works automatically from
3825 general timer_interrupt().
a8c7c708 3826
c609719b
WD
3827- General:
3828
43d9616c
WD
3829 In the target system modem support is enabled when a
3830 specific key (key combination) is pressed during
3831 power-on. Otherwise U-Boot will boot normally
11ccc33f 3832 (autoboot). The key_pressed() function is called from
43d9616c
WD
3833 board_init(). Currently key_pressed() is a dummy
3834 function, returning 1 and thus enabling modem
3835 initialization.
c609719b 3836
43d9616c
WD
3837 If there are no modem init strings in the
3838 environment, U-Boot proceed to autoboot; the
3839 previous output (banner, info printfs) will be
11ccc33f 3840 suppressed, though.
c609719b
WD
3841
3842 See also: doc/README.Modem
3843
9660e442
HR
3844Board initialization settings:
3845------------------------------
3846
3847During Initialization u-boot calls a number of board specific functions
3848to allow the preparation of board specific prerequisites, e.g. pin setup
3849before drivers are initialized. To enable these callbacks the
3850following configuration macros have to be defined. Currently this is
3851architecture specific, so please check arch/your_architecture/lib/board.c
3852typically in board_init_f() and board_init_r().
3853
3854- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3855- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3856- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3857- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
c609719b 3858
c609719b
WD
3859Configuration Settings:
3860-----------------------
3861
4d1fd7f1
YS
3862- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3863 Optionally it can be defined to support 64-bit memory commands.
3864
6d0f6bcf 3865- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
c609719b
WD
3866 undefine this when you're short of memory.
3867
2fb2604d
PT
3868- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3869 width of the commands listed in the 'help' command output.
3870
6d0f6bcf 3871- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
c609719b
WD
3872 prompt for user input.
3873
6d0f6bcf 3874- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
c609719b 3875
6d0f6bcf 3876- CONFIG_SYS_PBSIZE: Buffer size for Console output
c609719b 3877
6d0f6bcf 3878- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
c609719b 3879
6d0f6bcf 3880- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
c609719b
WD
3881 the application (usually a Linux kernel) when it is
3882 booted
3883
6d0f6bcf 3884- CONFIG_SYS_BAUDRATE_TABLE:
c609719b
WD
3885 List of legal baudrate settings for this board.
3886
6d0f6bcf 3887- CONFIG_SYS_CONSOLE_INFO_QUIET
8bde7f77 3888 Suppress display of console information at boot.
c609719b 3889
6d0f6bcf 3890- CONFIG_SYS_CONSOLE_IS_IN_ENV
8bde7f77
WD
3891 If the board specific function
3892 extern int overwrite_console (void);
3893 returns 1, the stdin, stderr and stdout are switched to the
c609719b
WD
3894 serial port, else the settings in the environment are used.
3895
6d0f6bcf 3896- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
8bde7f77 3897 Enable the call to overwrite_console().
c609719b 3898
6d0f6bcf 3899- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
c609719b
WD
3900 Enable overwrite of previous console environment settings.
3901
6d0f6bcf 3902- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
c609719b
WD
3903 Begin and End addresses of the area used by the
3904 simple memory test.
3905
6d0f6bcf 3906- CONFIG_SYS_ALT_MEMTEST:
8bde7f77 3907 Enable an alternate, more extensive memory test.
c609719b 3908
6d0f6bcf 3909- CONFIG_SYS_MEMTEST_SCRATCH:
5f535fe1
WD
3910 Scratch address used by the alternate memory test
3911 You only need to set this if address zero isn't writeable
3912
6d0f6bcf
JCPV
3913- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3914 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
14f73ca6 3915 this specified memory area will get subtracted from the top
11ccc33f 3916 (end) of RAM and won't get "touched" at all by U-Boot. By
14f73ca6
SR
3917 fixing up gd->ram_size the Linux kernel should gets passed
3918 the now "corrected" memory size and won't touch it either.
3919 This should work for arch/ppc and arch/powerpc. Only Linux
5e12e75d 3920 board ports in arch/powerpc with bootwrapper support that
14f73ca6 3921 recalculate the memory size from the SDRAM controller setup
5e12e75d 3922 will have to get fixed in Linux additionally.
14f73ca6
SR
3923
3924 This option can be used as a workaround for the 440EPx/GRx
3925 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3926 be touched.
3927
3928 WARNING: Please make sure that this value is a multiple of
3929 the Linux page size (normally 4k). If this is not the case,
3930 then the end address of the Linux memory will be located at a
3931 non page size aligned address and this could cause major
3932 problems.
3933
6d0f6bcf 3934- CONFIG_SYS_LOADS_BAUD_CHANGE:
c609719b
WD
3935 Enable temporary baudrate change while serial download
3936
6d0f6bcf 3937- CONFIG_SYS_SDRAM_BASE:
c609719b
WD
3938 Physical start address of SDRAM. _Must_ be 0 here.
3939
6d0f6bcf 3940- CONFIG_SYS_MBIO_BASE:
c609719b
WD
3941 Physical start address of Motherboard I/O (if using a
3942 Cogent motherboard)
3943
6d0f6bcf 3944- CONFIG_SYS_FLASH_BASE:
c609719b
WD
3945 Physical start address of Flash memory.
3946
6d0f6bcf 3947- CONFIG_SYS_MONITOR_BASE:
c609719b
WD
3948 Physical start address of boot monitor code (set by
3949 make config files to be same as the text base address
14d0a02a 3950 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
6d0f6bcf 3951 CONFIG_SYS_FLASH_BASE when booting from flash.
c609719b 3952
6d0f6bcf 3953- CONFIG_SYS_MONITOR_LEN:
8bde7f77
WD
3954 Size of memory reserved for monitor code, used to
3955 determine _at_compile_time_ (!) if the environment is
3956 embedded within the U-Boot image, or in a separate
3957 flash sector.
c609719b 3958
6d0f6bcf 3959- CONFIG_SYS_MALLOC_LEN:
c609719b
WD
3960 Size of DRAM reserved for malloc() use.
3961
d59476b6
SG
3962- CONFIG_SYS_MALLOC_F_LEN
3963 Size of the malloc() pool for use before relocation. If
3964 this is defined, then a very simple malloc() implementation
3965 will become available before relocation. The address is just
3966 below the global data, and the stack is moved down to make
3967 space.
3968
3969 This feature allocates regions with increasing addresses
3970 within the region. calloc() is supported, but realloc()
3971 is not available. free() is supported but does nothing.
b445bbb4 3972 The memory will be freed (or in fact just forgotten) when
d59476b6
SG
3973 U-Boot relocates itself.
3974
e7b14e9a 3975 Pre-relocation malloc() is only supported on ARM and sandbox
29afe9e6
SG
3976 at present but is fairly easy to enable for other archs.
3977
38687ae6
SG
3978- CONFIG_SYS_MALLOC_SIMPLE
3979 Provides a simple and small malloc() and calloc() for those
3980 boards which do not use the full malloc in SPL (which is
3981 enabled with CONFIG_SYS_SPL_MALLOC_START).
3982
1dfdd9ba
TR
3983- CONFIG_SYS_NONCACHED_MEMORY:
3984 Size of non-cached memory area. This area of memory will be
3985 typically located right below the malloc() area and mapped
3986 uncached in the MMU. This is useful for drivers that would
3987 otherwise require a lot of explicit cache maintenance. For
3988 some drivers it's also impossible to properly maintain the
3989 cache. For example if the regions that need to be flushed
3990 are not a multiple of the cache-line size, *and* padding
3991 cannot be allocated between the regions to align them (i.e.
3992 if the HW requires a contiguous array of regions, and the
3993 size of each region is not cache-aligned), then a flush of
3994 one region may result in overwriting data that hardware has
3995 written to another region in the same cache-line. This can
3996 happen for example in network drivers where descriptors for
3997 buffers are typically smaller than the CPU cache-line (e.g.
3998 16 bytes vs. 32 or 64 bytes).
3999
4000 Non-cached memory is only supported on 32-bit ARM at present.
4001
6d0f6bcf 4002- CONFIG_SYS_BOOTM_LEN:
15940c9a
SR
4003 Normally compressed uImages are limited to an
4004 uncompressed size of 8 MBytes. If this is not enough,
6d0f6bcf 4005 you can define CONFIG_SYS_BOOTM_LEN in your board config file
15940c9a
SR
4006 to adjust this setting to your needs.
4007
6d0f6bcf 4008- CONFIG_SYS_BOOTMAPSZ:
c609719b
WD
4009 Maximum size of memory mapped by the startup code of
4010 the Linux kernel; all data that must be processed by
7d721e34
BS
4011 the Linux kernel (bd_info, boot arguments, FDT blob if
4012 used) must be put below this limit, unless "bootm_low"
1bce2aeb 4013 environment variable is defined and non-zero. In such case
7d721e34 4014 all data for the Linux kernel must be between "bootm_low"
c0f40859 4015 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
c3624e6e
GL
4016 variable "bootm_mapsize" will override the value of
4017 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
4018 then the value in "bootm_size" will be used instead.
c609719b 4019
fca43cc8
JR
4020- CONFIG_SYS_BOOT_RAMDISK_HIGH:
4021 Enable initrd_high functionality. If defined then the
4022 initrd_high feature is enabled and the bootm ramdisk subcommand
4023 is enabled.
4024
4025- CONFIG_SYS_BOOT_GET_CMDLINE:
4026 Enables allocating and saving kernel cmdline in space between
4027 "bootm_low" and "bootm_low" + BOOTMAPSZ.
4028
4029- CONFIG_SYS_BOOT_GET_KBD:
4030 Enables allocating and saving a kernel copy of the bd_info in
4031 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
4032
6d0f6bcf 4033- CONFIG_SYS_MAX_FLASH_BANKS:
c609719b
WD
4034 Max number of Flash memory banks
4035
6d0f6bcf 4036- CONFIG_SYS_MAX_FLASH_SECT:
c609719b
WD
4037 Max number of sectors on a Flash chip
4038
6d0f6bcf 4039- CONFIG_SYS_FLASH_ERASE_TOUT:
c609719b
WD
4040 Timeout for Flash erase operations (in ms)
4041
6d0f6bcf 4042- CONFIG_SYS_FLASH_WRITE_TOUT:
c609719b
WD
4043 Timeout for Flash write operations (in ms)
4044
6d0f6bcf 4045- CONFIG_SYS_FLASH_LOCK_TOUT
8564acf9
WD
4046 Timeout for Flash set sector lock bit operation (in ms)
4047
6d0f6bcf 4048- CONFIG_SYS_FLASH_UNLOCK_TOUT
8564acf9
WD
4049 Timeout for Flash clear lock bits operation (in ms)
4050
6d0f6bcf 4051- CONFIG_SYS_FLASH_PROTECTION
8564acf9
WD
4052 If defined, hardware flash sectors protection is used
4053 instead of U-Boot software protection.
4054
6d0f6bcf 4055- CONFIG_SYS_DIRECT_FLASH_TFTP:
c609719b
WD
4056
4057 Enable TFTP transfers directly to flash memory;
4058 without this option such a download has to be
4059 performed in two steps: (1) download to RAM, and (2)
4060 copy from RAM to flash.
4061
4062 The two-step approach is usually more reliable, since
4063 you can check if the download worked before you erase
11ccc33f
MZ
4064 the flash, but in some situations (when system RAM is
4065 too limited to allow for a temporary copy of the
c609719b
WD
4066 downloaded image) this option may be very useful.
4067
6d0f6bcf 4068- CONFIG_SYS_FLASH_CFI:
43d9616c 4069 Define if the flash driver uses extra elements in the
5653fc33
WD
4070 common flash structure for storing flash geometry.
4071
00b1883a 4072- CONFIG_FLASH_CFI_DRIVER
5653fc33
WD
4073 This option also enables the building of the cfi_flash driver
4074 in the drivers directory
c609719b 4075
91809ed5
PZ
4076- CONFIG_FLASH_CFI_MTD
4077 This option enables the building of the cfi_mtd driver
4078 in the drivers directory. The driver exports CFI flash
4079 to the MTD layer.
4080
6d0f6bcf 4081- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
96ef831f
GL
4082 Use buffered writes to flash.
4083
4084- CONFIG_FLASH_SPANSION_S29WS_N
4085 s29ws-n MirrorBit flash has non-standard addresses for buffered
4086 write commands.
4087
6d0f6bcf 4088- CONFIG_SYS_FLASH_QUIET_TEST
5568e613
SR
4089 If this option is defined, the common CFI flash doesn't
4090 print it's warning upon not recognized FLASH banks. This
4091 is useful, if some of the configured banks are only
4092 optionally available.
4093
9a042e9c
JVB
4094- CONFIG_FLASH_SHOW_PROGRESS
4095 If defined (must be an integer), print out countdown
4096 digits and dots. Recommended value: 45 (9..1) for 80
4097 column displays, 15 (3..1) for 40 column displays.
4098
352ef3f1
SR
4099- CONFIG_FLASH_VERIFY
4100 If defined, the content of the flash (destination) is compared
4101 against the source after the write operation. An error message
4102 will be printed when the contents are not identical.
4103 Please note that this option is useless in nearly all cases,
4104 since such flash programming errors usually are detected earlier
4105 while unprotecting/erasing/programming. Please only enable
4106 this option if you really know what you are doing.
4107
6d0f6bcf 4108- CONFIG_SYS_RX_ETH_BUFFER:
11ccc33f
MZ
4109 Defines the number of Ethernet receive buffers. On some
4110 Ethernet controllers it is recommended to set this value
53cf9435
SR
4111 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4112 buffers can be full shortly after enabling the interface
11ccc33f 4113 on high Ethernet traffic.
53cf9435
SR
4114 Defaults to 4 if not defined.
4115
ea882baf
WD
4116- CONFIG_ENV_MAX_ENTRIES
4117
071bc923
WD
4118 Maximum number of entries in the hash table that is used
4119 internally to store the environment settings. The default
4120 setting is supposed to be generous and should work in most
4121 cases. This setting can be used to tune behaviour; see
4122 lib/hashtable.c for details.
ea882baf 4123
2598090b
JH
4124- CONFIG_ENV_FLAGS_LIST_DEFAULT
4125- CONFIG_ENV_FLAGS_LIST_STATIC
1bce2aeb 4126 Enable validation of the values given to environment variables when
2598090b
JH
4127 calling env set. Variables can be restricted to only decimal,
4128 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4129 the variables can also be restricted to IP address or MAC address.
4130
4131 The format of the list is:
4132 type_attribute = [s|d|x|b|i|m]
b445bbb4
JM
4133 access_attribute = [a|r|o|c]
4134 attributes = type_attribute[access_attribute]
2598090b
JH
4135 entry = variable_name[:attributes]
4136 list = entry[,list]
4137
4138 The type attributes are:
4139 s - String (default)
4140 d - Decimal
4141 x - Hexadecimal
4142 b - Boolean ([1yYtT|0nNfF])
4143 i - IP address
4144 m - MAC address
4145
267541f7
JH
4146 The access attributes are:
4147 a - Any (default)
4148 r - Read-only
4149 o - Write-once
4150 c - Change-default
4151
2598090b
JH
4152 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4153 Define this to a list (string) to define the ".flags"
b445bbb4 4154 environment variable in the default or embedded environment.
2598090b
JH
4155
4156 - CONFIG_ENV_FLAGS_LIST_STATIC
4157 Define this to a list (string) to define validation that
4158 should be done if an entry is not found in the ".flags"
4159 environment variable. To override a setting in the static
4160 list, simply add an entry for the same variable name to the
4161 ".flags" variable.
4162
267541f7
JH
4163- CONFIG_ENV_ACCESS_IGNORE_FORCE
4164 If defined, don't allow the -f switch to env set override variable
4165 access flags.
4166
5c1a7ea6
SG
4167- CONFIG_SYS_GENERIC_BOARD
4168 This selects the architecture-generic board system instead of the
4169 architecture-specific board files. It is intended to move boards
4170 to this new framework over time. Defining this will disable the
4171 arch/foo/lib/board.c file and use common/board_f.c and
4172 common/board_r.c instead. To use this option your architecture
0a12e687
MY
4173 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4174 If you find problems enabling this option on your board please report
4175 the problem and send patches!
5c1a7ea6 4176
0b1b60c7
LV
4177- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4178 This is set by OMAP boards for the max time that reset should
4179 be asserted. See doc/README.omap-reset-time for details on how
b445bbb4 4180 the value can be calculated on a given board.
632efa74 4181
0d296cc2
GB
4182- CONFIG_USE_STDINT
4183 If stdint.h is available with your toolchain you can define this
4184 option to enable it. You can provide option 'USE_STDINT=1' when
4185 building U-Boot to enable this.
4186
c609719b
WD
4187The following definitions that deal with the placement and management
4188of environment data (variable area); in general, we support the
4189following configurations:
4190
c3eb3fe4
MF
4191- CONFIG_BUILD_ENVCRC:
4192
4193 Builds up envcrc with the target environment so that external utils
4194 may easily extract it and embed it in final U-Boot images.
4195
5a1aceb0 4196- CONFIG_ENV_IS_IN_FLASH:
c609719b
WD
4197
4198 Define this if the environment is in flash memory.
4199
4200 a) The environment occupies one whole flash sector, which is
4201 "embedded" in the text segment with the U-Boot code. This
4202 happens usually with "bottom boot sector" or "top boot
4203 sector" type flash chips, which have several smaller
4204 sectors at the start or the end. For instance, such a
4205 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4206 such a case you would place the environment in one of the
4207 4 kB sectors - with U-Boot code before and after it. With
4208 "top boot sector" type flash chips, you would put the
4209 environment in one of the last sectors, leaving a gap
4210 between U-Boot and the environment.
4211
0e8d1586 4212 - CONFIG_ENV_OFFSET:
c609719b
WD
4213
4214 Offset of environment data (variable area) to the
4215 beginning of flash memory; for instance, with bottom boot
4216 type flash chips the second sector can be used: the offset
4217 for this sector is given here.
4218
6d0f6bcf 4219 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
c609719b 4220
0e8d1586 4221 - CONFIG_ENV_ADDR:
c609719b
WD
4222
4223 This is just another way to specify the start address of
4224 the flash sector containing the environment (instead of
0e8d1586 4225 CONFIG_ENV_OFFSET).
c609719b 4226
0e8d1586 4227 - CONFIG_ENV_SECT_SIZE:
c609719b
WD
4228
4229 Size of the sector containing the environment.
4230
4231
4232 b) Sometimes flash chips have few, equal sized, BIG sectors.
4233 In such a case you don't want to spend a whole sector for
4234 the environment.
4235
0e8d1586 4236 - CONFIG_ENV_SIZE:
c609719b 4237
5a1aceb0 4238 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
0e8d1586 4239 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
c609719b
WD
4240 of this flash sector for the environment. This saves
4241 memory for the RAM copy of the environment.
4242
4243 It may also save flash memory if you decide to use this
4244 when your environment is "embedded" within U-Boot code,
4245 since then the remainder of the flash sector could be used
4246 for U-Boot code. It should be pointed out that this is
4247 STRONGLY DISCOURAGED from a robustness point of view:
4248 updating the environment in flash makes it always
4249 necessary to erase the WHOLE sector. If something goes
4250 wrong before the contents has been restored from a copy in
4251 RAM, your target system will be dead.
4252
0e8d1586
JCPV
4253 - CONFIG_ENV_ADDR_REDUND
4254 CONFIG_ENV_SIZE_REDUND
c609719b 4255
43d9616c 4256 These settings describe a second storage area used to hold
11ccc33f 4257 a redundant copy of the environment data, so that there is
3e38691e 4258 a valid backup copy in case there is a power failure during
43d9616c 4259 a "saveenv" operation.
c609719b
WD
4260
4261BE CAREFUL! Any changes to the flash layout, and some changes to the
4262source code will make it necessary to adapt <board>/u-boot.lds*
4263accordingly!
4264
4265
9314cee6 4266- CONFIG_ENV_IS_IN_NVRAM:
c609719b
WD
4267
4268 Define this if you have some non-volatile memory device
4269 (NVRAM, battery buffered SRAM) which you want to use for the
4270 environment.
4271
0e8d1586
JCPV
4272 - CONFIG_ENV_ADDR:
4273 - CONFIG_ENV_SIZE:
c609719b 4274
11ccc33f 4275 These two #defines are used to determine the memory area you
c609719b
WD
4276 want to use for environment. It is assumed that this memory
4277 can just be read and written to, without any special
4278 provision.
4279
4280BE CAREFUL! The first access to the environment happens quite early
b445bbb4 4281in U-Boot initialization (when we try to get the setting of for the
11ccc33f 4282console baudrate). You *MUST* have mapped your NVRAM area then, or
c609719b
WD
4283U-Boot will hang.
4284
4285Please note that even with NVRAM we still use a copy of the
4286environment in RAM: we could work on NVRAM directly, but we want to
4287keep settings there always unmodified except somebody uses "saveenv"
4288to save the current settings.
4289
4290
bb1f8b4f 4291- CONFIG_ENV_IS_IN_EEPROM:
c609719b
WD
4292
4293 Use this if you have an EEPROM or similar serial access
4294 device and a driver for it.
4295
0e8d1586
JCPV
4296 - CONFIG_ENV_OFFSET:
4297 - CONFIG_ENV_SIZE:
c609719b
WD
4298
4299 These two #defines specify the offset and size of the
4300 environment area within the total memory of your EEPROM.
4301
6d0f6bcf 4302 - CONFIG_SYS_I2C_EEPROM_ADDR:
c609719b
WD
4303 If defined, specified the chip address of the EEPROM device.
4304 The default address is zero.
4305
189d257b
CG
4306 - CONFIG_SYS_I2C_EEPROM_BUS:
4307 If defined, specified the i2c bus of the EEPROM device.
4308
6d0f6bcf 4309 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
c609719b
WD
4310 If defined, the number of bits used to address bytes in a
4311 single page in the EEPROM device. A 64 byte page, for example
4312 would require six bits.
4313
6d0f6bcf 4314 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
c609719b 4315 If defined, the number of milliseconds to delay between
ba56f625 4316 page writes. The default is zero milliseconds.
c609719b 4317
6d0f6bcf 4318 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
c609719b
WD
4319 The length in bytes of the EEPROM memory array address. Note
4320 that this is NOT the chip address length!
4321
6d0f6bcf 4322 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
5cf91d6b
WD
4323 EEPROM chips that implement "address overflow" are ones
4324 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4325 address and the extra bits end up in the "chip address" bit
4326 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4327 byte chips.
4328
4329 Note that we consider the length of the address field to
4330 still be one byte because the extra address bits are hidden
4331 in the chip address.
4332
6d0f6bcf 4333 - CONFIG_SYS_EEPROM_SIZE:
c609719b
WD
4334 The size in bytes of the EEPROM device.
4335
548738b4
HS
4336 - CONFIG_ENV_EEPROM_IS_ON_I2C
4337 define this, if you have I2C and SPI activated, and your
4338 EEPROM, which holds the environment, is on the I2C bus.
4339
4340 - CONFIG_I2C_ENV_EEPROM_BUS
4341 if you have an Environment on an EEPROM reached over
4342 I2C muxes, you can define here, how to reach this
4343 EEPROM. For example:
4344
ea818dbb 4345 #define CONFIG_I2C_ENV_EEPROM_BUS 1
548738b4
HS
4346
4347 EEPROM which holds the environment, is reached over
4348 a pca9547 i2c mux with address 0x70, channel 3.
c609719b 4349
057c849c 4350- CONFIG_ENV_IS_IN_DATAFLASH:
5779d8d9 4351
d4ca31c4 4352 Define this if you have a DataFlash memory device which you
5779d8d9
WD
4353 want to use for the environment.
4354
0e8d1586
JCPV
4355 - CONFIG_ENV_OFFSET:
4356 - CONFIG_ENV_ADDR:
4357 - CONFIG_ENV_SIZE:
5779d8d9
WD
4358
4359 These three #defines specify the offset and size of the
4360 environment area within the total memory of your DataFlash placed
4361 at the specified address.
4362
bd83b592
WJ
4363- CONFIG_ENV_IS_IN_SPI_FLASH:
4364
4365 Define this if you have a SPI Flash memory device which you
4366 want to use for the environment.
4367
4368 - CONFIG_ENV_OFFSET:
4369 - CONFIG_ENV_SIZE:
4370
4371 These two #defines specify the offset and size of the
4372 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4373 aligned to an erase sector boundary.
4374
4375 - CONFIG_ENV_SECT_SIZE:
4376
4377 Define the SPI flash's sector size.
4378
4379 - CONFIG_ENV_OFFSET_REDUND (optional):
4380
4381 This setting describes a second storage area of CONFIG_ENV_SIZE
4382 size used to hold a redundant copy of the environment data, so
4383 that there is a valid backup copy in case there is a power failure
4384 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4385 aligned to an erase sector boundary.
4386
4387 - CONFIG_ENV_SPI_BUS (optional):
4388 - CONFIG_ENV_SPI_CS (optional):
4389
4390 Define the SPI bus and chip select. If not defined they will be 0.
4391
4392 - CONFIG_ENV_SPI_MAX_HZ (optional):
4393
4394 Define the SPI max work clock. If not defined then use 1MHz.
4395
4396 - CONFIG_ENV_SPI_MODE (optional):
4397
4398 Define the SPI work mode. If not defined then use SPI_MODE_3.
4399
0a85a9e7
LG
4400- CONFIG_ENV_IS_IN_REMOTE:
4401
4402 Define this if you have a remote memory space which you
4403 want to use for the local device's environment.
4404
4405 - CONFIG_ENV_ADDR:
4406 - CONFIG_ENV_SIZE:
4407
4408 These two #defines specify the address and size of the
4409 environment area within the remote memory space. The
4410 local device can get the environment from remote memory
fc54c7fa 4411 space by SRIO or PCIE links.
0a85a9e7
LG
4412
4413BE CAREFUL! For some special cases, the local device can not use
4414"saveenv" command. For example, the local device will get the
fc54c7fa
LG
4415environment stored in a remote NOR flash by SRIO or PCIE link,
4416but it can not erase, write this NOR flash by SRIO or PCIE interface.
0a85a9e7 4417
51bfee19 4418- CONFIG_ENV_IS_IN_NAND:
13a5695b
WD
4419
4420 Define this if you have a NAND device which you want to use
4421 for the environment.
4422
0e8d1586
JCPV
4423 - CONFIG_ENV_OFFSET:
4424 - CONFIG_ENV_SIZE:
13a5695b
WD
4425
4426 These two #defines specify the offset and size of the environment
fdd813de
SW
4427 area within the first NAND device. CONFIG_ENV_OFFSET must be
4428 aligned to an erase block boundary.
5779d8d9 4429
fdd813de 4430 - CONFIG_ENV_OFFSET_REDUND (optional):
e443c944 4431
0e8d1586 4432 This setting describes a second storage area of CONFIG_ENV_SIZE
fdd813de
SW
4433 size used to hold a redundant copy of the environment data, so
4434 that there is a valid backup copy in case there is a power failure
c0f40859 4435 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
fdd813de
SW
4436 aligned to an erase block boundary.
4437
4438 - CONFIG_ENV_RANGE (optional):
4439
4440 Specifies the length of the region in which the environment
4441 can be written. This should be a multiple of the NAND device's
4442 block size. Specifying a range with more erase blocks than
4443 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4444 the range to be avoided.
4445
4446 - CONFIG_ENV_OFFSET_OOB (optional):
4447
4448 Enables support for dynamically retrieving the offset of the
4449 environment from block zero's out-of-band data. The
4450 "nand env.oob" command can be used to record this offset.
4451 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4452 using CONFIG_ENV_OFFSET_OOB.
e443c944 4453
b74ab737
GL
4454- CONFIG_NAND_ENV_DST
4455
4456 Defines address in RAM to which the nand_spl code should copy the
4457 environment. If redundant environment is used, it will be copied to
4458 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4459
2b74433f
JH
4460- CONFIG_ENV_IS_IN_UBI:
4461
4462 Define this if you have an UBI volume that you want to use for the
4463 environment. This has the benefit of wear-leveling the environment
4464 accesses, which is important on NAND.
4465
4466 - CONFIG_ENV_UBI_PART:
4467
4468 Define this to a string that is the mtd partition containing the UBI.
4469
4470 - CONFIG_ENV_UBI_VOLUME:
4471
4472 Define this to the name of the volume that you want to store the
4473 environment in.
4474
785881f7
JH
4475 - CONFIG_ENV_UBI_VOLUME_REDUND:
4476
4477 Define this to the name of another volume to store a second copy of
4478 the environment in. This will enable redundant environments in UBI.
4479 It is assumed that both volumes are in the same MTD partition.
4480
2b74433f
JH
4481 - CONFIG_UBI_SILENCE_MSG
4482 - CONFIG_UBIFS_SILENCE_MSG
4483
4484 You will probably want to define these to avoid a really noisy system
4485 when storing the env in UBI.
4486
d1db76f1
WJ
4487- CONFIG_ENV_IS_IN_FAT:
4488 Define this if you want to use the FAT file system for the environment.
4489
4490 - FAT_ENV_INTERFACE:
4491
4492 Define this to a string that is the name of the block device.
4493
4494 - FAT_ENV_DEV_AND_PART:
4495
4496 Define this to a string to specify the partition of the device. It can
4497 be as following:
4498
4499 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4500 - "D:P": device D partition P. Error occurs if device D has no
4501 partition table.
4502 - "D:0": device D.
4503 - "D" or "D:": device D partition 1 if device D has partition
4504 table, or the whole device D if has no partition
4505 table.
4506 - "D:auto": first partition in device D with bootable flag set.
b445bbb4 4507 If none, first valid partition in device D. If no
d1db76f1
WJ
4508 partition table then means device D.
4509
4510 - FAT_ENV_FILE:
4511
4512 It's a string of the FAT file name. This file use to store the
b445bbb4 4513 environment.
d1db76f1
WJ
4514
4515 - CONFIG_FAT_WRITE:
b445bbb4 4516 This should be defined. Otherwise it cannot save the environment file.
d1db76f1 4517
06e4ae5f
SW
4518- CONFIG_ENV_IS_IN_MMC:
4519
4520 Define this if you have an MMC device which you want to use for the
4521 environment.
4522
4523 - CONFIG_SYS_MMC_ENV_DEV:
4524
4525 Specifies which MMC device the environment is stored in.
4526
4527 - CONFIG_SYS_MMC_ENV_PART (optional):
4528
4529 Specifies which MMC partition the environment is stored in. If not
4530 set, defaults to partition 0, the user area. Common values might be
4531 1 (first MMC boot partition), 2 (second MMC boot partition).
4532
4533 - CONFIG_ENV_OFFSET:
4534 - CONFIG_ENV_SIZE:
4535
4536 These two #defines specify the offset and size of the environment
4537 area within the specified MMC device.
4538
5c088ee8
SW
4539 If offset is positive (the usual case), it is treated as relative to
4540 the start of the MMC partition. If offset is negative, it is treated
4541 as relative to the end of the MMC partition. This can be useful if
4542 your board may be fitted with different MMC devices, which have
4543 different sizes for the MMC partitions, and you always want the
4544 environment placed at the very end of the partition, to leave the
4545 maximum possible space before it, to store other data.
4546
06e4ae5f
SW
4547 These two values are in units of bytes, but must be aligned to an
4548 MMC sector boundary.
4549
4550 - CONFIG_ENV_OFFSET_REDUND (optional):
4551
4552 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4553 hold a redundant copy of the environment data. This provides a
4554 valid backup copy in case the other copy is corrupted, e.g. due
4555 to a power failure during a "saveenv" operation.
4556
5c088ee8
SW
4557 This value may also be positive or negative; this is handled in the
4558 same way as CONFIG_ENV_OFFSET.
4559
06e4ae5f
SW
4560 This value is also in units of bytes, but must also be aligned to
4561 an MMC sector boundary.
4562
4563 - CONFIG_ENV_SIZE_REDUND (optional):
4564
4565 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4566 set. If this value is set, it must be set to the same value as
4567 CONFIG_ENV_SIZE.
4568
6d0f6bcf 4569- CONFIG_SYS_SPI_INIT_OFFSET
c609719b
WD
4570
4571 Defines offset to the initial SPI buffer area in DPRAM. The
4572 area is used at an early stage (ROM part) if the environment
4573 is configured to reside in the SPI EEPROM: We need a 520 byte
4574 scratch DPRAM area. It is used between the two initialization
4575 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4576 to be a good choice since it makes it far enough from the
4577 start of the data area as well as from the stack pointer.
4578
e881cb56 4579Please note that the environment is read-only until the monitor
c609719b 4580has been relocated to RAM and a RAM copy of the environment has been
cdb74977 4581created; also, when using EEPROM you will have to use getenv_f()
c609719b
WD
4582until then to read environment variables.
4583
85ec0bcc
WD
4584The environment is protected by a CRC32 checksum. Before the monitor
4585is relocated into RAM, as a result of a bad CRC you will be working
4586with the compiled-in default environment - *silently*!!! [This is
4587necessary, because the first environment variable we need is the
4588"baudrate" setting for the console - if we have a bad CRC, we don't
4589have any device yet where we could complain.]
c609719b
WD
4590
4591Note: once the monitor has been relocated, then it will complain if
4592the default environment is used; a new CRC is computed as soon as you
85ec0bcc 4593use the "saveenv" command to store a valid environment.
c609719b 4594
6d0f6bcf 4595- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
42d1f039 4596 Echo the inverted Ethernet link state to the fault LED.
fc3e2165 4597
6d0f6bcf 4598 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
fc3e2165
WD
4599 also needs to be defined.
4600
6d0f6bcf 4601- CONFIG_SYS_FAULT_MII_ADDR:
42d1f039 4602 MII address of the PHY to check for the Ethernet link state.
c609719b 4603
f5675aa5
RM
4604- CONFIG_NS16550_MIN_FUNCTIONS:
4605 Define this if you desire to only have use of the NS16550_init
4606 and NS16550_putc functions for the serial driver located at
4607 drivers/serial/ns16550.c. This option is useful for saving
4608 space for already greatly restricted images, including but not
4609 limited to NAND_SPL configurations.
4610
b2b92f53
SG
4611- CONFIG_DISPLAY_BOARDINFO
4612 Display information about the board that U-Boot is running on
4613 when U-Boot starts up. The board function checkboard() is called
4614 to do this.
4615
e2e3e2b1
SG
4616- CONFIG_DISPLAY_BOARDINFO_LATE
4617 Similar to the previous option, but display this information
4618 later, once stdio is running and output goes to the LCD, if
4619 present.
4620
feb85801
SS
4621- CONFIG_BOARD_SIZE_LIMIT:
4622 Maximum size of the U-Boot image. When defined, the
4623 build system checks that the actual size does not
4624 exceed it.
4625
c609719b 4626Low Level (hardware related) configuration options:
dc7c9a1a 4627---------------------------------------------------
c609719b 4628
6d0f6bcf 4629- CONFIG_SYS_CACHELINE_SIZE:
c609719b
WD
4630 Cache Line Size of the CPU.
4631
6d0f6bcf 4632- CONFIG_SYS_DEFAULT_IMMR:
c609719b 4633 Default address of the IMMR after system reset.
2535d602 4634
42d1f039
WD
4635 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4636 and RPXsuper) to be able to adjust the position of
4637 the IMMR register after a reset.
c609719b 4638
e46fedfe
TT
4639- CONFIG_SYS_CCSRBAR_DEFAULT:
4640 Default (power-on reset) physical address of CCSR on Freescale
4641 PowerPC SOCs.
4642
4643- CONFIG_SYS_CCSRBAR:
4644 Virtual address of CCSR. On a 32-bit build, this is typically
4645 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4646
4647 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4648 for cross-platform code that uses that macro instead.
4649
4650- CONFIG_SYS_CCSRBAR_PHYS:
4651 Physical address of CCSR. CCSR can be relocated to a new
4652 physical address, if desired. In this case, this macro should
c0f40859 4653 be set to that address. Otherwise, it should be set to the
e46fedfe
TT
4654 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4655 is typically relocated on 36-bit builds. It is recommended
4656 that this macro be defined via the _HIGH and _LOW macros:
4657
4658 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4659 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4660
4661- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4cf2609b
WD
4662 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4663 either 0 (32-bit build) or 0xF (36-bit build). This macro is
e46fedfe
TT
4664 used in assembly code, so it must not contain typecasts or
4665 integer size suffixes (e.g. "ULL").
4666
4667- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4668 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4669 used in assembly code, so it must not contain typecasts or
4670 integer size suffixes (e.g. "ULL").
4671
4672- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4673 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4674 forced to a value that ensures that CCSR is not relocated.
4675
7f6c2cbc 4676- Floppy Disk Support:
6d0f6bcf 4677 CONFIG_SYS_FDC_DRIVE_NUMBER
7f6c2cbc
WD
4678
4679 the default drive number (default value 0)
4680
6d0f6bcf 4681 CONFIG_SYS_ISA_IO_STRIDE
7f6c2cbc 4682
11ccc33f 4683 defines the spacing between FDC chipset registers
7f6c2cbc
WD
4684 (default value 1)
4685
6d0f6bcf 4686 CONFIG_SYS_ISA_IO_OFFSET
7f6c2cbc 4687
43d9616c
WD
4688 defines the offset of register from address. It
4689 depends on which part of the data bus is connected to
11ccc33f 4690 the FDC chipset. (default value 0)
7f6c2cbc 4691
6d0f6bcf
JCPV
4692 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4693 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
43d9616c 4694 default value.
7f6c2cbc 4695
6d0f6bcf 4696 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43d9616c
WD
4697 fdc_hw_init() is called at the beginning of the FDC
4698 setup. fdc_hw_init() must be provided by the board
b445bbb4 4699 source code. It is used to make hardware-dependent
43d9616c 4700 initializations.
7f6c2cbc 4701
0abddf82
ML
4702- CONFIG_IDE_AHB:
4703 Most IDE controllers were designed to be connected with PCI
4704 interface. Only few of them were designed for AHB interface.
4705 When software is doing ATA command and data transfer to
4706 IDE devices through IDE-AHB controller, some additional
4707 registers accessing to these kind of IDE-AHB controller
b445bbb4 4708 is required.
0abddf82 4709
6d0f6bcf 4710- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
efe2a4d5 4711 DO NOT CHANGE unless you know exactly what you're
25d6712a 4712 doing! (11-4) [MPC8xx/82xx systems only]
c609719b 4713
6d0f6bcf 4714- CONFIG_SYS_INIT_RAM_ADDR:
c609719b 4715
7152b1d0 4716 Start address of memory area that can be used for
c609719b
WD
4717 initial data and stack; please note that this must be
4718 writable memory that is working WITHOUT special
4719 initialization, i. e. you CANNOT use normal RAM which
4720 will become available only after programming the
4721 memory controller and running certain initialization
4722 sequences.
4723
4724 U-Boot uses the following memory types:
4725 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4726 - MPC824X: data cache
4727 - PPC4xx: data cache
4728
6d0f6bcf 4729- CONFIG_SYS_GBL_DATA_OFFSET:
c609719b
WD
4730
4731 Offset of the initial data structure in the memory
6d0f6bcf
JCPV
4732 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4733 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
c609719b 4734 data is located at the end of the available space
553f0982 4735 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
6d0f6bcf
JCPV
4736 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4737 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4738 CONFIG_SYS_GBL_DATA_OFFSET) downward.
c609719b
WD
4739
4740 Note:
4741 On the MPC824X (or other systems that use the data
4742 cache for initial memory) the address chosen for
6d0f6bcf 4743 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
c609719b
WD
4744 point to an otherwise UNUSED address space between
4745 the top of RAM and the start of the PCI space.
4746
6d0f6bcf 4747- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
c609719b 4748
6d0f6bcf 4749- CONFIG_SYS_SYPCR: System Protection Control (11-9)
c609719b 4750
6d0f6bcf 4751- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
c609719b 4752
6d0f6bcf 4753- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
c609719b 4754
6d0f6bcf 4755- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
c609719b 4756
6d0f6bcf 4757- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
c609719b 4758
6d0f6bcf 4759- CONFIG_SYS_OR_TIMING_SDRAM:
c609719b
WD
4760 SDRAM timing
4761
6d0f6bcf 4762- CONFIG_SYS_MAMR_PTA:
c609719b
WD
4763 periodic timer for refresh
4764
6d0f6bcf 4765- CONFIG_SYS_DER: Debug Event Register (37-47)
c609719b 4766
6d0f6bcf
JCPV
4767- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4768 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4769 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4770 CONFIG_SYS_BR1_PRELIM:
c609719b
WD
4771 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4772
4773- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
6d0f6bcf
JCPV
4774 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4775 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
c609719b
WD
4776 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4777
6d0f6bcf
JCPV
4778- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4779 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
c609719b
WD
4780 Machine Mode Register and Memory Periodic Timer
4781 Prescaler definitions (SDRAM timing)
4782
6d0f6bcf 4783- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
c609719b
WD
4784 enable I2C microcode relocation patch (MPC8xx);
4785 define relocation offset in DPRAM [DSP2]
4786
6d0f6bcf 4787- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
b423d055
HS
4788 enable SMC microcode relocation patch (MPC8xx);
4789 define relocation offset in DPRAM [SMC1]
4790
6d0f6bcf 4791- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
c609719b
WD
4792 enable SPI microcode relocation patch (MPC8xx);
4793 define relocation offset in DPRAM [SCC4]
4794
6d0f6bcf 4795- CONFIG_SYS_USE_OSCCLK:
c609719b
WD
4796 Use OSCM clock mode on MBX8xx board. Be careful,
4797 wrong setting might damage your board. Read
4798 doc/README.MBX before setting this variable!
4799
6d0f6bcf 4800- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
43d9616c
WD
4801 Offset of the bootmode word in DPRAM used by post
4802 (Power On Self Tests). This definition overrides
4803 #define'd default value in commproc.h resp.
4804 cpm_8260.h.
ea909b76 4805
6d0f6bcf
JCPV
4806- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4807 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4808 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4809 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4810 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4811 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4812 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4813 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
a47a12be 4814 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
5d232d0e 4815
9cacf4fc
DE
4816- CONFIG_PCI_DISABLE_PCIE:
4817 Disable PCI-Express on systems where it is supported but not
4818 required.
4819
69fd2d3b 4820- CONFIG_PCI_ENUM_ONLY
b445bbb4 4821 Only scan through and get the devices on the buses.
69fd2d3b
AS
4822 Don't do any setup work, presumably because someone or
4823 something has already done it, and we don't need to do it
4824 a second time. Useful for platforms that are pre-booted
4825 by coreboot or similar.
4826
842033e6
GJ
4827- CONFIG_PCI_INDIRECT_BRIDGE:
4828 Enable support for indirect PCI bridges.
4829
a09b9b68
KG
4830- CONFIG_SYS_SRIO:
4831 Chip has SRIO or not
4832
4833- CONFIG_SRIO1:
4834 Board has SRIO 1 port available
4835
4836- CONFIG_SRIO2:
4837 Board has SRIO 2 port available
4838
c8b28152
LG
4839- CONFIG_SRIO_PCIE_BOOT_MASTER
4840 Board can support master function for Boot from SRIO and PCIE
4841
a09b9b68
KG
4842- CONFIG_SYS_SRIOn_MEM_VIRT:
4843 Virtual Address of SRIO port 'n' memory region
4844
4845- CONFIG_SYS_SRIOn_MEM_PHYS:
4846 Physical Address of SRIO port 'n' memory region
4847
4848- CONFIG_SYS_SRIOn_MEM_SIZE:
4849 Size of SRIO port 'n' memory region
4850
66bd1846
FE
4851- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4852 Defined to tell the NAND controller that the NAND chip is using
4853 a 16 bit bus.
4854 Not all NAND drivers use this symbol.
a430e916 4855 Example of drivers that use it:
66bd1846 4856 - drivers/mtd/nand/ndfc.c
a430e916 4857 - drivers/mtd/nand/mxc_nand.c
eced4626
AW
4858
4859- CONFIG_SYS_NDFC_EBC0_CFG
4860 Sets the EBC0_CFG register for the NDFC. If not defined
4861 a default value will be used.
4862
bb99ad6d 4863- CONFIG_SPD_EEPROM
218ca724
WD
4864 Get DDR timing information from an I2C EEPROM. Common
4865 with pluggable memory modules such as SODIMMs
4866
bb99ad6d
BW
4867 SPD_EEPROM_ADDRESS
4868 I2C address of the SPD EEPROM
4869
6d0f6bcf 4870- CONFIG_SYS_SPD_BUS_NUM
218ca724
WD
4871 If SPD EEPROM is on an I2C bus other than the first
4872 one, specify here. Note that the value must resolve
4873 to something your driver can deal with.
bb99ad6d 4874
1b3e3c4f
YS
4875- CONFIG_SYS_DDR_RAW_TIMING
4876 Get DDR timing information from other than SPD. Common with
4877 soldered DDR chips onboard without SPD. DDR raw timing
4878 parameters are extracted from datasheet and hard-coded into
4879 header files or board specific files.
4880
6f5e1dc5
YS
4881- CONFIG_FSL_DDR_INTERACTIVE
4882 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4883
e32d59a2
YS
4884- CONFIG_FSL_DDR_SYNC_REFRESH
4885 Enable sync of refresh for multiple controllers.
4886
6d0f6bcf 4887- CONFIG_SYS_83XX_DDR_USES_CS0
218ca724
WD
4888 Only for 83xx systems. If specified, then DDR should
4889 be configured using CS0 and CS1 instead of CS2 and CS3.
2ad6b513 4890
c26e454d
WD
4891- CONFIG_ETHER_ON_FEC[12]
4892 Define to enable FEC[12] on a 8xx series processor.
4893
4894- CONFIG_FEC[12]_PHY
4895 Define to the hardcoded PHY address which corresponds
6e592385
WD
4896 to the given FEC; i. e.
4897 #define CONFIG_FEC1_PHY 4
c26e454d
WD
4898 means that the PHY with address 4 is connected to FEC1
4899
4900 When set to -1, means to probe for first available.
4901
4902- CONFIG_FEC[12]_PHY_NORXERR
4903 The PHY does not have a RXERR line (RMII only).
4904 (so program the FEC to ignore it).
4905
4906- CONFIG_RMII
4907 Enable RMII mode for all FECs.
4908 Note that this is a global option, we can't
4909 have one FEC in standard MII mode and another in RMII mode.
4910
5cf91d6b
WD
4911- CONFIG_CRC32_VERIFY
4912 Add a verify option to the crc32 command.
4913 The syntax is:
4914
4915 => crc32 -v <address> <count> <crc32>
4916
4917 Where address/count indicate a memory area
4918 and crc32 is the correct crc32 which the
4919 area should have.
4920
56523f12
WD
4921- CONFIG_LOOPW
4922 Add the "loopw" memory command. This only takes effect if
602ad3b3 4923 the memory commands are activated globally (CONFIG_CMD_MEM).
56523f12 4924
7b466641
SR
4925- CONFIG_MX_CYCLIC
4926 Add the "mdc" and "mwc" memory commands. These are cyclic
4927 "md/mw" commands.
4928 Examples:
4929
efe2a4d5 4930 => mdc.b 10 4 500
7b466641
SR
4931 This command will print 4 bytes (10,11,12,13) each 500 ms.
4932
efe2a4d5 4933 => mwc.l 100 12345678 10
7b466641
SR
4934 This command will write 12345678 to address 100 all 10 ms.
4935
efe2a4d5 4936 This only takes effect if the memory commands are activated
602ad3b3 4937 globally (CONFIG_CMD_MEM).
7b466641 4938
8aa1a2d1 4939- CONFIG_SKIP_LOWLEVEL_INIT
afc1ce82 4940 [ARM, NDS32, MIPS only] If this variable is defined, then certain
844f07d8
WD
4941 low level initializations (like setting up the memory
4942 controller) are omitted and/or U-Boot does not
4943 relocate itself into RAM.
4944
4945 Normally this variable MUST NOT be defined. The only
4946 exception is when U-Boot is loaded (to RAM) by some
4947 other boot loader or by a debugger which performs
4948 these initializations itself.
8aa1a2d1 4949
401bb30b 4950- CONFIG_SPL_BUILD
df81238b
ML
4951 Modifies the behaviour of start.S when compiling a loader
4952 that is executed before the actual U-Boot. E.g. when
4953 compiling a NAND SPL.
400558b5 4954
3aa29de0
YZ
4955- CONFIG_TPL_BUILD
4956 Modifies the behaviour of start.S when compiling a loader
4957 that is executed after the SPL and before the actual U-Boot.
4958 It is loaded by the SPL.
4959
5df572f0
YZ
4960- CONFIG_SYS_MPC85XX_NO_RESETVEC
4961 Only for 85xx systems. If this variable is specified, the section
4962 .resetvec is not kept and the section .bootpg is placed in the
4963 previous 4k of the .text section.
4964
4213fc29
SG
4965- CONFIG_ARCH_MAP_SYSMEM
4966 Generally U-Boot (and in particular the md command) uses
4967 effective address. It is therefore not necessary to regard
4968 U-Boot address as virtual addresses that need to be translated
4969 to physical addresses. However, sandbox requires this, since
4970 it maintains its own little RAM buffer which contains all
4971 addressable memory. This option causes some memory accesses
4972 to be mapped through map_sysmem() / unmap_sysmem().
4973
d8834a13
MW
4974- CONFIG_USE_ARCH_MEMCPY
4975 CONFIG_USE_ARCH_MEMSET
4976 If these options are used a optimized version of memcpy/memset will
4977 be used if available. These functions may be faster under some
4978 conditions but may increase the binary size.
4979
588a13f7
SG
4980- CONFIG_X86_RESET_VECTOR
4981 If defined, the x86 reset vector code is included. This is not
4982 needed when U-Boot is running from Coreboot.
b16f521a 4983
fc33705e
MJ
4984- CONFIG_SYS_MPUCLK
4985 Defines the MPU clock speed (in MHz).
4986
4987 NOTE : currently only supported on AM335x platforms.
5b5ece9e 4988
16678eb4
HS
4989- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4990 Enables the RTC32K OSC on AM33xx based plattforms
4991
999d7d32
KM
4992- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4993 Option to disable subpage write in NAND driver
4994 driver that uses this:
4995 drivers/mtd/nand/davinci_nand.c
4996
f2717b47
TT
4997Freescale QE/FMAN Firmware Support:
4998-----------------------------------
4999
5000The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
5001loading of "firmware", which is encoded in the QE firmware binary format.
5002This firmware often needs to be loaded during U-Boot booting, so macros
5003are used to identify the storage device (NOR flash, SPI, etc) and the address
5004within that device.
5005
dcf1d774
ZQ
5006- CONFIG_SYS_FMAN_FW_ADDR
5007 The address in the storage device where the FMAN microcode is located. The
5008 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5009 is also specified.
5010
5011- CONFIG_SYS_QE_FW_ADDR
5012 The address in the storage device where the QE microcode is located. The
f2717b47
TT
5013 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
5014 is also specified.
5015
5016- CONFIG_SYS_QE_FMAN_FW_LENGTH
5017 The maximum possible size of the firmware. The firmware binary format
5018 has a field that specifies the actual size of the firmware, but it
5019 might not be possible to read any part of the firmware unless some
5020 local storage is allocated to hold the entire firmware first.
5021
5022- CONFIG_SYS_QE_FMAN_FW_IN_NOR
5023 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
5024 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
5025 virtual address in NOR flash.
5026
5027- CONFIG_SYS_QE_FMAN_FW_IN_NAND
5028 Specifies that QE/FMAN firmware is located in NAND flash.
5029 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
5030
5031- CONFIG_SYS_QE_FMAN_FW_IN_MMC
5032 Specifies that QE/FMAN firmware is located on the primary SD/MMC
5033 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5034
5035- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
5036 Specifies that QE/FMAN firmware is located on the primary SPI
5037 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
5038
292dc6c5
LG
5039- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
5040 Specifies that QE/FMAN firmware is located in the remote (master)
5041 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
fc54c7fa
LG
5042 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
5043 window->master inbound window->master LAW->the ucode address in
5044 master's memory space.
f2717b47 5045
b940ca64
GR
5046Freescale Layerscape Management Complex Firmware Support:
5047---------------------------------------------------------
5048The Freescale Layerscape Management Complex (MC) supports the loading of
5049"firmware".
5050This firmware often needs to be loaded during U-Boot booting, so macros
5051are used to identify the storage device (NOR flash, SPI, etc) and the address
5052within that device.
5053
5054- CONFIG_FSL_MC_ENET
5055 Enable the MC driver for Layerscape SoCs.
5056
5057- CONFIG_SYS_LS_MC_FW_ADDR
5058 The address in the storage device where the firmware is located. The
5059 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
5060 is also specified.
5061
5062- CONFIG_SYS_LS_MC_FW_LENGTH
5063 The maximum possible size of the firmware. The firmware binary format
5064 has a field that specifies the actual size of the firmware, but it
5065 might not be possible to read any part of the firmware unless some
5066 local storage is allocated to hold the entire firmware first.
5067
5068- CONFIG_SYS_LS_MC_FW_IN_NOR
5069 Specifies that MC firmware is located in NOR flash, mapped as
5070 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5071 virtual address in NOR flash.
5072
c609719b
WD
5073Building the Software:
5074======================
5075
218ca724
WD
5076Building U-Boot has been tested in several native build environments
5077and in many different cross environments. Of course we cannot support
5078all possibly existing versions of cross development tools in all
5079(potentially obsolete) versions. In case of tool chain problems we
5080recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5081which is extensively used to build and test U-Boot.
c609719b 5082
218ca724
WD
5083If you are not using a native environment, it is assumed that you
5084have GNU cross compiling tools available in your path. In this case,
5085you must set the environment variable CROSS_COMPILE in your shell.
5086Note that no changes to the Makefile or any other source files are
5087necessary. For example using the ELDK on a 4xx CPU, please enter:
c609719b 5088
218ca724
WD
5089 $ CROSS_COMPILE=ppc_4xx-
5090 $ export CROSS_COMPILE
c609719b 5091
2f8d396b
PT
5092Note: If you wish to generate Windows versions of the utilities in
5093 the tools directory you can use the MinGW toolchain
5094 (http://www.mingw.org). Set your HOST tools to the MinGW
5095 toolchain and execute 'make tools'. For example:
5096
5097 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5098
5099 Binaries such as tools/mkimage.exe will be created which can
5100 be executed on computers running Windows.
5101
218ca724
WD
5102U-Boot is intended to be simple to build. After installing the
5103sources you must configure U-Boot for one specific board type. This
c609719b
WD
5104is done by typing:
5105
ab584d67 5106 make NAME_defconfig
c609719b 5107
ab584d67 5108where "NAME_defconfig" is the name of one of the existing configu-
4d675ae6 5109rations; see boards.cfg for supported names.
db01a2ea 5110
2729af9d
WD
5111Note: for some board special configuration names may exist; check if
5112 additional information is available from the board vendor; for
5113 instance, the TQM823L systems are available without (standard)
5114 or with LCD support. You can select such additional "features"
11ccc33f 5115 when choosing the configuration, i. e.
2729af9d 5116
ab584d67 5117 make TQM823L_defconfig
2729af9d
WD
5118 - will configure for a plain TQM823L, i. e. no LCD support
5119
ab584d67 5120 make TQM823L_LCD_defconfig
2729af9d
WD
5121 - will configure for a TQM823L with U-Boot console on LCD
5122
5123 etc.
5124
5125
5126Finally, type "make all", and you should get some working U-Boot
5127images ready for download to / installation on your system:
5128
5129- "u-boot.bin" is a raw binary image
5130- "u-boot" is an image in ELF binary format
5131- "u-boot.srec" is in Motorola S-Record format
5132
baf31249
MB
5133By default the build is performed locally and the objects are saved
5134in the source directory. One of the two methods can be used to change
5135this behavior and build U-Boot to some external directory:
5136
51371. Add O= to the make command line invocations:
5138
5139 make O=/tmp/build distclean
ab584d67 5140 make O=/tmp/build NAME_defconfig
baf31249
MB
5141 make O=/tmp/build all
5142
adbba996 51432. Set environment variable KBUILD_OUTPUT to point to the desired location:
baf31249 5144
adbba996 5145 export KBUILD_OUTPUT=/tmp/build
baf31249 5146 make distclean
ab584d67 5147 make NAME_defconfig
baf31249
MB
5148 make all
5149
adbba996 5150Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
baf31249
MB
5151variable.
5152
2729af9d
WD
5153
5154Please be aware that the Makefiles assume you are using GNU make, so
5155for instance on NetBSD you might need to use "gmake" instead of
5156native "make".
5157
5158
5159If the system board that you have is not listed, then you will need
5160to port U-Boot to your hardware platform. To do this, follow these
5161steps:
5162
51631. Add a new configuration option for your board to the toplevel
4d675ae6
MJ
5164 "boards.cfg" file, using the existing entries as examples.
5165 Follow the instructions there to keep the boards in order.
2729af9d
WD
51662. Create a new directory to hold your board specific code. Add any
5167 files you need. In your board directory, you will need at least
5168 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51693. Create a new configuration file "include/configs/<board>.h" for
5170 your board
51713. If you're porting U-Boot to a new CPU, then also create a new
5172 directory to hold your CPU specific code. Add any files you need.
ab584d67 51734. Run "make <board>_defconfig" with your new name.
2729af9d
WD
51745. Type "make", and you should get a working "u-boot.srec" file
5175 to be installed on your target system.
51766. Debug and solve any problems that might arise.
5177 [Of course, this last step is much harder than it sounds.]
5178
5179
5180Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5181==============================================================
5182
218ca724
WD
5183If you have modified U-Boot sources (for instance added a new board
5184or support for new devices, a new CPU, etc.) you are expected to
2729af9d
WD
5185provide feedback to the other developers. The feedback normally takes
5186the form of a "patch", i. e. a context diff against a certain (latest
218ca724 5187official or latest in the git repository) version of U-Boot sources.
2729af9d 5188
218ca724
WD
5189But before you submit such a patch, please verify that your modifi-
5190cation did not break existing code. At least make sure that *ALL* of
2729af9d
WD
5191the supported boards compile WITHOUT ANY compiler warnings. To do so,
5192just run the "MAKEALL" script, which will configure and build U-Boot
218ca724
WD
5193for ALL supported system. Be warned, this will take a while. You can
5194select which (cross) compiler to use by passing a `CROSS_COMPILE'
5195environment variable to the script, i. e. to use the ELDK cross tools
5196you can type
2729af9d
WD
5197
5198 CROSS_COMPILE=ppc_8xx- MAKEALL
5199
5200or to build on a native PowerPC system you can type
5201
5202 CROSS_COMPILE=' ' MAKEALL
5203
218ca724
WD
5204When using the MAKEALL script, the default behaviour is to build
5205U-Boot in the source directory. This location can be changed by
5206setting the BUILD_DIR environment variable. Also, for each target
5207built, the MAKEALL script saves two log files (<target>.ERR and
5208<target>.MAKEALL) in the <source dir>/LOG directory. This default
5209location can be changed by setting the MAKEALL_LOGDIR environment
5210variable. For example:
baf31249
MB
5211
5212 export BUILD_DIR=/tmp/build
5213 export MAKEALL_LOGDIR=/tmp/log
5214 CROSS_COMPILE=ppc_8xx- MAKEALL
5215
218ca724
WD
5216With the above settings build objects are saved in the /tmp/build,
5217log files are saved in the /tmp/log and the source tree remains clean
5218during the whole build process.
baf31249
MB
5219
5220
2729af9d
WD
5221See also "U-Boot Porting Guide" below.
5222
5223
5224Monitor Commands - Overview:
5225============================
5226
5227go - start application at address 'addr'
5228run - run commands in an environment variable
5229bootm - boot application image from memory
5230bootp - boot image via network using BootP/TFTP protocol
44f074c7 5231bootz - boot zImage from memory
2729af9d
WD
5232tftpboot- boot image via network using TFTP protocol
5233 and env variables "ipaddr" and "serverip"
5234 (and eventually "gatewayip")
1fb7cd49 5235tftpput - upload a file via network using TFTP protocol
2729af9d
WD
5236rarpboot- boot image via network using RARP/TFTP protocol
5237diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5238loads - load S-Record file over serial line
5239loadb - load binary file over serial line (kermit mode)
5240md - memory display
5241mm - memory modify (auto-incrementing)
5242nm - memory modify (constant address)
5243mw - memory write (fill)
5244cp - memory copy
5245cmp - memory compare
5246crc32 - checksum calculation
0f89c54b 5247i2c - I2C sub-system
2729af9d
WD
5248sspi - SPI utility commands
5249base - print or set address offset
5250printenv- print environment variables
5251setenv - set environment variables
5252saveenv - save environment variables to persistent storage
5253protect - enable or disable FLASH write protection
5254erase - erase FLASH memory
5255flinfo - print FLASH memory information
10635afa 5256nand - NAND memory operations (see doc/README.nand)
2729af9d
WD
5257bdinfo - print Board Info structure
5258iminfo - print header information for application image
5259coninfo - print console devices and informations
5260ide - IDE sub-system
5261loop - infinite loop on address range
56523f12 5262loopw - infinite write loop on address range
2729af9d
WD
5263mtest - simple RAM test
5264icache - enable or disable instruction cache
5265dcache - enable or disable data cache
5266reset - Perform RESET of the CPU
5267echo - echo args to console
5268version - print monitor version
5269help - print online help
5270? - alias for 'help'
5271
5272
5273Monitor Commands - Detailed Description:
5274========================================
5275
5276TODO.
5277
5278For now: just type "help <command>".
5279
5280
5281Environment Variables:
5282======================
5283
5284U-Boot supports user configuration using Environment Variables which
5285can be made persistent by saving to Flash memory.
c609719b 5286
2729af9d
WD
5287Environment Variables are set using "setenv", printed using
5288"printenv", and saved to Flash using "saveenv". Using "setenv"
5289without a value can be used to delete a variable from the
5290environment. As long as you don't save the environment you are
5291working with an in-memory copy. In case the Flash area containing the
5292environment is erased by accident, a default environment is provided.
c609719b 5293
c96f86ee
WD
5294Some configuration options can be set using Environment Variables.
5295
5296List of environment variables (most likely not complete):
c609719b 5297
2729af9d 5298 baudrate - see CONFIG_BAUDRATE
c609719b 5299
2729af9d 5300 bootdelay - see CONFIG_BOOTDELAY
c609719b 5301
2729af9d 5302 bootcmd - see CONFIG_BOOTCOMMAND
4a6fd34b 5303
2729af9d 5304 bootargs - Boot arguments when booting an RTOS image
c609719b 5305
2729af9d 5306 bootfile - Name of the image to load with TFTP
c609719b 5307
7d721e34
BS
5308 bootm_low - Memory range available for image processing in the bootm
5309 command can be restricted. This variable is given as
5310 a hexadecimal number and defines lowest address allowed
5311 for use by the bootm command. See also "bootm_size"
5312 environment variable. Address defined by "bootm_low" is
5313 also the base of the initial memory mapping for the Linux
c3624e6e
GL
5314 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5315 bootm_mapsize.
5316
c0f40859 5317 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
c3624e6e
GL
5318 This variable is given as a hexadecimal number and it
5319 defines the size of the memory region starting at base
5320 address bootm_low that is accessible by the Linux kernel
5321 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5322 as the default value if it is defined, and bootm_size is
5323 used otherwise.
7d721e34
BS
5324
5325 bootm_size - Memory range available for image processing in the bootm
5326 command can be restricted. This variable is given as
5327 a hexadecimal number and defines the size of the region
5328 allowed for use by the bootm command. See also "bootm_low"
5329 environment variable.
5330
4bae9090
BS
5331 updatefile - Location of the software update file on a TFTP server, used
5332 by the automatic software update feature. Please refer to
5333 documentation in doc/README.update for more details.
5334
2729af9d
WD
5335 autoload - if set to "no" (any string beginning with 'n'),
5336 "bootp" will just load perform a lookup of the
5337 configuration from the BOOTP server, but not try to
5338 load any image using TFTP
c609719b 5339
2729af9d
WD
5340 autostart - if set to "yes", an image loaded using the "bootp",
5341 "rarpboot", "tftpboot" or "diskboot" commands will
5342 be automatically started (by internally calling
5343 "bootm")
38b99261 5344
2729af9d
WD
5345 If set to "no", a standalone image passed to the
5346 "bootm" command will be copied to the load address
5347 (and eventually uncompressed), but NOT be started.
5348 This can be used to load and uncompress arbitrary
5349 data.
c609719b 5350
a28afca5
DL
5351 fdt_high - if set this restricts the maximum address that the
5352 flattened device tree will be copied into upon boot.
fa34f6b2
SG
5353 For example, if you have a system with 1 GB memory
5354 at physical address 0x10000000, while Linux kernel
5355 only recognizes the first 704 MB as low memory, you
5356 may need to set fdt_high as 0x3C000000 to have the
5357 device tree blob be copied to the maximum address
5358 of the 704 MB low memory, so that Linux kernel can
5359 access it during the boot procedure.
5360
a28afca5
DL
5361 If this is set to the special value 0xFFFFFFFF then
5362 the fdt will not be copied at all on boot. For this
5363 to work it must reside in writable memory, have
5364 sufficient padding on the end of it for u-boot to
5365 add the information it needs into it, and the memory
5366 must be accessible by the kernel.
5367
eea63e05
SG
5368 fdtcontroladdr- if set this is the address of the control flattened
5369 device tree used by U-Boot when CONFIG_OF_CONTROL is
5370 defined.
5371
17ea1177
WD
5372 i2cfast - (PPC405GP|PPC405EP only)
5373 if set to 'y' configures Linux I2C driver for fast
5374 mode (400kHZ). This environment variable is used in
5375 initialization code. So, for changes to be effective
5376 it must be saved and board must be reset.
5377
2729af9d
WD
5378 initrd_high - restrict positioning of initrd images:
5379 If this variable is not set, initrd images will be
5380 copied to the highest possible address in RAM; this
5381 is usually what you want since it allows for
5382 maximum initrd size. If for some reason you want to
5383 make sure that the initrd image is loaded below the
6d0f6bcf 5384 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2729af9d
WD
5385 variable to a value of "no" or "off" or "0".
5386 Alternatively, you can set it to a maximum upper
5387 address to use (U-Boot will still check that it
5388 does not overwrite the U-Boot stack and data).
c609719b 5389
2729af9d
WD
5390 For instance, when you have a system with 16 MB
5391 RAM, and want to reserve 4 MB from use by Linux,
5392 you can do this by adding "mem=12M" to the value of
5393 the "bootargs" variable. However, now you must make
5394 sure that the initrd image is placed in the first
5395 12 MB as well - this can be done with
c609719b 5396
2729af9d 5397 setenv initrd_high 00c00000
c609719b 5398
2729af9d
WD
5399 If you set initrd_high to 0xFFFFFFFF, this is an
5400 indication to U-Boot that all addresses are legal
5401 for the Linux kernel, including addresses in flash
5402 memory. In this case U-Boot will NOT COPY the
5403 ramdisk at all. This may be useful to reduce the
5404 boot time on your system, but requires that this
5405 feature is supported by your Linux kernel.
c609719b 5406
2729af9d 5407 ipaddr - IP address; needed for tftpboot command
c609719b 5408
2729af9d
WD
5409 loadaddr - Default load address for commands like "bootp",
5410 "rarpboot", "tftpboot", "loadb" or "diskboot"
c609719b 5411
2729af9d 5412 loads_echo - see CONFIG_LOADS_ECHO
a3d991bd 5413
2729af9d 5414 serverip - TFTP server IP address; needed for tftpboot command
a3d991bd 5415
2729af9d 5416 bootretry - see CONFIG_BOOT_RETRY_TIME
a3d991bd 5417
2729af9d 5418 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
a3d991bd 5419
2729af9d 5420 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
c609719b 5421
e2a53458 5422 ethprime - controls which interface is used first.
c609719b 5423
e2a53458
MF
5424 ethact - controls which interface is currently active.
5425 For example you can do the following
c609719b 5426
48690d80
HS
5427 => setenv ethact FEC
5428 => ping 192.168.0.1 # traffic sent on FEC
5429 => setenv ethact SCC
5430 => ping 10.0.0.1 # traffic sent on SCC
c609719b 5431
e1692577
MF
5432 ethrotate - When set to "no" U-Boot does not go through all
5433 available network interfaces.
5434 It just stays at the currently selected interface.
5435
c96f86ee 5436 netretry - When set to "no" each network operation will
2729af9d
WD
5437 either succeed or fail without retrying.
5438 When set to "once" the network operation will
5439 fail when all the available network interfaces
5440 are tried once without success.
5441 Useful on scripts which control the retry operation
5442 themselves.
c609719b 5443
b4e2f89d 5444 npe_ucode - set load address for the NPE microcode
a1cf027a 5445
b445bbb4 5446 silent_linux - If set then Linux will be told to boot silently, by
8d51aacd
SG
5447 changing the console to be empty. If "yes" it will be
5448 made silent. If "no" it will not be made silent. If
5449 unset, then it will be made silent if the U-Boot console
5450 is silent.
5451
28cb9375 5452 tftpsrcport - If this is set, the value is used for TFTP's
ecb0ccd9
WD
5453 UDP source port.
5454
28cb9375
WD
5455 tftpdstport - If this is set, the value is used for TFTP's UDP
5456 destination port instead of the Well Know Port 69.
5457
c96f86ee
WD
5458 tftpblocksize - Block size to use for TFTP transfers; if not set,
5459 we use the TFTP server's default block size
5460
5461 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5462 seconds, minimum value is 1000 = 1 second). Defines
5463 when a packet is considered to be lost so it has to
5464 be retransmitted. The default is 5000 = 5 seconds.
5465 Lowering this value may make downloads succeed
5466 faster in networks with high packet loss rates or
5467 with unreliable TFTP servers.
5468
5469 vlan - When set to a value < 4095 the traffic over
11ccc33f 5470 Ethernet is encapsulated/received over 802.1q
2729af9d 5471 VLAN tagged frames.
c609719b 5472
dc0b7b0e
JH
5473The following image location variables contain the location of images
5474used in booting. The "Image" column gives the role of the image and is
5475not an environment variable name. The other columns are environment
5476variable names. "File Name" gives the name of the file on a TFTP
5477server, "RAM Address" gives the location in RAM the image will be
5478loaded to, and "Flash Location" gives the image's address in NOR
5479flash or offset in NAND flash.
5480
5481*Note* - these variables don't have to be defined for all boards, some
5482boards currenlty use other variables for these purposes, and some
5483boards use these variables for other purposes.
5484
c0f40859
WD
5485Image File Name RAM Address Flash Location
5486----- --------- ----------- --------------
5487u-boot u-boot u-boot_addr_r u-boot_addr
5488Linux kernel bootfile kernel_addr_r kernel_addr
5489device tree blob fdtfile fdt_addr_r fdt_addr
5490ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
dc0b7b0e 5491
2729af9d
WD
5492The following environment variables may be used and automatically
5493updated by the network boot commands ("bootp" and "rarpboot"),
5494depending the information provided by your boot server:
c609719b 5495
2729af9d
WD
5496 bootfile - see above
5497 dnsip - IP address of your Domain Name Server
5498 dnsip2 - IP address of your secondary Domain Name Server
5499 gatewayip - IP address of the Gateway (Router) to use
5500 hostname - Target hostname
5501 ipaddr - see above
5502 netmask - Subnet Mask
5503 rootpath - Pathname of the root filesystem on the NFS server
5504 serverip - see above
c1551ea8 5505
c1551ea8 5506
2729af9d 5507There are two special Environment Variables:
c1551ea8 5508
2729af9d
WD
5509 serial# - contains hardware identification information such
5510 as type string and/or serial number
5511 ethaddr - Ethernet address
c609719b 5512
2729af9d
WD
5513These variables can be set only once (usually during manufacturing of
5514the board). U-Boot refuses to delete or overwrite these variables
5515once they have been set once.
c609719b 5516
f07771cc 5517
2729af9d 5518Further special Environment Variables:
f07771cc 5519
2729af9d
WD
5520 ver - Contains the U-Boot version string as printed
5521 with the "version" command. This variable is
5522 readonly (see CONFIG_VERSION_VARIABLE).
f07771cc 5523
f07771cc 5524
2729af9d
WD
5525Please note that changes to some configuration parameters may take
5526only effect after the next boot (yes, that's just like Windoze :-).
f07771cc 5527
f07771cc 5528
170ab110
JH
5529Callback functions for environment variables:
5530---------------------------------------------
5531
5532For some environment variables, the behavior of u-boot needs to change
b445bbb4 5533when their values are changed. This functionality allows functions to
170ab110
JH
5534be associated with arbitrary variables. On creation, overwrite, or
5535deletion, the callback will provide the opportunity for some side
5536effect to happen or for the change to be rejected.
5537
5538The callbacks are named and associated with a function using the
5539U_BOOT_ENV_CALLBACK macro in your board or driver code.
5540
5541These callbacks are associated with variables in one of two ways. The
5542static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5543in the board configuration to a string that defines a list of
5544associations. The list must be in the following format:
5545
5546 entry = variable_name[:callback_name]
5547 list = entry[,list]
5548
5549If the callback name is not specified, then the callback is deleted.
5550Spaces are also allowed anywhere in the list.
5551
5552Callbacks can also be associated by defining the ".callbacks" variable
5553with the same list format above. Any association in ".callbacks" will
5554override any association in the static list. You can define
5555CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
b445bbb4 5556".callbacks" environment variable in the default or embedded environment.
170ab110
JH
5557
5558
2729af9d
WD
5559Command Line Parsing:
5560=====================
f07771cc 5561
2729af9d
WD
5562There are two different command line parsers available with U-Boot:
5563the old "simple" one, and the much more powerful "hush" shell:
c609719b 5564
2729af9d
WD
5565Old, simple command line parser:
5566--------------------------------
c609719b 5567
2729af9d
WD
5568- supports environment variables (through setenv / saveenv commands)
5569- several commands on one line, separated by ';'
fe126d8b 5570- variable substitution using "... ${name} ..." syntax
2729af9d
WD
5571- special characters ('$', ';') can be escaped by prefixing with '\',
5572 for example:
fe126d8b 5573 setenv bootcmd bootm \${address}
2729af9d
WD
5574- You can also escape text by enclosing in single apostrophes, for example:
5575 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
c609719b 5576
2729af9d
WD
5577Hush shell:
5578-----------
c609719b 5579
2729af9d
WD
5580- similar to Bourne shell, with control structures like
5581 if...then...else...fi, for...do...done; while...do...done,
5582 until...do...done, ...
5583- supports environment ("global") variables (through setenv / saveenv
5584 commands) and local shell variables (through standard shell syntax
5585 "name=value"); only environment variables can be used with "run"
5586 command
5587
5588General rules:
5589--------------
c609719b 5590
2729af9d
WD
5591(1) If a command line (or an environment variable executed by a "run"
5592 command) contains several commands separated by semicolon, and
5593 one of these commands fails, then the remaining commands will be
5594 executed anyway.
c609719b 5595
2729af9d 5596(2) If you execute several variables with one call to run (i. e.
11ccc33f 5597 calling run with a list of variables as arguments), any failing
2729af9d
WD
5598 command will cause "run" to terminate, i. e. the remaining
5599 variables are not executed.
c609719b 5600
2729af9d
WD
5601Note for Redundant Ethernet Interfaces:
5602=======================================
c609719b 5603
11ccc33f 5604Some boards come with redundant Ethernet interfaces; U-Boot supports
2729af9d
WD
5605such configurations and is capable of automatic selection of a
5606"working" interface when needed. MAC assignment works as follows:
c609719b 5607
2729af9d
WD
5608Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5609MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5610"eth1addr" (=>eth1), "eth2addr", ...
c609719b 5611
2729af9d
WD
5612If the network interface stores some valid MAC address (for instance
5613in SROM), this is used as default address if there is NO correspon-
5614ding setting in the environment; if the corresponding environment
5615variable is set, this overrides the settings in the card; that means:
c609719b 5616
2729af9d
WD
5617o If the SROM has a valid MAC address, and there is no address in the
5618 environment, the SROM's address is used.
c609719b 5619
2729af9d
WD
5620o If there is no valid address in the SROM, and a definition in the
5621 environment exists, then the value from the environment variable is
5622 used.
c609719b 5623
2729af9d
WD
5624o If both the SROM and the environment contain a MAC address, and
5625 both addresses are the same, this MAC address is used.
c609719b 5626
2729af9d
WD
5627o If both the SROM and the environment contain a MAC address, and the
5628 addresses differ, the value from the environment is used and a
5629 warning is printed.
c609719b 5630
2729af9d
WD
5631o If neither SROM nor the environment contain a MAC address, an error
5632 is raised.
c609719b 5633
ecee9324 5634If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
c0f40859 5635will be programmed into hardware as part of the initialization process. This
ecee9324
BW
5636may be skipped by setting the appropriate 'ethmacskip' environment variable.
5637The naming convention is as follows:
5638"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
c609719b 5639
2729af9d
WD
5640Image Formats:
5641==============
c609719b 5642
3310c549
MB
5643U-Boot is capable of booting (and performing other auxiliary operations on)
5644images in two formats:
5645
5646New uImage format (FIT)
5647-----------------------
5648
5649Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5650to Flattened Device Tree). It allows the use of images with multiple
5651components (several kernels, ramdisks, etc.), with contents protected by
5652SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5653
5654
5655Old uImage format
5656-----------------
5657
5658Old image format is based on binary files which can be basically anything,
5659preceded by a special header; see the definitions in include/image.h for
5660details; basically, the header defines the following image properties:
c609719b 5661
2729af9d
WD
5662* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5663 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
f5ed9e39
PT
5664 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5665 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5666 INTEGRITY).
7b64fef3 5667* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
afc1ce82
ML
5668 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5669 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
2729af9d
WD
5670* Compression Type (uncompressed, gzip, bzip2)
5671* Load Address
5672* Entry Point
5673* Image Name
5674* Image Timestamp
c609719b 5675
2729af9d
WD
5676The header is marked by a special Magic Number, and both the header
5677and the data portions of the image are secured against corruption by
5678CRC32 checksums.
c609719b
WD
5679
5680
2729af9d
WD
5681Linux Support:
5682==============
c609719b 5683
2729af9d
WD
5684Although U-Boot should support any OS or standalone application
5685easily, the main focus has always been on Linux during the design of
5686U-Boot.
c609719b 5687
2729af9d
WD
5688U-Boot includes many features that so far have been part of some
5689special "boot loader" code within the Linux kernel. Also, any
5690"initrd" images to be used are no longer part of one big Linux image;
5691instead, kernel and "initrd" are separate images. This implementation
5692serves several purposes:
c609719b 5693
2729af9d
WD
5694- the same features can be used for other OS or standalone
5695 applications (for instance: using compressed images to reduce the
5696 Flash memory footprint)
c609719b 5697
2729af9d
WD
5698- it becomes much easier to port new Linux kernel versions because
5699 lots of low-level, hardware dependent stuff are done by U-Boot
c609719b 5700
2729af9d
WD
5701- the same Linux kernel image can now be used with different "initrd"
5702 images; of course this also means that different kernel images can
5703 be run with the same "initrd". This makes testing easier (you don't
5704 have to build a new "zImage.initrd" Linux image when you just
5705 change a file in your "initrd"). Also, a field-upgrade of the
5706 software is easier now.
c609719b 5707
c609719b 5708
2729af9d
WD
5709Linux HOWTO:
5710============
c609719b 5711
2729af9d
WD
5712Porting Linux to U-Boot based systems:
5713---------------------------------------
c609719b 5714
2729af9d
WD
5715U-Boot cannot save you from doing all the necessary modifications to
5716configure the Linux device drivers for use with your target hardware
5717(no, we don't intend to provide a full virtual machine interface to
5718Linux :-).
c609719b 5719
a47a12be 5720But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
24ee89b9 5721
2729af9d
WD
5722Just make sure your machine specific header file (for instance
5723include/asm-ppc/tqm8xx.h) includes the same definition of the Board
1dc30693
MH
5724Information structure as we define in include/asm-<arch>/u-boot.h,
5725and make sure that your definition of IMAP_ADDR uses the same value
6d0f6bcf 5726as your U-Boot configuration in CONFIG_SYS_IMMR.
24ee89b9 5727
2eb31b13
SG
5728Note that U-Boot now has a driver model, a unified model for drivers.
5729If you are adding a new driver, plumb it into driver model. If there
5730is no uclass available, you are encouraged to create one. See
5731doc/driver-model.
5732
c609719b 5733
2729af9d
WD
5734Configuring the Linux kernel:
5735-----------------------------
c609719b 5736
2729af9d
WD
5737No specific requirements for U-Boot. Make sure you have some root
5738device (initial ramdisk, NFS) for your target system.
5739
5740
5741Building a Linux Image:
5742-----------------------
c609719b 5743
2729af9d
WD
5744With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5745not used. If you use recent kernel source, a new build target
5746"uImage" will exist which automatically builds an image usable by
5747U-Boot. Most older kernels also have support for a "pImage" target,
5748which was introduced for our predecessor project PPCBoot and uses a
5749100% compatible format.
5750
5751Example:
5752
ab584d67 5753 make TQM850L_defconfig
2729af9d
WD
5754 make oldconfig
5755 make dep
5756 make uImage
5757
5758The "uImage" build target uses a special tool (in 'tools/mkimage') to
5759encapsulate a compressed Linux kernel image with header information,
5760CRC32 checksum etc. for use with U-Boot. This is what we are doing:
5761
5762* build a standard "vmlinux" kernel image (in ELF binary format):
5763
5764* convert the kernel into a raw binary image:
5765
5766 ${CROSS_COMPILE}-objcopy -O binary \
5767 -R .note -R .comment \
5768 -S vmlinux linux.bin
5769
5770* compress the binary image:
5771
5772 gzip -9 linux.bin
5773
5774* package compressed binary image for U-Boot:
5775
5776 mkimage -A ppc -O linux -T kernel -C gzip \
5777 -a 0 -e 0 -n "Linux Kernel Image" \
5778 -d linux.bin.gz uImage
c609719b 5779
c609719b 5780
2729af9d
WD
5781The "mkimage" tool can also be used to create ramdisk images for use
5782with U-Boot, either separated from the Linux kernel image, or
5783combined into one file. "mkimage" encapsulates the images with a 64
5784byte header containing information about target architecture,
5785operating system, image type, compression method, entry points, time
5786stamp, CRC32 checksums, etc.
5787
5788"mkimage" can be called in two ways: to verify existing images and
5789print the header information, or to build new images.
5790
5791In the first form (with "-l" option) mkimage lists the information
5792contained in the header of an existing U-Boot image; this includes
5793checksum verification:
c609719b 5794
2729af9d
WD
5795 tools/mkimage -l image
5796 -l ==> list image header information
5797
5798The second form (with "-d" option) is used to build a U-Boot image
5799from a "data file" which is used as image payload:
5800
5801 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5802 -n name -d data_file image
5803 -A ==> set architecture to 'arch'
5804 -O ==> set operating system to 'os'
5805 -T ==> set image type to 'type'
5806 -C ==> set compression type 'comp'
5807 -a ==> set load address to 'addr' (hex)
5808 -e ==> set entry point to 'ep' (hex)
5809 -n ==> set image name to 'name'
5810 -d ==> use image data from 'datafile'
5811
69459791
WD
5812Right now, all Linux kernels for PowerPC systems use the same load
5813address (0x00000000), but the entry point address depends on the
5814kernel version:
2729af9d
WD
5815
5816- 2.2.x kernels have the entry point at 0x0000000C,
5817- 2.3.x and later kernels have the entry point at 0x00000000.
5818
5819So a typical call to build a U-Boot image would read:
5820
5821 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5822 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
a47a12be 5823 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
2729af9d
WD
5824 > examples/uImage.TQM850L
5825 Image Name: 2.4.4 kernel for TQM850L
5826 Created: Wed Jul 19 02:34:59 2000
5827 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5828 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5829 Load Address: 0x00000000
5830 Entry Point: 0x00000000
5831
5832To verify the contents of the image (or check for corruption):
5833
5834 -> tools/mkimage -l examples/uImage.TQM850L
5835 Image Name: 2.4.4 kernel for TQM850L
5836 Created: Wed Jul 19 02:34:59 2000
5837 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5838 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5839 Load Address: 0x00000000
5840 Entry Point: 0x00000000
5841
5842NOTE: for embedded systems where boot time is critical you can trade
5843speed for memory and install an UNCOMPRESSED image instead: this
5844needs more space in Flash, but boots much faster since it does not
5845need to be uncompressed:
5846
a47a12be 5847 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
2729af9d
WD
5848 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5849 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
a47a12be 5850 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
2729af9d
WD
5851 > examples/uImage.TQM850L-uncompressed
5852 Image Name: 2.4.4 kernel for TQM850L
5853 Created: Wed Jul 19 02:34:59 2000
5854 Image Type: PowerPC Linux Kernel Image (uncompressed)
5855 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5856 Load Address: 0x00000000
5857 Entry Point: 0x00000000
5858
5859
5860Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5861when your kernel is intended to use an initial ramdisk:
5862
5863 -> tools/mkimage -n 'Simple Ramdisk Image' \
5864 > -A ppc -O linux -T ramdisk -C gzip \
5865 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5866 Image Name: Simple Ramdisk Image
5867 Created: Wed Jan 12 14:01:50 2000
5868 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5869 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5870 Load Address: 0x00000000
5871 Entry Point: 0x00000000
5872
a804b5ce
GMF
5873The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5874option performs the converse operation of the mkimage's second form (the "-d"
5875option). Given an image built by mkimage, the dumpimage extracts a "data file"
5876from the image:
5877
f41f5b7c
GMF
5878 tools/dumpimage -i image -T type -p position data_file
5879 -i ==> extract from the 'image' a specific 'data_file'
5880 -T ==> set image type to 'type'
5881 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
a804b5ce 5882
2729af9d
WD
5883
5884Installing a Linux Image:
5885-------------------------
5886
5887To downloading a U-Boot image over the serial (console) interface,
5888you must convert the image to S-Record format:
5889
5890 objcopy -I binary -O srec examples/image examples/image.srec
5891
5892The 'objcopy' does not understand the information in the U-Boot
5893image header, so the resulting S-Record file will be relative to
5894address 0x00000000. To load it to a given address, you need to
5895specify the target address as 'offset' parameter with the 'loads'
5896command.
5897
5898Example: install the image to address 0x40100000 (which on the
5899TQM8xxL is in the first Flash bank):
5900
5901 => erase 40100000 401FFFFF
5902
5903 .......... done
5904 Erased 8 sectors
5905
5906 => loads 40100000
5907 ## Ready for S-Record download ...
5908 ~>examples/image.srec
5909 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5910 ...
5911 15989 15990 15991 15992
5912 [file transfer complete]
5913 [connected]
5914 ## Start Addr = 0x00000000
5915
5916
5917You can check the success of the download using the 'iminfo' command;
218ca724 5918this includes a checksum verification so you can be sure no data
2729af9d
WD
5919corruption happened:
5920
5921 => imi 40100000
5922
5923 ## Checking Image at 40100000 ...
5924 Image Name: 2.2.13 for initrd on TQM850L
5925 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5926 Data Size: 335725 Bytes = 327 kB = 0 MB
5927 Load Address: 00000000
5928 Entry Point: 0000000c
5929 Verifying Checksum ... OK
5930
5931
5932Boot Linux:
5933-----------
5934
5935The "bootm" command is used to boot an application that is stored in
5936memory (RAM or Flash). In case of a Linux kernel image, the contents
5937of the "bootargs" environment variable is passed to the kernel as
5938parameters. You can check and modify this variable using the
5939"printenv" and "setenv" commands:
5940
5941
5942 => printenv bootargs
5943 bootargs=root=/dev/ram
5944
5945 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5946
5947 => printenv bootargs
5948 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5949
5950 => bootm 40020000
5951 ## Booting Linux kernel at 40020000 ...
5952 Image Name: 2.2.13 for NFS on TQM850L
5953 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5954 Data Size: 381681 Bytes = 372 kB = 0 MB
5955 Load Address: 00000000
5956 Entry Point: 0000000c
5957 Verifying Checksum ... OK
5958 Uncompressing Kernel Image ... OK
5959 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000
5960 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5961 time_init: decrementer frequency = 187500000/60
5962 Calibrating delay loop... 49.77 BogoMIPS
5963 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5964 ...
5965
11ccc33f 5966If you want to boot a Linux kernel with initial RAM disk, you pass
2729af9d
WD
5967the memory addresses of both the kernel and the initrd image (PPBCOOT
5968format!) to the "bootm" command:
5969
5970 => imi 40100000 40200000
5971
5972 ## Checking Image at 40100000 ...
5973 Image Name: 2.2.13 for initrd on TQM850L
5974 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5975 Data Size: 335725 Bytes = 327 kB = 0 MB
5976 Load Address: 00000000
5977 Entry Point: 0000000c
5978 Verifying Checksum ... OK
5979
5980 ## Checking Image at 40200000 ...
5981 Image Name: Simple Ramdisk Image
5982 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5983 Data Size: 566530 Bytes = 553 kB = 0 MB
5984 Load Address: 00000000
5985 Entry Point: 00000000
5986 Verifying Checksum ... OK
5987
5988 => bootm 40100000 40200000
5989 ## Booting Linux kernel at 40100000 ...
5990 Image Name: 2.2.13 for initrd on TQM850L
5991 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5992 Data Size: 335725 Bytes = 327 kB = 0 MB
5993 Load Address: 00000000
5994 Entry Point: 0000000c
5995 Verifying Checksum ... OK
5996 Uncompressing Kernel Image ... OK
5997 ## Loading RAMDisk Image at 40200000 ...
5998 Image Name: Simple Ramdisk Image
5999 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
6000 Data Size: 566530 Bytes = 553 kB = 0 MB
6001 Load Address: 00000000
6002 Entry Point: 00000000
6003 Verifying Checksum ... OK
6004 Loading Ramdisk ... OK
6005 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
6006 Boot arguments: root=/dev/ram
6007 time_init: decrementer frequency = 187500000/60
6008 Calibrating delay loop... 49.77 BogoMIPS
6009 ...
6010 RAMDISK: Compressed image found at block 0
6011 VFS: Mounted root (ext2 filesystem).
6012
6013 bash#
6014
0267768e
MM
6015Boot Linux and pass a flat device tree:
6016-----------
6017
6018First, U-Boot must be compiled with the appropriate defines. See the section
6019titled "Linux Kernel Interface" above for a more in depth explanation. The
6020following is an example of how to start a kernel and pass an updated
6021flat device tree:
6022
6023=> print oftaddr
6024oftaddr=0x300000
6025=> print oft
6026oft=oftrees/mpc8540ads.dtb
6027=> tftp $oftaddr $oft
6028Speed: 1000, full duplex
6029Using TSEC0 device
6030TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6031Filename 'oftrees/mpc8540ads.dtb'.
6032Load address: 0x300000
6033Loading: #
6034done
6035Bytes transferred = 4106 (100a hex)
6036=> tftp $loadaddr $bootfile
6037Speed: 1000, full duplex
6038Using TSEC0 device
6039TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6040Filename 'uImage'.
6041Load address: 0x200000
6042Loading:############
6043done
6044Bytes transferred = 1029407 (fb51f hex)
6045=> print loadaddr
6046loadaddr=200000
6047=> print oftaddr
6048oftaddr=0x300000
6049=> bootm $loadaddr - $oftaddr
6050## Booting image at 00200000 ...
a9398e01
WD
6051 Image Name: Linux-2.6.17-dirty
6052 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6053 Data Size: 1029343 Bytes = 1005.2 kB
0267768e 6054 Load Address: 00000000
a9398e01 6055 Entry Point: 00000000
0267768e
MM
6056 Verifying Checksum ... OK
6057 Uncompressing Kernel Image ... OK
6058Booting using flat device tree at 0x300000
6059Using MPC85xx ADS machine description
6060Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6061[snip]
6062
6063
2729af9d
WD
6064More About U-Boot Image Types:
6065------------------------------
6066
6067U-Boot supports the following image types:
6068
6069 "Standalone Programs" are directly runnable in the environment
6070 provided by U-Boot; it is expected that (if they behave
6071 well) you can continue to work in U-Boot after return from
6072 the Standalone Program.
6073 "OS Kernel Images" are usually images of some Embedded OS which
6074 will take over control completely. Usually these programs
6075 will install their own set of exception handlers, device
6076 drivers, set up the MMU, etc. - this means, that you cannot
6077 expect to re-enter U-Boot except by resetting the CPU.
6078 "RAMDisk Images" are more or less just data blocks, and their
6079 parameters (address, size) are passed to an OS kernel that is
6080 being started.
6081 "Multi-File Images" contain several images, typically an OS
6082 (Linux) kernel image and one or more data images like
6083 RAMDisks. This construct is useful for instance when you want
6084 to boot over the network using BOOTP etc., where the boot
6085 server provides just a single image file, but you want to get
6086 for instance an OS kernel and a RAMDisk image.
6087
6088 "Multi-File Images" start with a list of image sizes, each
6089 image size (in bytes) specified by an "uint32_t" in network
6090 byte order. This list is terminated by an "(uint32_t)0".
6091 Immediately after the terminating 0 follow the images, one by
6092 one, all aligned on "uint32_t" boundaries (size rounded up to
6093 a multiple of 4 bytes).
6094
6095 "Firmware Images" are binary images containing firmware (like
6096 U-Boot or FPGA images) which usually will be programmed to
6097 flash memory.
6098
6099 "Script files" are command sequences that will be executed by
6100 U-Boot's command interpreter; this feature is especially
6101 useful when you configure U-Boot to use a real shell (hush)
6102 as command interpreter.
6103
44f074c7
MV
6104Booting the Linux zImage:
6105-------------------------
6106
6107On some platforms, it's possible to boot Linux zImage. This is done
6108using the "bootz" command. The syntax of "bootz" command is the same
6109as the syntax of "bootm" command.
6110
8ac28563 6111Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
017e1f3f
MV
6112kernel with raw initrd images. The syntax is slightly different, the
6113address of the initrd must be augmented by it's size, in the following
6114format: "<initrd addres>:<initrd size>".
6115
2729af9d
WD
6116
6117Standalone HOWTO:
6118=================
6119
6120One of the features of U-Boot is that you can dynamically load and
6121run "standalone" applications, which can use some resources of
6122U-Boot like console I/O functions or interrupt services.
6123
6124Two simple examples are included with the sources:
6125
6126"Hello World" Demo:
6127-------------------
6128
6129'examples/hello_world.c' contains a small "Hello World" Demo
6130application; it is automatically compiled when you build U-Boot.
6131It's configured to run at address 0x00040004, so you can play with it
6132like that:
6133
6134 => loads
6135 ## Ready for S-Record download ...
6136 ~>examples/hello_world.srec
6137 1 2 3 4 5 6 7 8 9 10 11 ...
6138 [file transfer complete]
6139 [connected]
6140 ## Start Addr = 0x00040004
6141
6142 => go 40004 Hello World! This is a test.
6143 ## Starting application at 0x00040004 ...
6144 Hello World
6145 argc = 7
6146 argv[0] = "40004"
6147 argv[1] = "Hello"
6148 argv[2] = "World!"
6149 argv[3] = "This"
6150 argv[4] = "is"
6151 argv[5] = "a"
6152 argv[6] = "test."
6153 argv[7] = "<NULL>"
6154 Hit any key to exit ...
6155
6156 ## Application terminated, rc = 0x0
6157
6158Another example, which demonstrates how to register a CPM interrupt
6159handler with the U-Boot code, can be found in 'examples/timer.c'.
6160Here, a CPM timer is set up to generate an interrupt every second.
6161The interrupt service routine is trivial, just printing a '.'
6162character, but this is just a demo program. The application can be
6163controlled by the following keys:
6164
6165 ? - print current values og the CPM Timer registers
6166 b - enable interrupts and start timer
6167 e - stop timer and disable interrupts
6168 q - quit application
6169
6170 => loads
6171 ## Ready for S-Record download ...
6172 ~>examples/timer.srec
6173 1 2 3 4 5 6 7 8 9 10 11 ...
6174 [file transfer complete]
6175 [connected]
6176 ## Start Addr = 0x00040004
6177
6178 => go 40004
6179 ## Starting application at 0x00040004 ...
6180 TIMERS=0xfff00980
6181 Using timer 1
6182 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
6183
6184Hit 'b':
6185 [q, b, e, ?] Set interval 1000000 us
6186 Enabling timer
6187Hit '?':
6188 [q, b, e, ?] ........
6189 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6190Hit '?':
6191 [q, b, e, ?] .
6192 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6193Hit '?':
6194 [q, b, e, ?] .
6195 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6196Hit '?':
6197 [q, b, e, ?] .
6198 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6199Hit 'e':
6200 [q, b, e, ?] ...Stopping timer
6201Hit 'q':
6202 [q, b, e, ?] ## Application terminated, rc = 0x0
6203
6204
6205Minicom warning:
6206================
6207
6208Over time, many people have reported problems when trying to use the
6209"minicom" terminal emulation program for serial download. I (wd)
6210consider minicom to be broken, and recommend not to use it. Under
6211Unix, I recommend to use C-Kermit for general purpose use (and
6212especially for kermit binary protocol download ("loadb" command), and
e53515a2
KP
6213use "cu" for S-Record download ("loads" command). See
6214http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6215for help with kermit.
6216
2729af9d
WD
6217
6218Nevertheless, if you absolutely want to use it try adding this
6219configuration to your "File transfer protocols" section:
6220
6221 Name Program Name U/D FullScr IO-Red. Multi
6222 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6223 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
6224
6225
6226NetBSD Notes:
6227=============
6228
6229Starting at version 0.9.2, U-Boot supports NetBSD both as host
6230(build U-Boot) and target system (boots NetBSD/mpc8xx).
6231
6232Building requires a cross environment; it is known to work on
6233NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6234need gmake since the Makefiles are not compatible with BSD make).
6235Note that the cross-powerpc package does not install include files;
6236attempting to build U-Boot will fail because <machine/ansi.h> is
6237missing. This file has to be installed and patched manually:
6238
6239 # cd /usr/pkg/cross/powerpc-netbsd/include
6240 # mkdir powerpc
6241 # ln -s powerpc machine
6242 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6243 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
6244
6245Native builds *don't* work due to incompatibilities between native
6246and U-Boot include files.
6247
6248Booting assumes that (the first part of) the image booted is a
6249stage-2 loader which in turn loads and then invokes the kernel
6250proper. Loader sources will eventually appear in the NetBSD source
6251tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
2a8af187 6252meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
2729af9d
WD
6253
6254
6255Implementation Internals:
6256=========================
6257
6258The following is not intended to be a complete description of every
6259implementation detail. However, it should help to understand the
6260inner workings of U-Boot and make it easier to port it to custom
6261hardware.
6262
6263
6264Initial Stack, Global Data:
6265---------------------------
6266
6267The implementation of U-Boot is complicated by the fact that U-Boot
6268starts running out of ROM (flash memory), usually without access to
6269system RAM (because the memory controller is not initialized yet).
6270This means that we don't have writable Data or BSS segments, and BSS
6271is not initialized as zero. To be able to get a C environment working
6272at all, we have to allocate at least a minimal stack. Implementation
6273options for this are defined and restricted by the CPU used: Some CPU
6274models provide on-chip memory (like the IMMR area on MPC8xx and
6275MPC826x processors), on others (parts of) the data cache can be
6276locked as (mis-) used as memory, etc.
6277
218ca724 6278 Chris Hallinan posted a good summary of these issues to the
0668236b 6279 U-Boot mailing list:
2729af9d
WD
6280
6281 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6282 From: "Chris Hallinan" <clh@net1plus.com>
6283 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6284 ...
6285
6286 Correct me if I'm wrong, folks, but the way I understand it
6287 is this: Using DCACHE as initial RAM for Stack, etc, does not
6288 require any physical RAM backing up the cache. The cleverness
6289 is that the cache is being used as a temporary supply of
6290 necessary storage before the SDRAM controller is setup. It's
11ccc33f 6291 beyond the scope of this list to explain the details, but you
2729af9d
WD
6292 can see how this works by studying the cache architecture and
6293 operation in the architecture and processor-specific manuals.
6294
6295 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6296 is another option for the system designer to use as an
11ccc33f 6297 initial stack/RAM area prior to SDRAM being available. Either
2729af9d
WD
6298 option should work for you. Using CS 4 should be fine if your
6299 board designers haven't used it for something that would
6300 cause you grief during the initial boot! It is frequently not
6301 used.
6302
6d0f6bcf 6303 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
2729af9d
WD
6304 with your processor/board/system design. The default value
6305 you will find in any recent u-boot distribution in
8a316c9b 6306 walnut.h should work for you. I'd set it to a value larger
2729af9d
WD
6307 than your SDRAM module. If you have a 64MB SDRAM module, set
6308 it above 400_0000. Just make sure your board has no resources
6309 that are supposed to respond to that address! That code in
6310 start.S has been around a while and should work as is when
6311 you get the config right.
6312
6313 -Chris Hallinan
6314 DS4.COM, Inc.
6315
6316It is essential to remember this, since it has some impact on the C
6317code for the initialization procedures:
6318
6319* Initialized global data (data segment) is read-only. Do not attempt
6320 to write it.
6321
b445bbb4 6322* Do not use any uninitialized global data (or implicitly initialized
2729af9d
WD
6323 as zero data - BSS segment) at all - this is undefined, initiali-
6324 zation is performed later (when relocating to RAM).
6325
6326* Stack space is very limited. Avoid big data buffers or things like
6327 that.
6328
6329Having only the stack as writable memory limits means we cannot use
b445bbb4 6330normal global data to share information between the code. But it
2729af9d
WD
6331turned out that the implementation of U-Boot can be greatly
6332simplified by making a global data structure (gd_t) available to all
6333functions. We could pass a pointer to this data as argument to _all_
6334functions, but this would bloat the code. Instead we use a feature of
6335the GCC compiler (Global Register Variables) to share the data: we
6336place a pointer (gd) to the global data into a register which we
6337reserve for this purpose.
6338
6339When choosing a register for such a purpose we are restricted by the
6340relevant (E)ABI specifications for the current architecture, and by
6341GCC's implementation.
6342
6343For PowerPC, the following registers have specific use:
6344 R1: stack pointer
e7670f6c 6345 R2: reserved for system use
2729af9d
WD
6346 R3-R4: parameter passing and return values
6347 R5-R10: parameter passing
6348 R13: small data area pointer
6349 R30: GOT pointer
6350 R31: frame pointer
6351
e6bee808
JT
6352 (U-Boot also uses R12 as internal GOT pointer. r12
6353 is a volatile register so r12 needs to be reset when
6354 going back and forth between asm and C)
2729af9d 6355
e7670f6c 6356 ==> U-Boot will use R2 to hold a pointer to the global data
2729af9d
WD
6357
6358 Note: on PPC, we could use a static initializer (since the
6359 address of the global data structure is known at compile time),
6360 but it turned out that reserving a register results in somewhat
6361 smaller code - although the code savings are not that big (on
6362 average for all boards 752 bytes for the whole U-Boot image,
6363 624 text + 127 data).
6364
c4db335c 6365On Blackfin, the normal C ABI (except for P3) is followed as documented here:
4c58eb55
MF
6366 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6367
c4db335c 6368 ==> U-Boot will use P3 to hold a pointer to the global data
4c58eb55 6369
2729af9d
WD
6370On ARM, the following registers are used:
6371
6372 R0: function argument word/integer result
6373 R1-R3: function argument word
12eba1b4
JH
6374 R9: platform specific
6375 R10: stack limit (used only if stack checking is enabled)
2729af9d
WD
6376 R11: argument (frame) pointer
6377 R12: temporary workspace
6378 R13: stack pointer
6379 R14: link register
6380 R15: program counter
6381
12eba1b4
JH
6382 ==> U-Boot will use R9 to hold a pointer to the global data
6383
6384 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
2729af9d 6385
0df01fd3
TC
6386On Nios II, the ABI is documented here:
6387 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6388
6389 ==> U-Boot will use gp to hold a pointer to the global data
6390
6391 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6392 to access small data sections, so gp is free.
6393
afc1ce82
ML
6394On NDS32, the following registers are used:
6395
6396 R0-R1: argument/return
6397 R2-R5: argument
6398 R15: temporary register for assembler
6399 R16: trampoline register
6400 R28: frame pointer (FP)
6401 R29: global pointer (GP)
6402 R30: link register (LP)
6403 R31: stack pointer (SP)
6404 PC: program counter (PC)
6405
6406 ==> U-Boot will use R10 to hold a pointer to the global data
6407
d87080b7
WD
6408NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6409or current versions of GCC may "optimize" the code too much.
2729af9d
WD
6410
6411Memory Management:
6412------------------
6413
6414U-Boot runs in system state and uses physical addresses, i.e. the
6415MMU is not used either for address mapping nor for memory protection.
6416
6417The available memory is mapped to fixed addresses using the memory
6418controller. In this process, a contiguous block is formed for each
6419memory type (Flash, SDRAM, SRAM), even when it consists of several
6420physical memory banks.
6421
6422U-Boot is installed in the first 128 kB of the first Flash bank (on
6423TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6424booting and sizing and initializing DRAM, the code relocates itself
6425to the upper end of DRAM. Immediately below the U-Boot code some
6d0f6bcf 6426memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
2729af9d
WD
6427configuration setting]. Below that, a structure with global Board
6428Info data is placed, followed by the stack (growing downward).
6429
6430Additionally, some exception handler code is copied to the low 8 kB
6431of DRAM (0x00000000 ... 0x00001FFF).
6432
6433So a typical memory configuration with 16 MB of DRAM could look like
6434this:
6435
6436 0x0000 0000 Exception Vector code
6437 :
6438 0x0000 1FFF
6439 0x0000 2000 Free for Application Use
6440 :
6441 :
6442
6443 :
6444 :
6445 0x00FB FF20 Monitor Stack (Growing downward)
6446 0x00FB FFAC Board Info Data and permanent copy of global data
6447 0x00FC 0000 Malloc Arena
6448 :
6449 0x00FD FFFF
6450 0x00FE 0000 RAM Copy of Monitor Code
6451 ... eventually: LCD or video framebuffer
6452 ... eventually: pRAM (Protected RAM - unchanged by reset)
6453 0x00FF FFFF [End of RAM]
6454
6455
6456System Initialization:
6457----------------------
c609719b 6458
2729af9d 6459In the reset configuration, U-Boot starts at the reset entry point
11ccc33f 6460(on most PowerPC systems at address 0x00000100). Because of the reset
b445bbb4 6461configuration for CS0# this is a mirror of the on board Flash memory.
2729af9d
WD
6462To be able to re-map memory U-Boot then jumps to its link address.
6463To be able to implement the initialization code in C, a (small!)
6464initial stack is set up in the internal Dual Ported RAM (in case CPUs
6465which provide such a feature like MPC8xx or MPC8260), or in a locked
6466part of the data cache. After that, U-Boot initializes the CPU core,
6467the caches and the SIU.
6468
6469Next, all (potentially) available memory banks are mapped using a
6470preliminary mapping. For example, we put them on 512 MB boundaries
6471(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6472on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6473programmed for SDRAM access. Using the temporary configuration, a
6474simple memory test is run that determines the size of the SDRAM
6475banks.
6476
6477When there is more than one SDRAM bank, and the banks are of
6478different size, the largest is mapped first. For equal size, the first
6479bank (CS2#) is mapped first. The first mapping is always for address
64800x00000000, with any additional banks following immediately to create
6481contiguous memory starting from 0.
6482
6483Then, the monitor installs itself at the upper end of the SDRAM area
6484and allocates memory for use by malloc() and for the global Board
6485Info data; also, the exception vector code is copied to the low RAM
6486pages, and the final stack is set up.
6487
6488Only after this relocation will you have a "normal" C environment;
6489until that you are restricted in several ways, mostly because you are
6490running from ROM, and because the code will have to be relocated to a
6491new address in RAM.
6492
6493
6494U-Boot Porting Guide:
6495----------------------
c609719b 6496
2729af9d
WD
6497[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6498list, October 2002]
c609719b
WD
6499
6500
6c3fef28 6501int main(int argc, char *argv[])
2729af9d
WD
6502{
6503 sighandler_t no_more_time;
c609719b 6504
6c3fef28
JVB
6505 signal(SIGALRM, no_more_time);
6506 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
c609719b 6507
2729af9d 6508 if (available_money > available_manpower) {
6c3fef28 6509 Pay consultant to port U-Boot;
c609719b
WD
6510 return 0;
6511 }
6512
2729af9d
WD
6513 Download latest U-Boot source;
6514
0668236b 6515 Subscribe to u-boot mailing list;
2729af9d 6516
6c3fef28
JVB
6517 if (clueless)
6518 email("Hi, I am new to U-Boot, how do I get started?");
2729af9d
WD
6519
6520 while (learning) {
6521 Read the README file in the top level directory;
6c3fef28
JVB
6522 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6523 Read applicable doc/*.README;
2729af9d 6524 Read the source, Luke;
6c3fef28 6525 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
2729af9d
WD
6526 }
6527
6c3fef28
JVB
6528 if (available_money > toLocalCurrency ($2500))
6529 Buy a BDI3000;
6530 else
2729af9d 6531 Add a lot of aggravation and time;
2729af9d 6532
6c3fef28
JVB
6533 if (a similar board exists) { /* hopefully... */
6534 cp -a board/<similar> board/<myboard>
6535 cp include/configs/<similar>.h include/configs/<myboard>.h
6536 } else {
6537 Create your own board support subdirectory;
6538 Create your own board include/configs/<myboard>.h file;
6539 }
6540 Edit new board/<myboard> files
6541 Edit new include/configs/<myboard>.h
6542
6543 while (!accepted) {
6544 while (!running) {
6545 do {
6546 Add / modify source code;
6547 } until (compiles);
6548 Debug;
6549 if (clueless)
6550 email("Hi, I am having problems...");
6551 }
6552 Send patch file to the U-Boot email list;
6553 if (reasonable critiques)
6554 Incorporate improvements from email list code review;
6555 else
6556 Defend code as written;
2729af9d 6557 }
2729af9d
WD
6558
6559 return 0;
6560}
6561
6562void no_more_time (int sig)
6563{
6564 hire_a_guru();
6565}
6566
c609719b 6567
2729af9d
WD
6568Coding Standards:
6569-----------------
c609719b 6570
2729af9d 6571All contributions to U-Boot should conform to the Linux kernel
2c051651 6572coding style; see the file "Documentation/CodingStyle" and the script
7ca9296e 6573"scripts/Lindent" in your Linux kernel source directory.
2c051651
DZ
6574
6575Source files originating from a different project (for example the
6576MTD subsystem) are generally exempt from these guidelines and are not
b445bbb4 6577reformatted to ease subsequent migration to newer versions of those
2c051651
DZ
6578sources.
6579
6580Please note that U-Boot is implemented in C (and to some small parts in
6581Assembler); no C++ is used, so please do not use C++ style comments (//)
6582in your code.
c609719b 6583
2729af9d
WD
6584Please also stick to the following formatting rules:
6585- remove any trailing white space
7ca9296e 6586- use TAB characters for indentation and vertical alignment, not spaces
2729af9d 6587- make sure NOT to use DOS '\r\n' line feeds
7ca9296e 6588- do not add more than 2 consecutive empty lines to source files
2729af9d 6589- do not add trailing empty lines to source files
180d3f74 6590
2729af9d
WD
6591Submissions which do not conform to the standards may be returned
6592with a request to reformat the changes.
c609719b
WD
6593
6594
2729af9d
WD
6595Submitting Patches:
6596-------------------
c609719b 6597
2729af9d
WD
6598Since the number of patches for U-Boot is growing, we need to
6599establish some rules. Submissions which do not conform to these rules
6600may be rejected, even when they contain important and valuable stuff.
c609719b 6601
0d28f34b 6602Please see http://www.denx.de/wiki/U-Boot/Patches for details.
218ca724 6603
0668236b
WD
6604Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6605see http://lists.denx.de/mailman/listinfo/u-boot
6606
2729af9d
WD
6607When you send a patch, please include the following information with
6608it:
c609719b 6609
2729af9d
WD
6610* For bug fixes: a description of the bug and how your patch fixes
6611 this bug. Please try to include a way of demonstrating that the
6612 patch actually fixes something.
c609719b 6613
2729af9d
WD
6614* For new features: a description of the feature and your
6615 implementation.
c609719b 6616
2729af9d 6617* A CHANGELOG entry as plaintext (separate from the patch)
c609719b 6618
2729af9d 6619* For major contributions, your entry to the CREDITS file
c609719b 6620
27af930e
AA
6621* When you add support for a new board, don't forget to add a
6622 maintainer e-mail address to the boards.cfg file, too.
c609719b 6623
2729af9d
WD
6624* If your patch adds new configuration options, don't forget to
6625 document these in the README file.
c609719b 6626
218ca724
WD
6627* The patch itself. If you are using git (which is *strongly*
6628 recommended) you can easily generate the patch using the
7ca9296e 6629 "git format-patch". If you then use "git send-email" to send it to
218ca724
WD
6630 the U-Boot mailing list, you will avoid most of the common problems
6631 with some other mail clients.
6632
6633 If you cannot use git, use "diff -purN OLD NEW". If your version of
6634 diff does not support these options, then get the latest version of
6635 GNU diff.
c609719b 6636
218ca724
WD
6637 The current directory when running this command shall be the parent
6638 directory of the U-Boot source tree (i. e. please make sure that
6639 your patch includes sufficient directory information for the
6640 affected files).
6dff5529 6641
218ca724
WD
6642 We prefer patches as plain text. MIME attachments are discouraged,
6643 and compressed attachments must not be used.
c609719b 6644
2729af9d
WD
6645* If one logical set of modifications affects or creates several
6646 files, all these changes shall be submitted in a SINGLE patch file.
52f52c14 6647
2729af9d
WD
6648* Changesets that contain different, unrelated modifications shall be
6649 submitted as SEPARATE patches, one patch per changeset.
8bde7f77 6650
52f52c14 6651
2729af9d 6652Notes:
c609719b 6653
2729af9d
WD
6654* Before sending the patch, run the MAKEALL script on your patched
6655 source tree and make sure that no errors or warnings are reported
6656 for any of the boards.
c609719b 6657
2729af9d
WD
6658* Keep your modifications to the necessary minimum: A patch
6659 containing several unrelated changes or arbitrary reformats will be
6660 returned with a request to re-formatting / split it.
c609719b 6661
2729af9d
WD
6662* If you modify existing code, make sure that your new code does not
6663 add to the memory footprint of the code ;-) Small is beautiful!
6664 When adding new features, these should compile conditionally only
6665 (using #ifdef), and the resulting code with the new feature
6666 disabled must not need more memory than the old code without your
6667 modification.
90dc6704 6668
0668236b
WD
6669* Remember that there is a size limit of 100 kB per message on the
6670 u-boot mailing list. Bigger patches will be moderated. If they are
6671 reasonable and not too big, they will be acknowledged. But patches
6672 bigger than the size limit should be avoided.