blob: 09662a4a0369b2567f6b8274898b4e8b16af8595 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded 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.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support 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
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: 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
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<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
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where 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
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- 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
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
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
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting 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.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 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
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
135 /arm Files generic to ARM architecture
136 /cpu CPU specific files
137 /arm720t Files specific to ARM 720 CPUs
138 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000139 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200140 /imx Files specific to Freescale MC9328 i.MX CPUs
141 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /arm926ejs Files specific to ARM 926 CPUs
143 /arm1136 Files specific to ARM 1136 CPUs
144 /ixp Files specific to Intel XScale IXP CPUs
145 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
147 /lib Architecture specific library files
148 /avr32 Files generic to AVR32 architecture
149 /cpu CPU specific files
150 /lib Architecture specific library files
151 /blackfin Files generic to Analog Devices Blackfin architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500154 /m68k Files generic to m68k architecture
155 /cpu CPU specific files
156 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
157 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
158 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
159 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
160 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
161 /lib Architecture specific library files
162 /microblaze Files generic to microblaze architecture
163 /cpu CPU specific files
164 /lib Architecture specific library files
165 /mips Files generic to MIPS architecture
166 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200167 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800168 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500169 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000170 /nds32 Files generic to NDS32 architecture
171 /cpu CPU specific files
172 /n1213 Files specific to Andes Technology N1213 CPUs
173 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500174 /nios2 Files generic to Altera NIOS2 architecture
175 /cpu CPU specific files
176 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400177 /openrisc Files generic to OpenRISC architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200180 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500181 /cpu CPU specific files
182 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
183 /mpc5xx Files specific to Freescale MPC5xx CPUs
184 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
185 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500186 /mpc824x Files specific to Freescale MPC824x CPUs
187 /mpc8260 Files specific to Freescale MPC8260 CPUs
188 /mpc85xx Files specific to Freescale MPC85xx CPUs
189 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
190 /lib Architecture specific library files
191 /sh Files generic to SH architecture
192 /cpu CPU specific files
193 /sh2 Files specific to sh2 CPUs
194 /sh3 Files specific to sh3 CPUs
195 /sh4 Files specific to sh4 CPUs
196 /lib Architecture specific library files
197 /sparc Files generic to SPARC architecture
198 /cpu CPU specific files
199 /leon2 Files specific to Gaisler LEON2 SPARC CPU
200 /leon3 Files specific to Gaisler LEON3 SPARC CPU
201 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400202 /x86 Files generic to x86 architecture
203 /cpu CPU specific files
204 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500205/api Machine/arch independent API for external apps
206/board Board dependent files
207/common Misc architecture independent functions
208/disk Code for disk drive partition handling
209/doc Documentation (don't expect too much)
210/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400211/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500212/examples Example code for standalone applications, etc.
213/fs Filesystem code (cramfs, ext2, jffs2, etc.)
214/include Header Files
215/lib Files generic to all architectures
216 /libfdt Library files to support flattened device trees
217 /lzma Library files to support LZMA decompression
218 /lzo Library files to support LZO decompression
219/net Networking code
220/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400221/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500222/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000223
wdenkc6097192002-11-03 00:24:07 +0000224Software Configuration:
225=======================
226
227Configuration is usually done using C preprocessor defines; the
228rationale behind that is to avoid dead code whenever possible.
229
230There are two classes of configuration variables:
231
232* Configuration _OPTIONS_:
233 These are selectable by the user and have names beginning with
234 "CONFIG_".
235
236* Configuration _SETTINGS_:
237 These depend on the hardware etc. and should not be meddled with if
238 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200239 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000240
241Later we will add a configuration tool - probably similar to or even
242identical to what's used for the Linux kernel. Right now, we have to
243do the configuration by hand, which means creating some symbolic
244links and editing some configuration files. We use the TQM8xxL boards
245as an example here.
246
247
248Selection of Processor Architecture and Board Type:
249---------------------------------------------------
250
251For all supported boards there are ready-to-use default
252configurations available; just type "make <board_name>_config".
253
254Example: For a TQM823L module type:
255
256 cd u-boot
257 make TQM823L_config
258
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200259For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000260e.g. "make cogent_mpc8xx_config". And also configure the cogent
261directory according to the instructions in cogent/README.
262
263
264Configuration Options:
265----------------------
266
267Configuration depends on the combination of board and CPU type; all
268such information is kept in a configuration file
269"include/configs/<board_name>.h".
270
271Example: For a TQM823L module, all configuration settings are in
272"include/configs/TQM823L.h".
273
274
wdenk7f6c2cb2002-11-10 22:06:23 +0000275Many of the options are named exactly as the corresponding Linux
276kernel configuration options. The intention is to make it easier to
277build a config tool - later.
278
279
wdenkc6097192002-11-03 00:24:07 +0000280The following options need to be configured:
281
Kim Phillips26281142007-08-10 13:28:25 -0500282- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000283
Kim Phillips26281142007-08-10 13:28:25 -0500284- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200285
286- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100287 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000288
289- CPU Module Type: (if CONFIG_COGENT is defined)
290 Define exactly one of
291 CONFIG_CMA286_60_OLD
292--- FIXME --- not tested yet:
293 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
294 CONFIG_CMA287_23, CONFIG_CMA287_50
295
296- Motherboard Type: (if CONFIG_COGENT is defined)
297 Define exactly one of
298 CONFIG_CMA101, CONFIG_CMA102
299
300- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
301 Define one or more of
302 CONFIG_CMA302
303
304- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
305 Define one or more of
306 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200307 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000308 a "rotator" |\-/|\-/
309
wdenk2535d602003-07-17 23:16:40 +0000310- Board flavour: (if CONFIG_MPC8260ADS is defined)
311 CONFIG_ADSTYPE
312 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200313 CONFIG_SYS_8260ADS - original MPC8260ADS
314 CONFIG_SYS_8266ADS - MPC8266ADS
315 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
316 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000317
Lei Wencf946c62011-02-09 18:06:58 +0530318- Marvell Family Member
319 CONFIG_SYS_MVFS - define it if you want to enable
320 multiple fs option at one time
321 for marvell soc family
322
wdenkc6097192002-11-03 00:24:07 +0000323- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000324 Define exactly one of
325 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000326
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200327- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000328 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
329 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000330 e.g. if there is no 32KHz
331 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000332 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
333 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000334
wdenk66ca92a2004-09-28 17:59:53 +0000335- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200336 CONFIG_SYS_8xx_CPUCLK_MIN
337 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000339 See doc/README.MPC866
340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200341 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000342
wdenkba56f622004-02-06 23:19:44 +0000343 Define this to measure the actual CPU clock instead
344 of relying on the correctness of the configured
345 values. Mostly useful for board bringup to make sure
346 the PLL is locked at the intended frequency. Note
347 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200348 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000349
Heiko Schocher506f3912009-03-12 07:37:15 +0100350 CONFIG_SYS_DELAYED_ICACHE
351
352 Define this option if you want to enable the
353 ICache only when Code runs from RAM.
354
Kumar Gala66412c62011-02-18 05:40:54 -0600355- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000356 CONFIG_SYS_PPC64
357
358 Specifies that the core is a 64-bit PowerPC implementation (implements
359 the "64" category of the Power ISA). This is necessary for ePAPR
360 compliance, among other possible reasons.
361
Kumar Gala66412c62011-02-18 05:40:54 -0600362 CONFIG_SYS_FSL_TBCLK_DIV
363
364 Defines the core time base clock divider ratio compared to the
365 system clock. On most PQ3 devices this is 8, on newer QorIQ
366 devices it can be 16 or 32. The ratio varies from SoC to Soc.
367
Kumar Gala8f290842011-05-20 00:39:21 -0500368 CONFIG_SYS_FSL_PCIE_COMPAT
369
370 Defines the string to utilize when trying to match PCIe device
371 tree nodes for the given platform.
372
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000373 CONFIG_SYS_PPC_E500_DEBUG_TLB
374
375 Enables a temporary TLB entry to be used during boot to work
376 around limitations in e500v1 and e500v2 external debugger
377 support. This reduces the portions of the boot code where
378 breakpoints and single stepping do not work. The value of this
379 symbol should be set to the TLB1 entry to be used for this
380 purpose.
381
Scott Wood33eee332012-08-14 10:14:53 +0000382 CONFIG_SYS_FSL_ERRATUM_A004510
383
384 Enables a workaround for erratum A004510. If set,
385 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
386 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
387
388 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
389 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
390
391 Defines one or two SoC revisions (low 8 bits of SVR)
392 for which the A004510 workaround should be applied.
393
394 The rest of SVR is either not relevant to the decision
395 of whether the erratum is present (e.g. p2040 versus
396 p2041) or is implied by the build target, which controls
397 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
398
399 See Freescale App Note 4493 for more information about
400 this erratum.
401
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530402 CONFIG_A003399_NOR_WORKAROUND
403 Enables a workaround for IFC erratum A003399. It is only
404 requred during NOR boot.
405
Scott Wood33eee332012-08-14 10:14:53 +0000406 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
407
408 This is the value to write into CCSR offset 0x18600
409 according to the A004510 workaround.
410
Priyanka Jain64501c62013-07-02 09:21:04 +0530411 CONFIG_SYS_FSL_DSP_DDR_ADDR
412 This value denotes start offset of DDR memory which is
413 connected exclusively to the DSP cores.
414
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530415 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
416 This value denotes start offset of M2 memory
417 which is directly connected to the DSP core.
418
Priyanka Jain64501c62013-07-02 09:21:04 +0530419 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
420 This value denotes start offset of M3 memory which is directly
421 connected to the DSP core.
422
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530423 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
424 This value denotes start offset of DSP CCSR space.
425
York Suncb930712013-06-25 11:37:41 -0700426 CONFIG_SYS_FSL_DDR_EMU
427 Specify emulator support for DDR. Some DDR features such as
428 deskew training are not available.
429
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000430- Generic CPU options:
431 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
432
433 Defines the endianess of the CPU. Implementation of those
434 values is arch specific.
435
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100436- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200437 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100438
439 Defines the Monahans run mode to oscillator
440 ratio. Valid values are 8, 16, 24, 31. The core
441 frequency is this value multiplied by 13 MHz.
442
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200443 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200444
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100445 Defines the Monahans turbo mode to oscillator
446 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200447 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100448 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200449
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200450- MIPS CPU options:
451 CONFIG_SYS_INIT_SP_OFFSET
452
453 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
454 pointer. This is needed for the temporary stack before
455 relocation.
456
457 CONFIG_SYS_MIPS_CACHE_MODE
458
459 Cache operation mode for the MIPS CPU.
460 See also arch/mips/include/asm/mipsregs.h.
461 Possible values are:
462 CONF_CM_CACHABLE_NO_WA
463 CONF_CM_CACHABLE_WA
464 CONF_CM_UNCACHED
465 CONF_CM_CACHABLE_NONCOHERENT
466 CONF_CM_CACHABLE_CE
467 CONF_CM_CACHABLE_COW
468 CONF_CM_CACHABLE_CUW
469 CONF_CM_CACHABLE_ACCELERATED
470
471 CONFIG_SYS_XWAY_EBU_BOOTCFG
472
473 Special option for Lantiq XWAY SoCs for booting from NOR flash.
474 See also arch/mips/cpu/mips32/start.S.
475
476 CONFIG_XWAY_SWAP_BYTES
477
478 Enable compilation of tools/xway-swap-bytes needed for Lantiq
479 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
480 be swapped if a flash programmer is used.
481
Christian Rieschb67d8812012-02-02 00:44:39 +0000482- ARM options:
483 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
484
485 Select high exception vectors of the ARM core, e.g., do not
486 clear the V bit of the c1 register of CP15.
487
Aneesh V5356f542012-03-08 07:20:19 +0000488 CONFIG_SYS_THUMB_BUILD
489
490 Use this flag to build U-Boot using the Thumb instruction
491 set for ARM architectures. Thumb instruction set provides
492 better code density. For ARM architectures that support
493 Thumb2 this flag will result in Thumb2 code generated by
494 GCC.
495
Stephen Warrenc5d47522013-03-04 13:29:40 +0000496 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000497 CONFIG_ARM_ERRATA_742230
498 CONFIG_ARM_ERRATA_743622
499 CONFIG_ARM_ERRATA_751472
500
501 If set, the workarounds for these ARM errata are applied early
502 during U-Boot startup. Note that these options force the
503 workarounds to be applied; no CPU-type/version detection
504 exists, unlike the similar options in the Linux kernel. Do not
505 set these options unless they apply!
506
Stephen Warren795659d2013-03-27 17:06:41 +0000507- CPU timer options:
508 CONFIG_SYS_HZ
509
510 The frequency of the timer returned by get_timer().
511 get_timer() must operate in milliseconds and this CONFIG
512 option must be set to 1000.
513
wdenk5da627a2003-10-09 20:09:04 +0000514- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000515 CONFIG_CLOCKS_IN_MHZ
516
517 U-Boot stores all clock information in Hz
518 internally. For binary compatibility with older Linux
519 kernels (which expect the clocks passed in the
520 bd_info data to be in MHz) the environment variable
521 "clocks_in_mhz" can be defined so that U-Boot
522 converts clock data to MHZ before passing it to the
523 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000524 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100525 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000526 default environment.
527
wdenk5da627a2003-10-09 20:09:04 +0000528 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
529
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200530 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000531 expect it to be in bytes, others in MB.
532 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
533
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400534 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200535
536 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400537 passed using flattened device trees (based on open firmware
538 concepts).
539
540 CONFIG_OF_LIBFDT
541 * New libfdt-based support
542 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500543 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400544
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200545 OF_CPU - The proper name of the cpus node (only required for
546 MPC512X and MPC5xxx based boards).
547 OF_SOC - The proper name of the soc node (only required for
548 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200549 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600550 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200551
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200552 boards with QUICC Engines require OF_QE to set UCC MAC
553 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500554
Kumar Gala4e253132006-01-11 13:54:17 -0600555 CONFIG_OF_BOARD_SETUP
556
557 Board code has addition modification that it wants to make
558 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000559
Matthew McClintock02677682006-06-28 10:41:37 -0500560 CONFIG_OF_BOOT_CPU
561
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200562 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500563 param header, the default value is zero if undefined.
564
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200565 CONFIG_OF_IDE_FIXUP
566
567 U-Boot can detect if an IDE device is present or not.
568 If not, and this new config option is activated, U-Boot
569 removes the ATA node from the DTS before booting Linux,
570 so the Linux IDE driver does not probe the device and
571 crash. This is needed for buggy hardware (uc101) where
572 no pull down resistor is connected to the signal IDE5V_DD7.
573
Igor Grinberg7eb29392011-07-14 05:45:07 +0000574 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
575
576 This setting is mandatory for all boards that have only one
577 machine type and must be used to specify the machine type
578 number as it appears in the ARM machine registry
579 (see http://www.arm.linux.org.uk/developer/machines/).
580 Only boards that have multiple machine types supported
581 in a single configuration file and the machine type is
582 runtime discoverable, do not have to use this setting.
583
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100584- vxWorks boot parameters:
585
586 bootvx constructs a valid bootline using the following
587 environments variables: bootfile, ipaddr, serverip, hostname.
588 It loads the vxWorks image pointed bootfile.
589
590 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
591 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
592 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
593 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
594
595 CONFIG_SYS_VXWORKS_ADD_PARAMS
596
597 Add it at the end of the bootline. E.g "u=username pw=secret"
598
599 Note: If a "bootargs" environment is defined, it will overwride
600 the defaults discussed just above.
601
Aneesh V2c451f72011-06-16 23:30:47 +0000602- Cache Configuration:
603 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
604 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
605 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
606
Aneesh V93bc2192011-06-16 23:30:51 +0000607- Cache Configuration for ARM:
608 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
609 controller
610 CONFIG_SYS_PL310_BASE - Physical base address of PL310
611 controller register space
612
wdenk6705d812004-08-02 23:22:59 +0000613- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200614 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000615
616 Define this if you want support for Amba PrimeCell PL010 UARTs.
617
Andreas Engel48d01922008-09-08 14:30:53 +0200618 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000619
620 Define this if you want support for Amba PrimeCell PL011 UARTs.
621
622 CONFIG_PL011_CLOCK
623
624 If you have Amba PrimeCell PL011 UARTs, set this variable to
625 the clock speed of the UARTs.
626
627 CONFIG_PL01x_PORTS
628
629 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
630 define this to a list of base addresses for each (supported)
631 port. See e.g. include/configs/versatile.h
632
John Rigby910f1ae2011-04-19 10:42:39 +0000633 CONFIG_PL011_SERIAL_RLCR
634
635 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
636 have separate receive and transmit line control registers. Set
637 this variable to initialize the extra register.
638
639 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
640
641 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
642 boot loader that has already initialized the UART. Define this
643 variable to flush the UART at init time.
644
wdenk6705d812004-08-02 23:22:59 +0000645
wdenkc6097192002-11-03 00:24:07 +0000646- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000647 Depending on board, define exactly one serial port
648 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
649 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
650 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000651
652 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
653 port routines must be defined elsewhere
654 (i.e. serial_init(), serial_getc(), ...)
655
656 CONFIG_CFB_CONSOLE
657 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000658 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000659 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
660 (default big endian)
661 VIDEO_HW_RECTFILL graphic chip supports
662 rectangle fill
663 (cf. smiLynxEM)
664 VIDEO_HW_BITBLT graphic chip supports
665 bit-blit (cf. smiLynxEM)
666 VIDEO_VISIBLE_COLS visible pixel columns
667 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000668 VIDEO_VISIBLE_ROWS visible pixel rows
669 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000670 VIDEO_DATA_FORMAT graphic data format
671 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000672 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000673 VIDEO_KBD_INIT_FCT keyboard int fct
674 (i.e. i8042_kbd_init())
675 VIDEO_TSTC_FCT test char fct
676 (i.e. i8042_tstc)
677 VIDEO_GETC_FCT get char fct
678 (i.e. i8042_getc)
679 CONFIG_CONSOLE_CURSOR cursor drawing on/off
680 (requires blink timer
681 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200682 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000683 CONFIG_CONSOLE_TIME display time/date info in
684 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500685 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000686 CONFIG_VIDEO_LOGO display Linux logo in
687 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000688 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
689 linux_logo.h for logo.
690 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000691 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200692 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000693 the logo
694
Pali Rohár33a35bb2012-10-19 13:30:09 +0000695 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
696 a limited number of ANSI escape sequences (cursor control,
697 erase functions and limited graphics rendition control).
698
wdenk43d96162003-03-06 00:02:04 +0000699 When CONFIG_CFB_CONSOLE is defined, video console is
700 default i/o. Serial console can be forced with
701 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000702
wdenkd4ca31c2004-01-02 14:00:00 +0000703 When CONFIG_SILENT_CONSOLE is defined, all console
704 messages (by U-Boot and Linux!) can be silenced with
705 the "silent" environment variable. See
706 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000707
wdenkc6097192002-11-03 00:24:07 +0000708- Console Baudrate:
709 CONFIG_BAUDRATE - in bps
710 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200711 CONFIG_SYS_BAUDRATE_TABLE, see below.
712 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000713
Heiko Schocherc92fac92009-01-30 12:55:38 +0100714- Console Rx buffer length
715 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
716 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100717 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100718 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
719 must be defined, to setup the maximum idle timeout for
720 the SMC.
721
Graeme Russ9558b482011-09-01 00:48:27 +0000722- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200723 Prior to the console being initialised (i.e. serial UART
724 initialised etc) all console output is silently discarded.
725 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
726 buffer any console messages prior to the console being
727 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
728 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
729 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200730 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200731 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000732
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200733 'Sane' compilers will generate smaller code if
734 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000735
Sonny Rao046a37b2011-11-02 09:52:08 +0000736- Safe printf() functions
737 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
738 the printf() functions. These are defined in
739 include/vsprintf.h and include snprintf(), vsnprintf() and
740 so on. Code size increase is approximately 300-500 bytes.
741 If this option is not given then these functions will
742 silently discard their buffer size argument - this means
743 you are not getting any overflow checking in this case.
744
wdenkc6097192002-11-03 00:24:07 +0000745- Boot Delay: CONFIG_BOOTDELAY - in seconds
746 Delay before automatically booting the default image;
747 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000748 set to -2 to autoboot with no delay and not check for abort
749 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000750
751 See doc/README.autoboot for these options that
752 work with CONFIG_BOOTDELAY. None are required.
753 CONFIG_BOOT_RETRY_TIME
754 CONFIG_BOOT_RETRY_MIN
755 CONFIG_AUTOBOOT_KEYED
756 CONFIG_AUTOBOOT_PROMPT
757 CONFIG_AUTOBOOT_DELAY_STR
758 CONFIG_AUTOBOOT_STOP_STR
759 CONFIG_AUTOBOOT_DELAY_STR2
760 CONFIG_AUTOBOOT_STOP_STR2
761 CONFIG_ZERO_BOOTDELAY_CHECK
762 CONFIG_RESET_TO_RETRY
763
764- Autoboot Command:
765 CONFIG_BOOTCOMMAND
766 Only needed when CONFIG_BOOTDELAY is enabled;
767 define a command string that is automatically executed
768 when no character is read on the console interface
769 within "Boot Delay" after reset.
770
771 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000772 This can be used to pass arguments to the bootm
773 command. The value of CONFIG_BOOTARGS goes into the
774 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000775
776 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000777 The value of these goes into the environment as
778 "ramboot" and "nfsboot" respectively, and can be used
779 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200780 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000781
782- Pre-Boot Commands:
783 CONFIG_PREBOOT
784
785 When this option is #defined, the existence of the
786 environment variable "preboot" will be checked
787 immediately before starting the CONFIG_BOOTDELAY
788 countdown and/or running the auto-boot command resp.
789 entering interactive mode.
790
791 This feature is especially useful when "preboot" is
792 automatically generated or modified. For an example
793 see the LWMON board specific code: here "preboot" is
794 modified when the user holds down a certain
795 combination of keys on the (special) keyboard when
796 booting the systems
797
798- Serial Download Echo Mode:
799 CONFIG_LOADS_ECHO
800 If defined to 1, all characters received during a
801 serial download (using the "loads" command) are
802 echoed back. This might be needed by some terminal
803 emulations (like "cu"), but may as well just take
804 time on others. This setting #define's the initial
805 value of the "loads_echo" environment variable.
806
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500807- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000808 CONFIG_KGDB_BAUDRATE
809 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200810 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000811
812- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500813 Monitor commands can be included or excluded
814 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000815 <config_cmd_all.h> and #undef'ing unwanted
816 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500817 and augmenting with additional #define's
818 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000819
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500820 The default command configuration includes all commands
821 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000822
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500823 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500824 CONFIG_CMD_BDI bdinfo
825 CONFIG_CMD_BEDBUG * Include BedBug Debugger
826 CONFIG_CMD_BMP * BMP support
827 CONFIG_CMD_BSP * Board specific commands
828 CONFIG_CMD_BOOTD bootd
829 CONFIG_CMD_CACHE * icache, dcache
830 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500831 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500832 CONFIG_CMD_DATE * support for RTC, date/time...
833 CONFIG_CMD_DHCP * DHCP support
834 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600835 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
836 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
837 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
838 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500839 CONFIG_CMD_DTT * Digital Therm and Thermostat
840 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500841 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500842 CONFIG_CMD_EEPROM * EEPROM read/write support
843 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600844 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600845 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500846 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000847 CONFIG_CMD_EXT2 * ext2 command support
848 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500849 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500850 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000851 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500852 CONFIG_CMD_FDOS * Dos diskette Support
853 CONFIG_CMD_FLASH flinfo, erase, protect
854 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200855 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000856 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500857 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000858 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000859 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500860 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
861 CONFIG_CMD_I2C * I2C serial bus support
862 CONFIG_CMD_IDE * IDE harddisk support
863 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000864 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200865 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500866 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500867 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000868 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500869 CONFIG_CMD_IRQ * irqinfo
870 CONFIG_CMD_ITEST Integer/string test of 2 values
871 CONFIG_CMD_JFFS2 * JFFS2 Support
872 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200873 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000874 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
875 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500876 CONFIG_CMD_LOADB loadb
877 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200878 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400879 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000880 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500881 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000882 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200883 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500884 CONFIG_CMD_MISC Misc functions like sleep etc
885 CONFIG_CMD_MMC * MMC memory mapped support
886 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100887 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500888 CONFIG_CMD_NAND * NAND support
889 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200890 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -0600891 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000892 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500893 CONFIG_CMD_PCI * pciinfo
894 CONFIG_CMD_PCMCIA * PCMCIA support
895 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
896 host
897 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000898 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500899 CONFIG_CMD_REGINFO * Register dump
900 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000901 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500902 CONFIG_CMD_SAVES * save S record dump
903 CONFIG_CMD_SCSI * SCSI Support
904 CONFIG_CMD_SDRAM * print SDRAM configuration information
905 (requires CONFIG_CMD_I2C)
906 CONFIG_CMD_SETGETDCR Support for DCR Register access
907 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700908 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200909 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400910 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800911 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200912 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500913 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000914 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000915 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000916 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
917 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500918 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500919 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000920 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200921 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000922
wdenkc6097192002-11-03 00:24:07 +0000923
924 EXAMPLE: If you want all functions except of network
925 support you can write:
926
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500927 #include "config_cmd_all.h"
928 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000929
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400930 Other Commands:
931 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000932
933 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500934 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000935 what you (and your U-Boot users) are doing. Data
936 cache cannot be enabled on systems like the 8xx or
937 8260 (where accesses to the IMMR region must be
938 uncached), and it cannot be disabled on all other
939 systems where we (mis-) use the data cache to hold an
940 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000941
942
943 XXX - this list needs to get updated!
944
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000945- Regular expression support:
946 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200947 If this variable is defined, U-Boot is linked against
948 the SLRE (Super Light Regular Expression) library,
949 which adds regex support to some commands, as for
950 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000951
Simon Glass45ba8072011-10-15 05:48:20 +0000952- Device tree:
953 CONFIG_OF_CONTROL
954 If this variable is defined, U-Boot will use a device tree
955 to configure its devices, instead of relying on statically
956 compiled #defines in the board file. This option is
957 experimental and only available on a few boards. The device
958 tree is available in the global data as gd->fdt_blob.
959
Simon Glass2c0f79e2011-10-24 19:15:31 +0000960 U-Boot needs to get its device tree from somewhere. This can
961 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000962
963 CONFIG_OF_EMBED
964 If this variable is defined, U-Boot will embed a device tree
965 binary in its image. This device tree file should be in the
966 board directory and called <soc>-<board>.dts. The binary file
967 is then picked up in board_init_f() and made available through
968 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000969
Simon Glass2c0f79e2011-10-24 19:15:31 +0000970 CONFIG_OF_SEPARATE
971 If this variable is defined, U-Boot will build a device tree
972 binary. It will be called u-boot.dtb. Architecture-specific
973 code will locate it at run-time. Generally this works by:
974
975 cat u-boot.bin u-boot.dtb >image.bin
976
977 and in fact, U-Boot does this for you, creating a file called
978 u-boot-dtb.bin which is useful in the common case. You can
979 still use the individual files if you need something more
980 exotic.
981
wdenkc6097192002-11-03 00:24:07 +0000982- Watchdog:
983 CONFIG_WATCHDOG
984 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000985 support for the SoC. There must be support in the SoC
986 specific code for a watchdog. For the 8xx and 8260
987 CPUs, the SIU Watchdog feature is enabled in the SYPCR
988 register. When supported for a specific SoC is
989 available, then no further board specific code should
990 be needed to use it.
991
992 CONFIG_HW_WATCHDOG
993 When using a watchdog circuitry external to the used
994 SoC, then define this variable and provide board
995 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000996
stroesec1551ea2003-04-04 15:53:41 +0000997- U-Boot Version:
998 CONFIG_VERSION_VARIABLE
999 If this variable is defined, an environment variable
1000 named "ver" is created by U-Boot showing the U-Boot
1001 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001002 Any change to this variable will be reverted at the
1003 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001004
wdenkc6097192002-11-03 00:24:07 +00001005- Real-Time Clock:
1006
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001007 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001008 has to be selected, too. Define exactly one of the
1009 following options:
1010
1011 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1012 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001013 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001014 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001015 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001016 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001017 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001018 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001019 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001020 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001021 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001022 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1023 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001024
wdenkb37c7e52003-06-30 16:24:52 +00001025 Note that if the RTC uses I2C, then the I2C interface
1026 must also be configured. See I2C Support, below.
1027
Peter Tysere92739d2008-12-17 16:36:21 -06001028- GPIO Support:
1029 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1030 CONFIG_PCA953X_INFO - enable pca953x info command
1031
Chris Packham5dec49c2010-12-19 10:12:13 +00001032 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1033 chip-ngpio pairs that tell the PCA953X driver the number of
1034 pins supported by a particular chip.
1035
Peter Tysere92739d2008-12-17 16:36:21 -06001036 Note that if the GPIO device uses I2C, then the I2C interface
1037 must also be configured. See I2C Support, below.
1038
wdenkc6097192002-11-03 00:24:07 +00001039- Timestamp Support:
1040
wdenk43d96162003-03-06 00:02:04 +00001041 When CONFIG_TIMESTAMP is selected, the timestamp
1042 (date and time) of an image is printed by image
1043 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001044 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001045
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001046- Partition Labels (disklabels) Supported:
1047 Zero or more of the following:
1048 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1049 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1050 Intel architecture, USB sticks, etc.
1051 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1052 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1053 bootloader. Note 2TB partition limit; see
1054 disk/part_efi.c
1055 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001056
Wolfgang Denk218ca722008-03-26 10:40:12 +01001057 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1058 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001059 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001060
1061- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001062 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1063 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001064
wdenk4d13cba2004-03-14 14:09:05 +00001065 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1066 be performed by calling the function
1067 ide_set_reset(int reset)
1068 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001069
1070- ATAPI Support:
1071 CONFIG_ATAPI
1072
1073 Set this to enable ATAPI support.
1074
wdenkc40b2952004-03-13 23:29:43 +00001075- LBA48 Support
1076 CONFIG_LBA48
1077
1078 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001079 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001080 Whithout these , LBA48 support uses 32bit variables and will 'only'
1081 support disks up to 2.1TB.
1082
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001083 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001084 When enabled, makes the IDE subsystem use 64bit sector addresses.
1085 Default is 32bit.
1086
wdenkc6097192002-11-03 00:24:07 +00001087- SCSI Support:
1088 At the moment only there is only support for the
1089 SYM53C8XX SCSI controller; define
1090 CONFIG_SCSI_SYM53C8XX to enable it.
1091
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001092 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1093 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1094 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001095 maximum numbers of LUNs, SCSI ID's and target
1096 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001097 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001098
Wolfgang Denk93e14592013-10-04 17:43:24 +02001099 The environment variable 'scsidevs' is set to the number of
1100 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001101
wdenkc6097192002-11-03 00:24:07 +00001102- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001103 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001104 Support for Intel 8254x/8257x gigabit chips.
1105
1106 CONFIG_E1000_SPI
1107 Utility code for direct access to the SPI bus on Intel 8257x.
1108 This does not do anything useful unless you set at least one
1109 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1110
1111 CONFIG_E1000_SPI_GENERIC
1112 Allow generic access to the SPI bus on the Intel 8257x, for
1113 example with the "sspi" command.
1114
1115 CONFIG_CMD_E1000
1116 Management command for E1000 devices. When used on devices
1117 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001118
Andre Schwarzac3315c2008-03-06 16:45:44 +01001119 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001120 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001121
wdenkc6097192002-11-03 00:24:07 +00001122 CONFIG_EEPRO100
1123 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001124 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001125 write routine for first time initialisation.
1126
1127 CONFIG_TULIP
1128 Support for Digital 2114x chips.
1129 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1130 modem chip initialisation (KS8761/QS6611).
1131
1132 CONFIG_NATSEMI
1133 Support for National dp83815 chips.
1134
1135 CONFIG_NS8382X
1136 Support for National dp8382[01] gigabit chips.
1137
wdenk45219c42003-05-12 21:50:16 +00001138- NETWORK Support (other):
1139
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001140 CONFIG_DRIVER_AT91EMAC
1141 Support for AT91RM9200 EMAC.
1142
1143 CONFIG_RMII
1144 Define this to use reduced MII inteface
1145
1146 CONFIG_DRIVER_AT91EMAC_QUIET
1147 If this defined, the driver is quiet.
1148 The driver doen't show link status messages.
1149
Rob Herringefdd7312011-12-15 11:15:49 +00001150 CONFIG_CALXEDA_XGMAC
1151 Support for the Calxeda XGMAC device
1152
Ashok3bb46d22012-10-15 06:20:47 +00001153 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001154 Support for SMSC's LAN91C96 chips.
1155
1156 CONFIG_LAN91C96_BASE
1157 Define this to hold the physical address
1158 of the LAN91C96's I/O space
1159
1160 CONFIG_LAN91C96_USE_32_BIT
1161 Define this to enable 32 bit addressing
1162
Ashok3bb46d22012-10-15 06:20:47 +00001163 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001164 Support for SMSC's LAN91C111 chip
1165
1166 CONFIG_SMC91111_BASE
1167 Define this to hold the physical address
1168 of the device (I/O space)
1169
1170 CONFIG_SMC_USE_32_BIT
1171 Define this if data bus is 32 bits
1172
1173 CONFIG_SMC_USE_IOFUNCS
1174 Define this to use i/o functions instead of macros
1175 (some hardware wont work with macros)
1176
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001177 CONFIG_DRIVER_TI_EMAC
1178 Support for davinci emac
1179
1180 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1181 Define this if you have more then 3 PHYs.
1182
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001183 CONFIG_FTGMAC100
1184 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1185
1186 CONFIG_FTGMAC100_EGIGA
1187 Define this to use GE link update with gigabit PHY.
1188 Define this if FTGMAC100 is connected to gigabit PHY.
1189 If your system has 10/100 PHY only, it might not occur
1190 wrong behavior. Because PHY usually return timeout or
1191 useless data when polling gigabit status and gigabit
1192 control registers. This behavior won't affect the
1193 correctnessof 10/100 link speed update.
1194
Mike Rapoportc2fff332009-11-11 10:03:03 +02001195 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001196 Support for SMSC's LAN911x and LAN921x chips
1197
Mike Rapoportc2fff332009-11-11 10:03:03 +02001198 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001199 Define this to hold the physical address
1200 of the device (I/O space)
1201
Mike Rapoportc2fff332009-11-11 10:03:03 +02001202 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001203 Define this if data bus is 32 bits
1204
Mike Rapoportc2fff332009-11-11 10:03:03 +02001205 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001206 Define this if data bus is 16 bits. If your processor
1207 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001208 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001209
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001210 CONFIG_SH_ETHER
1211 Support for Renesas on-chip Ethernet controller
1212
1213 CONFIG_SH_ETHER_USE_PORT
1214 Define the number of ports to be used
1215
1216 CONFIG_SH_ETHER_PHY_ADDR
1217 Define the ETH PHY's address
1218
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001219 CONFIG_SH_ETHER_CACHE_WRITEBACK
1220 If this option is set, the driver enables cache flush.
1221
Vadim Bendebury5e124722011-10-17 08:36:14 +00001222- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001223 CONFIG_TPM
1224 Support TPM devices.
1225
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001226 CONFIG_TPM_TIS_I2C
1227 Support for i2c bus TPM devices. Only one device
1228 per system is supported at this time.
1229
1230 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1231 Define the the i2c bus number for the TPM device
1232
1233 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1234 Define the TPM's address on the i2c bus
1235
1236 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1237 Define the burst count bytes upper limit
1238
Dirk Eibachc01939c2013-06-26 15:55:15 +02001239 CONFIG_TPM_ATMEL_TWI
1240 Support for Atmel TWI TPM device. Requires I2C support.
1241
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001242 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001243 Support for generic parallel port TPM devices. Only one device
1244 per system is supported at this time.
1245
1246 CONFIG_TPM_TIS_BASE_ADDRESS
1247 Base address where the generic TPM device is mapped
1248 to. Contemporary x86 systems usually map it at
1249 0xfed40000.
1250
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001251 CONFIG_CMD_TPM
1252 Add tpm monitor functions.
1253 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1254 provides monitor access to authorized functions.
1255
1256 CONFIG_TPM
1257 Define this to enable the TPM support library which provides
1258 functional interfaces to some TPM commands.
1259 Requires support for a TPM device.
1260
1261 CONFIG_TPM_AUTH_SESSIONS
1262 Define this to enable authorized functions in the TPM library.
1263 Requires CONFIG_TPM and CONFIG_SHA1.
1264
wdenkc6097192002-11-03 00:24:07 +00001265- USB Support:
1266 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001267 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001268 CONFIG_USB_UHCI to enable it.
1269 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001270 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001271 storage devices.
1272 Note:
1273 Supported are USB Keyboards and USB Floppy drives
1274 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001275 MPC5200 USB requires additional defines:
1276 CONFIG_USB_CLOCK
1277 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001278 CONFIG_PSC3_USB
1279 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001280 CONFIG_USB_CONFIG
1281 for differential drivers: 0x00001000
1282 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001283 for differential drivers on PSC3: 0x00000100
1284 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001285 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001286 May be defined to allow interrupt polling
1287 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001288
Simon Glass9ab4ce22012-02-27 10:52:47 +00001289 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1290 txfilltuning field in the EHCI controller on reset.
1291
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001292 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1293 interval for usb hub power-on delay.(minimum 100msec)
1294
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001295- USB Device:
1296 Define the below if you wish to use the USB console.
1297 Once firmware is rebuilt from a serial console issue the
1298 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001299 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001300 it has found a new device. The environment variable usbtty
1301 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001302 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001303 Common Device Class Abstract Control Model serial device.
1304 If you select usbtty = gserial you should be able to enumerate
1305 a Linux host by
1306 # modprobe usbserial vendor=0xVendorID product=0xProductID
1307 else if using cdc_acm, simply setting the environment
1308 variable usbtty to be cdc_acm should suffice. The following
1309 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001310
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001311 CONFIG_USB_DEVICE
1312 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001313
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001314 CONFIG_USB_TTY
1315 Define this to have a tty type of device available to
1316 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001317
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301318 CONFIG_USBD_HS
1319 Define this to enable the high speed support for usb
1320 device and usbtty. If this feature is enabled, a routine
1321 int is_usbd_high_speed(void)
1322 also needs to be defined by the driver to dynamically poll
1323 whether the enumeration has succeded at high speed or full
1324 speed.
1325
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001326 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001327 Define this if you want stdin, stdout &/or stderr to
1328 be set to usbtty.
1329
1330 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001331 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001332 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001333 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001335 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001336 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001337 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001338
Wolfgang Denk386eda02006-06-14 18:14:56 +02001339 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001340 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001341 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001342 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1343 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1344 should pretend to be a Linux device to it's target host.
1345
1346 CONFIG_USBD_MANUFACTURER
1347 Define this string as the name of your company for
1348 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001349
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001350 CONFIG_USBD_PRODUCT_NAME
1351 Define this string as the name of your product
1352 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1353
1354 CONFIG_USBD_VENDORID
1355 Define this as your assigned Vendor ID from the USB
1356 Implementors Forum. This *must* be a genuine Vendor ID
1357 to avoid polluting the USB namespace.
1358 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001359
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001360 CONFIG_USBD_PRODUCTID
1361 Define this as the unique Product ID
1362 for your device
1363 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001364
Igor Grinbergd70a5602011-12-12 12:08:35 +02001365- ULPI Layer Support:
1366 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1367 the generic ULPI layer. The generic layer accesses the ULPI PHY
1368 via the platform viewport, so you need both the genric layer and
1369 the viewport enabled. Currently only Chipidea/ARC based
1370 viewport is supported.
1371 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1372 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001373 If your ULPI phy needs a different reference clock than the
1374 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1375 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001376
1377- MMC Support:
1378 The MMC controller on the Intel PXA is supported. To
1379 enable this define CONFIG_MMC. The MMC can be
1380 accessed from the boot prompt by mapping the device
1381 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001382 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1383 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001384
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001385 CONFIG_SH_MMCIF
1386 Support for Renesas on-chip MMCIF controller
1387
1388 CONFIG_SH_MMCIF_ADDR
1389 Define the base address of MMCIF registers
1390
1391 CONFIG_SH_MMCIF_CLK
1392 Define the clock frequency for MMCIF
1393
Tom Rinib3ba6e92013-03-14 05:32:47 +00001394- USB Device Firmware Update (DFU) class support:
1395 CONFIG_DFU_FUNCTION
1396 This enables the USB portion of the DFU USB class
1397
1398 CONFIG_CMD_DFU
1399 This enables the command "dfu" which is used to have
1400 U-Boot create a DFU class device via USB. This command
1401 requires that the "dfu_alt_info" environment variable be
1402 set and define the alt settings to expose to the host.
1403
1404 CONFIG_DFU_MMC
1405 This enables support for exposing (e)MMC devices via DFU.
1406
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001407 CONFIG_DFU_NAND
1408 This enables support for exposing NAND devices via DFU.
1409
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301410 CONFIG_DFU_RAM
1411 This enables support for exposing RAM via DFU.
1412 Note: DFU spec refer to non-volatile memory usage, but
1413 allow usages beyond the scope of spec - here RAM usage,
1414 one that would help mostly the developer.
1415
Heiko Schochere7e75c72013-06-12 06:05:51 +02001416 CONFIG_SYS_DFU_DATA_BUF_SIZE
1417 Dfu transfer uses a buffer before writing data to the
1418 raw storage device. Make the size (in bytes) of this buffer
1419 configurable. The size of this buffer is also configurable
1420 through the "dfu_bufsiz" environment variable.
1421
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001422 CONFIG_SYS_DFU_MAX_FILE_SIZE
1423 When updating files rather than the raw storage device,
1424 we use a static buffer to copy the file into and then write
1425 the buffer once we've been given the whole file. Define
1426 this to the maximum filesize (in bytes) for the buffer.
1427 Default is 4 MiB if undefined.
1428
wdenk6705d812004-08-02 23:22:59 +00001429- Journaling Flash filesystem support:
1430 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1431 CONFIG_JFFS2_NAND_DEV
1432 Define these for a default partition on a NAND device
1433
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001434 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1435 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001436 Define these for a default partition on a NOR device
1437
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001438 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001439 Define this to create an own partition. You have to provide a
1440 function struct part_info* jffs2_part_info(int part_num)
1441
1442 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001443 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001444 to disable the command chpart. This is the default when you
1445 have not defined a custom partition
1446
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001447- FAT(File Allocation Table) filesystem write function support:
1448 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001449
1450 Define this to enable support for saving memory data as a
1451 file in FAT formatted partition.
1452
1453 This will also enable the command "fatwrite" enabling the
1454 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001455
Gabe Black84cd9322012-10-12 14:26:11 +00001456CBFS (Coreboot Filesystem) support
1457 CONFIG_CMD_CBFS
1458
1459 Define this to enable support for reading from a Coreboot
1460 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1461 and cbfsload.
1462
wdenkc6097192002-11-03 00:24:07 +00001463- Keyboard Support:
1464 CONFIG_ISA_KEYBOARD
1465
1466 Define this to enable standard (PC-Style) keyboard
1467 support
1468
1469 CONFIG_I8042_KBD
1470 Standard PC keyboard driver with US (is default) and
1471 GERMAN key layout (switch via environment 'keymap=de') support.
1472 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1473 for cfb_console. Supports cursor blinking.
1474
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001475 CONFIG_CROS_EC_KEYB
1476 Enables a Chrome OS keyboard using the CROS_EC interface.
1477 This uses CROS_EC to communicate with a second microcontroller
1478 which provides key scans on request.
1479
wdenkc6097192002-11-03 00:24:07 +00001480- Video support:
1481 CONFIG_VIDEO
1482
1483 Define this to enable video support (for output to
1484 video).
1485
1486 CONFIG_VIDEO_CT69000
1487
1488 Enable Chips & Technologies 69000 Video chip
1489
1490 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001491 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001492 video output is selected via environment 'videoout'
1493 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1494 assumed.
wdenkc6097192002-11-03 00:24:07 +00001495
wdenkb79a11c2004-03-25 15:14:43 +00001496 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001497 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001498 are possible:
1499 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001500 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001501
1502 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1503 -------------+---------------------------------------------
1504 8 bits | 0x301* 0x303 0x305 0x161 0x307
1505 15 bits | 0x310 0x313 0x316 0x162 0x319
1506 16 bits | 0x311 0x314 0x317 0x163 0x31A
1507 24 bits | 0x312 0x315 0x318 ? 0x31B
1508 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001509 (i.e. setenv videomode 317; saveenv; reset;)
1510
wdenkb79a11c2004-03-25 15:14:43 +00001511 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001512 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001513
1514
stroesec1551ea2003-04-04 15:53:41 +00001515 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001516 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001517 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1518 or CONFIG_VIDEO_SED13806_16BPP
1519
Timur Tabi7d3053f2011-02-15 17:09:19 -06001520 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001521 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001522 SOCs that have a DIU should define this macro to enable DIU
1523 support, and should also define these other macros:
1524
1525 CONFIG_SYS_DIU_ADDR
1526 CONFIG_VIDEO
1527 CONFIG_CMD_BMP
1528 CONFIG_CFB_CONSOLE
1529 CONFIG_VIDEO_SW_CURSOR
1530 CONFIG_VGA_AS_SINGLE_DEVICE
1531 CONFIG_VIDEO_LOGO
1532 CONFIG_VIDEO_BMP_LOGO
1533
Timur Tabiba8e76b2011-04-11 14:18:22 -05001534 The DIU driver will look for the 'video-mode' environment
1535 variable, and if defined, enable the DIU as a console during
1536 boot. See the documentation file README.video for a
1537 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001538
Simon Glass058d59b2012-12-03 13:59:47 +00001539 CONFIG_VIDEO_VGA
1540
1541 Enable the VGA video / BIOS for x86. The alternative if you
1542 are using coreboot is to use the coreboot frame buffer
1543 driver.
1544
1545
wdenk682011f2003-06-03 23:54:09 +00001546- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001547 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001548
wdenk8bde7f72003-06-27 21:31:46 +00001549 Define this to enable a custom keyboard support.
1550 This simply calls drv_keyboard_init() which must be
1551 defined in your board-specific files.
1552 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001553
wdenkc6097192002-11-03 00:24:07 +00001554- LCD Support: CONFIG_LCD
1555
1556 Define this to enable LCD support (for output to LCD
1557 display); also select one of the supported displays
1558 by defining one of these:
1559
Stelian Pop39cf4802008-05-09 21:57:18 +02001560 CONFIG_ATMEL_LCD:
1561
1562 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1563
wdenkfd3103b2003-11-25 16:55:19 +00001564 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001565
wdenkfd3103b2003-11-25 16:55:19 +00001566 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001567
wdenkfd3103b2003-11-25 16:55:19 +00001568 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001569
wdenkfd3103b2003-11-25 16:55:19 +00001570 NEC NL6448BC20-08. 6.5", 640x480.
1571 Active, color, single scan.
1572
1573 CONFIG_NEC_NL6448BC33_54
1574
1575 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001576 Active, color, single scan.
1577
1578 CONFIG_SHARP_16x9
1579
1580 Sharp 320x240. Active, color, single scan.
1581 It isn't 16x9, and I am not sure what it is.
1582
1583 CONFIG_SHARP_LQ64D341
1584
1585 Sharp LQ64D341 display, 640x480.
1586 Active, color, single scan.
1587
1588 CONFIG_HLD1045
1589
1590 HLD1045 display, 640x480.
1591 Active, color, single scan.
1592
1593 CONFIG_OPTREX_BW
1594
1595 Optrex CBL50840-2 NF-FW 99 22 M5
1596 or
1597 Hitachi LMG6912RPFC-00T
1598 or
1599 Hitachi SP14Q002
1600
1601 320x240. Black & white.
1602
1603 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001604 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001605
Simon Glass676d3192012-10-17 13:24:54 +00001606 CONFIG_LCD_ALIGNMENT
1607
1608 Normally the LCD is page-aligned (tyically 4KB). If this is
1609 defined then the LCD will be aligned to this value instead.
1610 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1611 here, since it is cheaper to change data cache settings on
1612 a per-section basis.
1613
Simon Glass0d89efe2012-10-17 13:24:59 +00001614 CONFIG_CONSOLE_SCROLL_LINES
1615
1616 When the console need to be scrolled, this is the number of
1617 lines to scroll by. It defaults to 1. Increasing this makes
1618 the console jump but can help speed up operation when scrolling
1619 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001620
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001621 CONFIG_LCD_BMP_RLE8
1622
1623 Support drawing of RLE8-compressed bitmaps on the LCD.
1624
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001625 CONFIG_I2C_EDID
1626
1627 Enables an 'i2c edid' command which can read EDID
1628 information over I2C from an attached LCD display.
1629
wdenk7152b1d2003-09-05 23:19:14 +00001630- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001631
wdenk8bde7f72003-06-27 21:31:46 +00001632 If this option is set, the environment is checked for
1633 a variable "splashimage". If found, the usual display
1634 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001635 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001636 specified in "splashimage" is loaded instead. The
1637 console is redirected to the "nulldev", too. This
1638 allows for a "silent" boot where a splash screen is
1639 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001640
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001641 CONFIG_SPLASHIMAGE_GUARD
1642
1643 If this option is set, then U-Boot will prevent the environment
1644 variable "splashimage" from being set to a problematic address
1645 (see README.displaying-bmps and README.arm-unaligned-accesses).
1646 This option is useful for targets where, due to alignment
1647 restrictions, an improperly aligned BMP image will cause a data
1648 abort. If you think you will not have problems with unaligned
1649 accesses (for example because your toolchain prevents them)
1650 there is no need to set this option.
1651
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001652 CONFIG_SPLASH_SCREEN_ALIGN
1653
1654 If this option is set the splash image can be freely positioned
1655 on the screen. Environment variable "splashpos" specifies the
1656 position as "x,y". If a positive number is given it is used as
1657 number of pixel from left/top. If a negative number is given it
1658 is used as number of pixel from right/bottom. You can also
1659 specify 'm' for centering the image.
1660
1661 Example:
1662 setenv splashpos m,m
1663 => image at center of screen
1664
1665 setenv splashpos 30,20
1666 => image at x = 30 and y = 20
1667
1668 setenv splashpos -10,m
1669 => vertically centered image
1670 at x = dspWidth - bmpWidth - 9
1671
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001672- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1673
1674 If this option is set, additionally to standard BMP
1675 images, gzipped BMP images can be displayed via the
1676 splashscreen support or the bmp command.
1677
Anatolij Gustschind5011762010-03-15 14:50:25 +01001678- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1679
1680 If this option is set, 8-bit RLE compressed BMP images
1681 can be displayed via the splashscreen support or the
1682 bmp command.
1683
Lei Wenf2b96df2012-09-28 04:26:47 +00001684- Do compresssing for memory range:
1685 CONFIG_CMD_ZIP
1686
1687 If this option is set, it would use zlib deflate method
1688 to compress the specified memory at its best effort.
1689
wdenkc29fdfc2003-08-29 20:57:53 +00001690- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001691 CONFIG_GZIP
1692
1693 Enabled by default to support gzip compressed images.
1694
wdenkc29fdfc2003-08-29 20:57:53 +00001695 CONFIG_BZIP2
1696
1697 If this option is set, support for bzip2 compressed
1698 images is included. If not, only uncompressed and gzip
1699 compressed images are supported.
1700
wdenk42d1f032003-10-15 23:53:47 +00001701 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001702 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001703 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001704
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001705 CONFIG_LZMA
1706
1707 If this option is set, support for lzma compressed
1708 images is included.
1709
1710 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1711 requires an amount of dynamic memory that is given by the
1712 formula:
1713
1714 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1715
1716 Where lc and lp stand for, respectively, Literal context bits
1717 and Literal pos bits.
1718
1719 This value is upper-bounded by 14MB in the worst case. Anyway,
1720 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1721 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1722 a very small buffer.
1723
1724 Use the lzmainfo tool to determinate the lc and lp values and
1725 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001726 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001727
Kees Cook8ef70472013-08-16 07:59:12 -07001728 CONFIG_LZO
1729
1730 If this option is set, support for LZO compressed images
1731 is included.
1732
wdenk17ea1172004-06-06 21:51:03 +00001733- MII/PHY support:
1734 CONFIG_PHY_ADDR
1735
1736 The address of PHY on MII bus.
1737
1738 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1739
1740 The clock frequency of the MII bus
1741
1742 CONFIG_PHY_GIGE
1743
1744 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001745 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001746
1747 CONFIG_PHY_RESET_DELAY
1748
1749 Some PHY like Intel LXT971A need extra delay after
1750 reset before any MII register access is possible.
1751 For such PHY, set this option to the usec delay
1752 required. (minimum 300usec for LXT971A)
1753
1754 CONFIG_PHY_CMD_DELAY (ppc4xx)
1755
1756 Some PHY like Intel LXT971A need extra delay after
1757 command issued before MII status register can be read
1758
wdenkc6097192002-11-03 00:24:07 +00001759- Ethernet address:
1760 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001761 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001762 CONFIG_ETH2ADDR
1763 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001764 CONFIG_ETH4ADDR
1765 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001766
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001767 Define a default value for Ethernet address to use
1768 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001769 is not determined automatically.
1770
1771- IP address:
1772 CONFIG_IPADDR
1773
1774 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001775 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001776 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001777 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001778
1779- Server IP address:
1780 CONFIG_SERVERIP
1781
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001782 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001783 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001784 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001785
Robin Getz97cfe862009-07-21 12:15:28 -04001786 CONFIG_KEEP_SERVERADDR
1787
1788 Keeps the server's MAC address, in the env 'serveraddr'
1789 for passing to bootargs (like Linux's netconsole option)
1790
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001791- Gateway IP address:
1792 CONFIG_GATEWAYIP
1793
1794 Defines a default value for the IP address of the
1795 default router where packets to other networks are
1796 sent to.
1797 (Environment variable "gatewayip")
1798
1799- Subnet mask:
1800 CONFIG_NETMASK
1801
1802 Defines a default value for the subnet mask (or
1803 routing prefix) which is used to determine if an IP
1804 address belongs to the local subnet or needs to be
1805 forwarded through a router.
1806 (Environment variable "netmask")
1807
David Updegraff53a5c422007-06-11 10:41:07 -05001808- Multicast TFTP Mode:
1809 CONFIG_MCAST_TFTP
1810
1811 Defines whether you want to support multicast TFTP as per
1812 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001813 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001814 driver in use must provide a function: mcast() to join/leave a
1815 multicast group.
1816
wdenkc6097192002-11-03 00:24:07 +00001817- BOOTP Recovery Mode:
1818 CONFIG_BOOTP_RANDOM_DELAY
1819
1820 If you have many targets in a network that try to
1821 boot using BOOTP, you may want to avoid that all
1822 systems send out BOOTP requests at precisely the same
1823 moment (which would happen for instance at recovery
1824 from a power failure, when all systems will try to
1825 boot, thus flooding the BOOTP server. Defining
1826 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1827 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001828 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001829
1830 1st BOOTP request: delay 0 ... 1 sec
1831 2nd BOOTP request: delay 0 ... 2 sec
1832 3rd BOOTP request: delay 0 ... 4 sec
1833 4th and following
1834 BOOTP requests: delay 0 ... 8 sec
1835
stroesefe389a82003-08-28 14:17:32 +00001836- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001837 You can fine tune the DHCP functionality by defining
1838 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001839
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001840 CONFIG_BOOTP_SUBNETMASK
1841 CONFIG_BOOTP_GATEWAY
1842 CONFIG_BOOTP_HOSTNAME
1843 CONFIG_BOOTP_NISDOMAIN
1844 CONFIG_BOOTP_BOOTPATH
1845 CONFIG_BOOTP_BOOTFILESIZE
1846 CONFIG_BOOTP_DNS
1847 CONFIG_BOOTP_DNS2
1848 CONFIG_BOOTP_SEND_HOSTNAME
1849 CONFIG_BOOTP_NTPSERVER
1850 CONFIG_BOOTP_TIMEOFFSET
1851 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001852 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001853
Wilson Callan5d110f02007-07-28 10:56:13 -04001854 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1855 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001856
Joe Hershberger2c00e092012-05-23 07:59:19 +00001857 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1858 after the configured retry count, the call will fail
1859 instead of starting over. This can be used to fail over
1860 to Link-local IP address configuration if the DHCP server
1861 is not available.
1862
stroesefe389a82003-08-28 14:17:32 +00001863 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1864 serverip from a DHCP server, it is possible that more
1865 than one DNS serverip is offered to the client.
1866 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1867 serverip will be stored in the additional environment
1868 variable "dnsip2". The first DNS serverip is always
1869 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001870 is defined.
stroesefe389a82003-08-28 14:17:32 +00001871
1872 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1873 to do a dynamic update of a DNS server. To do this, they
1874 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001875 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001876 of the "hostname" environment variable is passed as
1877 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001878
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001879 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1880
1881 A 32bit value in microseconds for a delay between
1882 receiving a "DHCP Offer" and sending the "DHCP Request".
1883 This fixes a problem with certain DHCP servers that don't
1884 respond 100% of the time to a "DHCP request". E.g. On an
1885 AT91RM9200 processor running at 180MHz, this delay needed
1886 to be *at least* 15,000 usec before a Windows Server 2003
1887 DHCP server would reply 100% of the time. I recommend at
1888 least 50,000 usec to be safe. The alternative is to hope
1889 that one of the retries will be successful but note that
1890 the DHCP timeout and retry process takes a longer than
1891 this delay.
1892
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001893 - Link-local IP address negotiation:
1894 Negotiate with other link-local clients on the local network
1895 for an address that doesn't require explicit configuration.
1896 This is especially useful if a DHCP server cannot be guaranteed
1897 to exist in all environments that the device must operate.
1898
1899 See doc/README.link-local for more information.
1900
wdenka3d991b2004-04-15 21:48:45 +00001901 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001902 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001903
1904 The device id used in CDP trigger frames.
1905
1906 CONFIG_CDP_DEVICE_ID_PREFIX
1907
1908 A two character string which is prefixed to the MAC address
1909 of the device.
1910
1911 CONFIG_CDP_PORT_ID
1912
1913 A printf format string which contains the ascii name of
1914 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001915 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001916
1917 CONFIG_CDP_CAPABILITIES
1918
1919 A 32bit integer which indicates the device capabilities;
1920 0x00000010 for a normal host which does not forwards.
1921
1922 CONFIG_CDP_VERSION
1923
1924 An ascii string containing the version of the software.
1925
1926 CONFIG_CDP_PLATFORM
1927
1928 An ascii string containing the name of the platform.
1929
1930 CONFIG_CDP_TRIGGER
1931
1932 A 32bit integer sent on the trigger.
1933
1934 CONFIG_CDP_POWER_CONSUMPTION
1935
1936 A 16bit integer containing the power consumption of the
1937 device in .1 of milliwatts.
1938
1939 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1940
1941 A byte containing the id of the VLAN.
1942
wdenkc6097192002-11-03 00:24:07 +00001943- Status LED: CONFIG_STATUS_LED
1944
1945 Several configurations allow to display the current
1946 status using a LED. For instance, the LED will blink
1947 fast while running U-Boot code, stop blinking as
1948 soon as a reply to a BOOTP request was received, and
1949 start blinking slow once the Linux kernel is running
1950 (supported by a status LED driver in the Linux
1951 kernel). Defining CONFIG_STATUS_LED enables this
1952 feature in U-Boot.
1953
1954- CAN Support: CONFIG_CAN_DRIVER
1955
1956 Defining CONFIG_CAN_DRIVER enables CAN driver support
1957 on those systems that support this (optional)
1958 feature, like the TQM8xxL modules.
1959
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001960- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001961
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001962 This enable the NEW i2c subsystem, and will allow you to use
1963 i2c commands at the u-boot command line (as long as you set
1964 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1965 based realtime clock chips or other i2c devices. See
1966 common/cmd_i2c.c for a description of the command line
1967 interface.
1968
1969 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001970 - drivers/i2c/soft_i2c.c:
1971 - activate first bus with CONFIG_SYS_I2C_SOFT define
1972 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1973 for defining speed and slave address
1974 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1975 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1976 for defining speed and slave address
1977 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1978 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1979 for defining speed and slave address
1980 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1981 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1982 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001983
Heiko Schocher00f792e2012-10-24 13:48:22 +02001984 - drivers/i2c/fsl_i2c.c:
1985 - activate i2c driver with CONFIG_SYS_I2C_FSL
1986 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1987 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1988 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1989 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001990 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001991 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1992 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1993 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1994 second bus.
1995
Simon Glass1f2ba722012-10-30 07:28:53 +00001996 - drivers/i2c/tegra_i2c.c:
1997 - activate this driver with CONFIG_SYS_I2C_TEGRA
1998 - This driver adds 4 i2c buses with a fix speed from
1999 100000 and the slave addr 0!
2000
Dirk Eibach880540d2013-04-25 02:40:01 +00002001 - drivers/i2c/ppc4xx_i2c.c
2002 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2003 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2004 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2005
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002006 additional defines:
2007
2008 CONFIG_SYS_NUM_I2C_BUSES
2009 Hold the number of i2c busses you want to use. If you
2010 don't use/have i2c muxes on your i2c bus, this
2011 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2012 omit this define.
2013
2014 CONFIG_SYS_I2C_DIRECT_BUS
2015 define this, if you don't use i2c muxes on your hardware.
2016 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2017 omit this define.
2018
2019 CONFIG_SYS_I2C_MAX_HOPS
2020 define how many muxes are maximal consecutively connected
2021 on one i2c bus. If you not use i2c muxes, omit this
2022 define.
2023
2024 CONFIG_SYS_I2C_BUSES
2025 hold a list of busses you want to use, only used if
2026 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2027 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2028 CONFIG_SYS_NUM_I2C_BUSES = 9:
2029
2030 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2031 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2032 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2033 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2034 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2035 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2036 {1, {I2C_NULL_HOP}}, \
2037 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2038 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2039 }
2040
2041 which defines
2042 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002043 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2044 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2045 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2046 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2047 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002048 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002049 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2050 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002051
2052 If you do not have i2c muxes on your board, omit this define.
2053
Heiko Schocherea818db2013-01-29 08:53:15 +01002054- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002055
2056 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2057 provides the following compelling advantages:
2058
2059 - more than one i2c adapter is usable
2060 - approved multibus support
2061 - better i2c mux support
2062
2063 ** Please consider updating your I2C driver now. **
2064
Heiko Schocherea818db2013-01-29 08:53:15 +01002065 These enable legacy I2C serial bus commands. Defining
2066 CONFIG_HARD_I2C will include the appropriate I2C driver
2067 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002068
wdenk945af8d2003-07-16 21:53:01 +00002069 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002070 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002071 CONFIG_COMMANDS) and communicate with i2c based realtime
2072 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002073 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002074
Ben Warrenbb99ad62006-09-07 16:50:54 -04002075 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002076
wdenk945af8d2003-07-16 21:53:01 +00002077 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002078 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002079
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002080 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002081 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002082 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002083 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002084
Peter Tyser8d321b82010-04-12 22:28:21 -05002085 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002086 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002087 and so its address should therefore be cleared to 0 (See,
2088 eg, MPC823e User's Manual p.16-473). So, set
2089 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002090
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002091 CONFIG_SYS_I2C_INIT_MPC5XXX
2092
2093 When a board is reset during an i2c bus transfer
2094 chips might think that the current transfer is still
2095 in progress. Reset the slave devices by sending start
2096 commands until the slave device responds.
2097
wdenk945af8d2003-07-16 21:53:01 +00002098 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002099
Heiko Schocherea818db2013-01-29 08:53:15 +01002100 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002101 then the following macros need to be defined (examples are
2102 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002103
2104 I2C_INIT
2105
wdenkb37c7e52003-06-30 16:24:52 +00002106 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002107 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002108
wdenkba56f622004-02-06 23:19:44 +00002109 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002110
wdenkc6097192002-11-03 00:24:07 +00002111 I2C_PORT
2112
wdenk43d96162003-03-06 00:02:04 +00002113 (Only for MPC8260 CPU). The I/O port to use (the code
2114 assumes both bits are on the same port). Valid values
2115 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002116
2117 I2C_ACTIVE
2118
2119 The code necessary to make the I2C data line active
2120 (driven). If the data line is open collector, this
2121 define can be null.
2122
wdenkb37c7e52003-06-30 16:24:52 +00002123 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2124
wdenkc6097192002-11-03 00:24:07 +00002125 I2C_TRISTATE
2126
2127 The code necessary to make the I2C data line tri-stated
2128 (inactive). If the data line is open collector, this
2129 define can be null.
2130
wdenkb37c7e52003-06-30 16:24:52 +00002131 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2132
wdenkc6097192002-11-03 00:24:07 +00002133 I2C_READ
2134
York Sun472d5462013-04-01 11:29:11 -07002135 Code that returns true if the I2C data line is high,
2136 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002137
wdenkb37c7e52003-06-30 16:24:52 +00002138 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2139
wdenkc6097192002-11-03 00:24:07 +00002140 I2C_SDA(bit)
2141
York Sun472d5462013-04-01 11:29:11 -07002142 If <bit> is true, sets the I2C data line high. If it
2143 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002144
wdenkb37c7e52003-06-30 16:24:52 +00002145 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002146 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002147 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002148
wdenkc6097192002-11-03 00:24:07 +00002149 I2C_SCL(bit)
2150
York Sun472d5462013-04-01 11:29:11 -07002151 If <bit> is true, sets the I2C clock line high. If it
2152 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002153
wdenkb37c7e52003-06-30 16:24:52 +00002154 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002155 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002156 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002157
wdenkc6097192002-11-03 00:24:07 +00002158 I2C_DELAY
2159
2160 This delay is invoked four times per clock cycle so this
2161 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002162 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002163 like:
2164
wdenkb37c7e52003-06-30 16:24:52 +00002165 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002166
Mike Frysinger793b5722010-07-21 13:38:02 -04002167 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2168
2169 If your arch supports the generic GPIO framework (asm/gpio.h),
2170 then you may alternatively define the two GPIOs that are to be
2171 used as SCL / SDA. Any of the previous I2C_xxx macros will
2172 have GPIO-based defaults assigned to them as appropriate.
2173
2174 You should define these to the GPIO value as given directly to
2175 the generic GPIO functions.
2176
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002177 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002178
wdenk8bde7f72003-06-27 21:31:46 +00002179 When a board is reset during an i2c bus transfer
2180 chips might think that the current transfer is still
2181 in progress. On some boards it is possible to access
2182 the i2c SCLK line directly, either by using the
2183 processor pin as a GPIO or by having a second pin
2184 connected to the bus. If this option is defined a
2185 custom i2c_init_board() routine in boards/xxx/board.c
2186 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002187
Richard Retanubun26a33502010-04-12 15:08:17 -04002188 CONFIG_SYS_I2C_BOARD_LATE_INIT
2189
2190 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2191 defined a custom i2c_board_late_init() routine in
2192 boards/xxx/board.c is run AFTER the operations in i2c_init()
2193 is completed. This callpoint can be used to unreset i2c bus
2194 using CPU i2c controller register accesses for CPUs whose i2c
2195 controller provide such a method. It is called at the end of
2196 i2c_init() to allow i2c_init operations to setup the i2c bus
2197 controller on the CPU (e.g. setting bus speed & slave address).
2198
wdenk17ea1172004-06-06 21:51:03 +00002199 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2200
2201 This option enables configuration of bi_iic_fast[] flags
2202 in u-boot bd_info structure based on u-boot environment
2203 variable "i2cfast". (see also i2cfast)
2204
Ben Warrenbb99ad62006-09-07 16:50:54 -04002205 CONFIG_I2C_MULTI_BUS
2206
2207 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002208 must have a controller. At any point in time, only one bus is
2209 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002210 Note that bus numbering is zero-based.
2211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002212 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002213
2214 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002215 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002216 is set, specify a list of bus-device pairs. Otherwise, specify
2217 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002218
2219 e.g.
2220 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002221 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002222
2223 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2224
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002225 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002226 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002227
2228 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002230 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e61812006-11-03 19:15:00 -06002231
2232 If defined, then this indicates the I2C bus number for DDR SPD.
2233 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2234
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002235 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002236
2237 If defined, then this indicates the I2C bus number for the RTC.
2238 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2239
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002240 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002241
2242 If defined, then this indicates the I2C bus number for the DTT.
2243 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2244
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002245 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002246
2247 If defined, specifies the I2C address of the DTT device.
2248 If not defined, then U-Boot uses predefined value for
2249 specified DTT device.
2250
Andrew Dyer2ac69852008-12-29 17:36:01 -06002251 CONFIG_SOFT_I2C_READ_REPEATED_START
2252
2253 defining this will force the i2c_read() function in
2254 the soft_i2c driver to perform an I2C repeated start
2255 between writing the address pointer and reading the
2256 data. If this define is omitted the default behaviour
2257 of doing a stop-start sequence will be used. Most I2C
2258 devices can use either method, but some require one or
2259 the other.
Timur Tabibe5e61812006-11-03 19:15:00 -06002260
wdenkc6097192002-11-03 00:24:07 +00002261- SPI Support: CONFIG_SPI
2262
2263 Enables SPI driver (so far only tested with
2264 SPI EEPROM, also an instance works with Crystal A/D and
2265 D/As on the SACSng board)
2266
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002267 CONFIG_SH_SPI
2268
2269 Enables the driver for SPI controller on SuperH. Currently
2270 only SH7757 is supported.
2271
wdenkc6097192002-11-03 00:24:07 +00002272 CONFIG_SPI_X
2273
2274 Enables extended (16-bit) SPI EEPROM addressing.
2275 (symmetrical to CONFIG_I2C_X)
2276
2277 CONFIG_SOFT_SPI
2278
wdenk43d96162003-03-06 00:02:04 +00002279 Enables a software (bit-bang) SPI driver rather than
2280 using hardware support. This is a general purpose
2281 driver that only requires three general I/O port pins
2282 (two outputs, one input) to function. If this is
2283 defined, the board configuration must define several
2284 SPI configuration items (port pins to use, etc). For
2285 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002286
Ben Warren04a9e112008-01-16 22:37:35 -05002287 CONFIG_HARD_SPI
2288
2289 Enables a hardware SPI driver for general-purpose reads
2290 and writes. As with CONFIG_SOFT_SPI, the board configuration
2291 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002292 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002293 example, see include/configs/mpc8349emds.h.
2294
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002295 CONFIG_MXC_SPI
2296
2297 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002298 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002299
Matthias Fuchs01335022007-12-27 17:12:34 +01002300- FPGA Support: CONFIG_FPGA
2301
2302 Enables FPGA subsystem.
2303
2304 CONFIG_FPGA_<vendor>
2305
2306 Enables support for specific chip vendors.
2307 (ALTERA, XILINX)
2308
2309 CONFIG_FPGA_<family>
2310
2311 Enables support for FPGA family.
2312 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2313
2314 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002315
wdenk43d96162003-03-06 00:02:04 +00002316 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002317
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002318 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002319
wdenk8bde7f72003-06-27 21:31:46 +00002320 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002322 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002323
wdenk43d96162003-03-06 00:02:04 +00002324 Enable checks on FPGA configuration interface busy
2325 status by the configuration function. This option
2326 will require a board or device specific function to
2327 be written.
wdenkc6097192002-11-03 00:24:07 +00002328
2329 CONFIG_FPGA_DELAY
2330
2331 If defined, a function that provides delays in the FPGA
2332 configuration driver.
2333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002334 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002335 Allow Control-C to interrupt FPGA configuration
2336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002337 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002338
wdenk43d96162003-03-06 00:02:04 +00002339 Check for configuration errors during FPGA bitfile
2340 loading. For example, abort during Virtex II
2341 configuration if the INIT_B line goes low (which
2342 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002343
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002344 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002345
wdenk43d96162003-03-06 00:02:04 +00002346 Maximum time to wait for the INIT_B line to deassert
2347 after PROB_B has been deasserted during a Virtex II
2348 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002349 ms.
wdenkc6097192002-11-03 00:24:07 +00002350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002351 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002352
wdenk43d96162003-03-06 00:02:04 +00002353 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002354 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002355
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002356 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002357
wdenk43d96162003-03-06 00:02:04 +00002358 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002359 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002360
2361- Configuration Management:
2362 CONFIG_IDENT_STRING
2363
wdenk43d96162003-03-06 00:02:04 +00002364 If defined, this string will be added to the U-Boot
2365 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002366
2367- Vendor Parameter Protection:
2368
wdenk43d96162003-03-06 00:02:04 +00002369 U-Boot considers the values of the environment
2370 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002371 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002372 are set once by the board vendor / manufacturer, and
2373 protects these variables from casual modification by
2374 the user. Once set, these variables are read-only,
2375 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002376 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002377
2378 If CONFIG_ENV_OVERWRITE is #defined in your config
2379 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002380 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002381 these parameters.
2382
2383 Alternatively, if you #define _both_ CONFIG_ETHADDR
2384 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002385 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002386 which can be changed exactly ONCE by the user. [The
2387 serial# is unaffected by this, i. e. it remains
2388 read-only.]
2389
Joe Hershberger25980902012-12-11 22:16:31 -06002390 The same can be accomplished in a more flexible way
2391 for any variable by configuring the type of access
2392 to allow for those variables in the ".flags" variable
2393 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2394
wdenkc6097192002-11-03 00:24:07 +00002395- Protected RAM:
2396 CONFIG_PRAM
2397
2398 Define this variable to enable the reservation of
2399 "protected RAM", i. e. RAM which is not overwritten
2400 by U-Boot. Define CONFIG_PRAM to hold the number of
2401 kB you want to reserve for pRAM. You can overwrite
2402 this default value by defining an environment
2403 variable "pram" to the number of kB you want to
2404 reserve. Note that the board info structure will
2405 still show the full amount of RAM. If pRAM is
2406 reserved, a new environment variable "mem" will
2407 automatically be defined to hold the amount of
2408 remaining RAM in a form that can be passed as boot
2409 argument to Linux, for instance like that:
2410
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002411 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002412 saveenv
2413
2414 This way you can tell Linux not to use this memory,
2415 either, which results in a memory region that will
2416 not be affected by reboots.
2417
2418 *WARNING* If your board configuration uses automatic
2419 detection of the RAM size, you must make sure that
2420 this memory test is non-destructive. So far, the
2421 following board configurations are known to be
2422 "pRAM-clean":
2423
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002424 IVMS8, IVML24, SPD8xx, TQM8xxL,
2425 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002426 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002427
Gabe Black40fef042012-12-02 04:55:18 +00002428- Access to physical memory region (> 4GB)
2429 Some basic support is provided for operations on memory not
2430 normally accessible to U-Boot - e.g. some architectures
2431 support access to more than 4GB of memory on 32-bit
2432 machines using physical address extension or similar.
2433 Define CONFIG_PHYSMEM to access this basic support, which
2434 currently only supports clearing the memory.
2435
wdenkc6097192002-11-03 00:24:07 +00002436- Error Recovery:
2437 CONFIG_PANIC_HANG
2438
2439 Define this variable to stop the system in case of a
2440 fatal error, so that you have to reset it manually.
2441 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002442 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002443 automatically as fast as possible, but it may be
2444 useful during development since you can try to debug
2445 the conditions that lead to the situation.
2446
2447 CONFIG_NET_RETRY_COUNT
2448
wdenk43d96162003-03-06 00:02:04 +00002449 This variable defines the number of retries for
2450 network operations like ARP, RARP, TFTP, or BOOTP
2451 before giving up the operation. If not defined, a
2452 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002453
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002454 CONFIG_ARP_TIMEOUT
2455
2456 Timeout waiting for an ARP reply in milliseconds.
2457
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002458 CONFIG_NFS_TIMEOUT
2459
2460 Timeout in milliseconds used in NFS protocol.
2461 If you encounter "ERROR: Cannot umount" in nfs command,
2462 try longer timeout such as
2463 #define CONFIG_NFS_TIMEOUT 10000UL
2464
wdenkc6097192002-11-03 00:24:07 +00002465- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002466 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002467
2468 Enable auto completion of commands using TAB.
2469
Wolfgang Denka9398e02006-11-27 15:32:42 +01002470 Note that this feature has NOT been implemented yet
2471 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002472
2473
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002474 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002475
2476 Define this variable to enable the "hush" shell (from
2477 Busybox) as command line interpreter, thus enabling
2478 powerful command line syntax like
2479 if...then...else...fi conditionals or `&&' and '||'
2480 constructs ("shell scripts").
2481
2482 If undefined, you get the old, much simpler behaviour
2483 with a somewhat smaller memory footprint.
2484
2485
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002486 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002487
2488 This defines the secondary prompt string, which is
2489 printed when the command interpreter needs more input
2490 to complete a command. Usually "> ".
2491
2492 Note:
2493
wdenk8bde7f72003-06-27 21:31:46 +00002494 In the current implementation, the local variables
2495 space and global environment variables space are
2496 separated. Local variables are those you define by
2497 simply typing `name=value'. To access a local
2498 variable later on, you have write `$name' or
2499 `${name}'; to execute the contents of a variable
2500 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002501
wdenk43d96162003-03-06 00:02:04 +00002502 Global environment variables are those you use
2503 setenv/printenv to work with. To run a command stored
2504 in such a variable, you need to use the run command,
2505 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002506
2507 To store commands and special characters in a
2508 variable, please use double quotation marks
2509 surrounding the whole text of the variable, instead
2510 of the backslashes before semicolons and special
2511 symbols.
2512
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002513- Commandline Editing and History:
2514 CONFIG_CMDLINE_EDITING
2515
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002516 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002517 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002518
wdenka8c7c702003-12-06 19:49:23 +00002519- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002520 CONFIG_EXTRA_ENV_SETTINGS
2521
wdenk43d96162003-03-06 00:02:04 +00002522 Define this to contain any number of null terminated
2523 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002524 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002525
wdenk43d96162003-03-06 00:02:04 +00002526 For example, place something like this in your
2527 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002528
2529 #define CONFIG_EXTRA_ENV_SETTINGS \
2530 "myvar1=value1\0" \
2531 "myvar2=value2\0"
2532
wdenk43d96162003-03-06 00:02:04 +00002533 Warning: This method is based on knowledge about the
2534 internal format how the environment is stored by the
2535 U-Boot code. This is NOT an official, exported
2536 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002537 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002538 You better know what you are doing here.
2539
wdenk43d96162003-03-06 00:02:04 +00002540 Note: overly (ab)use of the default environment is
2541 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002542 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002543 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002544
Stephen Warren5e724ca2012-05-22 09:21:54 +00002545 CONFIG_ENV_VARS_UBOOT_CONFIG
2546
2547 Define this in order to add variables describing the
2548 U-Boot build configuration to the default environment.
2549 These will be named arch, cpu, board, vendor, and soc.
2550
2551 Enabling this option will cause the following to be defined:
2552
2553 - CONFIG_SYS_ARCH
2554 - CONFIG_SYS_CPU
2555 - CONFIG_SYS_BOARD
2556 - CONFIG_SYS_VENDOR
2557 - CONFIG_SYS_SOC
2558
Tom Rini7e27f892012-10-24 07:28:16 +00002559 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2560
2561 Define this in order to add variables describing certain
2562 run-time determined information about the hardware to the
2563 environment. These will be named board_name, board_rev.
2564
Simon Glass06fd8532012-11-30 13:01:17 +00002565 CONFIG_DELAY_ENVIRONMENT
2566
2567 Normally the environment is loaded when the board is
2568 intialised so that it is available to U-Boot. This inhibits
2569 that so that the environment is not available until
2570 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2571 this is instead controlled by the value of
2572 /config/load-environment.
2573
wdenka8c7c702003-12-06 19:49:23 +00002574- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002575 CONFIG_HAS_DATAFLASH
2576
wdenk8bde7f72003-06-27 21:31:46 +00002577 Defining this option enables DataFlash features and
2578 allows to read/write in Dataflash via the standard
2579 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002580
Eric Nelsonf61ec452012-01-31 10:52:08 -07002581- Serial Flash support
2582 CONFIG_CMD_SF
2583
2584 Defining this option enables SPI flash commands
2585 'sf probe/read/write/erase/update'.
2586
2587 Usage requires an initial 'probe' to define the serial
2588 flash parameters, followed by read/write/erase/update
2589 commands.
2590
2591 The following defaults may be provided by the platform
2592 to handle the common case when only a single serial
2593 flash is present on the system.
2594
2595 CONFIG_SF_DEFAULT_BUS Bus identifier
2596 CONFIG_SF_DEFAULT_CS Chip-select
2597 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2598 CONFIG_SF_DEFAULT_SPEED in Hz
2599
Simon Glass24007272012-10-08 13:16:02 +00002600 CONFIG_CMD_SF_TEST
2601
2602 Define this option to include a destructive SPI flash
2603 test ('sf test').
2604
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302605 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2606
2607 Define this option to use the Bank addr/Extended addr
2608 support on SPI flashes which has size > 16Mbytes.
2609
wdenk3f85ce22004-02-23 16:11:30 +00002610- SystemACE Support:
2611 CONFIG_SYSTEMACE
2612
2613 Adding this option adds support for Xilinx SystemACE
2614 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002615 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002616 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002617
2618 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002619 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002620
2621 When SystemACE support is added, the "ace" device type
2622 becomes available to the fat commands, i.e. fatls.
2623
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002624- TFTP Fixed UDP Port:
2625 CONFIG_TFTP_PORT
2626
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002627 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002628 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002629 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002630 number generator is used.
2631
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002632 Also, the environment variable tftpdstp is used to supply
2633 the TFTP UDP destination port value. If tftpdstp isn't
2634 defined, the normal port 69 is used.
2635
2636 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002637 blindly start the TFTP transfer using the pre-configured
2638 target IP address and UDP port. This has the effect of
2639 "punching through" the (Windows XP) firewall, allowing
2640 the remainder of the TFTP transfer to proceed normally.
2641 A better solution is to properly configure the firewall,
2642 but sometimes that is not allowed.
2643
Simon Glassbf36c5d2012-12-05 14:46:38 +00002644- Hashing support:
2645 CONFIG_CMD_HASH
2646
2647 This enables a generic 'hash' command which can produce
2648 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2649
2650 CONFIG_HASH_VERIFY
2651
2652 Enable the hash verify command (hash -v). This adds to code
2653 size a little.
2654
2655 CONFIG_SHA1 - support SHA1 hashing
2656 CONFIG_SHA256 - support SHA256 hashing
2657
2658 Note: There is also a sha1sum command, which should perhaps
2659 be deprecated in favour of 'hash sha1'.
2660
Robert Winklera11f1872013-07-24 17:57:06 -07002661- Freescale i.MX specific commands:
2662 CONFIG_CMD_HDMIDETECT
2663 This enables 'hdmidet' command which returns true if an
2664 HDMI monitor is detected. This command is i.MX 6 specific.
2665
2666 CONFIG_CMD_BMODE
2667 This enables the 'bmode' (bootmode) command for forcing
2668 a boot from specific media.
2669
2670 This is useful for forcing the ROM's usb downloader to
2671 activate upon a watchdog reset which is nice when iterating
2672 on U-Boot. Using the reset button or running bmode normal
2673 will set it back to normal. This command currently
2674 supports i.MX53 and i.MX6.
2675
Simon Glass19c402a2013-06-13 15:10:02 -07002676- Signing support:
2677 CONFIG_RSA
2678
2679 This enables the RSA algorithm used for FIT image verification
2680 in U-Boot. See doc/uImage/signature for more information.
2681
2682 The signing part is build into mkimage regardless of this
2683 option.
2684
2685
wdenka8c7c702003-12-06 19:49:23 +00002686- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002687 CONFIG_SHOW_BOOT_PROGRESS
2688
wdenk43d96162003-03-06 00:02:04 +00002689 Defining this option allows to add some board-
2690 specific code (calling a user-provided function
2691 "show_boot_progress(int)") that enables you to show
2692 the system's boot progress on some display (for
2693 example, some LED's) on your board. At the moment,
2694 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002695
Simon Glass3a608ca2012-02-13 13:51:19 +00002696- Detailed boot stage timing
2697 CONFIG_BOOTSTAGE
2698 Define this option to get detailed timing of each stage
2699 of the boot process.
2700
2701 CONFIG_BOOTSTAGE_USER_COUNT
2702 This is the number of available user bootstage records.
2703 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2704 a new ID will be allocated from this stash. If you exceed
2705 the limit, recording will stop.
2706
2707 CONFIG_BOOTSTAGE_REPORT
2708 Define this to print a report before boot, similar to this:
2709
2710 Timer summary in microseconds:
2711 Mark Elapsed Stage
2712 0 0 reset
2713 3,575,678 3,575,678 board_init_f start
2714 3,575,695 17 arch_cpu_init A9
2715 3,575,777 82 arch_cpu_init done
2716 3,659,598 83,821 board_init_r start
2717 3,910,375 250,777 main_loop
2718 29,916,167 26,005,792 bootm_start
2719 30,361,327 445,160 start_kernel
2720
Simon Glass2eba38c2012-09-28 08:56:39 +00002721 CONFIG_CMD_BOOTSTAGE
2722 Add a 'bootstage' command which supports printing a report
2723 and un/stashing of bootstage data.
2724
Simon Glass94fd1312012-09-28 08:56:37 +00002725 CONFIG_BOOTSTAGE_FDT
2726 Stash the bootstage information in the FDT. A root 'bootstage'
2727 node is created with each bootstage id as a child. Each child
2728 has a 'name' property and either 'mark' containing the
2729 mark time in microsecond, or 'accum' containing the
2730 accumulated time for that bootstage id in microseconds.
2731 For example:
2732
2733 bootstage {
2734 154 {
2735 name = "board_init_f";
2736 mark = <3575678>;
2737 };
2738 170 {
2739 name = "lcd";
2740 accum = <33482>;
2741 };
2742 };
2743
2744 Code in the Linux kernel can find this in /proc/devicetree.
2745
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002746Legacy uImage format:
2747
wdenkc6097192002-11-03 00:24:07 +00002748 Arg Where When
2749 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002750 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002751 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002752 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002753 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002754 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002755 4 common/cmd_bootm.c Image data has correct checksum
2756 -4 common/cmd_bootm.c Image is for unsupported architecture
2757 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002758 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002759 6 common/cmd_bootm.c Image Type check OK
2760 -6 common/cmd_bootm.c gunzip uncompression error
2761 -7 common/cmd_bootm.c Unimplemented compression type
2762 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002763 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002764 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002765
2766 9 common/image.c Start initial ramdisk verification
2767 -10 common/image.c Ramdisk header has bad magic number
2768 -11 common/image.c Ramdisk header has bad checksum
2769 10 common/image.c Ramdisk header is OK
2770 -12 common/image.c Ramdisk data has bad checksum
2771 11 common/image.c Ramdisk data has correct checksum
2772 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002773 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002774 13 common/image.c Start multifile image verification
2775 14 common/image.c No initial ramdisk, no multifile, continue.
2776
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002777 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002778
Stefan Roesea47a12b2010-04-15 16:07:28 +02002779 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002780 -31 post/post.c POST test failed, detected by post_output_backlog()
2781 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002782
Heiko Schocher566a4942007-06-22 19:11:54 +02002783 34 common/cmd_doc.c before loading a Image from a DOC device
2784 -35 common/cmd_doc.c Bad usage of "doc" command
2785 35 common/cmd_doc.c correct usage of "doc" command
2786 -36 common/cmd_doc.c No boot device
2787 36 common/cmd_doc.c correct boot device
2788 -37 common/cmd_doc.c Unknown Chip ID on boot device
2789 37 common/cmd_doc.c correct chip ID found, device available
2790 -38 common/cmd_doc.c Read Error on boot device
2791 38 common/cmd_doc.c reading Image header from DOC device OK
2792 -39 common/cmd_doc.c Image header has bad magic number
2793 39 common/cmd_doc.c Image header has correct magic number
2794 -40 common/cmd_doc.c Error reading Image from DOC device
2795 40 common/cmd_doc.c Image header has correct magic number
2796 41 common/cmd_ide.c before loading a Image from a IDE device
2797 -42 common/cmd_ide.c Bad usage of "ide" command
2798 42 common/cmd_ide.c correct usage of "ide" command
2799 -43 common/cmd_ide.c No boot device
2800 43 common/cmd_ide.c boot device found
2801 -44 common/cmd_ide.c Device not available
2802 44 common/cmd_ide.c Device available
2803 -45 common/cmd_ide.c wrong partition selected
2804 45 common/cmd_ide.c partition selected
2805 -46 common/cmd_ide.c Unknown partition table
2806 46 common/cmd_ide.c valid partition table found
2807 -47 common/cmd_ide.c Invalid partition type
2808 47 common/cmd_ide.c correct partition type
2809 -48 common/cmd_ide.c Error reading Image Header on boot device
2810 48 common/cmd_ide.c reading Image Header from IDE device OK
2811 -49 common/cmd_ide.c Image header has bad magic number
2812 49 common/cmd_ide.c Image header has correct magic number
2813 -50 common/cmd_ide.c Image header has bad checksum
2814 50 common/cmd_ide.c Image header has correct checksum
2815 -51 common/cmd_ide.c Error reading Image from IDE device
2816 51 common/cmd_ide.c reading Image from IDE device OK
2817 52 common/cmd_nand.c before loading a Image from a NAND device
2818 -53 common/cmd_nand.c Bad usage of "nand" command
2819 53 common/cmd_nand.c correct usage of "nand" command
2820 -54 common/cmd_nand.c No boot device
2821 54 common/cmd_nand.c boot device found
2822 -55 common/cmd_nand.c Unknown Chip ID on boot device
2823 55 common/cmd_nand.c correct chip ID found, device available
2824 -56 common/cmd_nand.c Error reading Image Header on boot device
2825 56 common/cmd_nand.c reading Image Header from NAND device OK
2826 -57 common/cmd_nand.c Image header has bad magic number
2827 57 common/cmd_nand.c Image header has correct magic number
2828 -58 common/cmd_nand.c Error reading Image from NAND device
2829 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002830
Heiko Schocher566a4942007-06-22 19:11:54 +02002831 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002832
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002833 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002834 -64 net/eth.c no Ethernet found.
2835 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002836
Heiko Schocher566a4942007-06-22 19:11:54 +02002837 -80 common/cmd_net.c usage wrong
2838 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002839 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002840 81 common/cmd_net.c NetLoop() back without error
2841 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2842 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002843 83 common/cmd_net.c running "source" command
2844 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002845 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002846
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002847FIT uImage format:
2848
2849 Arg Where When
2850 100 common/cmd_bootm.c Kernel FIT Image has correct format
2851 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2852 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2853 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2854 102 common/cmd_bootm.c Kernel unit name specified
2855 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002856 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002857 104 common/cmd_bootm.c Got kernel subimage node offset
2858 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2859 105 common/cmd_bootm.c Kernel subimage hash verification OK
2860 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2861 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002862 -106 common/cmd_bootm.c Kernel subimage has wrong type
2863 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002864 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2865 108 common/cmd_bootm.c Got kernel subimage data/size
2866 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2867 -109 common/cmd_bootm.c Can't get kernel subimage type
2868 -110 common/cmd_bootm.c Can't get kernel subimage comp
2869 -111 common/cmd_bootm.c Can't get kernel subimage os
2870 -112 common/cmd_bootm.c Can't get kernel subimage load address
2871 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2872
2873 120 common/image.c Start initial ramdisk verification
2874 -120 common/image.c Ramdisk FIT image has incorrect format
2875 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002876 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002877 -122 common/image.c Can't get configuration for ramdisk subimage
2878 123 common/image.c Ramdisk unit name specified
2879 -124 common/image.c Can't get ramdisk subimage node offset
2880 125 common/image.c Got ramdisk subimage node offset
2881 -125 common/image.c Ramdisk subimage hash verification failed
2882 126 common/image.c Ramdisk subimage hash verification OK
2883 -126 common/image.c Ramdisk subimage for unsupported architecture
2884 127 common/image.c Architecture check OK
2885 -127 common/image.c Can't get ramdisk subimage data/size
2886 128 common/image.c Got ramdisk subimage data/size
2887 129 common/image.c Can't get ramdisk load address
2888 -129 common/image.c Got ramdisk load address
2889
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002890 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002891 131 common/cmd_doc.c FIT image format OK
2892
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002893 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002894 141 common/cmd_ide.c FIT image format OK
2895
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002896 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002897 151 common/cmd_nand.c FIT image format OK
2898
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002899- FIT image support:
2900 CONFIG_FIT
2901 Enable support for the FIT uImage format.
2902
2903 CONFIG_FIT_BEST_MATCH
2904 When no configuration is explicitly selected, default to the
2905 one whose fdt's compatibility field best matches that of
2906 U-Boot itself. A match is considered "best" if it matches the
2907 most specific compatibility entry of U-Boot's fdt's root node.
2908 The order of entries in the configuration's fdt is ignored.
2909
Simon Glass3e569a62013-06-13 15:10:00 -07002910 CONFIG_FIT_SIGNATURE
2911 This option enables signature verification of FIT uImages,
2912 using a hash signed and verified using RSA. See
2913 doc/uImage.FIT/signature.txt for more details.
2914
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002915- Standalone program support:
2916 CONFIG_STANDALONE_LOAD_ADDR
2917
Wolfgang Denk6feff892011-10-09 21:06:34 +02002918 This option defines a board specific value for the
2919 address where standalone program gets loaded, thus
2920 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002921 settings.
2922
2923- Frame Buffer Address:
2924 CONFIG_FB_ADDR
2925
2926 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002927 address for frame buffer. This is typically the case
2928 when using a graphics controller has separate video
2929 memory. U-Boot will then place the frame buffer at
2930 the given address instead of dynamically reserving it
2931 in system RAM by calling lcd_setmem(), which grabs
2932 the memory for the frame buffer depending on the
2933 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002934
2935 Please see board_init_f function.
2936
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002937- Automatic software updates via TFTP server
2938 CONFIG_UPDATE_TFTP
2939 CONFIG_UPDATE_TFTP_CNT_MAX
2940 CONFIG_UPDATE_TFTP_MSEC_MAX
2941
2942 These options enable and control the auto-update feature;
2943 for a more detailed description refer to doc/README.update.
2944
2945- MTD Support (mtdparts command, UBI support)
2946 CONFIG_MTD_DEVICE
2947
2948 Adds the MTD device infrastructure from the Linux kernel.
2949 Needed for mtdparts command support.
2950
2951 CONFIG_MTD_PARTITIONS
2952
2953 Adds the MTD partitioning infrastructure from the Linux
2954 kernel. Needed for UBI support.
2955
Joe Hershberger70c219c2013-04-08 10:32:48 +00002956- UBI support
2957 CONFIG_CMD_UBI
2958
2959 Adds commands for interacting with MTD partitions formatted
2960 with the UBI flash translation layer
2961
2962 Requires also defining CONFIG_RBTREE
2963
Joe Hershberger147162d2013-04-08 10:32:49 +00002964 CONFIG_UBI_SILENCE_MSG
2965
2966 Make the verbose messages from UBI stop printing. This leaves
2967 warnings and errors enabled.
2968
Joe Hershberger70c219c2013-04-08 10:32:48 +00002969- UBIFS support
2970 CONFIG_CMD_UBIFS
2971
2972 Adds commands for interacting with UBI volumes formatted as
2973 UBIFS. UBIFS is read-only in u-boot.
2974
2975 Requires UBI support as well as CONFIG_LZO
2976
Joe Hershberger147162d2013-04-08 10:32:49 +00002977 CONFIG_UBIFS_SILENCE_MSG
2978
2979 Make the verbose messages from UBIFS stop printing. This leaves
2980 warnings and errors enabled.
2981
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002982- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002983 CONFIG_SPL
2984 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002985
Tom Rini95579792012-02-14 07:29:40 +00002986 CONFIG_SPL_LDSCRIPT
2987 LDSCRIPT for linking the SPL binary.
2988
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002989 CONFIG_SPL_MAX_FOOTPRINT
2990 Maximum size in memory allocated to the SPL, BSS included.
2991 When defined, the linker checks that the actual memory
2992 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002993 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002994 must not be both defined at the same time.
2995
Tom Rini95579792012-02-14 07:29:40 +00002996 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002997 Maximum size of the SPL image (text, data, rodata, and
2998 linker lists sections), BSS excluded.
2999 When defined, the linker checks that the actual size does
3000 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003001
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003002 CONFIG_SPL_TEXT_BASE
3003 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003004
Scott Wood94a45bb2012-09-20 19:05:12 -05003005 CONFIG_SPL_RELOC_TEXT_BASE
3006 Address to relocate to. If unspecified, this is equal to
3007 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3008
Tom Rini95579792012-02-14 07:29:40 +00003009 CONFIG_SPL_BSS_START_ADDR
3010 Link address for the BSS within the SPL binary.
3011
3012 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003013 Maximum size in memory allocated to the SPL BSS.
3014 When defined, the linker checks that the actual memory used
3015 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003016 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003017 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003018
3019 CONFIG_SPL_STACK
3020 Adress of the start of the stack SPL will use
3021
Scott Wood94a45bb2012-09-20 19:05:12 -05003022 CONFIG_SPL_RELOC_STACK
3023 Adress of the start of the stack SPL will use after
3024 relocation. If unspecified, this is equal to
3025 CONFIG_SPL_STACK.
3026
Tom Rini95579792012-02-14 07:29:40 +00003027 CONFIG_SYS_SPL_MALLOC_START
3028 Starting address of the malloc pool used in SPL.
3029
3030 CONFIG_SYS_SPL_MALLOC_SIZE
3031 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003032
Tom Rini47f7bca2012-08-13 12:03:19 -07003033 CONFIG_SPL_FRAMEWORK
3034 Enable the SPL framework under common/. This framework
3035 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3036 NAND loading of the Linux Kernel.
3037
Tom Rini861a86f2012-08-13 11:37:56 -07003038 CONFIG_SPL_DISPLAY_PRINT
3039 For ARM, enable an optional function to print more information
3040 about the running system.
3041
Scott Wood4b919722012-09-20 16:35:21 -05003042 CONFIG_SPL_INIT_MINIMAL
3043 Arch init code should be built for a very small image
3044
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003045 CONFIG_SPL_LIBCOMMON_SUPPORT
3046 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003047
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003048 CONFIG_SPL_LIBDISK_SUPPORT
3049 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003050
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003051 CONFIG_SPL_I2C_SUPPORT
3052 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003053
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003054 CONFIG_SPL_GPIO_SUPPORT
3055 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003056
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003057 CONFIG_SPL_MMC_SUPPORT
3058 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003059
Tom Rini95579792012-02-14 07:29:40 +00003060 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3061 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3062 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
3063 Address, size and partition on the MMC to load U-Boot from
3064 when the MMC is being used in raw mode.
3065
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003066 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3067 Sector to load kernel uImage from when MMC is being
3068 used in raw mode (for Falcon mode)
3069
3070 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3071 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3072 Sector and number of sectors to load kernel argument
3073 parameters from when MMC is being used in raw mode
3074 (for falcon mode)
3075
Tom Rini95579792012-02-14 07:29:40 +00003076 CONFIG_SPL_FAT_SUPPORT
3077 Support for fs/fat/libfat.o in SPL binary
3078
3079 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3080 Filename to read to load U-Boot when reading from FAT
3081
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003082 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3083 Filename to read to load kernel uImage when reading
3084 from FAT (for Falcon mode)
3085
3086 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3087 Filename to read to load kernel argument parameters
3088 when reading from FAT (for Falcon mode)
3089
Scott Wood06f60ae2012-12-06 13:33:17 +00003090 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3091 Set this for NAND SPL on PPC mpc83xx targets, so that
3092 start.S waits for the rest of the SPL to load before
3093 continuing (the hardware starts execution after just
3094 loading the first page rather than the full 4K).
3095
Scott Wood6f2f01b2012-09-20 19:09:07 -05003096 CONFIG_SPL_NAND_BASE
3097 Include nand_base.c in the SPL. Requires
3098 CONFIG_SPL_NAND_DRIVERS.
3099
3100 CONFIG_SPL_NAND_DRIVERS
3101 SPL uses normal NAND drivers, not minimal drivers.
3102
3103 CONFIG_SPL_NAND_ECC
3104 Include standard software ECC in the SPL
3105
Tom Rini95579792012-02-14 07:29:40 +00003106 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003107 Support for NAND boot using simple NAND drivers that
3108 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003109
Ying Zhangbb0dc102013-08-16 15:16:11 +08003110 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3111 Set for the SPL on PPC mpc8xxx targets, support for
3112 arch/powerpc/cpu/mpc8xxx/ddr/libddr.o in SPL binary.
3113
Ying Zhang7c8eea52013-08-16 15:16:12 +08003114 CONFIG_SPL_COMMON_INIT_DDR
3115 Set for common ddr init with serial presence detect in
3116 SPL binary.
3117
Tom Rini95579792012-02-14 07:29:40 +00003118 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3119 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3120 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3121 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3122 CONFIG_SYS_NAND_ECCBYTES
3123 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003124 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003125
3126 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003127 Location in NAND to read U-Boot from
3128
3129 CONFIG_SYS_NAND_U_BOOT_DST
3130 Location in memory to load U-Boot to
3131
3132 CONFIG_SYS_NAND_U_BOOT_SIZE
3133 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003134
3135 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003136 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003137
3138 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3139 Define this if you need to first read the OOB and then the
3140 data. This is used for example on davinci plattforms.
3141
3142 CONFIG_SPL_OMAP3_ID_NAND
3143 Support for an OMAP3-specific set of functions to return the
3144 ID and MFR of the first attached NAND chip, if present.
3145
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003146 CONFIG_SPL_SERIAL_SUPPORT
3147 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003148
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003149 CONFIG_SPL_SPI_FLASH_SUPPORT
3150 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003151
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003152 CONFIG_SPL_SPI_SUPPORT
3153 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003154
Pavel Machekc57b9532012-08-30 22:42:11 +02003155 CONFIG_SPL_RAM_DEVICE
3156 Support for running image already present in ram, in SPL binary
3157
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003158 CONFIG_SPL_LIBGENERIC_SUPPORT
3159 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003160
Ying Zhangba1bee42013-05-20 14:07:25 +08003161 CONFIG_SPL_ENV_SUPPORT
3162 Support for the environment operating in SPL binary
3163
3164 CONFIG_SPL_NET_SUPPORT
3165 Support for the net/libnet.o in SPL binary.
3166 It conflicts with SPL env from storage medium specified by
3167 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3168
Scott Wood74752ba2012-12-06 13:33:16 +00003169 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003170 Image offset to which the SPL should be padded before appending
3171 the SPL payload. By default, this is defined as
3172 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3173 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3174 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003175
Scott Woodca2fca22012-09-21 16:27:32 -05003176 CONFIG_SPL_TARGET
3177 Final target image containing SPL and payload. Some SPLs
3178 use an arch-specific makefile fragment instead, for
3179 example if more than one image needs to be produced.
3180
Simon Glass87ebee32013-05-08 08:05:59 +00003181 CONFIG_FIT_SPL_PRINT
3182 Printing information about a FIT image adds quite a bit of
3183 code to SPL. So this is normally disabled in SPL. Use this
3184 option to re-enable it. This will affect the output of the
3185 bootm command when booting a FIT image.
3186
Ying Zhang3aa29de2013-08-16 15:16:15 +08003187- TPL framework
3188 CONFIG_TPL
3189 Enable building of TPL globally.
3190
3191 CONFIG_TPL_PAD_TO
3192 Image offset to which the TPL should be padded before appending
3193 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003194 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3195 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3196 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003197
wdenkc6097192002-11-03 00:24:07 +00003198Modem Support:
3199--------------
3200
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003201[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003202
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003203- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003204 CONFIG_MODEM_SUPPORT
3205
3206- RTS/CTS Flow control enable:
3207 CONFIG_HWFLOW
3208
3209- Modem debug support:
3210 CONFIG_MODEM_SUPPORT_DEBUG
3211
wdenk43d96162003-03-06 00:02:04 +00003212 Enables debugging stuff (char screen[1024], dbg())
3213 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003214
wdenka8c7c702003-12-06 19:49:23 +00003215- Interrupt support (PPC):
3216
wdenkd4ca31c2004-01-02 14:00:00 +00003217 There are common interrupt_init() and timer_interrupt()
3218 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003219 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003220 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003221 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003222 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003223 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003224 specific handling. If board has watchdog / status_led
3225 / other_activity_monitor it works automatically from
3226 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003227
wdenkc6097192002-11-03 00:24:07 +00003228- General:
3229
wdenk43d96162003-03-06 00:02:04 +00003230 In the target system modem support is enabled when a
3231 specific key (key combination) is pressed during
3232 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003233 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003234 board_init(). Currently key_pressed() is a dummy
3235 function, returning 1 and thus enabling modem
3236 initialization.
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk43d96162003-03-06 00:02:04 +00003238 If there are no modem init strings in the
3239 environment, U-Boot proceed to autoboot; the
3240 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003241 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003242
3243 See also: doc/README.Modem
3244
Helmut Raiger9660e442011-10-20 04:19:47 +00003245Board initialization settings:
3246------------------------------
3247
3248During Initialization u-boot calls a number of board specific functions
3249to allow the preparation of board specific prerequisites, e.g. pin setup
3250before drivers are initialized. To enable these callbacks the
3251following configuration macros have to be defined. Currently this is
3252architecture specific, so please check arch/your_architecture/lib/board.c
3253typically in board_init_f() and board_init_r().
3254
3255- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3256- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3257- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3258- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003259
wdenkc6097192002-11-03 00:24:07 +00003260Configuration Settings:
3261-----------------------
3262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003263- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003264 undefine this when you're short of memory.
3265
Peter Tyser2fb26042009-01-27 18:03:12 -06003266- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3267 width of the commands listed in the 'help' command output.
3268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003269- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003270 prompt for user input.
3271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003272- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003274- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003275
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003276- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003278- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003279 the application (usually a Linux kernel) when it is
3280 booted
3281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003282- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003283 List of legal baudrate settings for this board.
3284
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003285- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003286 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003287
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003288- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003289 If the board specific function
3290 extern int overwrite_console (void);
3291 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003292 serial port, else the settings in the environment are used.
3293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003294- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003295 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003297- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003298 Enable overwrite of previous console environment settings.
3299
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003300- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003301 Begin and End addresses of the area used by the
3302 simple memory test.
3303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003304- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003305 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003307- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003308 Scratch address used by the alternate memory test
3309 You only need to set this if address zero isn't writeable
3310
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003311- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3312 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003313 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003314 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003315 fixing up gd->ram_size the Linux kernel should gets passed
3316 the now "corrected" memory size and won't touch it either.
3317 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003318 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003319 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003320 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003321
3322 This option can be used as a workaround for the 440EPx/GRx
3323 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3324 be touched.
3325
3326 WARNING: Please make sure that this value is a multiple of
3327 the Linux page size (normally 4k). If this is not the case,
3328 then the end address of the Linux memory will be located at a
3329 non page size aligned address and this could cause major
3330 problems.
3331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003332- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003333 Enable temporary baudrate change while serial download
3334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003335- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003336 Physical start address of SDRAM. _Must_ be 0 here.
3337
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003338- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003339 Physical start address of Motherboard I/O (if using a
3340 Cogent motherboard)
3341
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003342- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003343 Physical start address of Flash memory.
3344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003345- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003346 Physical start address of boot monitor code (set by
3347 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003348 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003349 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003351- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003352 Size of memory reserved for monitor code, used to
3353 determine _at_compile_time_ (!) if the environment is
3354 embedded within the U-Boot image, or in a separate
3355 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003356
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003357- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003358 Size of DRAM reserved for malloc() use.
3359
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003360- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003361 Normally compressed uImages are limited to an
3362 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003363 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003364 to adjust this setting to your needs.
3365
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003366- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003367 Maximum size of memory mapped by the startup code of
3368 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003369 the Linux kernel (bd_info, boot arguments, FDT blob if
3370 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003371 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003372 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003373 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003374 variable "bootm_mapsize" will override the value of
3375 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3376 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003377
John Rigbyfca43cc2010-10-13 13:57:35 -06003378- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3379 Enable initrd_high functionality. If defined then the
3380 initrd_high feature is enabled and the bootm ramdisk subcommand
3381 is enabled.
3382
3383- CONFIG_SYS_BOOT_GET_CMDLINE:
3384 Enables allocating and saving kernel cmdline in space between
3385 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3386
3387- CONFIG_SYS_BOOT_GET_KBD:
3388 Enables allocating and saving a kernel copy of the bd_info in
3389 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3390
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003391- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003392 Max number of Flash memory banks
3393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003394- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003395 Max number of sectors on a Flash chip
3396
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003397- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003398 Timeout for Flash erase operations (in ms)
3399
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003400- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003401 Timeout for Flash write operations (in ms)
3402
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003403- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003404 Timeout for Flash set sector lock bit operation (in ms)
3405
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003406- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003407 Timeout for Flash clear lock bits operation (in ms)
3408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003409- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003410 If defined, hardware flash sectors protection is used
3411 instead of U-Boot software protection.
3412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003413- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003414
3415 Enable TFTP transfers directly to flash memory;
3416 without this option such a download has to be
3417 performed in two steps: (1) download to RAM, and (2)
3418 copy from RAM to flash.
3419
3420 The two-step approach is usually more reliable, since
3421 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003422 the flash, but in some situations (when system RAM is
3423 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003424 downloaded image) this option may be very useful.
3425
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003426- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003427 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003428 common flash structure for storing flash geometry.
3429
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003430- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003431 This option also enables the building of the cfi_flash driver
3432 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003433
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003434- CONFIG_FLASH_CFI_MTD
3435 This option enables the building of the cfi_mtd driver
3436 in the drivers directory. The driver exports CFI flash
3437 to the MTD layer.
3438
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003439- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003440 Use buffered writes to flash.
3441
3442- CONFIG_FLASH_SPANSION_S29WS_N
3443 s29ws-n MirrorBit flash has non-standard addresses for buffered
3444 write commands.
3445
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003446- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003447 If this option is defined, the common CFI flash doesn't
3448 print it's warning upon not recognized FLASH banks. This
3449 is useful, if some of the configured banks are only
3450 optionally available.
3451
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003452- CONFIG_FLASH_SHOW_PROGRESS
3453 If defined (must be an integer), print out countdown
3454 digits and dots. Recommended value: 45 (9..1) for 80
3455 column displays, 15 (3..1) for 40 column displays.
3456
Stefan Roese352ef3f2013-04-04 15:53:14 +02003457- CONFIG_FLASH_VERIFY
3458 If defined, the content of the flash (destination) is compared
3459 against the source after the write operation. An error message
3460 will be printed when the contents are not identical.
3461 Please note that this option is useless in nearly all cases,
3462 since such flash programming errors usually are detected earlier
3463 while unprotecting/erasing/programming. Please only enable
3464 this option if you really know what you are doing.
3465
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003466- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003467 Defines the number of Ethernet receive buffers. On some
3468 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003469 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3470 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003471 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003472 Defaults to 4 if not defined.
3473
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003474- CONFIG_ENV_MAX_ENTRIES
3475
Wolfgang Denk071bc922010-10-27 22:48:30 +02003476 Maximum number of entries in the hash table that is used
3477 internally to store the environment settings. The default
3478 setting is supposed to be generous and should work in most
3479 cases. This setting can be used to tune behaviour; see
3480 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003481
Joe Hershberger25980902012-12-11 22:16:31 -06003482- CONFIG_ENV_FLAGS_LIST_DEFAULT
3483- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003484 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003485 calling env set. Variables can be restricted to only decimal,
3486 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3487 the variables can also be restricted to IP address or MAC address.
3488
3489 The format of the list is:
3490 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003491 access_atribute = [a|r|o|c]
3492 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003493 entry = variable_name[:attributes]
3494 list = entry[,list]
3495
3496 The type attributes are:
3497 s - String (default)
3498 d - Decimal
3499 x - Hexadecimal
3500 b - Boolean ([1yYtT|0nNfF])
3501 i - IP address
3502 m - MAC address
3503
Joe Hershberger267541f2012-12-11 22:16:34 -06003504 The access attributes are:
3505 a - Any (default)
3506 r - Read-only
3507 o - Write-once
3508 c - Change-default
3509
Joe Hershberger25980902012-12-11 22:16:31 -06003510 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3511 Define this to a list (string) to define the ".flags"
3512 envirnoment variable in the default or embedded environment.
3513
3514 - CONFIG_ENV_FLAGS_LIST_STATIC
3515 Define this to a list (string) to define validation that
3516 should be done if an entry is not found in the ".flags"
3517 environment variable. To override a setting in the static
3518 list, simply add an entry for the same variable name to the
3519 ".flags" variable.
3520
Joe Hershberger267541f2012-12-11 22:16:34 -06003521- CONFIG_ENV_ACCESS_IGNORE_FORCE
3522 If defined, don't allow the -f switch to env set override variable
3523 access flags.
3524
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003525- CONFIG_SYS_GENERIC_BOARD
3526 This selects the architecture-generic board system instead of the
3527 architecture-specific board files. It is intended to move boards
3528 to this new framework over time. Defining this will disable the
3529 arch/foo/lib/board.c file and use common/board_f.c and
3530 common/board_r.c instead. To use this option your architecture
3531 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3532 its config.mk file). If you find problems enabling this option on
3533 your board please report the problem and send patches!
3534
Simon Glass632efa72013-03-11 07:06:48 +00003535- CONFIG_SYS_SYM_OFFSETS
3536 This is set by architectures that use offsets for link symbols
3537 instead of absolute values. So bss_start is obtained using an
3538 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3539 directly. You should not need to touch this setting.
3540
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003541- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3542 This is set by OMAP boards for the max time that reset should
3543 be asserted. See doc/README.omap-reset-time for details on how
3544 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003545
wdenkc6097192002-11-03 00:24:07 +00003546The following definitions that deal with the placement and management
3547of environment data (variable area); in general, we support the
3548following configurations:
3549
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003550- CONFIG_BUILD_ENVCRC:
3551
3552 Builds up envcrc with the target environment so that external utils
3553 may easily extract it and embed it in final U-Boot images.
3554
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003555- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003556
3557 Define this if the environment is in flash memory.
3558
3559 a) The environment occupies one whole flash sector, which is
3560 "embedded" in the text segment with the U-Boot code. This
3561 happens usually with "bottom boot sector" or "top boot
3562 sector" type flash chips, which have several smaller
3563 sectors at the start or the end. For instance, such a
3564 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3565 such a case you would place the environment in one of the
3566 4 kB sectors - with U-Boot code before and after it. With
3567 "top boot sector" type flash chips, you would put the
3568 environment in one of the last sectors, leaving a gap
3569 between U-Boot and the environment.
3570
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003571 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003572
3573 Offset of environment data (variable area) to the
3574 beginning of flash memory; for instance, with bottom boot
3575 type flash chips the second sector can be used: the offset
3576 for this sector is given here.
3577
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003578 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003579
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003580 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003581
3582 This is just another way to specify the start address of
3583 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003584 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003585
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003586 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003587
3588 Size of the sector containing the environment.
3589
3590
3591 b) Sometimes flash chips have few, equal sized, BIG sectors.
3592 In such a case you don't want to spend a whole sector for
3593 the environment.
3594
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003595 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003596
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003597 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003598 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003599 of this flash sector for the environment. This saves
3600 memory for the RAM copy of the environment.
3601
3602 It may also save flash memory if you decide to use this
3603 when your environment is "embedded" within U-Boot code,
3604 since then the remainder of the flash sector could be used
3605 for U-Boot code. It should be pointed out that this is
3606 STRONGLY DISCOURAGED from a robustness point of view:
3607 updating the environment in flash makes it always
3608 necessary to erase the WHOLE sector. If something goes
3609 wrong before the contents has been restored from a copy in
3610 RAM, your target system will be dead.
3611
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003612 - CONFIG_ENV_ADDR_REDUND
3613 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003614
wdenk43d96162003-03-06 00:02:04 +00003615 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003616 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003617 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003618 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003619
3620BE CAREFUL! Any changes to the flash layout, and some changes to the
3621source code will make it necessary to adapt <board>/u-boot.lds*
3622accordingly!
3623
3624
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003625- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003626
3627 Define this if you have some non-volatile memory device
3628 (NVRAM, battery buffered SRAM) which you want to use for the
3629 environment.
3630
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003631 - CONFIG_ENV_ADDR:
3632 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003633
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003634 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003635 want to use for environment. It is assumed that this memory
3636 can just be read and written to, without any special
3637 provision.
3638
3639BE CAREFUL! The first access to the environment happens quite early
3640in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003641console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003642U-Boot will hang.
3643
3644Please note that even with NVRAM we still use a copy of the
3645environment in RAM: we could work on NVRAM directly, but we want to
3646keep settings there always unmodified except somebody uses "saveenv"
3647to save the current settings.
3648
3649
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003650- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003651
3652 Use this if you have an EEPROM or similar serial access
3653 device and a driver for it.
3654
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003655 - CONFIG_ENV_OFFSET:
3656 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003657
3658 These two #defines specify the offset and size of the
3659 environment area within the total memory of your EEPROM.
3660
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003661 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003662 If defined, specified the chip address of the EEPROM device.
3663 The default address is zero.
3664
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003665 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003666 If defined, the number of bits used to address bytes in a
3667 single page in the EEPROM device. A 64 byte page, for example
3668 would require six bits.
3669
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003670 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003671 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003672 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003673
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003674 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003675 The length in bytes of the EEPROM memory array address. Note
3676 that this is NOT the chip address length!
3677
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003678 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003679 EEPROM chips that implement "address overflow" are ones
3680 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3681 address and the extra bits end up in the "chip address" bit
3682 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3683 byte chips.
3684
3685 Note that we consider the length of the address field to
3686 still be one byte because the extra address bits are hidden
3687 in the chip address.
3688
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003689 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003690 The size in bytes of the EEPROM device.
3691
Heiko Schocher548738b2010-01-07 08:55:40 +01003692 - CONFIG_ENV_EEPROM_IS_ON_I2C
3693 define this, if you have I2C and SPI activated, and your
3694 EEPROM, which holds the environment, is on the I2C bus.
3695
3696 - CONFIG_I2C_ENV_EEPROM_BUS
3697 if you have an Environment on an EEPROM reached over
3698 I2C muxes, you can define here, how to reach this
3699 EEPROM. For example:
3700
Heiko Schocherea818db2013-01-29 08:53:15 +01003701 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01003702
3703 EEPROM which holds the environment, is reached over
3704 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003705
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003706- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003707
wdenkd4ca31c2004-01-02 14:00:00 +00003708 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003709 want to use for the environment.
3710
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003711 - CONFIG_ENV_OFFSET:
3712 - CONFIG_ENV_ADDR:
3713 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003714
3715 These three #defines specify the offset and size of the
3716 environment area within the total memory of your DataFlash placed
3717 at the specified address.
3718
Liu Gang0a85a9e2012-03-08 00:33:20 +00003719- CONFIG_ENV_IS_IN_REMOTE:
3720
3721 Define this if you have a remote memory space which you
3722 want to use for the local device's environment.
3723
3724 - CONFIG_ENV_ADDR:
3725 - CONFIG_ENV_SIZE:
3726
3727 These two #defines specify the address and size of the
3728 environment area within the remote memory space. The
3729 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003730 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003731
3732BE CAREFUL! For some special cases, the local device can not use
3733"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003734environment stored in a remote NOR flash by SRIO or PCIE link,
3735but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003736
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003737- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003738
3739 Define this if you have a NAND device which you want to use
3740 for the environment.
3741
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003742 - CONFIG_ENV_OFFSET:
3743 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003744
3745 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003746 area within the first NAND device. CONFIG_ENV_OFFSET must be
3747 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003748
Scott Woodfdd813d2010-09-17 14:38:37 -05003749 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003750
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003751 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003752 size used to hold a redundant copy of the environment data, so
3753 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003754 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003755 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003756
Scott Woodfdd813d2010-09-17 14:38:37 -05003757 - CONFIG_ENV_RANGE (optional):
3758
3759 Specifies the length of the region in which the environment
3760 can be written. This should be a multiple of the NAND device's
3761 block size. Specifying a range with more erase blocks than
3762 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3763 the range to be avoided.
3764
3765 - CONFIG_ENV_OFFSET_OOB (optional):
3766
3767 Enables support for dynamically retrieving the offset of the
3768 environment from block zero's out-of-band data. The
3769 "nand env.oob" command can be used to record this offset.
3770 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3771 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003772
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003773- CONFIG_NAND_ENV_DST
3774
3775 Defines address in RAM to which the nand_spl code should copy the
3776 environment. If redundant environment is used, it will be copied to
3777 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3778
Joe Hershberger2b744332013-04-08 10:32:51 +00003779- CONFIG_ENV_IS_IN_UBI:
3780
3781 Define this if you have an UBI volume that you want to use for the
3782 environment. This has the benefit of wear-leveling the environment
3783 accesses, which is important on NAND.
3784
3785 - CONFIG_ENV_UBI_PART:
3786
3787 Define this to a string that is the mtd partition containing the UBI.
3788
3789 - CONFIG_ENV_UBI_VOLUME:
3790
3791 Define this to the name of the volume that you want to store the
3792 environment in.
3793
Joe Hershberger785881f2013-04-08 10:32:52 +00003794 - CONFIG_ENV_UBI_VOLUME_REDUND:
3795
3796 Define this to the name of another volume to store a second copy of
3797 the environment in. This will enable redundant environments in UBI.
3798 It is assumed that both volumes are in the same MTD partition.
3799
Joe Hershberger2b744332013-04-08 10:32:51 +00003800 - CONFIG_UBI_SILENCE_MSG
3801 - CONFIG_UBIFS_SILENCE_MSG
3802
3803 You will probably want to define these to avoid a really noisy system
3804 when storing the env in UBI.
3805
Stephen Warren06e4ae52013-06-11 15:14:00 -06003806- CONFIG_ENV_IS_IN_MMC:
3807
3808 Define this if you have an MMC device which you want to use for the
3809 environment.
3810
3811 - CONFIG_SYS_MMC_ENV_DEV:
3812
3813 Specifies which MMC device the environment is stored in.
3814
3815 - CONFIG_SYS_MMC_ENV_PART (optional):
3816
3817 Specifies which MMC partition the environment is stored in. If not
3818 set, defaults to partition 0, the user area. Common values might be
3819 1 (first MMC boot partition), 2 (second MMC boot partition).
3820
3821 - CONFIG_ENV_OFFSET:
3822 - CONFIG_ENV_SIZE:
3823
3824 These two #defines specify the offset and size of the environment
3825 area within the specified MMC device.
3826
Stephen Warren5c088ee2013-06-11 15:14:02 -06003827 If offset is positive (the usual case), it is treated as relative to
3828 the start of the MMC partition. If offset is negative, it is treated
3829 as relative to the end of the MMC partition. This can be useful if
3830 your board may be fitted with different MMC devices, which have
3831 different sizes for the MMC partitions, and you always want the
3832 environment placed at the very end of the partition, to leave the
3833 maximum possible space before it, to store other data.
3834
Stephen Warren06e4ae52013-06-11 15:14:00 -06003835 These two values are in units of bytes, but must be aligned to an
3836 MMC sector boundary.
3837
3838 - CONFIG_ENV_OFFSET_REDUND (optional):
3839
3840 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3841 hold a redundant copy of the environment data. This provides a
3842 valid backup copy in case the other copy is corrupted, e.g. due
3843 to a power failure during a "saveenv" operation.
3844
Stephen Warren5c088ee2013-06-11 15:14:02 -06003845 This value may also be positive or negative; this is handled in the
3846 same way as CONFIG_ENV_OFFSET.
3847
Stephen Warren06e4ae52013-06-11 15:14:00 -06003848 This value is also in units of bytes, but must also be aligned to
3849 an MMC sector boundary.
3850
3851 - CONFIG_ENV_SIZE_REDUND (optional):
3852
3853 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3854 set. If this value is set, it must be set to the same value as
3855 CONFIG_ENV_SIZE.
3856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003857- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003858
3859 Defines offset to the initial SPI buffer area in DPRAM. The
3860 area is used at an early stage (ROM part) if the environment
3861 is configured to reside in the SPI EEPROM: We need a 520 byte
3862 scratch DPRAM area. It is used between the two initialization
3863 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3864 to be a good choice since it makes it far enough from the
3865 start of the data area as well as from the stack pointer.
3866
Bruce Adlere881cb52007-11-02 13:15:42 -07003867Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003868has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003869created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003870until then to read environment variables.
3871
wdenk85ec0bc2003-03-31 16:34:49 +00003872The environment is protected by a CRC32 checksum. Before the monitor
3873is relocated into RAM, as a result of a bad CRC you will be working
3874with the compiled-in default environment - *silently*!!! [This is
3875necessary, because the first environment variable we need is the
3876"baudrate" setting for the console - if we have a bad CRC, we don't
3877have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003878
3879Note: once the monitor has been relocated, then it will complain if
3880the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003881use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003882
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003883- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003884 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003885
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003886 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003887 also needs to be defined.
3888
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003889- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003890 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003891
Ron Madridf5675aa2009-02-18 14:30:44 -08003892- CONFIG_NS16550_MIN_FUNCTIONS:
3893 Define this if you desire to only have use of the NS16550_init
3894 and NS16550_putc functions for the serial driver located at
3895 drivers/serial/ns16550.c. This option is useful for saving
3896 space for already greatly restricted images, including but not
3897 limited to NAND_SPL configurations.
3898
Simon Glassb2b92f52012-11-30 13:01:18 +00003899- CONFIG_DISPLAY_BOARDINFO
3900 Display information about the board that U-Boot is running on
3901 when U-Boot starts up. The board function checkboard() is called
3902 to do this.
3903
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003904- CONFIG_DISPLAY_BOARDINFO_LATE
3905 Similar to the previous option, but display this information
3906 later, once stdio is running and output goes to the LCD, if
3907 present.
3908
wdenkc6097192002-11-03 00:24:07 +00003909Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003910---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003911
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003912- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003913 Cache Line Size of the CPU.
3914
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003915- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003916 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003917
wdenk42d1f032003-10-15 23:53:47 +00003918 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3919 and RPXsuper) to be able to adjust the position of
3920 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003921
Timur Tabie46fedf2011-08-04 18:03:41 -05003922- CONFIG_SYS_CCSRBAR_DEFAULT:
3923 Default (power-on reset) physical address of CCSR on Freescale
3924 PowerPC SOCs.
3925
3926- CONFIG_SYS_CCSRBAR:
3927 Virtual address of CCSR. On a 32-bit build, this is typically
3928 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3929
3930 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3931 for cross-platform code that uses that macro instead.
3932
3933- CONFIG_SYS_CCSRBAR_PHYS:
3934 Physical address of CCSR. CCSR can be relocated to a new
3935 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003936 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003937 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3938 is typically relocated on 36-bit builds. It is recommended
3939 that this macro be defined via the _HIGH and _LOW macros:
3940
3941 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3942 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3943
3944- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003945 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3946 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003947 used in assembly code, so it must not contain typecasts or
3948 integer size suffixes (e.g. "ULL").
3949
3950- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3951 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3952 used in assembly code, so it must not contain typecasts or
3953 integer size suffixes (e.g. "ULL").
3954
3955- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3956 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3957 forced to a value that ensures that CCSR is not relocated.
3958
wdenk7f6c2cb2002-11-10 22:06:23 +00003959- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003960 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003961
3962 the default drive number (default value 0)
3963
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003964 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003965
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003966 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003967 (default value 1)
3968
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003969 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003970
wdenk43d96162003-03-06 00:02:04 +00003971 defines the offset of register from address. It
3972 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003973 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003975 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3976 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003977 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003978
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003979 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003980 fdc_hw_init() is called at the beginning of the FDC
3981 setup. fdc_hw_init() must be provided by the board
3982 source code. It is used to make hardware dependant
3983 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003984
Macpaul Lin0abddf82011-04-11 20:45:32 +00003985- CONFIG_IDE_AHB:
3986 Most IDE controllers were designed to be connected with PCI
3987 interface. Only few of them were designed for AHB interface.
3988 When software is doing ATA command and data transfer to
3989 IDE devices through IDE-AHB controller, some additional
3990 registers accessing to these kind of IDE-AHB controller
3991 is requierd.
3992
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003993- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003994 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003995 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003996
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003997- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003998
wdenk7152b1d2003-09-05 23:19:14 +00003999 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004000 initial data and stack; please note that this must be
4001 writable memory that is working WITHOUT special
4002 initialization, i. e. you CANNOT use normal RAM which
4003 will become available only after programming the
4004 memory controller and running certain initialization
4005 sequences.
4006
4007 U-Boot uses the following memory types:
4008 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4009 - MPC824X: data cache
4010 - PPC4xx: data cache
4011
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004012- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004013
4014 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004015 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4016 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004017 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004018 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004019 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4020 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4021 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004022
4023 Note:
4024 On the MPC824X (or other systems that use the data
4025 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004026 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004027 point to an otherwise UNUSED address space between
4028 the top of RAM and the start of the PCI space.
4029
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004030- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004032- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004033
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004034- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004035
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004036- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004037
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004038- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004039
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004040- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004041
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004042- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004043 SDRAM timing
4044
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004045- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004046 periodic timer for refresh
4047
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004048- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004049
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004050- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4051 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4052 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4053 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004054 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4055
4056- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004057 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4058 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004059 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004061- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4062 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004063 Machine Mode Register and Memory Periodic Timer
4064 Prescaler definitions (SDRAM timing)
4065
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004066- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004067 enable I2C microcode relocation patch (MPC8xx);
4068 define relocation offset in DPRAM [DSP2]
4069
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004070- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004071 enable SMC microcode relocation patch (MPC8xx);
4072 define relocation offset in DPRAM [SMC1]
4073
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004074- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004075 enable SPI microcode relocation patch (MPC8xx);
4076 define relocation offset in DPRAM [SCC4]
4077
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004078- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004079 Use OSCM clock mode on MBX8xx board. Be careful,
4080 wrong setting might damage your board. Read
4081 doc/README.MBX before setting this variable!
4082
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004083- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004084 Offset of the bootmode word in DPRAM used by post
4085 (Power On Self Tests). This definition overrides
4086 #define'd default value in commproc.h resp.
4087 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004088
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004089- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4090 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4091 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4092 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4093 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4094 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4095 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4096 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004097 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004098
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004099- CONFIG_PCI_DISABLE_PCIE:
4100 Disable PCI-Express on systems where it is supported but not
4101 required.
4102
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004103- CONFIG_PCI_ENUM_ONLY
4104 Only scan through and get the devices on the busses.
4105 Don't do any setup work, presumably because someone or
4106 something has already done it, and we don't need to do it
4107 a second time. Useful for platforms that are pre-booted
4108 by coreboot or similar.
4109
Gabor Juhos842033e2013-05-30 07:06:12 +00004110- CONFIG_PCI_INDIRECT_BRIDGE:
4111 Enable support for indirect PCI bridges.
4112
Kumar Galaa09b9b62010-12-30 12:09:53 -06004113- CONFIG_SYS_SRIO:
4114 Chip has SRIO or not
4115
4116- CONFIG_SRIO1:
4117 Board has SRIO 1 port available
4118
4119- CONFIG_SRIO2:
4120 Board has SRIO 2 port available
4121
Liu Gangc8b28152013-05-07 16:30:46 +08004122- CONFIG_SRIO_PCIE_BOOT_MASTER
4123 Board can support master function for Boot from SRIO and PCIE
4124
Kumar Galaa09b9b62010-12-30 12:09:53 -06004125- CONFIG_SYS_SRIOn_MEM_VIRT:
4126 Virtual Address of SRIO port 'n' memory region
4127
4128- CONFIG_SYS_SRIOn_MEM_PHYS:
4129 Physical Address of SRIO port 'n' memory region
4130
4131- CONFIG_SYS_SRIOn_MEM_SIZE:
4132 Size of SRIO port 'n' memory region
4133
Fabio Estevam66bd1842013-04-11 09:35:34 +00004134- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4135 Defined to tell the NAND controller that the NAND chip is using
4136 a 16 bit bus.
4137 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004138 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004139 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004140 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004141
4142- CONFIG_SYS_NDFC_EBC0_CFG
4143 Sets the EBC0_CFG register for the NDFC. If not defined
4144 a default value will be used.
4145
Ben Warrenbb99ad62006-09-07 16:50:54 -04004146- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004147 Get DDR timing information from an I2C EEPROM. Common
4148 with pluggable memory modules such as SODIMMs
4149
Ben Warrenbb99ad62006-09-07 16:50:54 -04004150 SPD_EEPROM_ADDRESS
4151 I2C address of the SPD EEPROM
4152
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004153- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004154 If SPD EEPROM is on an I2C bus other than the first
4155 one, specify here. Note that the value must resolve
4156 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004157
York Sun1b3e3c42011-06-07 09:42:16 +08004158- CONFIG_SYS_DDR_RAW_TIMING
4159 Get DDR timing information from other than SPD. Common with
4160 soldered DDR chips onboard without SPD. DDR raw timing
4161 parameters are extracted from datasheet and hard-coded into
4162 header files or board specific files.
4163
York Sun6f5e1dc2011-09-16 13:21:35 -07004164- CONFIG_FSL_DDR_INTERACTIVE
4165 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004167- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004168 Only for 83xx systems. If specified, then DDR should
4169 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004170
wdenkc26e4542004-04-18 10:13:26 +00004171- CONFIG_ETHER_ON_FEC[12]
4172 Define to enable FEC[12] on a 8xx series processor.
4173
4174- CONFIG_FEC[12]_PHY
4175 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004176 to the given FEC; i. e.
4177 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004178 means that the PHY with address 4 is connected to FEC1
4179
4180 When set to -1, means to probe for first available.
4181
4182- CONFIG_FEC[12]_PHY_NORXERR
4183 The PHY does not have a RXERR line (RMII only).
4184 (so program the FEC to ignore it).
4185
4186- CONFIG_RMII
4187 Enable RMII mode for all FECs.
4188 Note that this is a global option, we can't
4189 have one FEC in standard MII mode and another in RMII mode.
4190
wdenk5cf91d62004-04-23 20:32:05 +00004191- CONFIG_CRC32_VERIFY
4192 Add a verify option to the crc32 command.
4193 The syntax is:
4194
4195 => crc32 -v <address> <count> <crc32>
4196
4197 Where address/count indicate a memory area
4198 and crc32 is the correct crc32 which the
4199 area should have.
4200
wdenk56523f12004-07-11 17:40:54 +00004201- CONFIG_LOOPW
4202 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004203 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004204
stroese7b466642004-12-16 18:46:55 +00004205- CONFIG_MX_CYCLIC
4206 Add the "mdc" and "mwc" memory commands. These are cyclic
4207 "md/mw" commands.
4208 Examples:
4209
wdenkefe2a4d2004-12-16 21:44:03 +00004210 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004211 This command will print 4 bytes (10,11,12,13) each 500 ms.
4212
wdenkefe2a4d2004-12-16 21:44:03 +00004213 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004214 This command will write 12345678 to address 100 all 10 ms.
4215
wdenkefe2a4d2004-12-16 21:44:03 +00004216 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004217 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004218
wdenk8aa1a2d2005-04-04 12:44:11 +00004219- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004220 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004221 low level initializations (like setting up the memory
4222 controller) are omitted and/or U-Boot does not
4223 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004224
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004225 Normally this variable MUST NOT be defined. The only
4226 exception is when U-Boot is loaded (to RAM) by some
4227 other boot loader or by a debugger which performs
4228 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004229
Aneesh V401bb302011-07-13 05:11:07 +00004230- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004231 Modifies the behaviour of start.S when compiling a loader
4232 that is executed before the actual U-Boot. E.g. when
4233 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004234
Ying Zhang3aa29de2013-08-16 15:16:15 +08004235- CONFIG_TPL_BUILD
4236 Modifies the behaviour of start.S when compiling a loader
4237 that is executed after the SPL and before the actual U-Boot.
4238 It is loaded by the SPL.
4239
Ying Zhang5df572f2013-05-20 14:07:23 +08004240- CONFIG_SYS_MPC85XX_NO_RESETVEC
4241 Only for 85xx systems. If this variable is specified, the section
4242 .resetvec is not kept and the section .bootpg is placed in the
4243 previous 4k of the .text section.
4244
Simon Glass4213fc22013-02-24 17:33:14 +00004245- CONFIG_ARCH_MAP_SYSMEM
4246 Generally U-Boot (and in particular the md command) uses
4247 effective address. It is therefore not necessary to regard
4248 U-Boot address as virtual addresses that need to be translated
4249 to physical addresses. However, sandbox requires this, since
4250 it maintains its own little RAM buffer which contains all
4251 addressable memory. This option causes some memory accesses
4252 to be mapped through map_sysmem() / unmap_sysmem().
4253
Matthias Weisserd8834a12011-03-10 21:36:32 +00004254- CONFIG_USE_ARCH_MEMCPY
4255 CONFIG_USE_ARCH_MEMSET
4256 If these options are used a optimized version of memcpy/memset will
4257 be used if available. These functions may be faster under some
4258 conditions but may increase the binary size.
4259
Simon Glass588a13f2013-02-14 04:18:54 +00004260- CONFIG_X86_RESET_VECTOR
4261 If defined, the x86 reset vector code is included. This is not
4262 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004263
Mark Jacksonfc337052013-03-04 01:27:20 +00004264- CONFIG_SYS_MPUCLK
4265 Defines the MPU clock speed (in MHz).
4266
4267 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004268
Timur Tabif2717b42011-11-22 09:21:25 -06004269Freescale QE/FMAN Firmware Support:
4270-----------------------------------
4271
4272The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4273loading of "firmware", which is encoded in the QE firmware binary format.
4274This firmware often needs to be loaded during U-Boot booting, so macros
4275are used to identify the storage device (NOR flash, SPI, etc) and the address
4276within that device.
4277
4278- CONFIG_SYS_QE_FMAN_FW_ADDR
4279 The address in the storage device where the firmware is located. The
4280 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4281 is also specified.
4282
4283- CONFIG_SYS_QE_FMAN_FW_LENGTH
4284 The maximum possible size of the firmware. The firmware binary format
4285 has a field that specifies the actual size of the firmware, but it
4286 might not be possible to read any part of the firmware unless some
4287 local storage is allocated to hold the entire firmware first.
4288
4289- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4290 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4291 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4292 virtual address in NOR flash.
4293
4294- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4295 Specifies that QE/FMAN firmware is located in NAND flash.
4296 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4297
4298- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4299 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4300 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4301
4302- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4303 Specifies that QE/FMAN firmware is located on the primary SPI
4304 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4305
Liu Gang292dc6c2012-03-08 00:33:18 +00004306- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4307 Specifies that QE/FMAN firmware is located in the remote (master)
4308 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004309 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4310 window->master inbound window->master LAW->the ucode address in
4311 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004312
wdenkc6097192002-11-03 00:24:07 +00004313Building the Software:
4314======================
4315
Wolfgang Denk218ca722008-03-26 10:40:12 +01004316Building U-Boot has been tested in several native build environments
4317and in many different cross environments. Of course we cannot support
4318all possibly existing versions of cross development tools in all
4319(potentially obsolete) versions. In case of tool chain problems we
4320recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4321which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004322
Wolfgang Denk218ca722008-03-26 10:40:12 +01004323If you are not using a native environment, it is assumed that you
4324have GNU cross compiling tools available in your path. In this case,
4325you must set the environment variable CROSS_COMPILE in your shell.
4326Note that no changes to the Makefile or any other source files are
4327necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004328
Wolfgang Denk218ca722008-03-26 10:40:12 +01004329 $ CROSS_COMPILE=ppc_4xx-
4330 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004331
Peter Tyser2f8d3962009-03-13 18:54:51 -05004332Note: If you wish to generate Windows versions of the utilities in
4333 the tools directory you can use the MinGW toolchain
4334 (http://www.mingw.org). Set your HOST tools to the MinGW
4335 toolchain and execute 'make tools'. For example:
4336
4337 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4338
4339 Binaries such as tools/mkimage.exe will be created which can
4340 be executed on computers running Windows.
4341
Wolfgang Denk218ca722008-03-26 10:40:12 +01004342U-Boot is intended to be simple to build. After installing the
4343sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004344is done by typing:
4345
4346 make NAME_config
4347
Wolfgang Denk218ca722008-03-26 10:40:12 +01004348where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004349rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004350
wdenk2729af92004-05-03 20:45:30 +00004351Note: for some board special configuration names may exist; check if
4352 additional information is available from the board vendor; for
4353 instance, the TQM823L systems are available without (standard)
4354 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004355 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004356
wdenk2729af92004-05-03 20:45:30 +00004357 make TQM823L_config
4358 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004359
wdenk2729af92004-05-03 20:45:30 +00004360 make TQM823L_LCD_config
4361 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004362
wdenk2729af92004-05-03 20:45:30 +00004363 etc.
wdenkc6097192002-11-03 00:24:07 +00004364
wdenkc6097192002-11-03 00:24:07 +00004365
wdenk2729af92004-05-03 20:45:30 +00004366Finally, type "make all", and you should get some working U-Boot
4367images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004368
wdenk2729af92004-05-03 20:45:30 +00004369- "u-boot.bin" is a raw binary image
4370- "u-boot" is an image in ELF binary format
4371- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004372
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004373By default the build is performed locally and the objects are saved
4374in the source directory. One of the two methods can be used to change
4375this behavior and build U-Boot to some external directory:
4376
43771. Add O= to the make command line invocations:
4378
4379 make O=/tmp/build distclean
4380 make O=/tmp/build NAME_config
4381 make O=/tmp/build all
4382
43832. Set environment variable BUILD_DIR to point to the desired location:
4384
4385 export BUILD_DIR=/tmp/build
4386 make distclean
4387 make NAME_config
4388 make all
4389
4390Note that the command line "O=" setting overrides the BUILD_DIR environment
4391variable.
4392
wdenkc6097192002-11-03 00:24:07 +00004393
wdenk2729af92004-05-03 20:45:30 +00004394Please be aware that the Makefiles assume you are using GNU make, so
4395for instance on NetBSD you might need to use "gmake" instead of
4396native "make".
wdenkc6097192002-11-03 00:24:07 +00004397
wdenkc6097192002-11-03 00:24:07 +00004398
wdenk2729af92004-05-03 20:45:30 +00004399If the system board that you have is not listed, then you will need
4400to port U-Boot to your hardware platform. To do this, follow these
4401steps:
wdenkc6097192002-11-03 00:24:07 +00004402
wdenk2729af92004-05-03 20:45:30 +000044031. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004404 "boards.cfg" file, using the existing entries as examples.
4405 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000044062. Create a new directory to hold your board specific code. Add any
4407 files you need. In your board directory, you will need at least
4408 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
44093. Create a new configuration file "include/configs/<board>.h" for
4410 your board
44113. If you're porting U-Boot to a new CPU, then also create a new
4412 directory to hold your CPU specific code. Add any files you need.
44134. Run "make <board>_config" with your new name.
44145. Type "make", and you should get a working "u-boot.srec" file
4415 to be installed on your target system.
44166. Debug and solve any problems that might arise.
4417 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004418
wdenkc6097192002-11-03 00:24:07 +00004419
wdenk2729af92004-05-03 20:45:30 +00004420Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4421==============================================================
wdenkc6097192002-11-03 00:24:07 +00004422
Wolfgang Denk218ca722008-03-26 10:40:12 +01004423If you have modified U-Boot sources (for instance added a new board
4424or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004425provide feedback to the other developers. The feedback normally takes
4426the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004427official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004428
Wolfgang Denk218ca722008-03-26 10:40:12 +01004429But before you submit such a patch, please verify that your modifi-
4430cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004431the supported boards compile WITHOUT ANY compiler warnings. To do so,
4432just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004433for ALL supported system. Be warned, this will take a while. You can
4434select which (cross) compiler to use by passing a `CROSS_COMPILE'
4435environment variable to the script, i. e. to use the ELDK cross tools
4436you can type
wdenkc6097192002-11-03 00:24:07 +00004437
wdenk2729af92004-05-03 20:45:30 +00004438 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004439
wdenk2729af92004-05-03 20:45:30 +00004440or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk2729af92004-05-03 20:45:30 +00004442 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004443
Wolfgang Denk218ca722008-03-26 10:40:12 +01004444When using the MAKEALL script, the default behaviour is to build
4445U-Boot in the source directory. This location can be changed by
4446setting the BUILD_DIR environment variable. Also, for each target
4447built, the MAKEALL script saves two log files (<target>.ERR and
4448<target>.MAKEALL) in the <source dir>/LOG directory. This default
4449location can be changed by setting the MAKEALL_LOGDIR environment
4450variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004451
4452 export BUILD_DIR=/tmp/build
4453 export MAKEALL_LOGDIR=/tmp/log
4454 CROSS_COMPILE=ppc_8xx- MAKEALL
4455
Wolfgang Denk218ca722008-03-26 10:40:12 +01004456With the above settings build objects are saved in the /tmp/build,
4457log files are saved in the /tmp/log and the source tree remains clean
4458during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004459
4460
wdenk2729af92004-05-03 20:45:30 +00004461See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004462
wdenkc6097192002-11-03 00:24:07 +00004463
wdenk2729af92004-05-03 20:45:30 +00004464Monitor Commands - Overview:
4465============================
wdenkc6097192002-11-03 00:24:07 +00004466
wdenk2729af92004-05-03 20:45:30 +00004467go - start application at address 'addr'
4468run - run commands in an environment variable
4469bootm - boot application image from memory
4470bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004471bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004472tftpboot- boot image via network using TFTP protocol
4473 and env variables "ipaddr" and "serverip"
4474 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004475tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004476rarpboot- boot image via network using RARP/TFTP protocol
4477diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4478loads - load S-Record file over serial line
4479loadb - load binary file over serial line (kermit mode)
4480md - memory display
4481mm - memory modify (auto-incrementing)
4482nm - memory modify (constant address)
4483mw - memory write (fill)
4484cp - memory copy
4485cmp - memory compare
4486crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004487i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004488sspi - SPI utility commands
4489base - print or set address offset
4490printenv- print environment variables
4491setenv - set environment variables
4492saveenv - save environment variables to persistent storage
4493protect - enable or disable FLASH write protection
4494erase - erase FLASH memory
4495flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004496nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004497bdinfo - print Board Info structure
4498iminfo - print header information for application image
4499coninfo - print console devices and informations
4500ide - IDE sub-system
4501loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004502loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004503mtest - simple RAM test
4504icache - enable or disable instruction cache
4505dcache - enable or disable data cache
4506reset - Perform RESET of the CPU
4507echo - echo args to console
4508version - print monitor version
4509help - print online help
4510? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004511
wdenkc6097192002-11-03 00:24:07 +00004512
wdenk2729af92004-05-03 20:45:30 +00004513Monitor Commands - Detailed Description:
4514========================================
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk2729af92004-05-03 20:45:30 +00004516TODO.
wdenkc6097192002-11-03 00:24:07 +00004517
wdenk2729af92004-05-03 20:45:30 +00004518For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004519
4520
wdenk2729af92004-05-03 20:45:30 +00004521Environment Variables:
4522======================
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk2729af92004-05-03 20:45:30 +00004524U-Boot supports user configuration using Environment Variables which
4525can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004526
wdenk2729af92004-05-03 20:45:30 +00004527Environment Variables are set using "setenv", printed using
4528"printenv", and saved to Flash using "saveenv". Using "setenv"
4529without a value can be used to delete a variable from the
4530environment. As long as you don't save the environment you are
4531working with an in-memory copy. In case the Flash area containing the
4532environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004533
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004534Some configuration options can be set using Environment Variables.
4535
4536List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004537
wdenk2729af92004-05-03 20:45:30 +00004538 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk2729af92004-05-03 20:45:30 +00004540 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004541
wdenk2729af92004-05-03 20:45:30 +00004542 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004543
wdenk2729af92004-05-03 20:45:30 +00004544 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004545
wdenk2729af92004-05-03 20:45:30 +00004546 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004547
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004548 bootm_low - Memory range available for image processing in the bootm
4549 command can be restricted. This variable is given as
4550 a hexadecimal number and defines lowest address allowed
4551 for use by the bootm command. See also "bootm_size"
4552 environment variable. Address defined by "bootm_low" is
4553 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004554 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4555 bootm_mapsize.
4556
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004557 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004558 This variable is given as a hexadecimal number and it
4559 defines the size of the memory region starting at base
4560 address bootm_low that is accessible by the Linux kernel
4561 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4562 as the default value if it is defined, and bootm_size is
4563 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004564
4565 bootm_size - Memory range available for image processing in the bootm
4566 command can be restricted. This variable is given as
4567 a hexadecimal number and defines the size of the region
4568 allowed for use by the bootm command. See also "bootm_low"
4569 environment variable.
4570
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004571 updatefile - Location of the software update file on a TFTP server, used
4572 by the automatic software update feature. Please refer to
4573 documentation in doc/README.update for more details.
4574
wdenk2729af92004-05-03 20:45:30 +00004575 autoload - if set to "no" (any string beginning with 'n'),
4576 "bootp" will just load perform a lookup of the
4577 configuration from the BOOTP server, but not try to
4578 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk2729af92004-05-03 20:45:30 +00004580 autostart - if set to "yes", an image loaded using the "bootp",
4581 "rarpboot", "tftpboot" or "diskboot" commands will
4582 be automatically started (by internally calling
4583 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004584
wdenk2729af92004-05-03 20:45:30 +00004585 If set to "no", a standalone image passed to the
4586 "bootm" command will be copied to the load address
4587 (and eventually uncompressed), but NOT be started.
4588 This can be used to load and uncompress arbitrary
4589 data.
wdenkc6097192002-11-03 00:24:07 +00004590
David A. Longa28afca2011-07-09 16:40:19 -04004591 fdt_high - if set this restricts the maximum address that the
4592 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004593 For example, if you have a system with 1 GB memory
4594 at physical address 0x10000000, while Linux kernel
4595 only recognizes the first 704 MB as low memory, you
4596 may need to set fdt_high as 0x3C000000 to have the
4597 device tree blob be copied to the maximum address
4598 of the 704 MB low memory, so that Linux kernel can
4599 access it during the boot procedure.
4600
David A. Longa28afca2011-07-09 16:40:19 -04004601 If this is set to the special value 0xFFFFFFFF then
4602 the fdt will not be copied at all on boot. For this
4603 to work it must reside in writable memory, have
4604 sufficient padding on the end of it for u-boot to
4605 add the information it needs into it, and the memory
4606 must be accessible by the kernel.
4607
Simon Glasseea63e02011-10-24 19:15:34 +00004608 fdtcontroladdr- if set this is the address of the control flattened
4609 device tree used by U-Boot when CONFIG_OF_CONTROL is
4610 defined.
4611
wdenk17ea1172004-06-06 21:51:03 +00004612 i2cfast - (PPC405GP|PPC405EP only)
4613 if set to 'y' configures Linux I2C driver for fast
4614 mode (400kHZ). This environment variable is used in
4615 initialization code. So, for changes to be effective
4616 it must be saved and board must be reset.
4617
wdenk2729af92004-05-03 20:45:30 +00004618 initrd_high - restrict positioning of initrd images:
4619 If this variable is not set, initrd images will be
4620 copied to the highest possible address in RAM; this
4621 is usually what you want since it allows for
4622 maximum initrd size. If for some reason you want to
4623 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004624 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004625 variable to a value of "no" or "off" or "0".
4626 Alternatively, you can set it to a maximum upper
4627 address to use (U-Boot will still check that it
4628 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004629
wdenk2729af92004-05-03 20:45:30 +00004630 For instance, when you have a system with 16 MB
4631 RAM, and want to reserve 4 MB from use by Linux,
4632 you can do this by adding "mem=12M" to the value of
4633 the "bootargs" variable. However, now you must make
4634 sure that the initrd image is placed in the first
4635 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk2729af92004-05-03 20:45:30 +00004637 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004638
wdenk2729af92004-05-03 20:45:30 +00004639 If you set initrd_high to 0xFFFFFFFF, this is an
4640 indication to U-Boot that all addresses are legal
4641 for the Linux kernel, including addresses in flash
4642 memory. In this case U-Boot will NOT COPY the
4643 ramdisk at all. This may be useful to reduce the
4644 boot time on your system, but requires that this
4645 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004646
wdenk2729af92004-05-03 20:45:30 +00004647 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004648
wdenk2729af92004-05-03 20:45:30 +00004649 loadaddr - Default load address for commands like "bootp",
4650 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004651
wdenk2729af92004-05-03 20:45:30 +00004652 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk2729af92004-05-03 20:45:30 +00004654 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004655
wdenk2729af92004-05-03 20:45:30 +00004656 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004657
wdenk2729af92004-05-03 20:45:30 +00004658 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004659
wdenk2729af92004-05-03 20:45:30 +00004660 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004661
Mike Frysingere2a53452011-10-02 10:01:27 +00004662 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004663
Mike Frysingere2a53452011-10-02 10:01:27 +00004664 ethact - controls which interface is currently active.
4665 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004666
Heiko Schocher48690d82010-07-20 17:45:02 +02004667 => setenv ethact FEC
4668 => ping 192.168.0.1 # traffic sent on FEC
4669 => setenv ethact SCC
4670 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004671
Matthias Fuchse1692572008-01-17 07:45:05 +01004672 ethrotate - When set to "no" U-Boot does not go through all
4673 available network interfaces.
4674 It just stays at the currently selected interface.
4675
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004676 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004677 either succeed or fail without retrying.
4678 When set to "once" the network operation will
4679 fail when all the available network interfaces
4680 are tried once without success.
4681 Useful on scripts which control the retry operation
4682 themselves.
wdenkc6097192002-11-03 00:24:07 +00004683
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004684 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004685
Simon Glass8d51aac2013-07-16 20:10:00 -07004686 silent_linux - If set then linux will be told to boot silently, by
4687 changing the console to be empty. If "yes" it will be
4688 made silent. If "no" it will not be made silent. If
4689 unset, then it will be made silent if the U-Boot console
4690 is silent.
4691
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004692 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004693 UDP source port.
4694
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004695 tftpdstport - If this is set, the value is used for TFTP's UDP
4696 destination port instead of the Well Know Port 69.
4697
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004698 tftpblocksize - Block size to use for TFTP transfers; if not set,
4699 we use the TFTP server's default block size
4700
4701 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4702 seconds, minimum value is 1000 = 1 second). Defines
4703 when a packet is considered to be lost so it has to
4704 be retransmitted. The default is 5000 = 5 seconds.
4705 Lowering this value may make downloads succeed
4706 faster in networks with high packet loss rates or
4707 with unreliable TFTP servers.
4708
4709 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004710 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004711 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004712
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004713The following image location variables contain the location of images
4714used in booting. The "Image" column gives the role of the image and is
4715not an environment variable name. The other columns are environment
4716variable names. "File Name" gives the name of the file on a TFTP
4717server, "RAM Address" gives the location in RAM the image will be
4718loaded to, and "Flash Location" gives the image's address in NOR
4719flash or offset in NAND flash.
4720
4721*Note* - these variables don't have to be defined for all boards, some
4722boards currenlty use other variables for these purposes, and some
4723boards use these variables for other purposes.
4724
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004725Image File Name RAM Address Flash Location
4726----- --------- ----------- --------------
4727u-boot u-boot u-boot_addr_r u-boot_addr
4728Linux kernel bootfile kernel_addr_r kernel_addr
4729device tree blob fdtfile fdt_addr_r fdt_addr
4730ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004731
wdenk2729af92004-05-03 20:45:30 +00004732The following environment variables may be used and automatically
4733updated by the network boot commands ("bootp" and "rarpboot"),
4734depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004735
wdenk2729af92004-05-03 20:45:30 +00004736 bootfile - see above
4737 dnsip - IP address of your Domain Name Server
4738 dnsip2 - IP address of your secondary Domain Name Server
4739 gatewayip - IP address of the Gateway (Router) to use
4740 hostname - Target hostname
4741 ipaddr - see above
4742 netmask - Subnet Mask
4743 rootpath - Pathname of the root filesystem on the NFS server
4744 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004745
wdenka3d991b2004-04-15 21:48:45 +00004746
wdenk2729af92004-05-03 20:45:30 +00004747There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004748
wdenk2729af92004-05-03 20:45:30 +00004749 serial# - contains hardware identification information such
4750 as type string and/or serial number
4751 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004752
wdenk2729af92004-05-03 20:45:30 +00004753These variables can be set only once (usually during manufacturing of
4754the board). U-Boot refuses to delete or overwrite these variables
4755once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004756
4757
wdenk2729af92004-05-03 20:45:30 +00004758Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk2729af92004-05-03 20:45:30 +00004760 ver - Contains the U-Boot version string as printed
4761 with the "version" command. This variable is
4762 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004763
wdenkc6097192002-11-03 00:24:07 +00004764
wdenk2729af92004-05-03 20:45:30 +00004765Please note that changes to some configuration parameters may take
4766only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004767
stroesec1551ea2003-04-04 15:53:41 +00004768
Joe Hershberger170ab112012-12-11 22:16:24 -06004769Callback functions for environment variables:
4770---------------------------------------------
4771
4772For some environment variables, the behavior of u-boot needs to change
4773when their values are changed. This functionailty allows functions to
4774be associated with arbitrary variables. On creation, overwrite, or
4775deletion, the callback will provide the opportunity for some side
4776effect to happen or for the change to be rejected.
4777
4778The callbacks are named and associated with a function using the
4779U_BOOT_ENV_CALLBACK macro in your board or driver code.
4780
4781These callbacks are associated with variables in one of two ways. The
4782static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4783in the board configuration to a string that defines a list of
4784associations. The list must be in the following format:
4785
4786 entry = variable_name[:callback_name]
4787 list = entry[,list]
4788
4789If the callback name is not specified, then the callback is deleted.
4790Spaces are also allowed anywhere in the list.
4791
4792Callbacks can also be associated by defining the ".callbacks" variable
4793with the same list format above. Any association in ".callbacks" will
4794override any association in the static list. You can define
4795CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4796".callbacks" envirnoment variable in the default or embedded environment.
4797
4798
wdenk2729af92004-05-03 20:45:30 +00004799Command Line Parsing:
4800=====================
stroesec1551ea2003-04-04 15:53:41 +00004801
wdenk2729af92004-05-03 20:45:30 +00004802There are two different command line parsers available with U-Boot:
4803the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004804
wdenk2729af92004-05-03 20:45:30 +00004805Old, simple command line parser:
4806--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk2729af92004-05-03 20:45:30 +00004808- supports environment variables (through setenv / saveenv commands)
4809- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004810- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004811- special characters ('$', ';') can be escaped by prefixing with '\',
4812 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004813 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004814- You can also escape text by enclosing in single apostrophes, for example:
4815 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004816
wdenk2729af92004-05-03 20:45:30 +00004817Hush shell:
4818-----------
wdenkf07771c2003-05-28 08:06:31 +00004819
wdenk2729af92004-05-03 20:45:30 +00004820- similar to Bourne shell, with control structures like
4821 if...then...else...fi, for...do...done; while...do...done,
4822 until...do...done, ...
4823- supports environment ("global") variables (through setenv / saveenv
4824 commands) and local shell variables (through standard shell syntax
4825 "name=value"); only environment variables can be used with "run"
4826 command
wdenkf07771c2003-05-28 08:06:31 +00004827
wdenk2729af92004-05-03 20:45:30 +00004828General rules:
4829--------------
wdenkf07771c2003-05-28 08:06:31 +00004830
wdenk2729af92004-05-03 20:45:30 +00004831(1) If a command line (or an environment variable executed by a "run"
4832 command) contains several commands separated by semicolon, and
4833 one of these commands fails, then the remaining commands will be
4834 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004835
wdenk2729af92004-05-03 20:45:30 +00004836(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004837 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004838 command will cause "run" to terminate, i. e. the remaining
4839 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004840
wdenk2729af92004-05-03 20:45:30 +00004841Note for Redundant Ethernet Interfaces:
4842=======================================
wdenkf07771c2003-05-28 08:06:31 +00004843
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004844Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004845such configurations and is capable of automatic selection of a
4846"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004847
wdenk2729af92004-05-03 20:45:30 +00004848Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4849MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4850"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004851
wdenk2729af92004-05-03 20:45:30 +00004852If the network interface stores some valid MAC address (for instance
4853in SROM), this is used as default address if there is NO correspon-
4854ding setting in the environment; if the corresponding environment
4855variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004856
wdenk2729af92004-05-03 20:45:30 +00004857o If the SROM has a valid MAC address, and there is no address in the
4858 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004859
wdenk2729af92004-05-03 20:45:30 +00004860o If there is no valid address in the SROM, and a definition in the
4861 environment exists, then the value from the environment variable is
4862 used.
wdenkc6097192002-11-03 00:24:07 +00004863
wdenk2729af92004-05-03 20:45:30 +00004864o If both the SROM and the environment contain a MAC address, and
4865 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004866
wdenk2729af92004-05-03 20:45:30 +00004867o If both the SROM and the environment contain a MAC address, and the
4868 addresses differ, the value from the environment is used and a
4869 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004870
wdenk2729af92004-05-03 20:45:30 +00004871o If neither SROM nor the environment contain a MAC address, an error
4872 is raised.
wdenkc6097192002-11-03 00:24:07 +00004873
Ben Warrenecee9322010-04-26 11:11:46 -07004874If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004875will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004876may be skipped by setting the appropriate 'ethmacskip' environment variable.
4877The naming convention is as follows:
4878"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004879
wdenk2729af92004-05-03 20:45:30 +00004880Image Formats:
4881==============
wdenkc6097192002-11-03 00:24:07 +00004882
Marian Balakowicz3310c542008-03-12 12:13:13 +01004883U-Boot is capable of booting (and performing other auxiliary operations on)
4884images in two formats:
4885
4886New uImage format (FIT)
4887-----------------------
4888
4889Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4890to Flattened Device Tree). It allows the use of images with multiple
4891components (several kernels, ramdisks, etc.), with contents protected by
4892SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4893
4894
4895Old uImage format
4896-----------------
4897
4898Old image format is based on binary files which can be basically anything,
4899preceded by a special header; see the definitions in include/image.h for
4900details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004901
wdenk2729af92004-05-03 20:45:30 +00004902* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4903 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004904 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4905 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4906 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004907* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004908 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4909 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004910* Compression Type (uncompressed, gzip, bzip2)
4911* Load Address
4912* Entry Point
4913* Image Name
4914* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004915
wdenk2729af92004-05-03 20:45:30 +00004916The header is marked by a special Magic Number, and both the header
4917and the data portions of the image are secured against corruption by
4918CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004919
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk2729af92004-05-03 20:45:30 +00004921Linux Support:
4922==============
wdenkc6097192002-11-03 00:24:07 +00004923
wdenk2729af92004-05-03 20:45:30 +00004924Although U-Boot should support any OS or standalone application
4925easily, the main focus has always been on Linux during the design of
4926U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004927
wdenk2729af92004-05-03 20:45:30 +00004928U-Boot includes many features that so far have been part of some
4929special "boot loader" code within the Linux kernel. Also, any
4930"initrd" images to be used are no longer part of one big Linux image;
4931instead, kernel and "initrd" are separate images. This implementation
4932serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk2729af92004-05-03 20:45:30 +00004934- the same features can be used for other OS or standalone
4935 applications (for instance: using compressed images to reduce the
4936 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004937
wdenk2729af92004-05-03 20:45:30 +00004938- it becomes much easier to port new Linux kernel versions because
4939 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004940
wdenk2729af92004-05-03 20:45:30 +00004941- the same Linux kernel image can now be used with different "initrd"
4942 images; of course this also means that different kernel images can
4943 be run with the same "initrd". This makes testing easier (you don't
4944 have to build a new "zImage.initrd" Linux image when you just
4945 change a file in your "initrd"). Also, a field-upgrade of the
4946 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004947
wdenkc6097192002-11-03 00:24:07 +00004948
wdenk2729af92004-05-03 20:45:30 +00004949Linux HOWTO:
4950============
wdenkc6097192002-11-03 00:24:07 +00004951
wdenk2729af92004-05-03 20:45:30 +00004952Porting Linux to U-Boot based systems:
4953---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004954
wdenk2729af92004-05-03 20:45:30 +00004955U-Boot cannot save you from doing all the necessary modifications to
4956configure the Linux device drivers for use with your target hardware
4957(no, we don't intend to provide a full virtual machine interface to
4958Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004959
Stefan Roesea47a12b2010-04-15 16:07:28 +02004960But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004961
wdenk2729af92004-05-03 20:45:30 +00004962Just make sure your machine specific header file (for instance
4963include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004964Information structure as we define in include/asm-<arch>/u-boot.h,
4965and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004966as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004967
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk2729af92004-05-03 20:45:30 +00004969Configuring the Linux kernel:
4970-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004971
wdenk2729af92004-05-03 20:45:30 +00004972No specific requirements for U-Boot. Make sure you have some root
4973device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004974
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk2729af92004-05-03 20:45:30 +00004976Building a Linux Image:
4977-----------------------
wdenkc6097192002-11-03 00:24:07 +00004978
wdenk2729af92004-05-03 20:45:30 +00004979With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4980not used. If you use recent kernel source, a new build target
4981"uImage" will exist which automatically builds an image usable by
4982U-Boot. Most older kernels also have support for a "pImage" target,
4983which was introduced for our predecessor project PPCBoot and uses a
4984100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004985
wdenk2729af92004-05-03 20:45:30 +00004986Example:
wdenkc6097192002-11-03 00:24:07 +00004987
wdenk2729af92004-05-03 20:45:30 +00004988 make TQM850L_config
4989 make oldconfig
4990 make dep
4991 make uImage
wdenkc6097192002-11-03 00:24:07 +00004992
wdenk2729af92004-05-03 20:45:30 +00004993The "uImage" build target uses a special tool (in 'tools/mkimage') to
4994encapsulate a compressed Linux kernel image with header information,
4995CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk2729af92004-05-03 20:45:30 +00004997* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk2729af92004-05-03 20:45:30 +00004999* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk2729af92004-05-03 20:45:30 +00005001 ${CROSS_COMPILE}-objcopy -O binary \
5002 -R .note -R .comment \
5003 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005004
wdenk2729af92004-05-03 20:45:30 +00005005* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005006
wdenk2729af92004-05-03 20:45:30 +00005007 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005008
wdenk2729af92004-05-03 20:45:30 +00005009* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011 mkimage -A ppc -O linux -T kernel -C gzip \
5012 -a 0 -e 0 -n "Linux Kernel Image" \
5013 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005014
wdenk24ee89b2002-11-03 17:56:27 +00005015
wdenk2729af92004-05-03 20:45:30 +00005016The "mkimage" tool can also be used to create ramdisk images for use
5017with U-Boot, either separated from the Linux kernel image, or
5018combined into one file. "mkimage" encapsulates the images with a 64
5019byte header containing information about target architecture,
5020operating system, image type, compression method, entry points, time
5021stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005022
wdenk2729af92004-05-03 20:45:30 +00005023"mkimage" can be called in two ways: to verify existing images and
5024print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005025
wdenk2729af92004-05-03 20:45:30 +00005026In the first form (with "-l" option) mkimage lists the information
5027contained in the header of an existing U-Boot image; this includes
5028checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005029
wdenk2729af92004-05-03 20:45:30 +00005030 tools/mkimage -l image
5031 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033The second form (with "-d" option) is used to build a U-Boot image
5034from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005035
wdenk2729af92004-05-03 20:45:30 +00005036 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5037 -n name -d data_file image
5038 -A ==> set architecture to 'arch'
5039 -O ==> set operating system to 'os'
5040 -T ==> set image type to 'type'
5041 -C ==> set compression type 'comp'
5042 -a ==> set load address to 'addr' (hex)
5043 -e ==> set entry point to 'ep' (hex)
5044 -n ==> set image name to 'name'
5045 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005046
wdenk69459792004-05-29 16:53:29 +00005047Right now, all Linux kernels for PowerPC systems use the same load
5048address (0x00000000), but the entry point address depends on the
5049kernel version:
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk2729af92004-05-03 20:45:30 +00005051- 2.2.x kernels have the entry point at 0x0000000C,
5052- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk2729af92004-05-03 20:45:30 +00005054So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk2729af92004-05-03 20:45:30 +00005056 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5057 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005058 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005059 > examples/uImage.TQM850L
5060 Image Name: 2.4.4 kernel for TQM850L
5061 Created: Wed Jul 19 02:34:59 2000
5062 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5063 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5064 Load Address: 0x00000000
5065 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005066
wdenk2729af92004-05-03 20:45:30 +00005067To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk2729af92004-05-03 20:45:30 +00005069 -> tools/mkimage -l examples/uImage.TQM850L
5070 Image Name: 2.4.4 kernel for TQM850L
5071 Created: Wed Jul 19 02:34:59 2000
5072 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5073 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5074 Load Address: 0x00000000
5075 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk2729af92004-05-03 20:45:30 +00005077NOTE: for embedded systems where boot time is critical you can trade
5078speed for memory and install an UNCOMPRESSED image instead: this
5079needs more space in Flash, but boots much faster since it does not
5080need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005081
Stefan Roesea47a12b2010-04-15 16:07:28 +02005082 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005083 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5084 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005085 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005086 > examples/uImage.TQM850L-uncompressed
5087 Image Name: 2.4.4 kernel for TQM850L
5088 Created: Wed Jul 19 02:34:59 2000
5089 Image Type: PowerPC Linux Kernel Image (uncompressed)
5090 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5091 Load Address: 0x00000000
5092 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005093
wdenkc6097192002-11-03 00:24:07 +00005094
wdenk2729af92004-05-03 20:45:30 +00005095Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5096when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005097
wdenk2729af92004-05-03 20:45:30 +00005098 -> tools/mkimage -n 'Simple Ramdisk Image' \
5099 > -A ppc -O linux -T ramdisk -C gzip \
5100 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5101 Image Name: Simple Ramdisk Image
5102 Created: Wed Jan 12 14:01:50 2000
5103 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5104 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5105 Load Address: 0x00000000
5106 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005107
wdenkdb01a2e2004-04-15 23:14:49 +00005108
wdenk2729af92004-05-03 20:45:30 +00005109Installing a Linux Image:
5110-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005111
wdenk2729af92004-05-03 20:45:30 +00005112To downloading a U-Boot image over the serial (console) interface,
5113you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005114
wdenk2729af92004-05-03 20:45:30 +00005115 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005116
wdenk2729af92004-05-03 20:45:30 +00005117The 'objcopy' does not understand the information in the U-Boot
5118image header, so the resulting S-Record file will be relative to
5119address 0x00000000. To load it to a given address, you need to
5120specify the target address as 'offset' parameter with the 'loads'
5121command.
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk2729af92004-05-03 20:45:30 +00005123Example: install the image to address 0x40100000 (which on the
5124TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005125
wdenk2729af92004-05-03 20:45:30 +00005126 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk2729af92004-05-03 20:45:30 +00005128 .......... done
5129 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk2729af92004-05-03 20:45:30 +00005131 => loads 40100000
5132 ## Ready for S-Record download ...
5133 ~>examples/image.srec
5134 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5135 ...
5136 15989 15990 15991 15992
5137 [file transfer complete]
5138 [connected]
5139 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005140
5141
wdenk2729af92004-05-03 20:45:30 +00005142You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005143this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005144corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005145
wdenk2729af92004-05-03 20:45:30 +00005146 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005147
wdenk2729af92004-05-03 20:45:30 +00005148 ## Checking Image at 40100000 ...
5149 Image Name: 2.2.13 for initrd on TQM850L
5150 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5151 Data Size: 335725 Bytes = 327 kB = 0 MB
5152 Load Address: 00000000
5153 Entry Point: 0000000c
5154 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005155
5156
wdenk2729af92004-05-03 20:45:30 +00005157Boot Linux:
5158-----------
wdenkc6097192002-11-03 00:24:07 +00005159
wdenk2729af92004-05-03 20:45:30 +00005160The "bootm" command is used to boot an application that is stored in
5161memory (RAM or Flash). In case of a Linux kernel image, the contents
5162of the "bootargs" environment variable is passed to the kernel as
5163parameters. You can check and modify this variable using the
5164"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005165
5166
wdenk2729af92004-05-03 20:45:30 +00005167 => printenv bootargs
5168 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk2729af92004-05-03 20:45:30 +00005170 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk2729af92004-05-03 20:45:30 +00005172 => printenv bootargs
5173 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175 => bootm 40020000
5176 ## Booting Linux kernel at 40020000 ...
5177 Image Name: 2.2.13 for NFS on TQM850L
5178 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5179 Data Size: 381681 Bytes = 372 kB = 0 MB
5180 Load Address: 00000000
5181 Entry Point: 0000000c
5182 Verifying Checksum ... OK
5183 Uncompressing Kernel Image ... OK
5184 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
5185 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5186 time_init: decrementer frequency = 187500000/60
5187 Calibrating delay loop... 49.77 BogoMIPS
5188 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5189 ...
wdenkc6097192002-11-03 00:24:07 +00005190
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005191If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005192the memory addresses of both the kernel and the initrd image (PPBCOOT
5193format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk2729af92004-05-03 20:45:30 +00005195 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk2729af92004-05-03 20:45:30 +00005197 ## Checking Image at 40100000 ...
5198 Image Name: 2.2.13 for initrd on TQM850L
5199 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5200 Data Size: 335725 Bytes = 327 kB = 0 MB
5201 Load Address: 00000000
5202 Entry Point: 0000000c
5203 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk2729af92004-05-03 20:45:30 +00005205 ## Checking Image at 40200000 ...
5206 Image Name: Simple Ramdisk Image
5207 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5208 Data Size: 566530 Bytes = 553 kB = 0 MB
5209 Load Address: 00000000
5210 Entry Point: 00000000
5211 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk2729af92004-05-03 20:45:30 +00005213 => bootm 40100000 40200000
5214 ## Booting Linux kernel at 40100000 ...
5215 Image Name: 2.2.13 for initrd on TQM850L
5216 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5217 Data Size: 335725 Bytes = 327 kB = 0 MB
5218 Load Address: 00000000
5219 Entry Point: 0000000c
5220 Verifying Checksum ... OK
5221 Uncompressing Kernel Image ... OK
5222 ## Loading RAMDisk Image at 40200000 ...
5223 Image Name: Simple Ramdisk Image
5224 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5225 Data Size: 566530 Bytes = 553 kB = 0 MB
5226 Load Address: 00000000
5227 Entry Point: 00000000
5228 Verifying Checksum ... OK
5229 Loading Ramdisk ... OK
5230 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
5231 Boot arguments: root=/dev/ram
5232 time_init: decrementer frequency = 187500000/60
5233 Calibrating delay loop... 49.77 BogoMIPS
5234 ...
5235 RAMDISK: Compressed image found at block 0
5236 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk2729af92004-05-03 20:45:30 +00005238 bash#
wdenkc6097192002-11-03 00:24:07 +00005239
Matthew McClintock02677682006-06-28 10:41:37 -05005240Boot Linux and pass a flat device tree:
5241-----------
5242
5243First, U-Boot must be compiled with the appropriate defines. See the section
5244titled "Linux Kernel Interface" above for a more in depth explanation. The
5245following is an example of how to start a kernel and pass an updated
5246flat device tree:
5247
5248=> print oftaddr
5249oftaddr=0x300000
5250=> print oft
5251oft=oftrees/mpc8540ads.dtb
5252=> tftp $oftaddr $oft
5253Speed: 1000, full duplex
5254Using TSEC0 device
5255TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5256Filename 'oftrees/mpc8540ads.dtb'.
5257Load address: 0x300000
5258Loading: #
5259done
5260Bytes transferred = 4106 (100a hex)
5261=> tftp $loadaddr $bootfile
5262Speed: 1000, full duplex
5263Using TSEC0 device
5264TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5265Filename 'uImage'.
5266Load address: 0x200000
5267Loading:############
5268done
5269Bytes transferred = 1029407 (fb51f hex)
5270=> print loadaddr
5271loadaddr=200000
5272=> print oftaddr
5273oftaddr=0x300000
5274=> bootm $loadaddr - $oftaddr
5275## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005276 Image Name: Linux-2.6.17-dirty
5277 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5278 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005279 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005280 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005281 Verifying Checksum ... OK
5282 Uncompressing Kernel Image ... OK
5283Booting using flat device tree at 0x300000
5284Using MPC85xx ADS machine description
5285Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5286[snip]
5287
5288
wdenk2729af92004-05-03 20:45:30 +00005289More About U-Boot Image Types:
5290------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005291
wdenk2729af92004-05-03 20:45:30 +00005292U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005293
wdenk2729af92004-05-03 20:45:30 +00005294 "Standalone Programs" are directly runnable in the environment
5295 provided by U-Boot; it is expected that (if they behave
5296 well) you can continue to work in U-Boot after return from
5297 the Standalone Program.
5298 "OS Kernel Images" are usually images of some Embedded OS which
5299 will take over control completely. Usually these programs
5300 will install their own set of exception handlers, device
5301 drivers, set up the MMU, etc. - this means, that you cannot
5302 expect to re-enter U-Boot except by resetting the CPU.
5303 "RAMDisk Images" are more or less just data blocks, and their
5304 parameters (address, size) are passed to an OS kernel that is
5305 being started.
5306 "Multi-File Images" contain several images, typically an OS
5307 (Linux) kernel image and one or more data images like
5308 RAMDisks. This construct is useful for instance when you want
5309 to boot over the network using BOOTP etc., where the boot
5310 server provides just a single image file, but you want to get
5311 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005312
wdenk2729af92004-05-03 20:45:30 +00005313 "Multi-File Images" start with a list of image sizes, each
5314 image size (in bytes) specified by an "uint32_t" in network
5315 byte order. This list is terminated by an "(uint32_t)0".
5316 Immediately after the terminating 0 follow the images, one by
5317 one, all aligned on "uint32_t" boundaries (size rounded up to
5318 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005319
wdenk2729af92004-05-03 20:45:30 +00005320 "Firmware Images" are binary images containing firmware (like
5321 U-Boot or FPGA images) which usually will be programmed to
5322 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005323
wdenk2729af92004-05-03 20:45:30 +00005324 "Script files" are command sequences that will be executed by
5325 U-Boot's command interpreter; this feature is especially
5326 useful when you configure U-Boot to use a real shell (hush)
5327 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005328
Marek Vasut44f074c2012-03-14 21:52:45 +00005329Booting the Linux zImage:
5330-------------------------
5331
5332On some platforms, it's possible to boot Linux zImage. This is done
5333using the "bootz" command. The syntax of "bootz" command is the same
5334as the syntax of "bootm" command.
5335
Tom Rini8ac28562013-05-16 11:40:11 -04005336Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005337kernel with raw initrd images. The syntax is slightly different, the
5338address of the initrd must be augmented by it's size, in the following
5339format: "<initrd addres>:<initrd size>".
5340
wdenkc6097192002-11-03 00:24:07 +00005341
wdenk2729af92004-05-03 20:45:30 +00005342Standalone HOWTO:
5343=================
wdenkc6097192002-11-03 00:24:07 +00005344
wdenk2729af92004-05-03 20:45:30 +00005345One of the features of U-Boot is that you can dynamically load and
5346run "standalone" applications, which can use some resources of
5347U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk2729af92004-05-03 20:45:30 +00005349Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk2729af92004-05-03 20:45:30 +00005351"Hello World" Demo:
5352-------------------
wdenkc6097192002-11-03 00:24:07 +00005353
wdenk2729af92004-05-03 20:45:30 +00005354'examples/hello_world.c' contains a small "Hello World" Demo
5355application; it is automatically compiled when you build U-Boot.
5356It's configured to run at address 0x00040004, so you can play with it
5357like that:
wdenkc6097192002-11-03 00:24:07 +00005358
wdenk2729af92004-05-03 20:45:30 +00005359 => loads
5360 ## Ready for S-Record download ...
5361 ~>examples/hello_world.srec
5362 1 2 3 4 5 6 7 8 9 10 11 ...
5363 [file transfer complete]
5364 [connected]
5365 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005366
wdenk2729af92004-05-03 20:45:30 +00005367 => go 40004 Hello World! This is a test.
5368 ## Starting application at 0x00040004 ...
5369 Hello World
5370 argc = 7
5371 argv[0] = "40004"
5372 argv[1] = "Hello"
5373 argv[2] = "World!"
5374 argv[3] = "This"
5375 argv[4] = "is"
5376 argv[5] = "a"
5377 argv[6] = "test."
5378 argv[7] = "<NULL>"
5379 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005380
wdenk2729af92004-05-03 20:45:30 +00005381 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005382
wdenk2729af92004-05-03 20:45:30 +00005383Another example, which demonstrates how to register a CPM interrupt
5384handler with the U-Boot code, can be found in 'examples/timer.c'.
5385Here, a CPM timer is set up to generate an interrupt every second.
5386The interrupt service routine is trivial, just printing a '.'
5387character, but this is just a demo program. The application can be
5388controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005389
wdenk2729af92004-05-03 20:45:30 +00005390 ? - print current values og the CPM Timer registers
5391 b - enable interrupts and start timer
5392 e - stop timer and disable interrupts
5393 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005394
wdenk2729af92004-05-03 20:45:30 +00005395 => loads
5396 ## Ready for S-Record download ...
5397 ~>examples/timer.srec
5398 1 2 3 4 5 6 7 8 9 10 11 ...
5399 [file transfer complete]
5400 [connected]
5401 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005402
wdenk2729af92004-05-03 20:45:30 +00005403 => go 40004
5404 ## Starting application at 0x00040004 ...
5405 TIMERS=0xfff00980
5406 Using timer 1
5407 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk2729af92004-05-03 20:45:30 +00005409Hit 'b':
5410 [q, b, e, ?] Set interval 1000000 us
5411 Enabling timer
5412Hit '?':
5413 [q, b, e, ?] ........
5414 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5415Hit '?':
5416 [q, b, e, ?] .
5417 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5418Hit '?':
5419 [q, b, e, ?] .
5420 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5421Hit '?':
5422 [q, b, e, ?] .
5423 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5424Hit 'e':
5425 [q, b, e, ?] ...Stopping timer
5426Hit 'q':
5427 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005428
5429
wdenk2729af92004-05-03 20:45:30 +00005430Minicom warning:
5431================
wdenk85ec0bc2003-03-31 16:34:49 +00005432
wdenk2729af92004-05-03 20:45:30 +00005433Over time, many people have reported problems when trying to use the
5434"minicom" terminal emulation program for serial download. I (wd)
5435consider minicom to be broken, and recommend not to use it. Under
5436Unix, I recommend to use C-Kermit for general purpose use (and
5437especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005438use "cu" for S-Record download ("loads" command). See
5439http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5440for help with kermit.
5441
wdenk85ec0bc2003-03-31 16:34:49 +00005442
wdenk2729af92004-05-03 20:45:30 +00005443Nevertheless, if you absolutely want to use it try adding this
5444configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005445
wdenk2729af92004-05-03 20:45:30 +00005446 Name Program Name U/D FullScr IO-Red. Multi
5447 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5448 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005449
5450
wdenk2729af92004-05-03 20:45:30 +00005451NetBSD Notes:
5452=============
wdenkc6097192002-11-03 00:24:07 +00005453
wdenk2729af92004-05-03 20:45:30 +00005454Starting at version 0.9.2, U-Boot supports NetBSD both as host
5455(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005456
wdenk2729af92004-05-03 20:45:30 +00005457Building requires a cross environment; it is known to work on
5458NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5459need gmake since the Makefiles are not compatible with BSD make).
5460Note that the cross-powerpc package does not install include files;
5461attempting to build U-Boot will fail because <machine/ansi.h> is
5462missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005463
wdenk2729af92004-05-03 20:45:30 +00005464 # cd /usr/pkg/cross/powerpc-netbsd/include
5465 # mkdir powerpc
5466 # ln -s powerpc machine
5467 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5468 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005469
wdenk2729af92004-05-03 20:45:30 +00005470Native builds *don't* work due to incompatibilities between native
5471and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005472
wdenk2729af92004-05-03 20:45:30 +00005473Booting assumes that (the first part of) the image booted is a
5474stage-2 loader which in turn loads and then invokes the kernel
5475proper. Loader sources will eventually appear in the NetBSD source
5476tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005477meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005478
5479
wdenk2729af92004-05-03 20:45:30 +00005480Implementation Internals:
5481=========================
wdenkc6097192002-11-03 00:24:07 +00005482
wdenk2729af92004-05-03 20:45:30 +00005483The following is not intended to be a complete description of every
5484implementation detail. However, it should help to understand the
5485inner workings of U-Boot and make it easier to port it to custom
5486hardware.
wdenkc6097192002-11-03 00:24:07 +00005487
5488
wdenk2729af92004-05-03 20:45:30 +00005489Initial Stack, Global Data:
5490---------------------------
wdenkc6097192002-11-03 00:24:07 +00005491
wdenk2729af92004-05-03 20:45:30 +00005492The implementation of U-Boot is complicated by the fact that U-Boot
5493starts running out of ROM (flash memory), usually without access to
5494system RAM (because the memory controller is not initialized yet).
5495This means that we don't have writable Data or BSS segments, and BSS
5496is not initialized as zero. To be able to get a C environment working
5497at all, we have to allocate at least a minimal stack. Implementation
5498options for this are defined and restricted by the CPU used: Some CPU
5499models provide on-chip memory (like the IMMR area on MPC8xx and
5500MPC826x processors), on others (parts of) the data cache can be
5501locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005502
Wolfgang Denk218ca722008-03-26 10:40:12 +01005503 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005504 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005505
wdenk2729af92004-05-03 20:45:30 +00005506 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5507 From: "Chris Hallinan" <clh@net1plus.com>
5508 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5509 ...
wdenk43d96162003-03-06 00:02:04 +00005510
wdenk2729af92004-05-03 20:45:30 +00005511 Correct me if I'm wrong, folks, but the way I understand it
5512 is this: Using DCACHE as initial RAM for Stack, etc, does not
5513 require any physical RAM backing up the cache. The cleverness
5514 is that the cache is being used as a temporary supply of
5515 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005516 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005517 can see how this works by studying the cache architecture and
5518 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005519
wdenk2729af92004-05-03 20:45:30 +00005520 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5521 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005522 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005523 option should work for you. Using CS 4 should be fine if your
5524 board designers haven't used it for something that would
5525 cause you grief during the initial boot! It is frequently not
5526 used.
wdenk43d96162003-03-06 00:02:04 +00005527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005528 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005529 with your processor/board/system design. The default value
5530 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005531 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005532 than your SDRAM module. If you have a 64MB SDRAM module, set
5533 it above 400_0000. Just make sure your board has no resources
5534 that are supposed to respond to that address! That code in
5535 start.S has been around a while and should work as is when
5536 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005537
wdenk2729af92004-05-03 20:45:30 +00005538 -Chris Hallinan
5539 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005540
wdenk2729af92004-05-03 20:45:30 +00005541It is essential to remember this, since it has some impact on the C
5542code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005543
wdenk2729af92004-05-03 20:45:30 +00005544* Initialized global data (data segment) is read-only. Do not attempt
5545 to write it.
wdenkc6097192002-11-03 00:24:07 +00005546
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005547* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005548 as zero data - BSS segment) at all - this is undefined, initiali-
5549 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005550
wdenk2729af92004-05-03 20:45:30 +00005551* Stack space is very limited. Avoid big data buffers or things like
5552 that.
wdenkc6097192002-11-03 00:24:07 +00005553
wdenk2729af92004-05-03 20:45:30 +00005554Having only the stack as writable memory limits means we cannot use
5555normal global data to share information beween the code. But it
5556turned out that the implementation of U-Boot can be greatly
5557simplified by making a global data structure (gd_t) available to all
5558functions. We could pass a pointer to this data as argument to _all_
5559functions, but this would bloat the code. Instead we use a feature of
5560the GCC compiler (Global Register Variables) to share the data: we
5561place a pointer (gd) to the global data into a register which we
5562reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005563
wdenk2729af92004-05-03 20:45:30 +00005564When choosing a register for such a purpose we are restricted by the
5565relevant (E)ABI specifications for the current architecture, and by
5566GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005567
wdenk2729af92004-05-03 20:45:30 +00005568For PowerPC, the following registers have specific use:
5569 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005570 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005571 R3-R4: parameter passing and return values
5572 R5-R10: parameter passing
5573 R13: small data area pointer
5574 R30: GOT pointer
5575 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005576
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005577 (U-Boot also uses R12 as internal GOT pointer. r12
5578 is a volatile register so r12 needs to be reset when
5579 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005580
Wolfgang Denke7670f62008-02-14 22:43:22 +01005581 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk2729af92004-05-03 20:45:30 +00005583 Note: on PPC, we could use a static initializer (since the
5584 address of the global data structure is known at compile time),
5585 but it turned out that reserving a register results in somewhat
5586 smaller code - although the code savings are not that big (on
5587 average for all boards 752 bytes for the whole U-Boot image,
5588 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005589
Robin Getzc4db3352009-08-17 15:23:02 +00005590On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005591 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5592
Robin Getzc4db3352009-08-17 15:23:02 +00005593 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005594
wdenk2729af92004-05-03 20:45:30 +00005595On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk2729af92004-05-03 20:45:30 +00005597 R0: function argument word/integer result
5598 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005599 R9: platform specific
5600 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00005601 R11: argument (frame) pointer
5602 R12: temporary workspace
5603 R13: stack pointer
5604 R14: link register
5605 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005606
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02005607 ==> U-Boot will use R9 to hold a pointer to the global data
5608
5609 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005610
Thomas Chou0df01fd2010-05-21 11:08:03 +08005611On Nios II, the ABI is documented here:
5612 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5613
5614 ==> U-Boot will use gp to hold a pointer to the global data
5615
5616 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5617 to access small data sections, so gp is free.
5618
Macpaul Linafc1ce82011-10-19 20:41:11 +00005619On NDS32, the following registers are used:
5620
5621 R0-R1: argument/return
5622 R2-R5: argument
5623 R15: temporary register for assembler
5624 R16: trampoline register
5625 R28: frame pointer (FP)
5626 R29: global pointer (GP)
5627 R30: link register (LP)
5628 R31: stack pointer (SP)
5629 PC: program counter (PC)
5630
5631 ==> U-Boot will use R10 to hold a pointer to the global data
5632
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005633NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5634or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk2729af92004-05-03 20:45:30 +00005636Memory Management:
5637------------------
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk2729af92004-05-03 20:45:30 +00005639U-Boot runs in system state and uses physical addresses, i.e. the
5640MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk2729af92004-05-03 20:45:30 +00005642The available memory is mapped to fixed addresses using the memory
5643controller. In this process, a contiguous block is formed for each
5644memory type (Flash, SDRAM, SRAM), even when it consists of several
5645physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005646
wdenk2729af92004-05-03 20:45:30 +00005647U-Boot is installed in the first 128 kB of the first Flash bank (on
5648TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5649booting and sizing and initializing DRAM, the code relocates itself
5650to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005651memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005652configuration setting]. Below that, a structure with global Board
5653Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005654
wdenk2729af92004-05-03 20:45:30 +00005655Additionally, some exception handler code is copied to the low 8 kB
5656of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk2729af92004-05-03 20:45:30 +00005658So a typical memory configuration with 16 MB of DRAM could look like
5659this:
wdenkc6097192002-11-03 00:24:07 +00005660
wdenk2729af92004-05-03 20:45:30 +00005661 0x0000 0000 Exception Vector code
5662 :
5663 0x0000 1FFF
5664 0x0000 2000 Free for Application Use
5665 :
5666 :
wdenkc6097192002-11-03 00:24:07 +00005667
wdenk2729af92004-05-03 20:45:30 +00005668 :
5669 :
5670 0x00FB FF20 Monitor Stack (Growing downward)
5671 0x00FB FFAC Board Info Data and permanent copy of global data
5672 0x00FC 0000 Malloc Arena
5673 :
5674 0x00FD FFFF
5675 0x00FE 0000 RAM Copy of Monitor Code
5676 ... eventually: LCD or video framebuffer
5677 ... eventually: pRAM (Protected RAM - unchanged by reset)
5678 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005679
5680
wdenk2729af92004-05-03 20:45:30 +00005681System Initialization:
5682----------------------
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk2729af92004-05-03 20:45:30 +00005684In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005685(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005686configuration for CS0# this is a mirror of the onboard Flash memory.
5687To be able to re-map memory U-Boot then jumps to its link address.
5688To be able to implement the initialization code in C, a (small!)
5689initial stack is set up in the internal Dual Ported RAM (in case CPUs
5690which provide such a feature like MPC8xx or MPC8260), or in a locked
5691part of the data cache. After that, U-Boot initializes the CPU core,
5692the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk2729af92004-05-03 20:45:30 +00005694Next, all (potentially) available memory banks are mapped using a
5695preliminary mapping. For example, we put them on 512 MB boundaries
5696(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5697on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5698programmed for SDRAM access. Using the temporary configuration, a
5699simple memory test is run that determines the size of the SDRAM
5700banks.
wdenkc6097192002-11-03 00:24:07 +00005701
wdenk2729af92004-05-03 20:45:30 +00005702When there is more than one SDRAM bank, and the banks are of
5703different size, the largest is mapped first. For equal size, the first
5704bank (CS2#) is mapped first. The first mapping is always for address
57050x00000000, with any additional banks following immediately to create
5706contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005707
wdenk2729af92004-05-03 20:45:30 +00005708Then, the monitor installs itself at the upper end of the SDRAM area
5709and allocates memory for use by malloc() and for the global Board
5710Info data; also, the exception vector code is copied to the low RAM
5711pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005712
wdenk2729af92004-05-03 20:45:30 +00005713Only after this relocation will you have a "normal" C environment;
5714until that you are restricted in several ways, mostly because you are
5715running from ROM, and because the code will have to be relocated to a
5716new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005717
5718
wdenk2729af92004-05-03 20:45:30 +00005719U-Boot Porting Guide:
5720----------------------
wdenkc6097192002-11-03 00:24:07 +00005721
wdenk2729af92004-05-03 20:45:30 +00005722[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5723list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005724
5725
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005726int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005727{
5728 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005729
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005730 signal(SIGALRM, no_more_time);
5731 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk2729af92004-05-03 20:45:30 +00005733 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005734 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005735 return 0;
5736 }
5737
wdenk2729af92004-05-03 20:45:30 +00005738 Download latest U-Boot source;
5739
Wolfgang Denk06682362008-12-30 22:56:11 +01005740 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005741
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005742 if (clueless)
5743 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk2729af92004-05-03 20:45:30 +00005745 while (learning) {
5746 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005747 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5748 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005749 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005750 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005751 }
wdenkc6097192002-11-03 00:24:07 +00005752
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005753 if (available_money > toLocalCurrency ($2500))
5754 Buy a BDI3000;
5755 else
wdenk2729af92004-05-03 20:45:30 +00005756 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005757
5758 if (a similar board exists) { /* hopefully... */
5759 cp -a board/<similar> board/<myboard>
5760 cp include/configs/<similar>.h include/configs/<myboard>.h
5761 } else {
5762 Create your own board support subdirectory;
5763 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005764 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005765 Edit new board/<myboard> files
5766 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005767
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005768 while (!accepted) {
5769 while (!running) {
5770 do {
5771 Add / modify source code;
5772 } until (compiles);
5773 Debug;
5774 if (clueless)
5775 email("Hi, I am having problems...");
5776 }
5777 Send patch file to the U-Boot email list;
5778 if (reasonable critiques)
5779 Incorporate improvements from email list code review;
5780 else
5781 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005782 }
wdenkc6097192002-11-03 00:24:07 +00005783
wdenk2729af92004-05-03 20:45:30 +00005784 return 0;
5785}
5786
5787void no_more_time (int sig)
5788{
5789 hire_a_guru();
5790}
wdenkc6097192002-11-03 00:24:07 +00005791
5792
wdenk2729af92004-05-03 20:45:30 +00005793Coding Standards:
5794-----------------
wdenkc6097192002-11-03 00:24:07 +00005795
wdenk2729af92004-05-03 20:45:30 +00005796All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005797coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005798"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005799
Detlev Zundel2c051652006-09-01 15:39:02 +02005800Source files originating from a different project (for example the
5801MTD subsystem) are generally exempt from these guidelines and are not
5802reformated to ease subsequent migration to newer versions of those
5803sources.
5804
5805Please note that U-Boot is implemented in C (and to some small parts in
5806Assembler); no C++ is used, so please do not use C++ style comments (//)
5807in your code.
wdenk2729af92004-05-03 20:45:30 +00005808
5809Please also stick to the following formatting rules:
5810- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005811- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005812- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005813- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005814- do not add trailing empty lines to source files
5815
5816Submissions which do not conform to the standards may be returned
5817with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005818
5819
wdenk2729af92004-05-03 20:45:30 +00005820Submitting Patches:
5821-------------------
wdenkc6097192002-11-03 00:24:07 +00005822
wdenk2729af92004-05-03 20:45:30 +00005823Since the number of patches for U-Boot is growing, we need to
5824establish some rules. Submissions which do not conform to these rules
5825may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005826
Magnus Lilja0d28f342008-08-06 19:32:33 +02005827Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005828
Wolfgang Denk06682362008-12-30 22:56:11 +01005829Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5830see http://lists.denx.de/mailman/listinfo/u-boot
5831
wdenk2729af92004-05-03 20:45:30 +00005832When you send a patch, please include the following information with
5833it:
wdenkc6097192002-11-03 00:24:07 +00005834
wdenk2729af92004-05-03 20:45:30 +00005835* For bug fixes: a description of the bug and how your patch fixes
5836 this bug. Please try to include a way of demonstrating that the
5837 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005838
wdenk2729af92004-05-03 20:45:30 +00005839* For new features: a description of the feature and your
5840 implementation.
wdenkc6097192002-11-03 00:24:07 +00005841
wdenk2729af92004-05-03 20:45:30 +00005842* A CHANGELOG entry as plaintext (separate from the patch)
5843
5844* For major contributions, your entry to the CREDITS file
5845
Albert ARIBAUD27af9302013-09-11 15:52:51 +02005846* When you add support for a new board, don't forget to add a
5847 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00005848
5849* If your patch adds new configuration options, don't forget to
5850 document these in the README file.
5851
Wolfgang Denk218ca722008-03-26 10:40:12 +01005852* The patch itself. If you are using git (which is *strongly*
5853 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005854 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005855 the U-Boot mailing list, you will avoid most of the common problems
5856 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005857
Wolfgang Denk218ca722008-03-26 10:40:12 +01005858 If you cannot use git, use "diff -purN OLD NEW". If your version of
5859 diff does not support these options, then get the latest version of
5860 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005861
Wolfgang Denk218ca722008-03-26 10:40:12 +01005862 The current directory when running this command shall be the parent
5863 directory of the U-Boot source tree (i. e. please make sure that
5864 your patch includes sufficient directory information for the
5865 affected files).
5866
5867 We prefer patches as plain text. MIME attachments are discouraged,
5868 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005869
5870* If one logical set of modifications affects or creates several
5871 files, all these changes shall be submitted in a SINGLE patch file.
5872
5873* Changesets that contain different, unrelated modifications shall be
5874 submitted as SEPARATE patches, one patch per changeset.
5875
5876
5877Notes:
5878
5879* Before sending the patch, run the MAKEALL script on your patched
5880 source tree and make sure that no errors or warnings are reported
5881 for any of the boards.
5882
5883* Keep your modifications to the necessary minimum: A patch
5884 containing several unrelated changes or arbitrary reformats will be
5885 returned with a request to re-formatting / split it.
5886
5887* If you modify existing code, make sure that your new code does not
5888 add to the memory footprint of the code ;-) Small is beautiful!
5889 When adding new features, these should compile conditionally only
5890 (using #ifdef), and the resulting code with the new feature
5891 disabled must not need more memory than the old code without your
5892 modification.
wdenk90dc6702005-05-03 14:12:25 +00005893
Wolfgang Denk06682362008-12-30 22:56:11 +01005894* Remember that there is a size limit of 100 kB per message on the
5895 u-boot mailing list. Bigger patches will be moderated. If they are
5896 reasonable and not too big, they will be acknowledged. But patches
5897 bigger than the size limit should be avoided.