blob: 5c343da32bdf581420c0d18e5cea3cac49c8f9e3 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk8c831282012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denkb240aef2008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000057Note: There is no CHANGELOG file in the actual U-Boot source tree;
58it can be created dynamically from the Git log using:
59
60 make CHANGELOG
61
wdenkc6097192002-11-03 00:24:07 +000062
63Where to get help:
64==================
65
wdenk24ee89b2002-11-03 17:56:27 +000066In case you have questions about, problems with or contributions for
67U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050068<u-boot@lists.denx.de>. There is also an archive of previous traffic
69on the mailing list - please search the archive before asking FAQ's.
70Please see http://lists.denx.de/pipermail/u-boot and
71http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000072
73
Wolfgang Denkb240aef2008-03-26 10:40:12 +010074Where to get source code:
75=========================
76
77The U-Boot source code is maintained in the git repository at
78git://www.denx.de/git/u-boot.git ; you can browse it online at
79http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
80
81The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschin08337f32008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010087ftp://ftp.denx.de/pub/u-boot/images/
88
89
wdenkc6097192002-11-03 00:24:07 +000090Where we come from:
91===================
92
93- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000094- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000095- clean up code
96- make it easier to add custom boards
97- make it possible to add other [PowerPC] CPUs
98- extend functions, especially:
99 * Provide extended interface to Linux boot loader
100 * S-Record download
101 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200102 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +0000103- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +0000104- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000105- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +0200106- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000107
108
109Names and Spelling:
110===================
111
112The "official" name of this project is "Das U-Boot". The spelling
113"U-Boot" shall be used in all written text (documentation, comments
114in source files etc.). Example:
115
116 This is the README file for the U-Boot project.
117
118File names etc. shall be based on the string "u-boot". Examples:
119
120 include/asm-ppc/u-boot.h
121
122 #include <asm/u-boot.h>
123
124Variable names, preprocessor constants etc. shall be either based on
125the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000126
wdenk24ee89b2002-11-03 17:56:27 +0000127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
129
wdenkc6097192002-11-03 00:24:07 +0000130
wdenk7474aca2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Webere89e6282010-09-28 08:06:25 +0200134Starting with the release in October 2008, the names of the releases
135were changed from numerical release numbers without deeper meaning
136into a time stamp based numbering. Regular releases are identified by
137names consisting of the calendar year and month of the release date.
138Additional fields (if present) indicate release candidates or bug fix
139releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000140
Thomas Webere89e6282010-09-28 08:06:25 +0200141Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200143 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
144 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150/arch Architecture specific files
151 /arm Files generic to ARM architecture
152 /cpu CPU specific files
153 /arm720t Files specific to ARM 720 CPUs
154 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmannd9a9d562011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500158 /arm925t Files specific to ARM 925 CPUs
159 /arm926ejs Files specific to ARM 926 CPUs
160 /arm1136 Files specific to ARM 1136 CPUs
161 /ixp Files specific to Intel XScale IXP CPUs
162 /pxa Files specific to Intel XScale PXA CPUs
163 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
164 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
165 /lib Architecture specific library files
166 /avr32 Files generic to AVR32 architecture
167 /cpu CPU specific files
168 /lib Architecture specific library files
169 /blackfin Files generic to Analog Devices Blackfin architecture
170 /cpu CPU specific files
171 /lib Architecture specific library files
Graeme Russcbfce1d2011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500173 /cpu CPU specific files
174 /lib Architecture specific library files
175 /m68k Files generic to m68k architecture
176 /cpu CPU specific files
177 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
178 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
179 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
180 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
181 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
182 /lib Architecture specific library files
183 /microblaze Files generic to microblaze architecture
184 /cpu CPU specific files
185 /lib Architecture specific library files
186 /mips Files generic to MIPS architecture
187 /cpu CPU specific files
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu2f46d422011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000191 /nds32 Files generic to NDS32 architecture
192 /cpu CPU specific files
193 /n1213 Files specific to Andes Technology N1213 CPUs
194 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500195 /nios2 Files generic to Altera NIOS2 architecture
196 /cpu CPU specific files
197 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500199 /cpu CPU specific files
200 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
201 /mpc5xx Files specific to Freescale MPC5xx CPUs
202 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
203 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500204 /mpc824x Files specific to Freescale MPC824x CPUs
205 /mpc8260 Files specific to Freescale MPC8260 CPUs
206 /mpc85xx Files specific to Freescale MPC85xx CPUs
207 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
208 /lib Architecture specific library files
209 /sh Files generic to SH architecture
210 /cpu CPU specific files
211 /sh2 Files specific to sh2 CPUs
212 /sh3 Files specific to sh3 CPUs
213 /sh4 Files specific to sh4 CPUs
214 /lib Architecture specific library files
215 /sparc Files generic to SPARC architecture
216 /cpu CPU specific files
217 /leon2 Files specific to Gaisler LEON2 SPARC CPU
218 /leon3 Files specific to Gaisler LEON3 SPARC CPU
219 /lib Architecture specific library files
220/api Machine/arch independent API for external apps
221/board Board dependent files
222/common Misc architecture independent functions
223/disk Code for disk drive partition handling
224/doc Documentation (don't expect too much)
225/drivers Commonly used device drivers
226/examples Example code for standalone applications, etc.
227/fs Filesystem code (cramfs, ext2, jffs2, etc.)
228/include Header Files
229/lib Files generic to all architectures
230 /libfdt Library files to support flattened device trees
231 /lzma Library files to support LZMA decompression
232 /lzo Library files to support LZO decompression
233/net Networking code
234/post Power On Self Test
235/rtc Real Time Clock drivers
236/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000237
wdenkc6097192002-11-03 00:24:07 +0000238Software Configuration:
239=======================
240
241Configuration is usually done using C preprocessor defines; the
242rationale behind that is to avoid dead code whenever possible.
243
244There are two classes of configuration variables:
245
246* Configuration _OPTIONS_:
247 These are selectable by the user and have names beginning with
248 "CONFIG_".
249
250* Configuration _SETTINGS_:
251 These depend on the hardware etc. and should not be meddled with if
252 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200253 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000254
255Later we will add a configuration tool - probably similar to or even
256identical to what's used for the Linux kernel. Right now, we have to
257do the configuration by hand, which means creating some symbolic
258links and editing some configuration files. We use the TQM8xxL boards
259as an example here.
260
261
262Selection of Processor Architecture and Board Type:
263---------------------------------------------------
264
265For all supported boards there are ready-to-use default
266configurations available; just type "make <board_name>_config".
267
268Example: For a TQM823L module type:
269
270 cd u-boot
271 make TQM823L_config
272
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200273For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000274e.g. "make cogent_mpc8xx_config". And also configure the cogent
275directory according to the instructions in cogent/README.
276
277
278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk1272e232002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips203fee32007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips203fee32007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
wdenk2bb11052003-07-17 23:16:40 +0000324- Board flavour: (if CONFIG_MPC8260ADS is defined)
325 CONFIG_ADSTYPE
326 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200327 CONFIG_SYS_8260ADS - original MPC8260ADS
328 CONFIG_SYS_8266ADS - MPC8266ADS
329 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
330 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2bb11052003-07-17 23:16:40 +0000331
Lei Wen20014762011-02-09 18:06:58 +0530332- Marvell Family Member
333 CONFIG_SYS_MVFS - define it if you want to enable
334 multiple fs option at one time
335 for marvell soc family
336
wdenkc6097192002-11-03 00:24:07 +0000337- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000338 Define exactly one of
339 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000340
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200341- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000342 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
343 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000344 e.g. if there is no 32KHz
345 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000346 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
347 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000348
wdenk20bddb32004-09-28 17:59:53 +0000349- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200350 CONFIG_SYS_8xx_CPUCLK_MIN
351 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000352 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000353 See doc/README.MPC866
354
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200355 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000356
wdenk544e9732004-02-06 23:19:44 +0000357 Define this to measure the actual CPU clock instead
358 of relying on the correctness of the configured
359 values. Mostly useful for board bringup to make sure
360 the PLL is locked at the intended frequency. Note
361 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200362 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000363
Heiko Schocher734f0272009-03-12 07:37:15 +0100364 CONFIG_SYS_DELAYED_ICACHE
365
366 Define this option if you want to enable the
367 ICache only when Code runs from RAM.
368
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600369- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000370 CONFIG_SYS_PPC64
371
372 Specifies that the core is a 64-bit PowerPC implementation (implements
373 the "64" category of the Power ISA). This is necessary for ePAPR
374 compliance, among other possible reasons.
375
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600376 CONFIG_SYS_FSL_TBCLK_DIV
377
378 Defines the core time base clock divider ratio compared to the
379 system clock. On most PQ3 devices this is 8, on newer QorIQ
380 devices it can be 16 or 32. The ratio varies from SoC to Soc.
381
Kumar Gala179b1b22011-05-20 00:39:21 -0500382 CONFIG_SYS_FSL_PCIE_COMPAT
383
384 Defines the string to utilize when trying to match PCIe device
385 tree nodes for the given platform.
386
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000387 CONFIG_SYS_PPC_E500_DEBUG_TLB
388
389 Enables a temporary TLB entry to be used during boot to work
390 around limitations in e500v1 and e500v2 external debugger
391 support. This reduces the portions of the boot code where
392 breakpoints and single stepping do not work. The value of this
393 symbol should be set to the TLB1 entry to be used for this
394 purpose.
395
Scott Wood80806962012-08-14 10:14:53 +0000396 CONFIG_SYS_FSL_ERRATUM_A004510
397
398 Enables a workaround for erratum A004510. If set,
399 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
400 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
401
402 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
403 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
404
405 Defines one or two SoC revisions (low 8 bits of SVR)
406 for which the A004510 workaround should be applied.
407
408 The rest of SVR is either not relevant to the decision
409 of whether the erratum is present (e.g. p2040 versus
410 p2041) or is implied by the build target, which controls
411 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
412
413 See Freescale App Note 4493 for more information about
414 this erratum.
415
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530416 CONFIG_A003399_NOR_WORKAROUND
417 Enables a workaround for IFC erratum A003399. It is only
418 requred during NOR boot.
419
Scott Wood80806962012-08-14 10:14:53 +0000420 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
421
422 This is the value to write into CCSR offset 0x18600
423 according to the A004510 workaround.
424
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530425 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426 This value denotes start offset of M2 memory
427 which is directly connected to the DSP core.
428
429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000432- Generic CPU options:
433 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
434
435 Defines the endianess of the CPU. Implementation of those
436 values is arch specific.
437
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100438- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200439 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100440
441 Defines the Monahans run mode to oscillator
442 ratio. Valid values are 8, 16, 24, 31. The core
443 frequency is this value multiplied by 13 MHz.
444
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200445 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200446
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100447 Defines the Monahans turbo mode to oscillator
448 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200449 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100450 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200451
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200452- MIPS CPU options:
453 CONFIG_SYS_INIT_SP_OFFSET
454
455 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
456 pointer. This is needed for the temporary stack before
457 relocation.
458
459 CONFIG_SYS_MIPS_CACHE_MODE
460
461 Cache operation mode for the MIPS CPU.
462 See also arch/mips/include/asm/mipsregs.h.
463 Possible values are:
464 CONF_CM_CACHABLE_NO_WA
465 CONF_CM_CACHABLE_WA
466 CONF_CM_UNCACHED
467 CONF_CM_CACHABLE_NONCOHERENT
468 CONF_CM_CACHABLE_CE
469 CONF_CM_CACHABLE_COW
470 CONF_CM_CACHABLE_CUW
471 CONF_CM_CACHABLE_ACCELERATED
472
473 CONFIG_SYS_XWAY_EBU_BOOTCFG
474
475 Special option for Lantiq XWAY SoCs for booting from NOR flash.
476 See also arch/mips/cpu/mips32/start.S.
477
478 CONFIG_XWAY_SWAP_BYTES
479
480 Enable compilation of tools/xway-swap-bytes needed for Lantiq
481 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
482 be swapped if a flash programmer is used.
483
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000484- ARM options:
485 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
486
487 Select high exception vectors of the ARM core, e.g., do not
488 clear the V bit of the c1 register of CP15.
489
Aneesh Vb8e40802012-03-08 07:20:19 +0000490 CONFIG_SYS_THUMB_BUILD
491
492 Use this flag to build U-Boot using the Thumb instruction
493 set for ARM architectures. Thumb instruction set provides
494 better code density. For ARM architectures that support
495 Thumb2 this flag will result in Thumb2 code generated by
496 GCC.
497
Stephen Warrenc63c3502013-03-04 13:29:40 +0000498 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000499 CONFIG_ARM_ERRATA_742230
500 CONFIG_ARM_ERRATA_743622
501 CONFIG_ARM_ERRATA_751472
502
503 If set, the workarounds for these ARM errata are applied early
504 during U-Boot startup. Note that these options force the
505 workarounds to be applied; no CPU-type/version detection
506 exists, unlike the similar options in the Linux kernel. Do not
507 set these options unless they apply!
508
Stephen Warren445d56c2013-03-27 17:06:41 +0000509- CPU timer options:
510 CONFIG_SYS_HZ
511
512 The frequency of the timer returned by get_timer().
513 get_timer() must operate in milliseconds and this CONFIG
514 option must be set to 1000.
515
wdenk9b7f3842003-10-09 20:09:04 +0000516- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000517 CONFIG_CLOCKS_IN_MHZ
518
519 U-Boot stores all clock information in Hz
520 internally. For binary compatibility with older Linux
521 kernels (which expect the clocks passed in the
522 bd_info data to be in MHz) the environment variable
523 "clocks_in_mhz" can be defined so that U-Boot
524 converts clock data to MHZ before passing it to the
525 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000526 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100527 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000528 default environment.
529
wdenk9b7f3842003-10-09 20:09:04 +0000530 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
531
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200532 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000533 expect it to be in bytes, others in MB.
534 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
535
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400536 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200537
538 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400539 passed using flattened device trees (based on open firmware
540 concepts).
541
542 CONFIG_OF_LIBFDT
543 * New libfdt-based support
544 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500545 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400546
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200547 OF_CPU - The proper name of the cpus node (only required for
548 MPC512X and MPC5xxx based boards).
549 OF_SOC - The proper name of the soc node (only required for
550 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200551 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600552 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200553
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200554 boards with QUICC Engines require OF_QE to set UCC MAC
555 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500556
Kumar Gala1e26aa52006-01-11 13:54:17 -0600557 CONFIG_OF_BOARD_SETUP
558
559 Board code has addition modification that it wants to make
560 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000561
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500562 CONFIG_OF_BOOT_CPU
563
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200564 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500565 param header, the default value is zero if undefined.
566
Heiko Schocherffb293a2009-09-23 07:56:08 +0200567 CONFIG_OF_IDE_FIXUP
568
569 U-Boot can detect if an IDE device is present or not.
570 If not, and this new config option is activated, U-Boot
571 removes the ATA node from the DTS before booting Linux,
572 so the Linux IDE driver does not probe the device and
573 crash. This is needed for buggy hardware (uc101) where
574 no pull down resistor is connected to the signal IDE5V_DD7.
575
Igor Grinberg06890672011-07-14 05:45:07 +0000576 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
577
578 This setting is mandatory for all boards that have only one
579 machine type and must be used to specify the machine type
580 number as it appears in the ARM machine registry
581 (see http://www.arm.linux.org.uk/developer/machines/).
582 Only boards that have multiple machine types supported
583 in a single configuration file and the machine type is
584 runtime discoverable, do not have to use this setting.
585
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100586- vxWorks boot parameters:
587
588 bootvx constructs a valid bootline using the following
589 environments variables: bootfile, ipaddr, serverip, hostname.
590 It loads the vxWorks image pointed bootfile.
591
592 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
593 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
594 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
595 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
596
597 CONFIG_SYS_VXWORKS_ADD_PARAMS
598
599 Add it at the end of the bootline. E.g "u=username pw=secret"
600
601 Note: If a "bootargs" environment is defined, it will overwride
602 the defaults discussed just above.
603
Aneesh V960f5c02011-06-16 23:30:47 +0000604- Cache Configuration:
605 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
606 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
607 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
608
Aneesh V686a0752011-06-16 23:30:51 +0000609- Cache Configuration for ARM:
610 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
611 controller
612 CONFIG_SYS_PL310_BASE - Physical base address of PL310
613 controller register space
614
wdenkda04a8b2004-08-02 23:22:59 +0000615- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200616 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000617
618 Define this if you want support for Amba PrimeCell PL010 UARTs.
619
Andreas Engel0813b122008-09-08 14:30:53 +0200620 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000621
622 Define this if you want support for Amba PrimeCell PL011 UARTs.
623
624 CONFIG_PL011_CLOCK
625
626 If you have Amba PrimeCell PL011 UARTs, set this variable to
627 the clock speed of the UARTs.
628
629 CONFIG_PL01x_PORTS
630
631 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
632 define this to a list of base addresses for each (supported)
633 port. See e.g. include/configs/versatile.h
634
John Rigby34e21ee2011-04-19 10:42:39 +0000635 CONFIG_PL011_SERIAL_RLCR
636
637 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
638 have separate receive and transmit line control registers. Set
639 this variable to initialize the extra register.
640
641 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
642
643 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
644 boot loader that has already initialized the UART. Define this
645 variable to flush the UART at init time.
646
wdenkda04a8b2004-08-02 23:22:59 +0000647
wdenkc6097192002-11-03 00:24:07 +0000648- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000649 Depending on board, define exactly one serial port
650 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
651 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
652 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000653
654 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
655 port routines must be defined elsewhere
656 (i.e. serial_init(), serial_getc(), ...)
657
658 CONFIG_CFB_CONSOLE
659 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000660 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000661 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
662 (default big endian)
663 VIDEO_HW_RECTFILL graphic chip supports
664 rectangle fill
665 (cf. smiLynxEM)
666 VIDEO_HW_BITBLT graphic chip supports
667 bit-blit (cf. smiLynxEM)
668 VIDEO_VISIBLE_COLS visible pixel columns
669 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000670 VIDEO_VISIBLE_ROWS visible pixel rows
671 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000672 VIDEO_DATA_FORMAT graphic data format
673 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000674 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000675 VIDEO_KBD_INIT_FCT keyboard int fct
676 (i.e. i8042_kbd_init())
677 VIDEO_TSTC_FCT test char fct
678 (i.e. i8042_tstc)
679 VIDEO_GETC_FCT get char fct
680 (i.e. i8042_getc)
681 CONFIG_CONSOLE_CURSOR cursor drawing on/off
682 (requires blink timer
683 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200684 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000685 CONFIG_CONSOLE_TIME display time/date info in
686 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500687 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000688 CONFIG_VIDEO_LOGO display Linux logo in
689 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000690 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
691 linux_logo.h for logo.
692 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000693 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200694 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000695 the logo
696
Pali Rohár4a57da32012-10-19 13:30:09 +0000697 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
698 a limited number of ANSI escape sequences (cursor control,
699 erase functions and limited graphics rendition control).
700
wdenk4a5c8a72003-03-06 00:02:04 +0000701 When CONFIG_CFB_CONSOLE is defined, video console is
702 default i/o. Serial console can be forced with
703 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000704
wdenk1ebf41e2004-01-02 14:00:00 +0000705 When CONFIG_SILENT_CONSOLE is defined, all console
706 messages (by U-Boot and Linux!) can be silenced with
707 the "silent" environment variable. See
708 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000709
wdenkc6097192002-11-03 00:24:07 +0000710- Console Baudrate:
711 CONFIG_BAUDRATE - in bps
712 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200713 CONFIG_SYS_BAUDRATE_TABLE, see below.
714 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000715
Heiko Schocher327480a2009-01-30 12:55:38 +0100716- Console Rx buffer length
717 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
718 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100719 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100720 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
721 must be defined, to setup the maximum idle timeout for
722 the SMC.
723
Graeme Russ3c28f482011-09-01 00:48:27 +0000724- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200725 Prior to the console being initialised (i.e. serial UART
726 initialised etc) all console output is silently discarded.
727 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
728 buffer any console messages prior to the console being
729 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
730 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
731 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200732 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200733 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000734
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200735 'Sane' compilers will generate smaller code if
736 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000737
Sonny Raocd55bde2011-11-02 09:52:08 +0000738- Safe printf() functions
739 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
740 the printf() functions. These are defined in
741 include/vsprintf.h and include snprintf(), vsnprintf() and
742 so on. Code size increase is approximately 300-500 bytes.
743 If this option is not given then these functions will
744 silently discard their buffer size argument - this means
745 you are not getting any overflow checking in this case.
746
wdenkc6097192002-11-03 00:24:07 +0000747- Boot Delay: CONFIG_BOOTDELAY - in seconds
748 Delay before automatically booting the default image;
749 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000750 set to -2 to autoboot with no delay and not check for abort
751 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000752
753 See doc/README.autoboot for these options that
754 work with CONFIG_BOOTDELAY. None are required.
755 CONFIG_BOOT_RETRY_TIME
756 CONFIG_BOOT_RETRY_MIN
757 CONFIG_AUTOBOOT_KEYED
758 CONFIG_AUTOBOOT_PROMPT
759 CONFIG_AUTOBOOT_DELAY_STR
760 CONFIG_AUTOBOOT_STOP_STR
761 CONFIG_AUTOBOOT_DELAY_STR2
762 CONFIG_AUTOBOOT_STOP_STR2
763 CONFIG_ZERO_BOOTDELAY_CHECK
764 CONFIG_RESET_TO_RETRY
765
766- Autoboot Command:
767 CONFIG_BOOTCOMMAND
768 Only needed when CONFIG_BOOTDELAY is enabled;
769 define a command string that is automatically executed
770 when no character is read on the console interface
771 within "Boot Delay" after reset.
772
773 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000774 This can be used to pass arguments to the bootm
775 command. The value of CONFIG_BOOTARGS goes into the
776 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000777
778 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000779 The value of these goes into the environment as
780 "ramboot" and "nfsboot" respectively, and can be used
781 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200782 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000783
784- Pre-Boot Commands:
785 CONFIG_PREBOOT
786
787 When this option is #defined, the existence of the
788 environment variable "preboot" will be checked
789 immediately before starting the CONFIG_BOOTDELAY
790 countdown and/or running the auto-boot command resp.
791 entering interactive mode.
792
793 This feature is especially useful when "preboot" is
794 automatically generated or modified. For an example
795 see the LWMON board specific code: here "preboot" is
796 modified when the user holds down a certain
797 combination of keys on the (special) keyboard when
798 booting the systems
799
800- Serial Download Echo Mode:
801 CONFIG_LOADS_ECHO
802 If defined to 1, all characters received during a
803 serial download (using the "loads" command) are
804 echoed back. This might be needed by some terminal
805 emulations (like "cu"), but may as well just take
806 time on others. This setting #define's the initial
807 value of the "loads_echo" environment variable.
808
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500809- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000810 CONFIG_KGDB_BAUDRATE
811 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200812 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000813
814- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500815 Monitor commands can be included or excluded
816 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000817 <config_cmd_all.h> and #undef'ing unwanted
818 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500819 and augmenting with additional #define's
820 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000821
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500822 The default command configuration includes all commands
823 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000824
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500825 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500826 CONFIG_CMD_BDI bdinfo
827 CONFIG_CMD_BEDBUG * Include BedBug Debugger
828 CONFIG_CMD_BMP * BMP support
829 CONFIG_CMD_BSP * Board specific commands
830 CONFIG_CMD_BOOTD bootd
831 CONFIG_CMD_CACHE * icache, dcache
832 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500833 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500834 CONFIG_CMD_DATE * support for RTC, date/time...
835 CONFIG_CMD_DHCP * DHCP support
836 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600837 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
838 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
839 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
840 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500841 CONFIG_CMD_DTT * Digital Therm and Thermostat
842 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500843 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500844 CONFIG_CMD_EEPROM * EEPROM read/write support
845 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600846 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600847 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500848 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000849 CONFIG_CMD_EXT2 * ext2 command support
850 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500851 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500852 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000853 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500854 CONFIG_CMD_FDOS * Dos diskette Support
855 CONFIG_CMD_FLASH flinfo, erase, protect
856 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200857 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000858 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500859 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000860 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000861 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
863 CONFIG_CMD_I2C * I2C serial bus support
864 CONFIG_CMD_IDE * IDE harddisk support
865 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000866 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200867 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500868 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500869 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000870 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500871 CONFIG_CMD_IRQ * irqinfo
872 CONFIG_CMD_ITEST Integer/string test of 2 values
873 CONFIG_CMD_JFFS2 * JFFS2 Support
874 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200875 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000876 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
877 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500878 CONFIG_CMD_LOADB loadb
879 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200880 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400881 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000882 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500883 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000884 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200885 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500886 CONFIG_CMD_MISC Misc functions like sleep etc
887 CONFIG_CMD_MMC * MMC memory mapped support
888 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100889 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500890 CONFIG_CMD_NAND * NAND support
891 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200892 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600893 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000894 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500895 CONFIG_CMD_PCI * pciinfo
896 CONFIG_CMD_PCMCIA * PCMCIA support
897 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
898 host
899 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000900 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500901 CONFIG_CMD_REGINFO * Register dump
902 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000903 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500904 CONFIG_CMD_SAVES * save S record dump
905 CONFIG_CMD_SCSI * SCSI Support
906 CONFIG_CMD_SDRAM * print SDRAM configuration information
907 (requires CONFIG_CMD_I2C)
908 CONFIG_CMD_SETGETDCR Support for DCR Register access
909 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700910 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200911 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400912 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800913 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200914 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500915 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000916 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000917 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000918 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
919 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500920 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500921 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000922 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200923 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000924
wdenkc6097192002-11-03 00:24:07 +0000925
926 EXAMPLE: If you want all functions except of network
927 support you can write:
928
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500929 #include "config_cmd_all.h"
930 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000931
Gerald Van Barend6abef42007-03-31 12:23:51 -0400932 Other Commands:
933 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000934
935 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500936 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000937 what you (and your U-Boot users) are doing. Data
938 cache cannot be enabled on systems like the 8xx or
939 8260 (where accesses to the IMMR region must be
940 uncached), and it cannot be disabled on all other
941 systems where we (mis-) use the data cache to hold an
942 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000943
944
945 XXX - this list needs to get updated!
946
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000947- Regular expression support:
948 CONFIG_REGEX
949 If this variable is defined, U-Boot is linked against
950 the SLRE (Super Light Regular Expression) library,
951 which adds regex support to some commands, as for
952 example "env grep" and "setexpr".
953
Simon Glass3d686442011-10-15 05:48:20 +0000954- Device tree:
955 CONFIG_OF_CONTROL
956 If this variable is defined, U-Boot will use a device tree
957 to configure its devices, instead of relying on statically
958 compiled #defines in the board file. This option is
959 experimental and only available on a few boards. The device
960 tree is available in the global data as gd->fdt_blob.
961
Simon Glass5cb34db2011-10-24 19:15:31 +0000962 U-Boot needs to get its device tree from somewhere. This can
963 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000964
965 CONFIG_OF_EMBED
966 If this variable is defined, U-Boot will embed a device tree
967 binary in its image. This device tree file should be in the
968 board directory and called <soc>-<board>.dts. The binary file
969 is then picked up in board_init_f() and made available through
970 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000971
Simon Glass5cb34db2011-10-24 19:15:31 +0000972 CONFIG_OF_SEPARATE
973 If this variable is defined, U-Boot will build a device tree
974 binary. It will be called u-boot.dtb. Architecture-specific
975 code will locate it at run-time. Generally this works by:
976
977 cat u-boot.bin u-boot.dtb >image.bin
978
979 and in fact, U-Boot does this for you, creating a file called
980 u-boot-dtb.bin which is useful in the common case. You can
981 still use the individual files if you need something more
982 exotic.
983
wdenkc6097192002-11-03 00:24:07 +0000984- Watchdog:
985 CONFIG_WATCHDOG
986 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000987 support for the SoC. There must be support in the SoC
988 specific code for a watchdog. For the 8xx and 8260
989 CPUs, the SIU Watchdog feature is enabled in the SYPCR
990 register. When supported for a specific SoC is
991 available, then no further board specific code should
992 be needed to use it.
993
994 CONFIG_HW_WATCHDOG
995 When using a watchdog circuitry external to the used
996 SoC, then define this variable and provide board
997 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000998
stroeseb9c17c52003-04-04 15:53:41 +0000999- U-Boot Version:
1000 CONFIG_VERSION_VARIABLE
1001 If this variable is defined, an environment variable
1002 named "ver" is created by U-Boot showing the U-Boot
1003 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001004 Any change to this variable will be reverted at the
1005 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001006
wdenkc6097192002-11-03 00:24:07 +00001007- Real-Time Clock:
1008
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001009 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001010 has to be selected, too. Define exactly one of the
1011 following options:
1012
1013 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1014 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001015 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001016 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001017 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001018 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001019 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +00001020 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001021 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001022 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001023 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001024 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1025 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001026
wdenkb9bbd242003-06-30 16:24:52 +00001027 Note that if the RTC uses I2C, then the I2C interface
1028 must also be configured. See I2C Support, below.
1029
Peter Tyser9902e422008-12-17 16:36:21 -06001030- GPIO Support:
1031 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1032 CONFIG_PCA953X_INFO - enable pca953x info command
1033
Chris Packham9b383202010-12-19 10:12:13 +00001034 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1035 chip-ngpio pairs that tell the PCA953X driver the number of
1036 pins supported by a particular chip.
1037
Peter Tyser9902e422008-12-17 16:36:21 -06001038 Note that if the GPIO device uses I2C, then the I2C interface
1039 must also be configured. See I2C Support, below.
1040
wdenkc6097192002-11-03 00:24:07 +00001041- Timestamp Support:
1042
wdenk4a5c8a72003-03-06 00:02:04 +00001043 When CONFIG_TIMESTAMP is selected, the timestamp
1044 (date and time) of an image is printed by image
1045 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001046 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001047
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001048- Partition Labels (disklabels) Supported:
1049 Zero or more of the following:
1050 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1051 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1052 Intel architecture, USB sticks, etc.
1053 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1054 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1055 bootloader. Note 2TB partition limit; see
1056 disk/part_efi.c
1057 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001058
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001059 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1060 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001061 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001062
1063- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001064 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1065 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001066
wdenk369d43d2004-03-14 14:09:05 +00001067 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1068 be performed by calling the function
1069 ide_set_reset(int reset)
1070 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001071
1072- ATAPI Support:
1073 CONFIG_ATAPI
1074
1075 Set this to enable ATAPI support.
1076
wdenkf602aa02004-03-13 23:29:43 +00001077- LBA48 Support
1078 CONFIG_LBA48
1079
1080 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001081 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001082 Whithout these , LBA48 support uses 32bit variables and will 'only'
1083 support disks up to 2.1TB.
1084
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001085 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001086 When enabled, makes the IDE subsystem use 64bit sector addresses.
1087 Default is 32bit.
1088
wdenkc6097192002-11-03 00:24:07 +00001089- SCSI Support:
1090 At the moment only there is only support for the
1091 SYM53C8XX SCSI controller; define
1092 CONFIG_SCSI_SYM53C8XX to enable it.
1093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001094 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1095 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1096 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001097 maximum numbers of LUNs, SCSI ID's and target
1098 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001099 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001100
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001101 The environment variable 'scsidevs' is set to the number of
1102 SCSI devices found during the last scan.
1103
wdenkc6097192002-11-03 00:24:07 +00001104- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001105 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001106 Support for Intel 8254x/8257x gigabit chips.
1107
1108 CONFIG_E1000_SPI
1109 Utility code for direct access to the SPI bus on Intel 8257x.
1110 This does not do anything useful unless you set at least one
1111 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1112
1113 CONFIG_E1000_SPI_GENERIC
1114 Allow generic access to the SPI bus on the Intel 8257x, for
1115 example with the "sspi" command.
1116
1117 CONFIG_CMD_E1000
1118 Management command for E1000 devices. When used on devices
1119 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001120
Andre Schwarz68c2a302008-03-06 16:45:44 +01001121 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001122 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001123
wdenkc6097192002-11-03 00:24:07 +00001124 CONFIG_EEPRO100
1125 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001126 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001127 write routine for first time initialisation.
1128
1129 CONFIG_TULIP
1130 Support for Digital 2114x chips.
1131 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1132 modem chip initialisation (KS8761/QS6611).
1133
1134 CONFIG_NATSEMI
1135 Support for National dp83815 chips.
1136
1137 CONFIG_NS8382X
1138 Support for National dp8382[01] gigabit chips.
1139
wdenkaa603362003-05-12 21:50:16 +00001140- NETWORK Support (other):
1141
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001142 CONFIG_DRIVER_AT91EMAC
1143 Support for AT91RM9200 EMAC.
1144
1145 CONFIG_RMII
1146 Define this to use reduced MII inteface
1147
1148 CONFIG_DRIVER_AT91EMAC_QUIET
1149 If this defined, the driver is quiet.
1150 The driver doen't show link status messages.
1151
Rob Herringc9830dc2011-12-15 11:15:49 +00001152 CONFIG_CALXEDA_XGMAC
1153 Support for the Calxeda XGMAC device
1154
Ashok93fb8722012-10-15 06:20:47 +00001155 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001156 Support for SMSC's LAN91C96 chips.
1157
1158 CONFIG_LAN91C96_BASE
1159 Define this to hold the physical address
1160 of the LAN91C96's I/O space
1161
1162 CONFIG_LAN91C96_USE_32_BIT
1163 Define this to enable 32 bit addressing
1164
Ashok93fb8722012-10-15 06:20:47 +00001165 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001166 Support for SMSC's LAN91C111 chip
1167
1168 CONFIG_SMC91111_BASE
1169 Define this to hold the physical address
1170 of the device (I/O space)
1171
1172 CONFIG_SMC_USE_32_BIT
1173 Define this if data bus is 32 bits
1174
1175 CONFIG_SMC_USE_IOFUNCS
1176 Define this to use i/o functions instead of macros
1177 (some hardware wont work with macros)
1178
Heiko Schocher7d037f72011-11-15 10:00:04 -05001179 CONFIG_DRIVER_TI_EMAC
1180 Support for davinci emac
1181
1182 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1183 Define this if you have more then 3 PHYs.
1184
Macpaul Lin199c6252010-12-21 16:59:46 +08001185 CONFIG_FTGMAC100
1186 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1187
1188 CONFIG_FTGMAC100_EGIGA
1189 Define this to use GE link update with gigabit PHY.
1190 Define this if FTGMAC100 is connected to gigabit PHY.
1191 If your system has 10/100 PHY only, it might not occur
1192 wrong behavior. Because PHY usually return timeout or
1193 useless data when polling gigabit status and gigabit
1194 control registers. This behavior won't affect the
1195 correctnessof 10/100 link speed update.
1196
Mike Rapoportf4761af2009-11-11 10:03:03 +02001197 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001198 Support for SMSC's LAN911x and LAN921x chips
1199
Mike Rapoportf4761af2009-11-11 10:03:03 +02001200 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001201 Define this to hold the physical address
1202 of the device (I/O space)
1203
Mike Rapoportf4761af2009-11-11 10:03:03 +02001204 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001205 Define this if data bus is 32 bits
1206
Mike Rapoportf4761af2009-11-11 10:03:03 +02001207 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001208 Define this if data bus is 16 bits. If your processor
1209 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001210 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001211
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001212 CONFIG_SH_ETHER
1213 Support for Renesas on-chip Ethernet controller
1214
1215 CONFIG_SH_ETHER_USE_PORT
1216 Define the number of ports to be used
1217
1218 CONFIG_SH_ETHER_PHY_ADDR
1219 Define the ETH PHY's address
1220
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001221 CONFIG_SH_ETHER_CACHE_WRITEBACK
1222 If this option is set, the driver enables cache flush.
1223
Vadim Bendeburydac69642011-10-17 08:36:14 +00001224- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001225 CONFIG_TPM
1226 Support TPM devices.
1227
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001228 CONFIG_TPM_TIS_I2C
1229 Support for i2c bus TPM devices. Only one device
1230 per system is supported at this time.
1231
1232 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1233 Define the the i2c bus number for the TPM device
1234
1235 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1236 Define the TPM's address on the i2c bus
1237
1238 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1239 Define the burst count bytes upper limit
1240
Che-liang Chiouacea5702013-04-12 11:04:34 +00001241 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001242 Support for generic parallel port TPM devices. Only one device
1243 per system is supported at this time.
1244
1245 CONFIG_TPM_TIS_BASE_ADDRESS
1246 Base address where the generic TPM device is mapped
1247 to. Contemporary x86 systems usually map it at
1248 0xfed40000.
1249
wdenkc6097192002-11-03 00:24:07 +00001250- USB Support:
1251 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001252 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001253 CONFIG_USB_UHCI to enable it.
1254 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001255 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001256 storage devices.
1257 Note:
1258 Supported are USB Keyboards and USB Floppy drives
1259 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001260 MPC5200 USB requires additional defines:
1261 CONFIG_USB_CLOCK
1262 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001263 CONFIG_PSC3_USB
1264 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001265 CONFIG_USB_CONFIG
1266 for differential drivers: 0x00001000
1267 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001268 for differential drivers on PSC3: 0x00000100
1269 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001270 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001271 May be defined to allow interrupt polling
1272 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001273
Simon Glass5978cdb2012-02-27 10:52:47 +00001274 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1275 txfilltuning field in the EHCI controller on reset.
1276
Kuo-Jung Su4e5923f2013-05-15 15:29:22 +08001277 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1278 interval for usb hub power-on delay.(minimum 100msec)
1279
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001280- USB Device:
1281 Define the below if you wish to use the USB console.
1282 Once firmware is rebuilt from a serial console issue the
1283 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001284 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001285 it has found a new device. The environment variable usbtty
1286 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001287 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001288 Common Device Class Abstract Control Model serial device.
1289 If you select usbtty = gserial you should be able to enumerate
1290 a Linux host by
1291 # modprobe usbserial vendor=0xVendorID product=0xProductID
1292 else if using cdc_acm, simply setting the environment
1293 variable usbtty to be cdc_acm should suffice. The following
1294 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001295
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001296 CONFIG_USB_DEVICE
1297 Define this to build a UDC device
1298
1299 CONFIG_USB_TTY
1300 Define this to have a tty type of device available to
1301 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001302
Vipin KUMARbdb17702012-03-26 15:38:06 +05301303 CONFIG_USBD_HS
1304 Define this to enable the high speed support for usb
1305 device and usbtty. If this feature is enabled, a routine
1306 int is_usbd_high_speed(void)
1307 also needs to be defined by the driver to dynamically poll
1308 whether the enumeration has succeded at high speed or full
1309 speed.
1310
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001311 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001312 Define this if you want stdin, stdout &/or stderr to
1313 be set to usbtty.
1314
1315 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001316 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001317 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001318 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001319
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001320 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001321 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001322 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001323
Wolfgang Denke2601822006-06-14 18:14:56 +02001324 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001325 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001326 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001327 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1328 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1329 should pretend to be a Linux device to it's target host.
1330
1331 CONFIG_USBD_MANUFACTURER
1332 Define this string as the name of your company for
1333 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001334
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001335 CONFIG_USBD_PRODUCT_NAME
1336 Define this string as the name of your product
1337 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001338
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001339 CONFIG_USBD_VENDORID
1340 Define this as your assigned Vendor ID from the USB
1341 Implementors Forum. This *must* be a genuine Vendor ID
1342 to avoid polluting the USB namespace.
1343 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001344
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001345 CONFIG_USBD_PRODUCTID
1346 Define this as the unique Product ID
1347 for your device
1348 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001349
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001350- ULPI Layer Support:
1351 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1352 the generic ULPI layer. The generic layer accesses the ULPI PHY
1353 via the platform viewport, so you need both the genric layer and
1354 the viewport enabled. Currently only Chipidea/ARC based
1355 viewport is supported.
1356 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1357 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001358 If your ULPI phy needs a different reference clock than the
1359 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1360 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001361
wdenk7a428cc2003-06-15 22:40:42 +00001362- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001363 The MMC controller on the Intel PXA is supported. To
1364 enable this define CONFIG_MMC. The MMC can be
1365 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001366 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001367 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1368 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001369
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001370 CONFIG_SH_MMCIF
1371 Support for Renesas on-chip MMCIF controller
1372
1373 CONFIG_SH_MMCIF_ADDR
1374 Define the base address of MMCIF registers
1375
1376 CONFIG_SH_MMCIF_CLK
1377 Define the clock frequency for MMCIF
1378
Tom Rini58a8d322013-03-14 05:32:47 +00001379- USB Device Firmware Update (DFU) class support:
1380 CONFIG_DFU_FUNCTION
1381 This enables the USB portion of the DFU USB class
1382
1383 CONFIG_CMD_DFU
1384 This enables the command "dfu" which is used to have
1385 U-Boot create a DFU class device via USB. This command
1386 requires that the "dfu_alt_info" environment variable be
1387 set and define the alt settings to expose to the host.
1388
1389 CONFIG_DFU_MMC
1390 This enables support for exposing (e)MMC devices via DFU.
1391
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001392 CONFIG_DFU_NAND
1393 This enables support for exposing NAND devices via DFU.
1394
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001395 CONFIG_SYS_DFU_MAX_FILE_SIZE
1396 When updating files rather than the raw storage device,
1397 we use a static buffer to copy the file into and then write
1398 the buffer once we've been given the whole file. Define
1399 this to the maximum filesize (in bytes) for the buffer.
1400 Default is 4 MiB if undefined.
1401
wdenkda04a8b2004-08-02 23:22:59 +00001402- Journaling Flash filesystem support:
1403 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1404 CONFIG_JFFS2_NAND_DEV
1405 Define these for a default partition on a NAND device
1406
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001407 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1408 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001409 Define these for a default partition on a NOR device
1410
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001411 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001412 Define this to create an own partition. You have to provide a
1413 function struct part_info* jffs2_part_info(int part_num)
1414
1415 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001416 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001417 to disable the command chpart. This is the default when you
1418 have not defined a custom partition
1419
Donggeun Kim8f814002011-10-24 21:15:28 +00001420- FAT(File Allocation Table) filesystem write function support:
1421 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001422
1423 Define this to enable support for saving memory data as a
1424 file in FAT formatted partition.
1425
1426 This will also enable the command "fatwrite" enabling the
1427 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001428
Gabe Black7f8574c2012-10-12 14:26:11 +00001429CBFS (Coreboot Filesystem) support
1430 CONFIG_CMD_CBFS
1431
1432 Define this to enable support for reading from a Coreboot
1433 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1434 and cbfsload.
1435
wdenkc6097192002-11-03 00:24:07 +00001436- Keyboard Support:
1437 CONFIG_ISA_KEYBOARD
1438
1439 Define this to enable standard (PC-Style) keyboard
1440 support
1441
1442 CONFIG_I8042_KBD
1443 Standard PC keyboard driver with US (is default) and
1444 GERMAN key layout (switch via environment 'keymap=de') support.
1445 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1446 for cfb_console. Supports cursor blinking.
1447
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001448 CONFIG_CROS_EC_KEYB
1449 Enables a Chrome OS keyboard using the CROS_EC interface.
1450 This uses CROS_EC to communicate with a second microcontroller
1451 which provides key scans on request.
1452
wdenkc6097192002-11-03 00:24:07 +00001453- Video support:
1454 CONFIG_VIDEO
1455
1456 Define this to enable video support (for output to
1457 video).
1458
1459 CONFIG_VIDEO_CT69000
1460
1461 Enable Chips & Technologies 69000 Video chip
1462
1463 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001464 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001465 video output is selected via environment 'videoout'
1466 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1467 assumed.
wdenkc6097192002-11-03 00:24:07 +00001468
wdenkd3602132004-03-25 15:14:43 +00001469 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001470 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001471 are possible:
1472 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001473 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001474
1475 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1476 -------------+---------------------------------------------
1477 8 bits | 0x301* 0x303 0x305 0x161 0x307
1478 15 bits | 0x310 0x313 0x316 0x162 0x319
1479 16 bits | 0x311 0x314 0x317 0x163 0x31A
1480 24 bits | 0x312 0x315 0x318 ? 0x31B
1481 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001482 (i.e. setenv videomode 317; saveenv; reset;)
1483
wdenkd3602132004-03-25 15:14:43 +00001484 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001485 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001486
1487
stroeseb9c17c52003-04-04 15:53:41 +00001488 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001489 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001490 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1491 or CONFIG_VIDEO_SED13806_16BPP
1492
Timur Tabi020edd22011-02-15 17:09:19 -06001493 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001494 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001495 SOCs that have a DIU should define this macro to enable DIU
1496 support, and should also define these other macros:
1497
1498 CONFIG_SYS_DIU_ADDR
1499 CONFIG_VIDEO
1500 CONFIG_CMD_BMP
1501 CONFIG_CFB_CONSOLE
1502 CONFIG_VIDEO_SW_CURSOR
1503 CONFIG_VGA_AS_SINGLE_DEVICE
1504 CONFIG_VIDEO_LOGO
1505 CONFIG_VIDEO_BMP_LOGO
1506
Timur Tabi32f709e2011-04-11 14:18:22 -05001507 The DIU driver will look for the 'video-mode' environment
1508 variable, and if defined, enable the DIU as a console during
1509 boot. See the documentation file README.video for a
1510 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001511
Simon Glass54df8ce2012-12-03 13:59:47 +00001512 CONFIG_VIDEO_VGA
1513
1514 Enable the VGA video / BIOS for x86. The alternative if you
1515 are using coreboot is to use the coreboot frame buffer
1516 driver.
1517
1518
wdenk4e112c12003-06-03 23:54:09 +00001519- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001520 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001521
wdenk57b2d802003-06-27 21:31:46 +00001522 Define this to enable a custom keyboard support.
1523 This simply calls drv_keyboard_init() which must be
1524 defined in your board-specific files.
1525 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001526
wdenkc6097192002-11-03 00:24:07 +00001527- LCD Support: CONFIG_LCD
1528
1529 Define this to enable LCD support (for output to LCD
1530 display); also select one of the supported displays
1531 by defining one of these:
1532
Stelian Popf6f86652008-05-09 21:57:18 +02001533 CONFIG_ATMEL_LCD:
1534
1535 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1536
wdenkc0d54ae2003-11-25 16:55:19 +00001537 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001538
wdenkc0d54ae2003-11-25 16:55:19 +00001539 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001540
wdenkc0d54ae2003-11-25 16:55:19 +00001541 CONFIG_NEC_NL6448BC20
1542
1543 NEC NL6448BC20-08. 6.5", 640x480.
1544 Active, color, single scan.
1545
1546 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001547
wdenkc0d54ae2003-11-25 16:55:19 +00001548 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001549 Active, color, single scan.
1550
1551 CONFIG_SHARP_16x9
1552
1553 Sharp 320x240. Active, color, single scan.
1554 It isn't 16x9, and I am not sure what it is.
1555
1556 CONFIG_SHARP_LQ64D341
1557
1558 Sharp LQ64D341 display, 640x480.
1559 Active, color, single scan.
1560
1561 CONFIG_HLD1045
1562
1563 HLD1045 display, 640x480.
1564 Active, color, single scan.
1565
1566 CONFIG_OPTREX_BW
1567
1568 Optrex CBL50840-2 NF-FW 99 22 M5
1569 or
1570 Hitachi LMG6912RPFC-00T
1571 or
1572 Hitachi SP14Q002
1573
1574 320x240. Black & white.
1575
1576 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001577 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001578
Simon Glass599a4df2012-10-17 13:24:54 +00001579 CONFIG_LCD_ALIGNMENT
1580
1581 Normally the LCD is page-aligned (tyically 4KB). If this is
1582 defined then the LCD will be aligned to this value instead.
1583 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1584 here, since it is cheaper to change data cache settings on
1585 a per-section basis.
1586
Simon Glassaf3e2802012-10-17 13:24:59 +00001587 CONFIG_CONSOLE_SCROLL_LINES
1588
1589 When the console need to be scrolled, this is the number of
1590 lines to scroll by. It defaults to 1. Increasing this makes
1591 the console jump but can help speed up operation when scrolling
1592 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001593
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001594 CONFIG_LCD_BMP_RLE8
1595
1596 Support drawing of RLE8-compressed bitmaps on the LCD.
1597
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001598 CONFIG_I2C_EDID
1599
1600 Enables an 'i2c edid' command which can read EDID
1601 information over I2C from an attached LCD display.
1602
wdenkeb20ad32003-09-05 23:19:14 +00001603- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001604
wdenk57b2d802003-06-27 21:31:46 +00001605 If this option is set, the environment is checked for
1606 a variable "splashimage". If found, the usual display
1607 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001608 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001609 specified in "splashimage" is loaded instead. The
1610 console is redirected to the "nulldev", too. This
1611 allows for a "silent" boot where a splash screen is
1612 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001613
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001614 CONFIG_SPLASHIMAGE_GUARD
1615
1616 If this option is set, then U-Boot will prevent the environment
1617 variable "splashimage" from being set to a problematic address
1618 (see README.displaying-bmps and README.arm-unaligned-accesses).
1619 This option is useful for targets where, due to alignment
1620 restrictions, an improperly aligned BMP image will cause a data
1621 abort. If you think you will not have problems with unaligned
1622 accesses (for example because your toolchain prevents them)
1623 there is no need to set this option.
1624
Matthias Weisser53884182009-07-09 16:07:30 +02001625 CONFIG_SPLASH_SCREEN_ALIGN
1626
1627 If this option is set the splash image can be freely positioned
1628 on the screen. Environment variable "splashpos" specifies the
1629 position as "x,y". If a positive number is given it is used as
1630 number of pixel from left/top. If a negative number is given it
1631 is used as number of pixel from right/bottom. You can also
1632 specify 'm' for centering the image.
1633
1634 Example:
1635 setenv splashpos m,m
1636 => image at center of screen
1637
1638 setenv splashpos 30,20
1639 => image at x = 30 and y = 20
1640
1641 setenv splashpos -10,m
1642 => vertically centered image
1643 at x = dspWidth - bmpWidth - 9
1644
Nikita Kiryanove0eba1f2013-01-30 21:39:57 +00001645 CONFIG_SPLASH_SCREEN_PREPARE
1646
1647 If this option is set then the board_splash_screen_prepare()
1648 function, which must be defined in your code, is called as part
1649 of the splash screen display sequence. It gives the board an
1650 opportunity to prepare the splash image data before it is
1651 processed and sent to the frame buffer by U-Boot.
1652
Stefan Roesed9d97742005-09-22 09:04:17 +02001653- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1654
1655 If this option is set, additionally to standard BMP
1656 images, gzipped BMP images can be displayed via the
1657 splashscreen support or the bmp command.
1658
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001659- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1660
1661 If this option is set, 8-bit RLE compressed BMP images
1662 can be displayed via the splashscreen support or the
1663 bmp command.
1664
Lei Wene4e248d2012-09-28 04:26:47 +00001665- Do compresssing for memory range:
1666 CONFIG_CMD_ZIP
1667
1668 If this option is set, it would use zlib deflate method
1669 to compress the specified memory at its best effort.
1670
wdenk710e3502003-08-29 20:57:53 +00001671- Compression support:
1672 CONFIG_BZIP2
1673
1674 If this option is set, support for bzip2 compressed
1675 images is included. If not, only uncompressed and gzip
1676 compressed images are supported.
1677
wdenk9c53f402003-10-15 23:53:47 +00001678 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001679 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001680 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001681
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001682 CONFIG_LZMA
1683
1684 If this option is set, support for lzma compressed
1685 images is included.
1686
1687 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1688 requires an amount of dynamic memory that is given by the
1689 formula:
1690
1691 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1692
1693 Where lc and lp stand for, respectively, Literal context bits
1694 and Literal pos bits.
1695
1696 This value is upper-bounded by 14MB in the worst case. Anyway,
1697 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1698 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1699 a very small buffer.
1700
1701 Use the lzmainfo tool to determinate the lc and lp values and
1702 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001703 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001704
wdenk0e2bd9c2004-06-06 21:51:03 +00001705- MII/PHY support:
1706 CONFIG_PHY_ADDR
1707
1708 The address of PHY on MII bus.
1709
1710 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1711
1712 The clock frequency of the MII bus
1713
1714 CONFIG_PHY_GIGE
1715
1716 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001717 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001718
1719 CONFIG_PHY_RESET_DELAY
1720
1721 Some PHY like Intel LXT971A need extra delay after
1722 reset before any MII register access is possible.
1723 For such PHY, set this option to the usec delay
1724 required. (minimum 300usec for LXT971A)
1725
1726 CONFIG_PHY_CMD_DELAY (ppc4xx)
1727
1728 Some PHY like Intel LXT971A need extra delay after
1729 command issued before MII status register can be read
1730
wdenkc6097192002-11-03 00:24:07 +00001731- Ethernet address:
1732 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001733 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001734 CONFIG_ETH2ADDR
1735 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001736 CONFIG_ETH4ADDR
1737 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001738
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001739 Define a default value for Ethernet address to use
1740 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001741 is not determined automatically.
1742
1743- IP address:
1744 CONFIG_IPADDR
1745
1746 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001747 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001748 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001749 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001750
1751- Server IP address:
1752 CONFIG_SERVERIP
1753
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001754 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001755 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001756 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001757
Robin Getz470a6d42009-07-21 12:15:28 -04001758 CONFIG_KEEP_SERVERADDR
1759
1760 Keeps the server's MAC address, in the env 'serveraddr'
1761 for passing to bootargs (like Linux's netconsole option)
1762
Wolfgang Denk26da2992011-10-26 10:21:22 +00001763- Gateway IP address:
1764 CONFIG_GATEWAYIP
1765
1766 Defines a default value for the IP address of the
1767 default router where packets to other networks are
1768 sent to.
1769 (Environment variable "gatewayip")
1770
1771- Subnet mask:
1772 CONFIG_NETMASK
1773
1774 Defines a default value for the subnet mask (or
1775 routing prefix) which is used to determine if an IP
1776 address belongs to the local subnet or needs to be
1777 forwarded through a router.
1778 (Environment variable "netmask")
1779
David Updegraff7280da72007-06-11 10:41:07 -05001780- Multicast TFTP Mode:
1781 CONFIG_MCAST_TFTP
1782
1783 Defines whether you want to support multicast TFTP as per
1784 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001785 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001786 driver in use must provide a function: mcast() to join/leave a
1787 multicast group.
1788
wdenkc6097192002-11-03 00:24:07 +00001789- BOOTP Recovery Mode:
1790 CONFIG_BOOTP_RANDOM_DELAY
1791
1792 If you have many targets in a network that try to
1793 boot using BOOTP, you may want to avoid that all
1794 systems send out BOOTP requests at precisely the same
1795 moment (which would happen for instance at recovery
1796 from a power failure, when all systems will try to
1797 boot, thus flooding the BOOTP server. Defining
1798 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1799 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001800 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001801
1802 1st BOOTP request: delay 0 ... 1 sec
1803 2nd BOOTP request: delay 0 ... 2 sec
1804 3rd BOOTP request: delay 0 ... 4 sec
1805 4th and following
1806 BOOTP requests: delay 0 ... 8 sec
1807
stroesee0aadfb2003-08-28 14:17:32 +00001808- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001809 You can fine tune the DHCP functionality by defining
1810 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001811
Jon Loeliger5336a762007-07-09 22:08:34 -05001812 CONFIG_BOOTP_SUBNETMASK
1813 CONFIG_BOOTP_GATEWAY
1814 CONFIG_BOOTP_HOSTNAME
1815 CONFIG_BOOTP_NISDOMAIN
1816 CONFIG_BOOTP_BOOTPATH
1817 CONFIG_BOOTP_BOOTFILESIZE
1818 CONFIG_BOOTP_DNS
1819 CONFIG_BOOTP_DNS2
1820 CONFIG_BOOTP_SEND_HOSTNAME
1821 CONFIG_BOOTP_NTPSERVER
1822 CONFIG_BOOTP_TIMEOFFSET
1823 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001824 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001825
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001826 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1827 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001828
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001829 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1830 after the configured retry count, the call will fail
1831 instead of starting over. This can be used to fail over
1832 to Link-local IP address configuration if the DHCP server
1833 is not available.
1834
stroesee0aadfb2003-08-28 14:17:32 +00001835 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1836 serverip from a DHCP server, it is possible that more
1837 than one DNS serverip is offered to the client.
1838 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1839 serverip will be stored in the additional environment
1840 variable "dnsip2". The first DNS serverip is always
1841 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001842 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001843
1844 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1845 to do a dynamic update of a DNS server. To do this, they
1846 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001847 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001848 of the "hostname" environment variable is passed as
1849 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001850
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001851 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1852
1853 A 32bit value in microseconds for a delay between
1854 receiving a "DHCP Offer" and sending the "DHCP Request".
1855 This fixes a problem with certain DHCP servers that don't
1856 respond 100% of the time to a "DHCP request". E.g. On an
1857 AT91RM9200 processor running at 180MHz, this delay needed
1858 to be *at least* 15,000 usec before a Windows Server 2003
1859 DHCP server would reply 100% of the time. I recommend at
1860 least 50,000 usec to be safe. The alternative is to hope
1861 that one of the retries will be successful but note that
1862 the DHCP timeout and retry process takes a longer than
1863 this delay.
1864
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001865 - Link-local IP address negotiation:
1866 Negotiate with other link-local clients on the local network
1867 for an address that doesn't require explicit configuration.
1868 This is especially useful if a DHCP server cannot be guaranteed
1869 to exist in all environments that the device must operate.
1870
1871 See doc/README.link-local for more information.
1872
wdenk145d2c12004-04-15 21:48:45 +00001873 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001874 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001875
1876 The device id used in CDP trigger frames.
1877
1878 CONFIG_CDP_DEVICE_ID_PREFIX
1879
1880 A two character string which is prefixed to the MAC address
1881 of the device.
1882
1883 CONFIG_CDP_PORT_ID
1884
1885 A printf format string which contains the ascii name of
1886 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001887 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001888
1889 CONFIG_CDP_CAPABILITIES
1890
1891 A 32bit integer which indicates the device capabilities;
1892 0x00000010 for a normal host which does not forwards.
1893
1894 CONFIG_CDP_VERSION
1895
1896 An ascii string containing the version of the software.
1897
1898 CONFIG_CDP_PLATFORM
1899
1900 An ascii string containing the name of the platform.
1901
1902 CONFIG_CDP_TRIGGER
1903
1904 A 32bit integer sent on the trigger.
1905
1906 CONFIG_CDP_POWER_CONSUMPTION
1907
1908 A 16bit integer containing the power consumption of the
1909 device in .1 of milliwatts.
1910
1911 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1912
1913 A byte containing the id of the VLAN.
1914
wdenkc6097192002-11-03 00:24:07 +00001915- Status LED: CONFIG_STATUS_LED
1916
1917 Several configurations allow to display the current
1918 status using a LED. For instance, the LED will blink
1919 fast while running U-Boot code, stop blinking as
1920 soon as a reply to a BOOTP request was received, and
1921 start blinking slow once the Linux kernel is running
1922 (supported by a status LED driver in the Linux
1923 kernel). Defining CONFIG_STATUS_LED enables this
1924 feature in U-Boot.
1925
1926- CAN Support: CONFIG_CAN_DRIVER
1927
1928 Defining CONFIG_CAN_DRIVER enables CAN driver support
1929 on those systems that support this (optional)
1930 feature, like the TQM8xxL modules.
1931
1932- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1933
wdenkb9bbd242003-06-30 16:24:52 +00001934 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001935 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001936 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001937
wdenk21136db2003-07-16 21:53:01 +00001938 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001939 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001940 CONFIG_COMMANDS) and communicate with i2c based realtime
1941 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001942 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001943
Ben Warren45657152006-09-07 16:50:54 -04001944 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001945
wdenk21136db2003-07-16 21:53:01 +00001946 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001947 bit-banging) driver instead of CPM or similar hardware
1948 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001949
wdenk21136db2003-07-16 21:53:01 +00001950 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001951 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001952
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001953 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001954 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001955 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001956 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001957
Peter Tysere4d1abc2010-04-12 22:28:21 -05001958 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001959 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001960 and so its address should therefore be cleared to 0 (See,
1961 eg, MPC823e User's Manual p.16-473). So, set
1962 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001963
Eric Millbrandt12990a42009-09-03 08:09:44 -05001964 CONFIG_SYS_I2C_INIT_MPC5XXX
1965
1966 When a board is reset during an i2c bus transfer
1967 chips might think that the current transfer is still
1968 in progress. Reset the slave devices by sending start
1969 commands until the slave device responds.
1970
wdenk21136db2003-07-16 21:53:01 +00001971 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001972
wdenkb9bbd242003-06-30 16:24:52 +00001973 If you use the software i2c interface (CONFIG_SOFT_I2C)
1974 then the following macros need to be defined (examples are
1975 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001976
1977 I2C_INIT
1978
wdenkb9bbd242003-06-30 16:24:52 +00001979 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001980 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001981
wdenk544e9732004-02-06 23:19:44 +00001982 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001983
wdenkc6097192002-11-03 00:24:07 +00001984 I2C_PORT
1985
wdenk4a5c8a72003-03-06 00:02:04 +00001986 (Only for MPC8260 CPU). The I/O port to use (the code
1987 assumes both bits are on the same port). Valid values
1988 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001989
1990 I2C_ACTIVE
1991
1992 The code necessary to make the I2C data line active
1993 (driven). If the data line is open collector, this
1994 define can be null.
1995
wdenkb9bbd242003-06-30 16:24:52 +00001996 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1997
wdenkc6097192002-11-03 00:24:07 +00001998 I2C_TRISTATE
1999
2000 The code necessary to make the I2C data line tri-stated
2001 (inactive). If the data line is open collector, this
2002 define can be null.
2003
wdenkb9bbd242003-06-30 16:24:52 +00002004 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2005
wdenkc6097192002-11-03 00:24:07 +00002006 I2C_READ
2007
York Sun4a598092013-04-01 11:29:11 -07002008 Code that returns true if the I2C data line is high,
2009 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002010
wdenkb9bbd242003-06-30 16:24:52 +00002011 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2012
wdenkc6097192002-11-03 00:24:07 +00002013 I2C_SDA(bit)
2014
York Sun4a598092013-04-01 11:29:11 -07002015 If <bit> is true, sets the I2C data line high. If it
2016 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002017
wdenkb9bbd242003-06-30 16:24:52 +00002018 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002019 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002020 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002021
wdenkc6097192002-11-03 00:24:07 +00002022 I2C_SCL(bit)
2023
York Sun4a598092013-04-01 11:29:11 -07002024 If <bit> is true, sets the I2C clock line high. If it
2025 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002026
wdenkb9bbd242003-06-30 16:24:52 +00002027 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002028 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002029 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002030
wdenkc6097192002-11-03 00:24:07 +00002031 I2C_DELAY
2032
2033 This delay is invoked four times per clock cycle so this
2034 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002035 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002036 like:
2037
wdenkb9bbd242003-06-30 16:24:52 +00002038 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002039
Mike Frysingeree12d542010-07-21 13:38:02 -04002040 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2041
2042 If your arch supports the generic GPIO framework (asm/gpio.h),
2043 then you may alternatively define the two GPIOs that are to be
2044 used as SCL / SDA. Any of the previous I2C_xxx macros will
2045 have GPIO-based defaults assigned to them as appropriate.
2046
2047 You should define these to the GPIO value as given directly to
2048 the generic GPIO functions.
2049
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002050 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002051
wdenk57b2d802003-06-27 21:31:46 +00002052 When a board is reset during an i2c bus transfer
2053 chips might think that the current transfer is still
2054 in progress. On some boards it is possible to access
2055 the i2c SCLK line directly, either by using the
2056 processor pin as a GPIO or by having a second pin
2057 connected to the bus. If this option is defined a
2058 custom i2c_init_board() routine in boards/xxx/board.c
2059 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002060
Richard Retanubundf0149c2010-04-12 15:08:17 -04002061 CONFIG_SYS_I2C_BOARD_LATE_INIT
2062
2063 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2064 defined a custom i2c_board_late_init() routine in
2065 boards/xxx/board.c is run AFTER the operations in i2c_init()
2066 is completed. This callpoint can be used to unreset i2c bus
2067 using CPU i2c controller register accesses for CPUs whose i2c
2068 controller provide such a method. It is called at the end of
2069 i2c_init() to allow i2c_init operations to setup the i2c bus
2070 controller on the CPU (e.g. setting bus speed & slave address).
2071
wdenk0e2bd9c2004-06-06 21:51:03 +00002072 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2073
2074 This option enables configuration of bi_iic_fast[] flags
2075 in u-boot bd_info structure based on u-boot environment
2076 variable "i2cfast". (see also i2cfast)
2077
Ben Warren45657152006-09-07 16:50:54 -04002078 CONFIG_I2C_MULTI_BUS
2079
2080 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002081 must have a controller. At any point in time, only one bus is
2082 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002083 Note that bus numbering is zero-based.
2084
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002085 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002086
2087 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002088 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002089 is set, specify a list of bus-device pairs. Otherwise, specify
2090 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002091
2092 e.g.
2093 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002094 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002095
2096 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2097
Wolfgang Denk092ae952011-10-26 10:21:21 +00002098 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002099 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002100
2101 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2102
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002103 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002104
2105 If defined, then this indicates the I2C bus number for DDR SPD.
2106 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2107
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002108 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002109
2110 If defined, then this indicates the I2C bus number for the RTC.
2111 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2112
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002113 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002114
2115 If defined, then this indicates the I2C bus number for the DTT.
2116 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2117
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002118 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002119
2120 If defined, specifies the I2C address of the DTT device.
2121 If not defined, then U-Boot uses predefined value for
2122 specified DTT device.
2123
Timur Tabiab347542006-11-03 19:15:00 -06002124 CONFIG_FSL_I2C
2125
2126 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01002127 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06002128
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002129 CONFIG_I2C_MUX
2130
2131 Define this option if you have I2C devices reached over 1 .. n
2132 I2C Muxes like the pca9544a. This option addes a new I2C
2133 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2134 new I2C Bus to the existing I2C Busses. If you select the
2135 new Bus with "i2c dev", u-bbot sends first the commandos for
2136 the muxes to activate this new "bus".
2137
2138 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2139 feature!
2140
2141 Example:
2142 Adding a new I2C Bus reached over 2 pca9544a muxes
2143 The First mux with address 70 and channel 6
2144 The Second mux with address 71 and channel 4
2145
2146 => i2c bus pca9544a:70:6:pca9544a:71:4
2147
2148 Use the "i2c bus" command without parameter, to get a list
2149 of I2C Busses with muxes:
2150
2151 => i2c bus
2152 Busses reached over muxes:
2153 Bus ID: 2
2154 reached over Mux(es):
2155 pca9544a@70 ch: 4
2156 Bus ID: 3
2157 reached over Mux(es):
2158 pca9544a@70 ch: 6
2159 pca9544a@71 ch: 4
2160 =>
2161
2162 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002163 u-boot first sends the command to the mux@70 to enable
2164 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002165 the channel 4.
2166
2167 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002168 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002169 the 2 muxes.
2170
2171 This option is actually implemented for the bitbanging
2172 algorithm in common/soft_i2c.c and for the Hardware I2C
2173 Bus on the MPC8260. But it should be not so difficult
2174 to add this option to other architectures.
2175
Andrew Dyer58c41f92008-12-29 17:36:01 -06002176 CONFIG_SOFT_I2C_READ_REPEATED_START
2177
2178 defining this will force the i2c_read() function in
2179 the soft_i2c driver to perform an I2C repeated start
2180 between writing the address pointer and reading the
2181 data. If this define is omitted the default behaviour
2182 of doing a stop-start sequence will be used. Most I2C
2183 devices can use either method, but some require one or
2184 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002185
wdenkc6097192002-11-03 00:24:07 +00002186- SPI Support: CONFIG_SPI
2187
2188 Enables SPI driver (so far only tested with
2189 SPI EEPROM, also an instance works with Crystal A/D and
2190 D/As on the SACSng board)
2191
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002192 CONFIG_SH_SPI
2193
2194 Enables the driver for SPI controller on SuperH. Currently
2195 only SH7757 is supported.
2196
wdenkc6097192002-11-03 00:24:07 +00002197 CONFIG_SPI_X
2198
2199 Enables extended (16-bit) SPI EEPROM addressing.
2200 (symmetrical to CONFIG_I2C_X)
2201
2202 CONFIG_SOFT_SPI
2203
wdenk4a5c8a72003-03-06 00:02:04 +00002204 Enables a software (bit-bang) SPI driver rather than
2205 using hardware support. This is a general purpose
2206 driver that only requires three general I/O port pins
2207 (two outputs, one input) to function. If this is
2208 defined, the board configuration must define several
2209 SPI configuration items (port pins to use, etc). For
2210 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002211
Ben Warren7efe9272008-01-16 22:37:35 -05002212 CONFIG_HARD_SPI
2213
2214 Enables a hardware SPI driver for general-purpose reads
2215 and writes. As with CONFIG_SOFT_SPI, the board configuration
2216 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002217 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002218 example, see include/configs/mpc8349emds.h.
2219
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002220 CONFIG_MXC_SPI
2221
2222 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002223 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002224
Matthias Fuchsa4400872007-12-27 17:12:34 +01002225- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002226
Matthias Fuchsa4400872007-12-27 17:12:34 +01002227 Enables FPGA subsystem.
2228
2229 CONFIG_FPGA_<vendor>
2230
2231 Enables support for specific chip vendors.
2232 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002233
Matthias Fuchsa4400872007-12-27 17:12:34 +01002234 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002235
Matthias Fuchsa4400872007-12-27 17:12:34 +01002236 Enables support for FPGA family.
2237 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2238
2239 CONFIG_FPGA_COUNT
2240
2241 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002242
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002243 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002244
wdenk57b2d802003-06-27 21:31:46 +00002245 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002246
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002247 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002248
wdenk4a5c8a72003-03-06 00:02:04 +00002249 Enable checks on FPGA configuration interface busy
2250 status by the configuration function. This option
2251 will require a board or device specific function to
2252 be written.
wdenkc6097192002-11-03 00:24:07 +00002253
2254 CONFIG_FPGA_DELAY
2255
2256 If defined, a function that provides delays in the FPGA
2257 configuration driver.
2258
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002259 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002260 Allow Control-C to interrupt FPGA configuration
2261
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002262 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002263
wdenk4a5c8a72003-03-06 00:02:04 +00002264 Check for configuration errors during FPGA bitfile
2265 loading. For example, abort during Virtex II
2266 configuration if the INIT_B line goes low (which
2267 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002268
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002269 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002270
wdenk4a5c8a72003-03-06 00:02:04 +00002271 Maximum time to wait for the INIT_B line to deassert
2272 after PROB_B has been deasserted during a Virtex II
2273 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002274 ms.
wdenkc6097192002-11-03 00:24:07 +00002275
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002276 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002277
wdenk4a5c8a72003-03-06 00:02:04 +00002278 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002279 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002281 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002282
wdenk4a5c8a72003-03-06 00:02:04 +00002283 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002284 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002285
2286- Configuration Management:
2287 CONFIG_IDENT_STRING
2288
wdenk4a5c8a72003-03-06 00:02:04 +00002289 If defined, this string will be added to the U-Boot
2290 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002291
2292- Vendor Parameter Protection:
2293
wdenk4a5c8a72003-03-06 00:02:04 +00002294 U-Boot considers the values of the environment
2295 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002296 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002297 are set once by the board vendor / manufacturer, and
2298 protects these variables from casual modification by
2299 the user. Once set, these variables are read-only,
2300 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002301 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002302
2303 If CONFIG_ENV_OVERWRITE is #defined in your config
2304 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002305 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002306 these parameters.
2307
2308 Alternatively, if you #define _both_ CONFIG_ETHADDR
2309 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002310 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002311 which can be changed exactly ONCE by the user. [The
2312 serial# is unaffected by this, i. e. it remains
2313 read-only.]
2314
Joe Hershberger71497d02012-12-11 22:16:31 -06002315 The same can be accomplished in a more flexible way
2316 for any variable by configuring the type of access
2317 to allow for those variables in the ".flags" variable
2318 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2319
wdenkc6097192002-11-03 00:24:07 +00002320- Protected RAM:
2321 CONFIG_PRAM
2322
2323 Define this variable to enable the reservation of
2324 "protected RAM", i. e. RAM which is not overwritten
2325 by U-Boot. Define CONFIG_PRAM to hold the number of
2326 kB you want to reserve for pRAM. You can overwrite
2327 this default value by defining an environment
2328 variable "pram" to the number of kB you want to
2329 reserve. Note that the board info structure will
2330 still show the full amount of RAM. If pRAM is
2331 reserved, a new environment variable "mem" will
2332 automatically be defined to hold the amount of
2333 remaining RAM in a form that can be passed as boot
2334 argument to Linux, for instance like that:
2335
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002336 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002337 saveenv
2338
2339 This way you can tell Linux not to use this memory,
2340 either, which results in a memory region that will
2341 not be affected by reboots.
2342
2343 *WARNING* If your board configuration uses automatic
2344 detection of the RAM size, you must make sure that
2345 this memory test is non-destructive. So far, the
2346 following board configurations are known to be
2347 "pRAM-clean":
2348
Wolfgang Denk90326762012-10-24 02:36:15 +00002349 IVMS8, IVML24, SPD8xx, TQM8xxL,
2350 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002351 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002352
Gabe Blacka2f3a932012-12-02 04:55:18 +00002353- Access to physical memory region (> 4GB)
2354 Some basic support is provided for operations on memory not
2355 normally accessible to U-Boot - e.g. some architectures
2356 support access to more than 4GB of memory on 32-bit
2357 machines using physical address extension or similar.
2358 Define CONFIG_PHYSMEM to access this basic support, which
2359 currently only supports clearing the memory.
2360
wdenkc6097192002-11-03 00:24:07 +00002361- Error Recovery:
2362 CONFIG_PANIC_HANG
2363
2364 Define this variable to stop the system in case of a
2365 fatal error, so that you have to reset it manually.
2366 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002367 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002368 automatically as fast as possible, but it may be
2369 useful during development since you can try to debug
2370 the conditions that lead to the situation.
2371
2372 CONFIG_NET_RETRY_COUNT
2373
wdenk4a5c8a72003-03-06 00:02:04 +00002374 This variable defines the number of retries for
2375 network operations like ARP, RARP, TFTP, or BOOTP
2376 before giving up the operation. If not defined, a
2377 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002378
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002379 CONFIG_ARP_TIMEOUT
2380
2381 Timeout waiting for an ARP reply in milliseconds.
2382
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002383 CONFIG_NFS_TIMEOUT
2384
2385 Timeout in milliseconds used in NFS protocol.
2386 If you encounter "ERROR: Cannot umount" in nfs command,
2387 try longer timeout such as
2388 #define CONFIG_NFS_TIMEOUT 10000UL
2389
wdenkc6097192002-11-03 00:24:07 +00002390- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002391 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002392
2393 Enable auto completion of commands using TAB.
2394
Wolfgang Denk018147d2006-11-27 15:32:42 +01002395 Note that this feature has NOT been implemented yet
2396 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002397
2398
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002399 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002400
2401 Define this variable to enable the "hush" shell (from
2402 Busybox) as command line interpreter, thus enabling
2403 powerful command line syntax like
2404 if...then...else...fi conditionals or `&&' and '||'
2405 constructs ("shell scripts").
2406
2407 If undefined, you get the old, much simpler behaviour
2408 with a somewhat smaller memory footprint.
2409
2410
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002411 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002412
2413 This defines the secondary prompt string, which is
2414 printed when the command interpreter needs more input
2415 to complete a command. Usually "> ".
2416
2417 Note:
2418
wdenk57b2d802003-06-27 21:31:46 +00002419 In the current implementation, the local variables
2420 space and global environment variables space are
2421 separated. Local variables are those you define by
2422 simply typing `name=value'. To access a local
2423 variable later on, you have write `$name' or
2424 `${name}'; to execute the contents of a variable
2425 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002426
wdenk4a5c8a72003-03-06 00:02:04 +00002427 Global environment variables are those you use
2428 setenv/printenv to work with. To run a command stored
2429 in such a variable, you need to use the run command,
2430 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002431
2432 To store commands and special characters in a
2433 variable, please use double quotation marks
2434 surrounding the whole text of the variable, instead
2435 of the backslashes before semicolons and special
2436 symbols.
2437
Wolfgang Denk2039a072006-07-21 11:35:21 +02002438- Commandline Editing and History:
2439 CONFIG_CMDLINE_EDITING
2440
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002441 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002442 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002443
wdenkc0aa5c52003-12-06 19:49:23 +00002444- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002445 CONFIG_EXTRA_ENV_SETTINGS
2446
wdenk4a5c8a72003-03-06 00:02:04 +00002447 Define this to contain any number of null terminated
2448 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002449 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002450
wdenk4a5c8a72003-03-06 00:02:04 +00002451 For example, place something like this in your
2452 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002453
2454 #define CONFIG_EXTRA_ENV_SETTINGS \
2455 "myvar1=value1\0" \
2456 "myvar2=value2\0"
2457
wdenk4a5c8a72003-03-06 00:02:04 +00002458 Warning: This method is based on knowledge about the
2459 internal format how the environment is stored by the
2460 U-Boot code. This is NOT an official, exported
2461 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002462 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002463 You better know what you are doing here.
2464
wdenk4a5c8a72003-03-06 00:02:04 +00002465 Note: overly (ab)use of the default environment is
2466 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002467 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002468 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002469
Stephen Warren1465d5f2012-05-22 09:21:54 +00002470 CONFIG_ENV_VARS_UBOOT_CONFIG
2471
2472 Define this in order to add variables describing the
2473 U-Boot build configuration to the default environment.
2474 These will be named arch, cpu, board, vendor, and soc.
2475
2476 Enabling this option will cause the following to be defined:
2477
2478 - CONFIG_SYS_ARCH
2479 - CONFIG_SYS_CPU
2480 - CONFIG_SYS_BOARD
2481 - CONFIG_SYS_VENDOR
2482 - CONFIG_SYS_SOC
2483
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002484 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2485
2486 Define this in order to add variables describing certain
2487 run-time determined information about the hardware to the
2488 environment. These will be named board_name, board_rev.
2489
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002490 CONFIG_DELAY_ENVIRONMENT
2491
2492 Normally the environment is loaded when the board is
2493 intialised so that it is available to U-Boot. This inhibits
2494 that so that the environment is not available until
2495 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2496 this is instead controlled by the value of
2497 /config/load-environment.
2498
wdenkc0aa5c52003-12-06 19:49:23 +00002499- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002500 CONFIG_HAS_DATAFLASH
2501
wdenk57b2d802003-06-27 21:31:46 +00002502 Defining this option enables DataFlash features and
2503 allows to read/write in Dataflash via the standard
2504 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002505
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002506- Serial Flash support
2507 CONFIG_CMD_SF
2508
2509 Defining this option enables SPI flash commands
2510 'sf probe/read/write/erase/update'.
2511
2512 Usage requires an initial 'probe' to define the serial
2513 flash parameters, followed by read/write/erase/update
2514 commands.
2515
2516 The following defaults may be provided by the platform
2517 to handle the common case when only a single serial
2518 flash is present on the system.
2519
2520 CONFIG_SF_DEFAULT_BUS Bus identifier
2521 CONFIG_SF_DEFAULT_CS Chip-select
2522 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2523 CONFIG_SF_DEFAULT_SPEED in Hz
2524
Simon Glass4b5545e2012-10-08 13:16:02 +00002525 CONFIG_CMD_SF_TEST
2526
2527 Define this option to include a destructive SPI flash
2528 test ('sf test').
2529
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05302530 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2531
2532 Define this option to use the Bank addr/Extended addr
2533 support on SPI flashes which has size > 16Mbytes.
2534
wdenkef893942004-02-23 16:11:30 +00002535- SystemACE Support:
2536 CONFIG_SYSTEMACE
2537
2538 Adding this option adds support for Xilinx SystemACE
2539 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002540 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002541 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002542
2543 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002544 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002545
2546 When SystemACE support is added, the "ace" device type
2547 becomes available to the fat commands, i.e. fatls.
2548
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002549- TFTP Fixed UDP Port:
2550 CONFIG_TFTP_PORT
2551
Wolfgang Denk227b5192005-09-24 23:25:46 +02002552 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002553 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002554 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002555 number generator is used.
2556
Wolfgang Denk227b5192005-09-24 23:25:46 +02002557 Also, the environment variable tftpdstp is used to supply
2558 the TFTP UDP destination port value. If tftpdstp isn't
2559 defined, the normal port 69 is used.
2560
2561 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002562 blindly start the TFTP transfer using the pre-configured
2563 target IP address and UDP port. This has the effect of
2564 "punching through" the (Windows XP) firewall, allowing
2565 the remainder of the TFTP transfer to proceed normally.
2566 A better solution is to properly configure the firewall,
2567 but sometimes that is not allowed.
2568
Simon Glass058bb8d2012-12-05 14:46:38 +00002569- Hashing support:
2570 CONFIG_CMD_HASH
2571
2572 This enables a generic 'hash' command which can produce
2573 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2574
2575 CONFIG_HASH_VERIFY
2576
2577 Enable the hash verify command (hash -v). This adds to code
2578 size a little.
2579
2580 CONFIG_SHA1 - support SHA1 hashing
2581 CONFIG_SHA256 - support SHA256 hashing
2582
2583 Note: There is also a sha1sum command, which should perhaps
2584 be deprecated in favour of 'hash sha1'.
2585
Simon Glass35191a32013-06-13 15:10:02 -07002586- Signing support:
2587 CONFIG_RSA
2588
2589 This enables the RSA algorithm used for FIT image verification
2590 in U-Boot. See doc/uImage/signature for more information.
2591
2592 The signing part is build into mkimage regardless of this
2593 option.
2594
2595
wdenkc0aa5c52003-12-06 19:49:23 +00002596- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002597 CONFIG_SHOW_BOOT_PROGRESS
2598
wdenk4a5c8a72003-03-06 00:02:04 +00002599 Defining this option allows to add some board-
2600 specific code (calling a user-provided function
2601 "show_boot_progress(int)") that enables you to show
2602 the system's boot progress on some display (for
2603 example, some LED's) on your board. At the moment,
2604 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002605
Simon Glass31a870e2012-02-13 13:51:19 +00002606- Detailed boot stage timing
2607 CONFIG_BOOTSTAGE
2608 Define this option to get detailed timing of each stage
2609 of the boot process.
2610
2611 CONFIG_BOOTSTAGE_USER_COUNT
2612 This is the number of available user bootstage records.
2613 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2614 a new ID will be allocated from this stash. If you exceed
2615 the limit, recording will stop.
2616
2617 CONFIG_BOOTSTAGE_REPORT
2618 Define this to print a report before boot, similar to this:
2619
2620 Timer summary in microseconds:
2621 Mark Elapsed Stage
2622 0 0 reset
2623 3,575,678 3,575,678 board_init_f start
2624 3,575,695 17 arch_cpu_init A9
2625 3,575,777 82 arch_cpu_init done
2626 3,659,598 83,821 board_init_r start
2627 3,910,375 250,777 main_loop
2628 29,916,167 26,005,792 bootm_start
2629 30,361,327 445,160 start_kernel
2630
Simon Glass4afd88e2012-09-28 08:56:39 +00002631 CONFIG_CMD_BOOTSTAGE
2632 Add a 'bootstage' command which supports printing a report
2633 and un/stashing of bootstage data.
2634
Simon Glass0fa36a42012-09-28 08:56:37 +00002635 CONFIG_BOOTSTAGE_FDT
2636 Stash the bootstage information in the FDT. A root 'bootstage'
2637 node is created with each bootstage id as a child. Each child
2638 has a 'name' property and either 'mark' containing the
2639 mark time in microsecond, or 'accum' containing the
2640 accumulated time for that bootstage id in microseconds.
2641 For example:
2642
2643 bootstage {
2644 154 {
2645 name = "board_init_f";
2646 mark = <3575678>;
2647 };
2648 170 {
2649 name = "lcd";
2650 accum = <33482>;
2651 };
2652 };
2653
2654 Code in the Linux kernel can find this in /proc/devicetree.
2655
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002656Legacy uImage format:
2657
wdenkc6097192002-11-03 00:24:07 +00002658 Arg Where When
2659 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002660 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002661 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002662 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002663 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002664 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002665 4 common/cmd_bootm.c Image data has correct checksum
2666 -4 common/cmd_bootm.c Image is for unsupported architecture
2667 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002668 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002669 6 common/cmd_bootm.c Image Type check OK
2670 -6 common/cmd_bootm.c gunzip uncompression error
2671 -7 common/cmd_bootm.c Unimplemented compression type
2672 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002673 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002674 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002675
2676 9 common/image.c Start initial ramdisk verification
2677 -10 common/image.c Ramdisk header has bad magic number
2678 -11 common/image.c Ramdisk header has bad checksum
2679 10 common/image.c Ramdisk header is OK
2680 -12 common/image.c Ramdisk data has bad checksum
2681 11 common/image.c Ramdisk data has correct checksum
2682 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002683 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002684 13 common/image.c Start multifile image verification
2685 14 common/image.c No initial ramdisk, no multifile, continue.
2686
Wolfgang Denk092ae952011-10-26 10:21:21 +00002687 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002688
Stefan Roese88fbf932010-04-15 16:07:28 +02002689 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002690 -31 post/post.c POST test failed, detected by post_output_backlog()
2691 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002692
Heiko Schocher633e03a2007-06-22 19:11:54 +02002693 34 common/cmd_doc.c before loading a Image from a DOC device
2694 -35 common/cmd_doc.c Bad usage of "doc" command
2695 35 common/cmd_doc.c correct usage of "doc" command
2696 -36 common/cmd_doc.c No boot device
2697 36 common/cmd_doc.c correct boot device
2698 -37 common/cmd_doc.c Unknown Chip ID on boot device
2699 37 common/cmd_doc.c correct chip ID found, device available
2700 -38 common/cmd_doc.c Read Error on boot device
2701 38 common/cmd_doc.c reading Image header from DOC device OK
2702 -39 common/cmd_doc.c Image header has bad magic number
2703 39 common/cmd_doc.c Image header has correct magic number
2704 -40 common/cmd_doc.c Error reading Image from DOC device
2705 40 common/cmd_doc.c Image header has correct magic number
2706 41 common/cmd_ide.c before loading a Image from a IDE device
2707 -42 common/cmd_ide.c Bad usage of "ide" command
2708 42 common/cmd_ide.c correct usage of "ide" command
2709 -43 common/cmd_ide.c No boot device
2710 43 common/cmd_ide.c boot device found
2711 -44 common/cmd_ide.c Device not available
2712 44 common/cmd_ide.c Device available
2713 -45 common/cmd_ide.c wrong partition selected
2714 45 common/cmd_ide.c partition selected
2715 -46 common/cmd_ide.c Unknown partition table
2716 46 common/cmd_ide.c valid partition table found
2717 -47 common/cmd_ide.c Invalid partition type
2718 47 common/cmd_ide.c correct partition type
2719 -48 common/cmd_ide.c Error reading Image Header on boot device
2720 48 common/cmd_ide.c reading Image Header from IDE device OK
2721 -49 common/cmd_ide.c Image header has bad magic number
2722 49 common/cmd_ide.c Image header has correct magic number
2723 -50 common/cmd_ide.c Image header has bad checksum
2724 50 common/cmd_ide.c Image header has correct checksum
2725 -51 common/cmd_ide.c Error reading Image from IDE device
2726 51 common/cmd_ide.c reading Image from IDE device OK
2727 52 common/cmd_nand.c before loading a Image from a NAND device
2728 -53 common/cmd_nand.c Bad usage of "nand" command
2729 53 common/cmd_nand.c correct usage of "nand" command
2730 -54 common/cmd_nand.c No boot device
2731 54 common/cmd_nand.c boot device found
2732 -55 common/cmd_nand.c Unknown Chip ID on boot device
2733 55 common/cmd_nand.c correct chip ID found, device available
2734 -56 common/cmd_nand.c Error reading Image Header on boot device
2735 56 common/cmd_nand.c reading Image Header from NAND device OK
2736 -57 common/cmd_nand.c Image header has bad magic number
2737 57 common/cmd_nand.c Image header has correct magic number
2738 -58 common/cmd_nand.c Error reading Image from NAND device
2739 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002740
Heiko Schocher633e03a2007-06-22 19:11:54 +02002741 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002742
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002743 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002744 -64 net/eth.c no Ethernet found.
2745 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002746
Heiko Schocher633e03a2007-06-22 19:11:54 +02002747 -80 common/cmd_net.c usage wrong
2748 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002749 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002750 81 common/cmd_net.c NetLoop() back without error
2751 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2752 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002753 83 common/cmd_net.c running "source" command
2754 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002755 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002756
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002757FIT uImage format:
2758
2759 Arg Where When
2760 100 common/cmd_bootm.c Kernel FIT Image has correct format
2761 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2762 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2763 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2764 102 common/cmd_bootm.c Kernel unit name specified
2765 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002766 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002767 104 common/cmd_bootm.c Got kernel subimage node offset
2768 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2769 105 common/cmd_bootm.c Kernel subimage hash verification OK
2770 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2771 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002772 -106 common/cmd_bootm.c Kernel subimage has wrong type
2773 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002774 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2775 108 common/cmd_bootm.c Got kernel subimage data/size
2776 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2777 -109 common/cmd_bootm.c Can't get kernel subimage type
2778 -110 common/cmd_bootm.c Can't get kernel subimage comp
2779 -111 common/cmd_bootm.c Can't get kernel subimage os
2780 -112 common/cmd_bootm.c Can't get kernel subimage load address
2781 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2782
2783 120 common/image.c Start initial ramdisk verification
2784 -120 common/image.c Ramdisk FIT image has incorrect format
2785 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002786 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002787 -122 common/image.c Can't get configuration for ramdisk subimage
2788 123 common/image.c Ramdisk unit name specified
2789 -124 common/image.c Can't get ramdisk subimage node offset
2790 125 common/image.c Got ramdisk subimage node offset
2791 -125 common/image.c Ramdisk subimage hash verification failed
2792 126 common/image.c Ramdisk subimage hash verification OK
2793 -126 common/image.c Ramdisk subimage for unsupported architecture
2794 127 common/image.c Architecture check OK
2795 -127 common/image.c Can't get ramdisk subimage data/size
2796 128 common/image.c Got ramdisk subimage data/size
2797 129 common/image.c Can't get ramdisk load address
2798 -129 common/image.c Got ramdisk load address
2799
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002800 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002801 131 common/cmd_doc.c FIT image format OK
2802
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002803 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002804 141 common/cmd_ide.c FIT image format OK
2805
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002806 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002807 151 common/cmd_nand.c FIT image format OK
2808
Gabe Blackd572e162012-10-25 16:31:10 +00002809- FIT image support:
2810 CONFIG_FIT
2811 Enable support for the FIT uImage format.
2812
2813 CONFIG_FIT_BEST_MATCH
2814 When no configuration is explicitly selected, default to the
2815 one whose fdt's compatibility field best matches that of
2816 U-Boot itself. A match is considered "best" if it matches the
2817 most specific compatibility entry of U-Boot's fdt's root node.
2818 The order of entries in the configuration's fdt is ignored.
2819
Simon Glass58fe7e52013-06-13 15:10:00 -07002820 CONFIG_FIT_SIGNATURE
2821 This option enables signature verification of FIT uImages,
2822 using a hash signed and verified using RSA. See
2823 doc/uImage.FIT/signature.txt for more details.
2824
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002825- Standalone program support:
2826 CONFIG_STANDALONE_LOAD_ADDR
2827
Wolfgang Denk23f78482011-10-09 21:06:34 +02002828 This option defines a board specific value for the
2829 address where standalone program gets loaded, thus
2830 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002831 settings.
2832
2833- Frame Buffer Address:
2834 CONFIG_FB_ADDR
2835
2836 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002837 address for frame buffer. This is typically the case
2838 when using a graphics controller has separate video
2839 memory. U-Boot will then place the frame buffer at
2840 the given address instead of dynamically reserving it
2841 in system RAM by calling lcd_setmem(), which grabs
2842 the memory for the frame buffer depending on the
2843 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002844
2845 Please see board_init_f function.
2846
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002847- Automatic software updates via TFTP server
2848 CONFIG_UPDATE_TFTP
2849 CONFIG_UPDATE_TFTP_CNT_MAX
2850 CONFIG_UPDATE_TFTP_MSEC_MAX
2851
2852 These options enable and control the auto-update feature;
2853 for a more detailed description refer to doc/README.update.
2854
2855- MTD Support (mtdparts command, UBI support)
2856 CONFIG_MTD_DEVICE
2857
2858 Adds the MTD device infrastructure from the Linux kernel.
2859 Needed for mtdparts command support.
2860
2861 CONFIG_MTD_PARTITIONS
2862
2863 Adds the MTD partitioning infrastructure from the Linux
2864 kernel. Needed for UBI support.
2865
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002866- UBI support
2867 CONFIG_CMD_UBI
2868
2869 Adds commands for interacting with MTD partitions formatted
2870 with the UBI flash translation layer
2871
2872 Requires also defining CONFIG_RBTREE
2873
Joe Hershberger47550fc2013-04-08 10:32:49 +00002874 CONFIG_UBI_SILENCE_MSG
2875
2876 Make the verbose messages from UBI stop printing. This leaves
2877 warnings and errors enabled.
2878
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002879- UBIFS support
2880 CONFIG_CMD_UBIFS
2881
2882 Adds commands for interacting with UBI volumes formatted as
2883 UBIFS. UBIFS is read-only in u-boot.
2884
2885 Requires UBI support as well as CONFIG_LZO
2886
Joe Hershberger47550fc2013-04-08 10:32:49 +00002887 CONFIG_UBIFS_SILENCE_MSG
2888
2889 Make the verbose messages from UBIFS stop printing. This leaves
2890 warnings and errors enabled.
2891
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002892- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002893 CONFIG_SPL
2894 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002895
Tom Rini36853852012-02-14 07:29:40 +00002896 CONFIG_SPL_LDSCRIPT
2897 LDSCRIPT for linking the SPL binary.
2898
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002899 CONFIG_SPL_MAX_FOOTPRINT
2900 Maximum size in memory allocated to the SPL, BSS included.
2901 When defined, the linker checks that the actual memory
2902 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002903 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002904 must not be both defined at the same time.
2905
Tom Rini36853852012-02-14 07:29:40 +00002906 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002907 Maximum size of the SPL image (text, data, rodata, and
2908 linker lists sections), BSS excluded.
2909 When defined, the linker checks that the actual size does
2910 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002911
Wolfgang Denk825223d2011-09-11 21:24:09 +02002912 CONFIG_SPL_TEXT_BASE
2913 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002914
Scott Woodc4f0d002012-09-20 19:05:12 -05002915 CONFIG_SPL_RELOC_TEXT_BASE
2916 Address to relocate to. If unspecified, this is equal to
2917 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2918
Tom Rini36853852012-02-14 07:29:40 +00002919 CONFIG_SPL_BSS_START_ADDR
2920 Link address for the BSS within the SPL binary.
2921
2922 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002923 Maximum size in memory allocated to the SPL BSS.
2924 When defined, the linker checks that the actual memory used
2925 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002926 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002927 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002928
2929 CONFIG_SPL_STACK
2930 Adress of the start of the stack SPL will use
2931
Scott Woodc4f0d002012-09-20 19:05:12 -05002932 CONFIG_SPL_RELOC_STACK
2933 Adress of the start of the stack SPL will use after
2934 relocation. If unspecified, this is equal to
2935 CONFIG_SPL_STACK.
2936
Tom Rini36853852012-02-14 07:29:40 +00002937 CONFIG_SYS_SPL_MALLOC_START
2938 Starting address of the malloc pool used in SPL.
2939
2940 CONFIG_SYS_SPL_MALLOC_SIZE
2941 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002942
Tom Rini28591df2012-08-13 12:03:19 -07002943 CONFIG_SPL_FRAMEWORK
2944 Enable the SPL framework under common/. This framework
2945 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2946 NAND loading of the Linux Kernel.
2947
Tom Rinife3b0c72012-08-13 11:37:56 -07002948 CONFIG_SPL_DISPLAY_PRINT
2949 For ARM, enable an optional function to print more information
2950 about the running system.
2951
Scott Wood7c810902012-09-20 16:35:21 -05002952 CONFIG_SPL_INIT_MINIMAL
2953 Arch init code should be built for a very small image
2954
Wolfgang Denk825223d2011-09-11 21:24:09 +02002955 CONFIG_SPL_LIBCOMMON_SUPPORT
2956 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002957
Wolfgang Denk825223d2011-09-11 21:24:09 +02002958 CONFIG_SPL_LIBDISK_SUPPORT
2959 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002960
Wolfgang Denk825223d2011-09-11 21:24:09 +02002961 CONFIG_SPL_I2C_SUPPORT
2962 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002963
Wolfgang Denk825223d2011-09-11 21:24:09 +02002964 CONFIG_SPL_GPIO_SUPPORT
2965 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002966
Wolfgang Denk825223d2011-09-11 21:24:09 +02002967 CONFIG_SPL_MMC_SUPPORT
2968 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002969
Tom Rini36853852012-02-14 07:29:40 +00002970 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2971 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2972 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2973 Address, size and partition on the MMC to load U-Boot from
2974 when the MMC is being used in raw mode.
2975
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002976 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2977 Sector to load kernel uImage from when MMC is being
2978 used in raw mode (for Falcon mode)
2979
2980 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2981 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2982 Sector and number of sectors to load kernel argument
2983 parameters from when MMC is being used in raw mode
2984 (for falcon mode)
2985
Tom Rini36853852012-02-14 07:29:40 +00002986 CONFIG_SPL_FAT_SUPPORT
2987 Support for fs/fat/libfat.o in SPL binary
2988
2989 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2990 Filename to read to load U-Boot when reading from FAT
2991
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002992 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
2993 Filename to read to load kernel uImage when reading
2994 from FAT (for Falcon mode)
2995
2996 CONFIG_SPL_FAT_LOAD_ARGS_NAME
2997 Filename to read to load kernel argument parameters
2998 when reading from FAT (for Falcon mode)
2999
Scott Wood2b36fbb2012-12-06 13:33:17 +00003000 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3001 Set this for NAND SPL on PPC mpc83xx targets, so that
3002 start.S waits for the rest of the SPL to load before
3003 continuing (the hardware starts execution after just
3004 loading the first page rather than the full 4K).
3005
Scott Woodc352a0c2012-09-20 19:09:07 -05003006 CONFIG_SPL_NAND_BASE
3007 Include nand_base.c in the SPL. Requires
3008 CONFIG_SPL_NAND_DRIVERS.
3009
3010 CONFIG_SPL_NAND_DRIVERS
3011 SPL uses normal NAND drivers, not minimal drivers.
3012
3013 CONFIG_SPL_NAND_ECC
3014 Include standard software ECC in the SPL
3015
Tom Rini36853852012-02-14 07:29:40 +00003016 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003017 Support for NAND boot using simple NAND drivers that
3018 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003019
3020 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3021 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3022 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3023 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3024 CONFIG_SYS_NAND_ECCBYTES
3025 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003026 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003027
3028 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003029 Location in NAND to read U-Boot from
3030
3031 CONFIG_SYS_NAND_U_BOOT_DST
3032 Location in memory to load U-Boot to
3033
3034 CONFIG_SYS_NAND_U_BOOT_SIZE
3035 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003036
3037 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003038 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003039
3040 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3041 Define this if you need to first read the OOB and then the
3042 data. This is used for example on davinci plattforms.
3043
3044 CONFIG_SPL_OMAP3_ID_NAND
3045 Support for an OMAP3-specific set of functions to return the
3046 ID and MFR of the first attached NAND chip, if present.
3047
Wolfgang Denk825223d2011-09-11 21:24:09 +02003048 CONFIG_SPL_SERIAL_SUPPORT
3049 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003050
Wolfgang Denk825223d2011-09-11 21:24:09 +02003051 CONFIG_SPL_SPI_FLASH_SUPPORT
3052 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003053
Wolfgang Denk825223d2011-09-11 21:24:09 +02003054 CONFIG_SPL_SPI_SUPPORT
3055 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003056
Pavel Machekde997252012-08-30 22:42:11 +02003057 CONFIG_SPL_RAM_DEVICE
3058 Support for running image already present in ram, in SPL binary
3059
Wolfgang Denk825223d2011-09-11 21:24:09 +02003060 CONFIG_SPL_LIBGENERIC_SUPPORT
3061 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003062
Ying Zhang602f7d32013-05-20 14:07:25 +08003063 CONFIG_SPL_ENV_SUPPORT
3064 Support for the environment operating in SPL binary
3065
3066 CONFIG_SPL_NET_SUPPORT
3067 Support for the net/libnet.o in SPL binary.
3068 It conflicts with SPL env from storage medium specified by
3069 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3070
Scott Woodeb7bd972012-12-06 13:33:16 +00003071 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003072 Image offset to which the SPL should be padded before appending
3073 the SPL payload. By default, this is defined as
3074 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3075 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3076 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003077
Scott Woodf147eb72012-09-21 16:27:32 -05003078 CONFIG_SPL_TARGET
3079 Final target image containing SPL and payload. Some SPLs
3080 use an arch-specific makefile fragment instead, for
3081 example if more than one image needs to be produced.
3082
Simon Glass82d94532013-05-08 08:05:59 +00003083 CONFIG_FIT_SPL_PRINT
3084 Printing information about a FIT image adds quite a bit of
3085 code to SPL. So this is normally disabled in SPL. Use this
3086 option to re-enable it. This will affect the output of the
3087 bootm command when booting a FIT image.
3088
wdenkc6097192002-11-03 00:24:07 +00003089Modem Support:
3090--------------
3091
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003092[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003093
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003094- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003095 CONFIG_MODEM_SUPPORT
3096
3097- RTS/CTS Flow control enable:
3098 CONFIG_HWFLOW
3099
3100- Modem debug support:
3101 CONFIG_MODEM_SUPPORT_DEBUG
3102
wdenk4a5c8a72003-03-06 00:02:04 +00003103 Enables debugging stuff (char screen[1024], dbg())
3104 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003105
wdenkc0aa5c52003-12-06 19:49:23 +00003106- Interrupt support (PPC):
3107
wdenk1ebf41e2004-01-02 14:00:00 +00003108 There are common interrupt_init() and timer_interrupt()
3109 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003110 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003111 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003112 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003113 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003114 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003115 specific handling. If board has watchdog / status_led
3116 / other_activity_monitor it works automatically from
3117 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003118
wdenkc6097192002-11-03 00:24:07 +00003119- General:
3120
wdenk4a5c8a72003-03-06 00:02:04 +00003121 In the target system modem support is enabled when a
3122 specific key (key combination) is pressed during
3123 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003124 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003125 board_init(). Currently key_pressed() is a dummy
3126 function, returning 1 and thus enabling modem
3127 initialization.
wdenkc6097192002-11-03 00:24:07 +00003128
wdenk4a5c8a72003-03-06 00:02:04 +00003129 If there are no modem init strings in the
3130 environment, U-Boot proceed to autoboot; the
3131 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003132 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003133
3134 See also: doc/README.Modem
3135
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003136Board initialization settings:
3137------------------------------
3138
3139During Initialization u-boot calls a number of board specific functions
3140to allow the preparation of board specific prerequisites, e.g. pin setup
3141before drivers are initialized. To enable these callbacks the
3142following configuration macros have to be defined. Currently this is
3143architecture specific, so please check arch/your_architecture/lib/board.c
3144typically in board_init_f() and board_init_r().
3145
3146- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3147- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3148- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3149- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003150
wdenkc6097192002-11-03 00:24:07 +00003151Configuration Settings:
3152-----------------------
3153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003154- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003155 undefine this when you're short of memory.
3156
Peter Tyserdfb72b82009-01-27 18:03:12 -06003157- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3158 width of the commands listed in the 'help' command output.
3159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003160- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003161 prompt for user input.
3162
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003163- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003164
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003165- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003166
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003167- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003168
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003169- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003170 the application (usually a Linux kernel) when it is
3171 booted
3172
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003173- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003174 List of legal baudrate settings for this board.
3175
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003176- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003177 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003178
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003179- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003180 If the board specific function
3181 extern int overwrite_console (void);
3182 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003183 serial port, else the settings in the environment are used.
3184
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003185- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003186 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003187
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003188- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003189 Enable overwrite of previous console environment settings.
3190
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003191- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003192 Begin and End addresses of the area used by the
3193 simple memory test.
3194
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003195- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003196 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003197
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003198- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003199 Scratch address used by the alternate memory test
3200 You only need to set this if address zero isn't writeable
3201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003202- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3203 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003204 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003205 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003206 fixing up gd->ram_size the Linux kernel should gets passed
3207 the now "corrected" memory size and won't touch it either.
3208 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003209 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003210 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003211 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003212
3213 This option can be used as a workaround for the 440EPx/GRx
3214 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3215 be touched.
3216
3217 WARNING: Please make sure that this value is a multiple of
3218 the Linux page size (normally 4k). If this is not the case,
3219 then the end address of the Linux memory will be located at a
3220 non page size aligned address and this could cause major
3221 problems.
3222
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003223- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003224 Enable temporary baudrate change while serial download
3225
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003226- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003227 Physical start address of SDRAM. _Must_ be 0 here.
3228
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003229- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003230 Physical start address of Motherboard I/O (if using a
3231 Cogent motherboard)
3232
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003233- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003234 Physical start address of Flash memory.
3235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003236- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003237 Physical start address of boot monitor code (set by
3238 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003239 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003240 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003241
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003242- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003243 Size of memory reserved for monitor code, used to
3244 determine _at_compile_time_ (!) if the environment is
3245 embedded within the U-Boot image, or in a separate
3246 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003247
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003248- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003249 Size of DRAM reserved for malloc() use.
3250
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003251- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003252 Normally compressed uImages are limited to an
3253 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003254 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003255 to adjust this setting to your needs.
3256
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003257- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003258 Maximum size of memory mapped by the startup code of
3259 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003260 the Linux kernel (bd_info, boot arguments, FDT blob if
3261 used) must be put below this limit, unless "bootm_low"
3262 enviroment variable is defined and non-zero. In such case
3263 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003264 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003265 variable "bootm_mapsize" will override the value of
3266 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3267 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003268
John Rigbyeea8e692010-10-13 13:57:35 -06003269- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3270 Enable initrd_high functionality. If defined then the
3271 initrd_high feature is enabled and the bootm ramdisk subcommand
3272 is enabled.
3273
3274- CONFIG_SYS_BOOT_GET_CMDLINE:
3275 Enables allocating and saving kernel cmdline in space between
3276 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3277
3278- CONFIG_SYS_BOOT_GET_KBD:
3279 Enables allocating and saving a kernel copy of the bd_info in
3280 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3281
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003282- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003283 Max number of Flash memory banks
3284
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003285- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003286 Max number of sectors on a Flash chip
3287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003288- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003289 Timeout for Flash erase operations (in ms)
3290
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003291- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003292 Timeout for Flash write operations (in ms)
3293
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003294- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003295 Timeout for Flash set sector lock bit operation (in ms)
3296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003297- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003298 Timeout for Flash clear lock bits operation (in ms)
3299
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003300- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003301 If defined, hardware flash sectors protection is used
3302 instead of U-Boot software protection.
3303
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003304- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003305
3306 Enable TFTP transfers directly to flash memory;
3307 without this option such a download has to be
3308 performed in two steps: (1) download to RAM, and (2)
3309 copy from RAM to flash.
3310
3311 The two-step approach is usually more reliable, since
3312 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003313 the flash, but in some situations (when system RAM is
3314 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003315 downloaded image) this option may be very useful.
3316
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003317- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003318 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003319 common flash structure for storing flash geometry.
3320
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003321- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003322 This option also enables the building of the cfi_flash driver
3323 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003324
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003325- CONFIG_FLASH_CFI_MTD
3326 This option enables the building of the cfi_mtd driver
3327 in the drivers directory. The driver exports CFI flash
3328 to the MTD layer.
3329
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003330- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003331 Use buffered writes to flash.
3332
3333- CONFIG_FLASH_SPANSION_S29WS_N
3334 s29ws-n MirrorBit flash has non-standard addresses for buffered
3335 write commands.
3336
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003337- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003338 If this option is defined, the common CFI flash doesn't
3339 print it's warning upon not recognized FLASH banks. This
3340 is useful, if some of the configured banks are only
3341 optionally available.
3342
Jerry Van Barenaae73572008-03-08 13:48:01 -05003343- CONFIG_FLASH_SHOW_PROGRESS
3344 If defined (must be an integer), print out countdown
3345 digits and dots. Recommended value: 45 (9..1) for 80
3346 column displays, 15 (3..1) for 40 column displays.
3347
Stefan Roesed20cba52013-04-04 15:53:14 +02003348- CONFIG_FLASH_VERIFY
3349 If defined, the content of the flash (destination) is compared
3350 against the source after the write operation. An error message
3351 will be printed when the contents are not identical.
3352 Please note that this option is useless in nearly all cases,
3353 since such flash programming errors usually are detected earlier
3354 while unprotecting/erasing/programming. Please only enable
3355 this option if you really know what you are doing.
3356
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003357- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003358 Defines the number of Ethernet receive buffers. On some
3359 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003360 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3361 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003362 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003363 Defaults to 4 if not defined.
3364
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003365- CONFIG_ENV_MAX_ENTRIES
3366
Wolfgang Denk1136f692010-10-27 22:48:30 +02003367 Maximum number of entries in the hash table that is used
3368 internally to store the environment settings. The default
3369 setting is supposed to be generous and should work in most
3370 cases. This setting can be used to tune behaviour; see
3371 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003372
Joe Hershberger71497d02012-12-11 22:16:31 -06003373- CONFIG_ENV_FLAGS_LIST_DEFAULT
3374- CONFIG_ENV_FLAGS_LIST_STATIC
3375 Enable validation of the values given to enviroment variables when
3376 calling env set. Variables can be restricted to only decimal,
3377 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3378 the variables can also be restricted to IP address or MAC address.
3379
3380 The format of the list is:
3381 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003382 access_atribute = [a|r|o|c]
3383 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003384 entry = variable_name[:attributes]
3385 list = entry[,list]
3386
3387 The type attributes are:
3388 s - String (default)
3389 d - Decimal
3390 x - Hexadecimal
3391 b - Boolean ([1yYtT|0nNfF])
3392 i - IP address
3393 m - MAC address
3394
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003395 The access attributes are:
3396 a - Any (default)
3397 r - Read-only
3398 o - Write-once
3399 c - Change-default
3400
Joe Hershberger71497d02012-12-11 22:16:31 -06003401 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3402 Define this to a list (string) to define the ".flags"
3403 envirnoment variable in the default or embedded environment.
3404
3405 - CONFIG_ENV_FLAGS_LIST_STATIC
3406 Define this to a list (string) to define validation that
3407 should be done if an entry is not found in the ".flags"
3408 environment variable. To override a setting in the static
3409 list, simply add an entry for the same variable name to the
3410 ".flags" variable.
3411
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003412- CONFIG_ENV_ACCESS_IGNORE_FORCE
3413 If defined, don't allow the -f switch to env set override variable
3414 access flags.
3415
Simon Glass66828322013-03-08 13:45:27 +00003416- CONFIG_SYS_GENERIC_BOARD
3417 This selects the architecture-generic board system instead of the
3418 architecture-specific board files. It is intended to move boards
3419 to this new framework over time. Defining this will disable the
3420 arch/foo/lib/board.c file and use common/board_f.c and
3421 common/board_r.c instead. To use this option your architecture
3422 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3423 its config.mk file). If you find problems enabling this option on
3424 your board please report the problem and send patches!
3425
Simon Glass9c9f44a2013-03-11 07:06:48 +00003426- CONFIG_SYS_SYM_OFFSETS
3427 This is set by architectures that use offsets for link symbols
3428 instead of absolute values. So bss_start is obtained using an
3429 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3430 directly. You should not need to touch this setting.
3431
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003432- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3433 This is set by OMAP boards for the max time that reset should
3434 be asserted. See doc/README.omap-reset-time for details on how
3435 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003436
wdenkc6097192002-11-03 00:24:07 +00003437The following definitions that deal with the placement and management
3438of environment data (variable area); in general, we support the
3439following configurations:
3440
Mike Frysinger63b8f122011-07-08 10:44:25 +00003441- CONFIG_BUILD_ENVCRC:
3442
3443 Builds up envcrc with the target environment so that external utils
3444 may easily extract it and embed it in final U-Boot images.
3445
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003446- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003447
3448 Define this if the environment is in flash memory.
3449
3450 a) The environment occupies one whole flash sector, which is
3451 "embedded" in the text segment with the U-Boot code. This
3452 happens usually with "bottom boot sector" or "top boot
3453 sector" type flash chips, which have several smaller
3454 sectors at the start or the end. For instance, such a
3455 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3456 such a case you would place the environment in one of the
3457 4 kB sectors - with U-Boot code before and after it. With
3458 "top boot sector" type flash chips, you would put the
3459 environment in one of the last sectors, leaving a gap
3460 between U-Boot and the environment.
3461
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003462 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003463
3464 Offset of environment data (variable area) to the
3465 beginning of flash memory; for instance, with bottom boot
3466 type flash chips the second sector can be used: the offset
3467 for this sector is given here.
3468
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003469 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003470
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003471 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003472
3473 This is just another way to specify the start address of
3474 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003475 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003476
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003477 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003478
3479 Size of the sector containing the environment.
3480
3481
3482 b) Sometimes flash chips have few, equal sized, BIG sectors.
3483 In such a case you don't want to spend a whole sector for
3484 the environment.
3485
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003486 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003487
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003488 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003489 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003490 of this flash sector for the environment. This saves
3491 memory for the RAM copy of the environment.
3492
3493 It may also save flash memory if you decide to use this
3494 when your environment is "embedded" within U-Boot code,
3495 since then the remainder of the flash sector could be used
3496 for U-Boot code. It should be pointed out that this is
3497 STRONGLY DISCOURAGED from a robustness point of view:
3498 updating the environment in flash makes it always
3499 necessary to erase the WHOLE sector. If something goes
3500 wrong before the contents has been restored from a copy in
3501 RAM, your target system will be dead.
3502
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003503 - CONFIG_ENV_ADDR_REDUND
3504 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003505
wdenk4a5c8a72003-03-06 00:02:04 +00003506 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003507 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003508 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003509 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003510
3511BE CAREFUL! Any changes to the flash layout, and some changes to the
3512source code will make it necessary to adapt <board>/u-boot.lds*
3513accordingly!
3514
3515
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003516- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003517
3518 Define this if you have some non-volatile memory device
3519 (NVRAM, battery buffered SRAM) which you want to use for the
3520 environment.
3521
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003522 - CONFIG_ENV_ADDR:
3523 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003524
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003525 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003526 want to use for environment. It is assumed that this memory
3527 can just be read and written to, without any special
3528 provision.
3529
3530BE CAREFUL! The first access to the environment happens quite early
3531in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003532console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003533U-Boot will hang.
3534
3535Please note that even with NVRAM we still use a copy of the
3536environment in RAM: we could work on NVRAM directly, but we want to
3537keep settings there always unmodified except somebody uses "saveenv"
3538to save the current settings.
3539
3540
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003541- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003542
3543 Use this if you have an EEPROM or similar serial access
3544 device and a driver for it.
3545
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003546 - CONFIG_ENV_OFFSET:
3547 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003548
3549 These two #defines specify the offset and size of the
3550 environment area within the total memory of your EEPROM.
3551
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003552 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003553 If defined, specified the chip address of the EEPROM device.
3554 The default address is zero.
3555
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003556 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003557 If defined, the number of bits used to address bytes in a
3558 single page in the EEPROM device. A 64 byte page, for example
3559 would require six bits.
3560
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003561 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003562 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003563 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003565 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003566 The length in bytes of the EEPROM memory array address. Note
3567 that this is NOT the chip address length!
3568
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003569 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003570 EEPROM chips that implement "address overflow" are ones
3571 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3572 address and the extra bits end up in the "chip address" bit
3573 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3574 byte chips.
3575
3576 Note that we consider the length of the address field to
3577 still be one byte because the extra address bits are hidden
3578 in the chip address.
3579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003580 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003581 The size in bytes of the EEPROM device.
3582
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003583 - CONFIG_ENV_EEPROM_IS_ON_I2C
3584 define this, if you have I2C and SPI activated, and your
3585 EEPROM, which holds the environment, is on the I2C bus.
3586
3587 - CONFIG_I2C_ENV_EEPROM_BUS
3588 if you have an Environment on an EEPROM reached over
3589 I2C muxes, you can define here, how to reach this
3590 EEPROM. For example:
3591
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02003592 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003593
3594 EEPROM which holds the environment, is reached over
3595 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003596
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003597- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003598
wdenk1ebf41e2004-01-02 14:00:00 +00003599 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003600 want to use for the environment.
3601
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003602 - CONFIG_ENV_OFFSET:
3603 - CONFIG_ENV_ADDR:
3604 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003605
3606 These three #defines specify the offset and size of the
3607 environment area within the total memory of your DataFlash placed
3608 at the specified address.
3609
Liu Gang85bcd732012-03-08 00:33:20 +00003610- CONFIG_ENV_IS_IN_REMOTE:
3611
3612 Define this if you have a remote memory space which you
3613 want to use for the local device's environment.
3614
3615 - CONFIG_ENV_ADDR:
3616 - CONFIG_ENV_SIZE:
3617
3618 These two #defines specify the address and size of the
3619 environment area within the remote memory space. The
3620 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003621 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003622
3623BE CAREFUL! For some special cases, the local device can not use
3624"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003625environment stored in a remote NOR flash by SRIO or PCIE link,
3626but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003627
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003628- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003629
3630 Define this if you have a NAND device which you want to use
3631 for the environment.
3632
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003633 - CONFIG_ENV_OFFSET:
3634 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003635
3636 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003637 area within the first NAND device. CONFIG_ENV_OFFSET must be
3638 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003639
Scott Wood08239322010-09-17 14:38:37 -05003640 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003641
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003642 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003643 size used to hold a redundant copy of the environment data, so
3644 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003645 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003646 aligned to an erase block boundary.
3647
3648 - CONFIG_ENV_RANGE (optional):
3649
3650 Specifies the length of the region in which the environment
3651 can be written. This should be a multiple of the NAND device's
3652 block size. Specifying a range with more erase blocks than
3653 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3654 the range to be avoided.
3655
3656 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003657
Scott Wood08239322010-09-17 14:38:37 -05003658 Enables support for dynamically retrieving the offset of the
3659 environment from block zero's out-of-band data. The
3660 "nand env.oob" command can be used to record this offset.
3661 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3662 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003663
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003664- CONFIG_NAND_ENV_DST
3665
3666 Defines address in RAM to which the nand_spl code should copy the
3667 environment. If redundant environment is used, it will be copied to
3668 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3669
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003670- CONFIG_ENV_IS_IN_UBI:
3671
3672 Define this if you have an UBI volume that you want to use for the
3673 environment. This has the benefit of wear-leveling the environment
3674 accesses, which is important on NAND.
3675
3676 - CONFIG_ENV_UBI_PART:
3677
3678 Define this to a string that is the mtd partition containing the UBI.
3679
3680 - CONFIG_ENV_UBI_VOLUME:
3681
3682 Define this to the name of the volume that you want to store the
3683 environment in.
3684
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003685 - CONFIG_ENV_UBI_VOLUME_REDUND:
3686
3687 Define this to the name of another volume to store a second copy of
3688 the environment in. This will enable redundant environments in UBI.
3689 It is assumed that both volumes are in the same MTD partition.
3690
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003691 - CONFIG_UBI_SILENCE_MSG
3692 - CONFIG_UBIFS_SILENCE_MSG
3693
3694 You will probably want to define these to avoid a really noisy system
3695 when storing the env in UBI.
3696
Stephen Warreneedcacd2013-06-11 15:14:00 -06003697- CONFIG_ENV_IS_IN_MMC:
3698
3699 Define this if you have an MMC device which you want to use for the
3700 environment.
3701
3702 - CONFIG_SYS_MMC_ENV_DEV:
3703
3704 Specifies which MMC device the environment is stored in.
3705
3706 - CONFIG_SYS_MMC_ENV_PART (optional):
3707
3708 Specifies which MMC partition the environment is stored in. If not
3709 set, defaults to partition 0, the user area. Common values might be
3710 1 (first MMC boot partition), 2 (second MMC boot partition).
3711
3712 - CONFIG_ENV_OFFSET:
3713 - CONFIG_ENV_SIZE:
3714
3715 These two #defines specify the offset and size of the environment
3716 area within the specified MMC device.
3717
Stephen Warren24dc2032013-06-11 15:14:02 -06003718 If offset is positive (the usual case), it is treated as relative to
3719 the start of the MMC partition. If offset is negative, it is treated
3720 as relative to the end of the MMC partition. This can be useful if
3721 your board may be fitted with different MMC devices, which have
3722 different sizes for the MMC partitions, and you always want the
3723 environment placed at the very end of the partition, to leave the
3724 maximum possible space before it, to store other data.
3725
Stephen Warreneedcacd2013-06-11 15:14:00 -06003726 These two values are in units of bytes, but must be aligned to an
3727 MMC sector boundary.
3728
3729 - CONFIG_ENV_OFFSET_REDUND (optional):
3730
3731 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3732 hold a redundant copy of the environment data. This provides a
3733 valid backup copy in case the other copy is corrupted, e.g. due
3734 to a power failure during a "saveenv" operation.
3735
Stephen Warren24dc2032013-06-11 15:14:02 -06003736 This value may also be positive or negative; this is handled in the
3737 same way as CONFIG_ENV_OFFSET.
3738
Stephen Warreneedcacd2013-06-11 15:14:00 -06003739 This value is also in units of bytes, but must also be aligned to
3740 an MMC sector boundary.
3741
3742 - CONFIG_ENV_SIZE_REDUND (optional):
3743
3744 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3745 set. If this value is set, it must be set to the same value as
3746 CONFIG_ENV_SIZE.
3747
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003748- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003749
3750 Defines offset to the initial SPI buffer area in DPRAM. The
3751 area is used at an early stage (ROM part) if the environment
3752 is configured to reside in the SPI EEPROM: We need a 520 byte
3753 scratch DPRAM area. It is used between the two initialization
3754 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3755 to be a good choice since it makes it far enough from the
3756 start of the data area as well as from the stack pointer.
3757
Bruce Adleredecc942007-11-02 13:15:42 -07003758Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003759has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003760created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003761until then to read environment variables.
3762
wdenk8dba0502003-03-31 16:34:49 +00003763The environment is protected by a CRC32 checksum. Before the monitor
3764is relocated into RAM, as a result of a bad CRC you will be working
3765with the compiled-in default environment - *silently*!!! [This is
3766necessary, because the first environment variable we need is the
3767"baudrate" setting for the console - if we have a bad CRC, we don't
3768have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003769
3770Note: once the monitor has been relocated, then it will complain if
3771the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003772use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003773
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003774- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003775 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003777 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003778 also needs to be defined.
3779
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003780- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003781 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003782
Ron Madriddfa028a2009-02-18 14:30:44 -08003783- CONFIG_NS16550_MIN_FUNCTIONS:
3784 Define this if you desire to only have use of the NS16550_init
3785 and NS16550_putc functions for the serial driver located at
3786 drivers/serial/ns16550.c. This option is useful for saving
3787 space for already greatly restricted images, including but not
3788 limited to NAND_SPL configurations.
3789
Simon Glass28a9e332012-11-30 13:01:18 +00003790- CONFIG_DISPLAY_BOARDINFO
3791 Display information about the board that U-Boot is running on
3792 when U-Boot starts up. The board function checkboard() is called
3793 to do this.
3794
Simon Glasse8822012012-11-30 13:01:19 +00003795- CONFIG_DISPLAY_BOARDINFO_LATE
3796 Similar to the previous option, but display this information
3797 later, once stdio is running and output goes to the LCD, if
3798 present.
3799
wdenkc6097192002-11-03 00:24:07 +00003800Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003801---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003802
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003803- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003804 Cache Line Size of the CPU.
3805
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003806- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003807 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003808
wdenk9c53f402003-10-15 23:53:47 +00003809 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3810 and RPXsuper) to be able to adjust the position of
3811 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003812
Timur Tabid8f341c2011-08-04 18:03:41 -05003813- CONFIG_SYS_CCSRBAR_DEFAULT:
3814 Default (power-on reset) physical address of CCSR on Freescale
3815 PowerPC SOCs.
3816
3817- CONFIG_SYS_CCSRBAR:
3818 Virtual address of CCSR. On a 32-bit build, this is typically
3819 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3820
3821 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3822 for cross-platform code that uses that macro instead.
3823
3824- CONFIG_SYS_CCSRBAR_PHYS:
3825 Physical address of CCSR. CCSR can be relocated to a new
3826 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003827 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003828 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3829 is typically relocated on 36-bit builds. It is recommended
3830 that this macro be defined via the _HIGH and _LOW macros:
3831
3832 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3833 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3834
3835- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003836 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3837 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003838 used in assembly code, so it must not contain typecasts or
3839 integer size suffixes (e.g. "ULL").
3840
3841- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3842 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3843 used in assembly code, so it must not contain typecasts or
3844 integer size suffixes (e.g. "ULL").
3845
3846- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3847 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3848 forced to a value that ensures that CCSR is not relocated.
3849
wdenk1272e232002-11-10 22:06:23 +00003850- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003851 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003852
3853 the default drive number (default value 0)
3854
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003855 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003856
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003857 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003858 (default value 1)
3859
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003860 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003861
wdenk4a5c8a72003-03-06 00:02:04 +00003862 defines the offset of register from address. It
3863 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003864 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003865
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003866 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3867 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003868 default value.
wdenk1272e232002-11-10 22:06:23 +00003869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003870 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003871 fdc_hw_init() is called at the beginning of the FDC
3872 setup. fdc_hw_init() must be provided by the board
3873 source code. It is used to make hardware dependant
3874 initializations.
wdenk1272e232002-11-10 22:06:23 +00003875
Macpaul Lind1e49942011-04-11 20:45:32 +00003876- CONFIG_IDE_AHB:
3877 Most IDE controllers were designed to be connected with PCI
3878 interface. Only few of them were designed for AHB interface.
3879 When software is doing ATA command and data transfer to
3880 IDE devices through IDE-AHB controller, some additional
3881 registers accessing to these kind of IDE-AHB controller
3882 is requierd.
3883
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003884- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003885 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003886 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003888- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003889
wdenkeb20ad32003-09-05 23:19:14 +00003890 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003891 initial data and stack; please note that this must be
3892 writable memory that is working WITHOUT special
3893 initialization, i. e. you CANNOT use normal RAM which
3894 will become available only after programming the
3895 memory controller and running certain initialization
3896 sequences.
3897
3898 U-Boot uses the following memory types:
3899 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3900 - MPC824X: data cache
3901 - PPC4xx: data cache
3902
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003903- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003904
3905 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003906 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3907 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003908 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003909 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003910 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3911 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3912 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003913
3914 Note:
3915 On the MPC824X (or other systems that use the data
3916 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003917 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003918 point to an otherwise UNUSED address space between
3919 the top of RAM and the start of the PCI space.
3920
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003921- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003922
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003923- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003925- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003926
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003927- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003928
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003929- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003930
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003931- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003932
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003933- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003934 SDRAM timing
3935
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003936- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003937 periodic timer for refresh
3938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003939- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003940
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003941- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3942 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3943 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3944 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003945 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3946
3947- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003948 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3949 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003950 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3951
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003952- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3953 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003954 Machine Mode Register and Memory Periodic Timer
3955 Prescaler definitions (SDRAM timing)
3956
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003957- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003958 enable I2C microcode relocation patch (MPC8xx);
3959 define relocation offset in DPRAM [DSP2]
3960
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003961- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003962 enable SMC microcode relocation patch (MPC8xx);
3963 define relocation offset in DPRAM [SMC1]
3964
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003965- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003966 enable SPI microcode relocation patch (MPC8xx);
3967 define relocation offset in DPRAM [SCC4]
3968
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003969- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003970 Use OSCM clock mode on MBX8xx board. Be careful,
3971 wrong setting might damage your board. Read
3972 doc/README.MBX before setting this variable!
3973
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003974- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003975 Offset of the bootmode word in DPRAM used by post
3976 (Power On Self Tests). This definition overrides
3977 #define'd default value in commproc.h resp.
3978 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003979
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003980- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3981 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3982 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3983 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3984 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3985 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3986 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3987 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003988 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003989
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003990- CONFIG_PCI_DISABLE_PCIE:
3991 Disable PCI-Express on systems where it is supported but not
3992 required.
3993
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003994- CONFIG_PCI_ENUM_ONLY
3995 Only scan through and get the devices on the busses.
3996 Don't do any setup work, presumably because someone or
3997 something has already done it, and we don't need to do it
3998 a second time. Useful for platforms that are pre-booted
3999 by coreboot or similar.
4000
Gabor Juhosb4458732013-05-30 07:06:12 +00004001- CONFIG_PCI_INDIRECT_BRIDGE:
4002 Enable support for indirect PCI bridges.
4003
Kumar Gala8975d7a2010-12-30 12:09:53 -06004004- CONFIG_SYS_SRIO:
4005 Chip has SRIO or not
4006
4007- CONFIG_SRIO1:
4008 Board has SRIO 1 port available
4009
4010- CONFIG_SRIO2:
4011 Board has SRIO 2 port available
4012
Liu Gang27afb9c2013-05-07 16:30:46 +08004013- CONFIG_SRIO_PCIE_BOOT_MASTER
4014 Board can support master function for Boot from SRIO and PCIE
4015
Kumar Gala8975d7a2010-12-30 12:09:53 -06004016- CONFIG_SYS_SRIOn_MEM_VIRT:
4017 Virtual Address of SRIO port 'n' memory region
4018
4019- CONFIG_SYS_SRIOn_MEM_PHYS:
4020 Physical Address of SRIO port 'n' memory region
4021
4022- CONFIG_SYS_SRIOn_MEM_SIZE:
4023 Size of SRIO port 'n' memory region
4024
Fabio Estevamf17e8782013-04-11 09:35:34 +00004025- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4026 Defined to tell the NAND controller that the NAND chip is using
4027 a 16 bit bus.
4028 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004029 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004030 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004031 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004032
4033- CONFIG_SYS_NDFC_EBC0_CFG
4034 Sets the EBC0_CFG register for the NDFC. If not defined
4035 a default value will be used.
4036
Ben Warren45657152006-09-07 16:50:54 -04004037- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004038 Get DDR timing information from an I2C EEPROM. Common
4039 with pluggable memory modules such as SODIMMs
4040
Ben Warren45657152006-09-07 16:50:54 -04004041 SPD_EEPROM_ADDRESS
4042 I2C address of the SPD EEPROM
4043
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004044- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004045 If SPD EEPROM is on an I2C bus other than the first
4046 one, specify here. Note that the value must resolve
4047 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004048
York Sune73cc042011-06-07 09:42:16 +08004049- CONFIG_SYS_DDR_RAW_TIMING
4050 Get DDR timing information from other than SPD. Common with
4051 soldered DDR chips onboard without SPD. DDR raw timing
4052 parameters are extracted from datasheet and hard-coded into
4053 header files or board specific files.
4054
York Sunbd495cf2011-09-16 13:21:35 -07004055- CONFIG_FSL_DDR_INTERACTIVE
4056 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4057
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004058- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004059 Only for 83xx systems. If specified, then DDR should
4060 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004061
wdenk6203e402004-04-18 10:13:26 +00004062- CONFIG_ETHER_ON_FEC[12]
4063 Define to enable FEC[12] on a 8xx series processor.
4064
4065- CONFIG_FEC[12]_PHY
4066 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004067 to the given FEC; i. e.
4068 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004069 means that the PHY with address 4 is connected to FEC1
4070
4071 When set to -1, means to probe for first available.
4072
4073- CONFIG_FEC[12]_PHY_NORXERR
4074 The PHY does not have a RXERR line (RMII only).
4075 (so program the FEC to ignore it).
4076
4077- CONFIG_RMII
4078 Enable RMII mode for all FECs.
4079 Note that this is a global option, we can't
4080 have one FEC in standard MII mode and another in RMII mode.
4081
wdenk20c98a62004-04-23 20:32:05 +00004082- CONFIG_CRC32_VERIFY
4083 Add a verify option to the crc32 command.
4084 The syntax is:
4085
4086 => crc32 -v <address> <count> <crc32>
4087
4088 Where address/count indicate a memory area
4089 and crc32 is the correct crc32 which the
4090 area should have.
4091
wdenk64519362004-07-11 17:40:54 +00004092- CONFIG_LOOPW
4093 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004094 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004095
stroesecc3af832004-12-16 18:46:55 +00004096- CONFIG_MX_CYCLIC
4097 Add the "mdc" and "mwc" memory commands. These are cyclic
4098 "md/mw" commands.
4099 Examples:
4100
wdenk07d7e6b2004-12-16 21:44:03 +00004101 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004102 This command will print 4 bytes (10,11,12,13) each 500 ms.
4103
wdenk07d7e6b2004-12-16 21:44:03 +00004104 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004105 This command will write 12345678 to address 100 all 10 ms.
4106
wdenk07d7e6b2004-12-16 21:44:03 +00004107 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004108 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004109
wdenk3d3d99f2005-04-04 12:44:11 +00004110- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004111 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004112 low level initializations (like setting up the memory
4113 controller) are omitted and/or U-Boot does not
4114 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004115
Wolfgang Denk302141d2010-11-27 23:30:56 +01004116 Normally this variable MUST NOT be defined. The only
4117 exception is when U-Boot is loaded (to RAM) by some
4118 other boot loader or by a debugger which performs
4119 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004120
Aneesh V552a3192011-07-13 05:11:07 +00004121- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004122 Modifies the behaviour of start.S when compiling a loader
4123 that is executed before the actual U-Boot. E.g. when
4124 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004125
Ying Zhang0d4f5442013-05-20 14:07:23 +08004126- CONFIG_SYS_MPC85XX_NO_RESETVEC
4127 Only for 85xx systems. If this variable is specified, the section
4128 .resetvec is not kept and the section .bootpg is placed in the
4129 previous 4k of the .text section.
4130
Simon Glass17dabf02013-02-24 17:33:14 +00004131- CONFIG_ARCH_MAP_SYSMEM
4132 Generally U-Boot (and in particular the md command) uses
4133 effective address. It is therefore not necessary to regard
4134 U-Boot address as virtual addresses that need to be translated
4135 to physical addresses. However, sandbox requires this, since
4136 it maintains its own little RAM buffer which contains all
4137 addressable memory. This option causes some memory accesses
4138 to be mapped through map_sysmem() / unmap_sysmem().
4139
Matthias Weisser93416c12011-03-10 21:36:32 +00004140- CONFIG_USE_ARCH_MEMCPY
4141 CONFIG_USE_ARCH_MEMSET
4142 If these options are used a optimized version of memcpy/memset will
4143 be used if available. These functions may be faster under some
4144 conditions but may increase the binary size.
4145
Simon Glassbfb59802013-02-14 04:18:54 +00004146- CONFIG_X86_RESET_VECTOR
4147 If defined, the x86 reset vector code is included. This is not
4148 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004149
Mark Jackson52b003c2013-03-04 01:27:20 +00004150- CONFIG_SYS_MPUCLK
4151 Defines the MPU clock speed (in MHz).
4152
4153 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004154
Timur Tabi275f4bb2011-11-22 09:21:25 -06004155Freescale QE/FMAN Firmware Support:
4156-----------------------------------
4157
4158The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4159loading of "firmware", which is encoded in the QE firmware binary format.
4160This firmware often needs to be loaded during U-Boot booting, so macros
4161are used to identify the storage device (NOR flash, SPI, etc) and the address
4162within that device.
4163
4164- CONFIG_SYS_QE_FMAN_FW_ADDR
4165 The address in the storage device where the firmware is located. The
4166 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4167 is also specified.
4168
4169- CONFIG_SYS_QE_FMAN_FW_LENGTH
4170 The maximum possible size of the firmware. The firmware binary format
4171 has a field that specifies the actual size of the firmware, but it
4172 might not be possible to read any part of the firmware unless some
4173 local storage is allocated to hold the entire firmware first.
4174
4175- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4176 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4177 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4178 virtual address in NOR flash.
4179
4180- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4181 Specifies that QE/FMAN firmware is located in NAND flash.
4182 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4183
4184- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4185 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4186 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4187
4188- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4189 Specifies that QE/FMAN firmware is located on the primary SPI
4190 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4191
Liu Gang1e084582012-03-08 00:33:18 +00004192- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4193 Specifies that QE/FMAN firmware is located in the remote (master)
4194 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004195 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4196 window->master inbound window->master LAW->the ucode address in
4197 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004198
wdenkc6097192002-11-03 00:24:07 +00004199Building the Software:
4200======================
4201
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004202Building U-Boot has been tested in several native build environments
4203and in many different cross environments. Of course we cannot support
4204all possibly existing versions of cross development tools in all
4205(potentially obsolete) versions. In case of tool chain problems we
4206recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4207which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004208
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004209If you are not using a native environment, it is assumed that you
4210have GNU cross compiling tools available in your path. In this case,
4211you must set the environment variable CROSS_COMPILE in your shell.
4212Note that no changes to the Makefile or any other source files are
4213necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004214
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004215 $ CROSS_COMPILE=ppc_4xx-
4216 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004217
Peter Tyserb06976d2009-03-13 18:54:51 -05004218Note: If you wish to generate Windows versions of the utilities in
4219 the tools directory you can use the MinGW toolchain
4220 (http://www.mingw.org). Set your HOST tools to the MinGW
4221 toolchain and execute 'make tools'. For example:
4222
4223 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4224
4225 Binaries such as tools/mkimage.exe will be created which can
4226 be executed on computers running Windows.
4227
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004228U-Boot is intended to be simple to build. After installing the
4229sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004230is done by typing:
4231
4232 make NAME_config
4233
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004234where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004235rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004236
wdenk6c59edc2004-05-03 20:45:30 +00004237Note: for some board special configuration names may exist; check if
4238 additional information is available from the board vendor; for
4239 instance, the TQM823L systems are available without (standard)
4240 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004241 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk6c59edc2004-05-03 20:45:30 +00004243 make TQM823L_config
4244 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk6c59edc2004-05-03 20:45:30 +00004246 make TQM823L_LCD_config
4247 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004248
wdenk6c59edc2004-05-03 20:45:30 +00004249 etc.
wdenkc6097192002-11-03 00:24:07 +00004250
wdenkc6097192002-11-03 00:24:07 +00004251
wdenk6c59edc2004-05-03 20:45:30 +00004252Finally, type "make all", and you should get some working U-Boot
4253images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004254
wdenk6c59edc2004-05-03 20:45:30 +00004255- "u-boot.bin" is a raw binary image
4256- "u-boot" is an image in ELF binary format
4257- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004258
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004259By default the build is performed locally and the objects are saved
4260in the source directory. One of the two methods can be used to change
4261this behavior and build U-Boot to some external directory:
4262
42631. Add O= to the make command line invocations:
4264
4265 make O=/tmp/build distclean
4266 make O=/tmp/build NAME_config
4267 make O=/tmp/build all
4268
42692. Set environment variable BUILD_DIR to point to the desired location:
4270
4271 export BUILD_DIR=/tmp/build
4272 make distclean
4273 make NAME_config
4274 make all
4275
4276Note that the command line "O=" setting overrides the BUILD_DIR environment
4277variable.
4278
wdenkc6097192002-11-03 00:24:07 +00004279
wdenk6c59edc2004-05-03 20:45:30 +00004280Please be aware that the Makefiles assume you are using GNU make, so
4281for instance on NetBSD you might need to use "gmake" instead of
4282native "make".
wdenkc6097192002-11-03 00:24:07 +00004283
wdenkc6097192002-11-03 00:24:07 +00004284
wdenk6c59edc2004-05-03 20:45:30 +00004285If the system board that you have is not listed, then you will need
4286to port U-Boot to your hardware platform. To do this, follow these
4287steps:
wdenkc6097192002-11-03 00:24:07 +00004288
wdenk6c59edc2004-05-03 20:45:30 +000042891. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004290 "boards.cfg" file, using the existing entries as examples.
4291 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000042922. Create a new directory to hold your board specific code. Add any
4293 files you need. In your board directory, you will need at least
4294 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
42953. Create a new configuration file "include/configs/<board>.h" for
4296 your board
42973. If you're porting U-Boot to a new CPU, then also create a new
4298 directory to hold your CPU specific code. Add any files you need.
42994. Run "make <board>_config" with your new name.
43005. Type "make", and you should get a working "u-boot.srec" file
4301 to be installed on your target system.
43026. Debug and solve any problems that might arise.
4303 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004304
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk6c59edc2004-05-03 20:45:30 +00004306Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4307==============================================================
wdenkc6097192002-11-03 00:24:07 +00004308
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004309If you have modified U-Boot sources (for instance added a new board
4310or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004311provide feedback to the other developers. The feedback normally takes
4312the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004313official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004314
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004315But before you submit such a patch, please verify that your modifi-
4316cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004317the supported boards compile WITHOUT ANY compiler warnings. To do so,
4318just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004319for ALL supported system. Be warned, this will take a while. You can
4320select which (cross) compiler to use by passing a `CROSS_COMPILE'
4321environment variable to the script, i. e. to use the ELDK cross tools
4322you can type
wdenkc6097192002-11-03 00:24:07 +00004323
wdenk6c59edc2004-05-03 20:45:30 +00004324 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004325
wdenk6c59edc2004-05-03 20:45:30 +00004326or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk6c59edc2004-05-03 20:45:30 +00004328 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004329
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004330When using the MAKEALL script, the default behaviour is to build
4331U-Boot in the source directory. This location can be changed by
4332setting the BUILD_DIR environment variable. Also, for each target
4333built, the MAKEALL script saves two log files (<target>.ERR and
4334<target>.MAKEALL) in the <source dir>/LOG directory. This default
4335location can be changed by setting the MAKEALL_LOGDIR environment
4336variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004337
4338 export BUILD_DIR=/tmp/build
4339 export MAKEALL_LOGDIR=/tmp/log
4340 CROSS_COMPILE=ppc_8xx- MAKEALL
4341
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004342With the above settings build objects are saved in the /tmp/build,
4343log files are saved in the /tmp/log and the source tree remains clean
4344during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004345
4346
wdenk6c59edc2004-05-03 20:45:30 +00004347See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004348
wdenkc6097192002-11-03 00:24:07 +00004349
wdenk6c59edc2004-05-03 20:45:30 +00004350Monitor Commands - Overview:
4351============================
wdenkc6097192002-11-03 00:24:07 +00004352
wdenk6c59edc2004-05-03 20:45:30 +00004353go - start application at address 'addr'
4354run - run commands in an environment variable
4355bootm - boot application image from memory
4356bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004357bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004358tftpboot- boot image via network using TFTP protocol
4359 and env variables "ipaddr" and "serverip"
4360 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004361tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004362rarpboot- boot image via network using RARP/TFTP protocol
4363diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4364loads - load S-Record file over serial line
4365loadb - load binary file over serial line (kermit mode)
4366md - memory display
4367mm - memory modify (auto-incrementing)
4368nm - memory modify (constant address)
4369mw - memory write (fill)
4370cp - memory copy
4371cmp - memory compare
4372crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004373i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004374sspi - SPI utility commands
4375base - print or set address offset
4376printenv- print environment variables
4377setenv - set environment variables
4378saveenv - save environment variables to persistent storage
4379protect - enable or disable FLASH write protection
4380erase - erase FLASH memory
4381flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004382nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004383bdinfo - print Board Info structure
4384iminfo - print header information for application image
4385coninfo - print console devices and informations
4386ide - IDE sub-system
4387loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004388loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004389mtest - simple RAM test
4390icache - enable or disable instruction cache
4391dcache - enable or disable data cache
4392reset - Perform RESET of the CPU
4393echo - echo args to console
4394version - print monitor version
4395help - print online help
4396? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004397
wdenkc6097192002-11-03 00:24:07 +00004398
wdenk6c59edc2004-05-03 20:45:30 +00004399Monitor Commands - Detailed Description:
4400========================================
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk6c59edc2004-05-03 20:45:30 +00004402TODO.
wdenkc6097192002-11-03 00:24:07 +00004403
wdenk6c59edc2004-05-03 20:45:30 +00004404For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004405
4406
wdenk6c59edc2004-05-03 20:45:30 +00004407Environment Variables:
4408======================
wdenkc6097192002-11-03 00:24:07 +00004409
wdenk6c59edc2004-05-03 20:45:30 +00004410U-Boot supports user configuration using Environment Variables which
4411can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004412
wdenk6c59edc2004-05-03 20:45:30 +00004413Environment Variables are set using "setenv", printed using
4414"printenv", and saved to Flash using "saveenv". Using "setenv"
4415without a value can be used to delete a variable from the
4416environment. As long as you don't save the environment you are
4417working with an in-memory copy. In case the Flash area containing the
4418environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004419
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004420Some configuration options can be set using Environment Variables.
4421
4422List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004423
wdenk6c59edc2004-05-03 20:45:30 +00004424 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004425
wdenk6c59edc2004-05-03 20:45:30 +00004426 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004427
wdenk6c59edc2004-05-03 20:45:30 +00004428 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004429
wdenk6c59edc2004-05-03 20:45:30 +00004430 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004431
wdenk6c59edc2004-05-03 20:45:30 +00004432 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004433
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004434 bootm_low - Memory range available for image processing in the bootm
4435 command can be restricted. This variable is given as
4436 a hexadecimal number and defines lowest address allowed
4437 for use by the bootm command. See also "bootm_size"
4438 environment variable. Address defined by "bootm_low" is
4439 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004440 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4441 bootm_mapsize.
4442
Wolfgang Denk092ae952011-10-26 10:21:21 +00004443 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004444 This variable is given as a hexadecimal number and it
4445 defines the size of the memory region starting at base
4446 address bootm_low that is accessible by the Linux kernel
4447 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4448 as the default value if it is defined, and bootm_size is
4449 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004450
4451 bootm_size - Memory range available for image processing in the bootm
4452 command can be restricted. This variable is given as
4453 a hexadecimal number and defines the size of the region
4454 allowed for use by the bootm command. See also "bootm_low"
4455 environment variable.
4456
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004457 updatefile - Location of the software update file on a TFTP server, used
4458 by the automatic software update feature. Please refer to
4459 documentation in doc/README.update for more details.
4460
wdenk6c59edc2004-05-03 20:45:30 +00004461 autoload - if set to "no" (any string beginning with 'n'),
4462 "bootp" will just load perform a lookup of the
4463 configuration from the BOOTP server, but not try to
4464 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004465
wdenk6c59edc2004-05-03 20:45:30 +00004466 autostart - if set to "yes", an image loaded using the "bootp",
4467 "rarpboot", "tftpboot" or "diskboot" commands will
4468 be automatically started (by internally calling
4469 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004470
wdenk6c59edc2004-05-03 20:45:30 +00004471 If set to "no", a standalone image passed to the
4472 "bootm" command will be copied to the load address
4473 (and eventually uncompressed), but NOT be started.
4474 This can be used to load and uncompress arbitrary
4475 data.
wdenkc6097192002-11-03 00:24:07 +00004476
David A. Longd558a4e2011-07-09 16:40:19 -04004477 fdt_high - if set this restricts the maximum address that the
4478 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004479 For example, if you have a system with 1 GB memory
4480 at physical address 0x10000000, while Linux kernel
4481 only recognizes the first 704 MB as low memory, you
4482 may need to set fdt_high as 0x3C000000 to have the
4483 device tree blob be copied to the maximum address
4484 of the 704 MB low memory, so that Linux kernel can
4485 access it during the boot procedure.
4486
David A. Longd558a4e2011-07-09 16:40:19 -04004487 If this is set to the special value 0xFFFFFFFF then
4488 the fdt will not be copied at all on boot. For this
4489 to work it must reside in writable memory, have
4490 sufficient padding on the end of it for u-boot to
4491 add the information it needs into it, and the memory
4492 must be accessible by the kernel.
4493
Simon Glassdc6fa642011-10-24 19:15:34 +00004494 fdtcontroladdr- if set this is the address of the control flattened
4495 device tree used by U-Boot when CONFIG_OF_CONTROL is
4496 defined.
4497
wdenk0e2bd9c2004-06-06 21:51:03 +00004498 i2cfast - (PPC405GP|PPC405EP only)
4499 if set to 'y' configures Linux I2C driver for fast
4500 mode (400kHZ). This environment variable is used in
4501 initialization code. So, for changes to be effective
4502 it must be saved and board must be reset.
4503
wdenk6c59edc2004-05-03 20:45:30 +00004504 initrd_high - restrict positioning of initrd images:
4505 If this variable is not set, initrd images will be
4506 copied to the highest possible address in RAM; this
4507 is usually what you want since it allows for
4508 maximum initrd size. If for some reason you want to
4509 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004510 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004511 variable to a value of "no" or "off" or "0".
4512 Alternatively, you can set it to a maximum upper
4513 address to use (U-Boot will still check that it
4514 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk6c59edc2004-05-03 20:45:30 +00004516 For instance, when you have a system with 16 MB
4517 RAM, and want to reserve 4 MB from use by Linux,
4518 you can do this by adding "mem=12M" to the value of
4519 the "bootargs" variable. However, now you must make
4520 sure that the initrd image is placed in the first
4521 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004522
wdenk6c59edc2004-05-03 20:45:30 +00004523 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004524
wdenk6c59edc2004-05-03 20:45:30 +00004525 If you set initrd_high to 0xFFFFFFFF, this is an
4526 indication to U-Boot that all addresses are legal
4527 for the Linux kernel, including addresses in flash
4528 memory. In this case U-Boot will NOT COPY the
4529 ramdisk at all. This may be useful to reduce the
4530 boot time on your system, but requires that this
4531 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004532
wdenk6c59edc2004-05-03 20:45:30 +00004533 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004534
wdenk6c59edc2004-05-03 20:45:30 +00004535 loadaddr - Default load address for commands like "bootp",
4536 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004537
wdenk6c59edc2004-05-03 20:45:30 +00004538 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004539
wdenk6c59edc2004-05-03 20:45:30 +00004540 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004541
wdenk6c59edc2004-05-03 20:45:30 +00004542 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004543
wdenk6c59edc2004-05-03 20:45:30 +00004544 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004545
wdenk6c59edc2004-05-03 20:45:30 +00004546 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004547
Mike Frysingera23230c2011-10-02 10:01:27 +00004548 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004549
Mike Frysingera23230c2011-10-02 10:01:27 +00004550 ethact - controls which interface is currently active.
4551 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004552
Heiko Schocherc5e84052010-07-20 17:45:02 +02004553 => setenv ethact FEC
4554 => ping 192.168.0.1 # traffic sent on FEC
4555 => setenv ethact SCC
4556 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004557
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004558 ethrotate - When set to "no" U-Boot does not go through all
4559 available network interfaces.
4560 It just stays at the currently selected interface.
4561
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004562 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004563 either succeed or fail without retrying.
4564 When set to "once" the network operation will
4565 fail when all the available network interfaces
4566 are tried once without success.
4567 Useful on scripts which control the retry operation
4568 themselves.
wdenkc6097192002-11-03 00:24:07 +00004569
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004570 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004571
Wolfgang Denk227b5192005-09-24 23:25:46 +02004572 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004573 UDP source port.
4574
Wolfgang Denk227b5192005-09-24 23:25:46 +02004575 tftpdstport - If this is set, the value is used for TFTP's UDP
4576 destination port instead of the Well Know Port 69.
4577
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004578 tftpblocksize - Block size to use for TFTP transfers; if not set,
4579 we use the TFTP server's default block size
4580
4581 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4582 seconds, minimum value is 1000 = 1 second). Defines
4583 when a packet is considered to be lost so it has to
4584 be retransmitted. The default is 5000 = 5 seconds.
4585 Lowering this value may make downloads succeed
4586 faster in networks with high packet loss rates or
4587 with unreliable TFTP servers.
4588
4589 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004590 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004591 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004592
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004593The following image location variables contain the location of images
4594used in booting. The "Image" column gives the role of the image and is
4595not an environment variable name. The other columns are environment
4596variable names. "File Name" gives the name of the file on a TFTP
4597server, "RAM Address" gives the location in RAM the image will be
4598loaded to, and "Flash Location" gives the image's address in NOR
4599flash or offset in NAND flash.
4600
4601*Note* - these variables don't have to be defined for all boards, some
4602boards currenlty use other variables for these purposes, and some
4603boards use these variables for other purposes.
4604
Wolfgang Denk092ae952011-10-26 10:21:21 +00004605Image File Name RAM Address Flash Location
4606----- --------- ----------- --------------
4607u-boot u-boot u-boot_addr_r u-boot_addr
4608Linux kernel bootfile kernel_addr_r kernel_addr
4609device tree blob fdtfile fdt_addr_r fdt_addr
4610ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004611
wdenk6c59edc2004-05-03 20:45:30 +00004612The following environment variables may be used and automatically
4613updated by the network boot commands ("bootp" and "rarpboot"),
4614depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004615
wdenk6c59edc2004-05-03 20:45:30 +00004616 bootfile - see above
4617 dnsip - IP address of your Domain Name Server
4618 dnsip2 - IP address of your secondary Domain Name Server
4619 gatewayip - IP address of the Gateway (Router) to use
4620 hostname - Target hostname
4621 ipaddr - see above
4622 netmask - Subnet Mask
4623 rootpath - Pathname of the root filesystem on the NFS server
4624 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004625
wdenk145d2c12004-04-15 21:48:45 +00004626
wdenk6c59edc2004-05-03 20:45:30 +00004627There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004628
wdenk6c59edc2004-05-03 20:45:30 +00004629 serial# - contains hardware identification information such
4630 as type string and/or serial number
4631 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk6c59edc2004-05-03 20:45:30 +00004633These variables can be set only once (usually during manufacturing of
4634the board). U-Boot refuses to delete or overwrite these variables
4635once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004636
4637
wdenk6c59edc2004-05-03 20:45:30 +00004638Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk6c59edc2004-05-03 20:45:30 +00004640 ver - Contains the U-Boot version string as printed
4641 with the "version" command. This variable is
4642 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004643
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk6c59edc2004-05-03 20:45:30 +00004645Please note that changes to some configuration parameters may take
4646only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004647
stroeseb9c17c52003-04-04 15:53:41 +00004648
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004649Callback functions for environment variables:
4650---------------------------------------------
4651
4652For some environment variables, the behavior of u-boot needs to change
4653when their values are changed. This functionailty allows functions to
4654be associated with arbitrary variables. On creation, overwrite, or
4655deletion, the callback will provide the opportunity for some side
4656effect to happen or for the change to be rejected.
4657
4658The callbacks are named and associated with a function using the
4659U_BOOT_ENV_CALLBACK macro in your board or driver code.
4660
4661These callbacks are associated with variables in one of two ways. The
4662static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4663in the board configuration to a string that defines a list of
4664associations. The list must be in the following format:
4665
4666 entry = variable_name[:callback_name]
4667 list = entry[,list]
4668
4669If the callback name is not specified, then the callback is deleted.
4670Spaces are also allowed anywhere in the list.
4671
4672Callbacks can also be associated by defining the ".callbacks" variable
4673with the same list format above. Any association in ".callbacks" will
4674override any association in the static list. You can define
4675CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4676".callbacks" envirnoment variable in the default or embedded environment.
4677
4678
wdenk6c59edc2004-05-03 20:45:30 +00004679Command Line Parsing:
4680=====================
stroeseb9c17c52003-04-04 15:53:41 +00004681
wdenk6c59edc2004-05-03 20:45:30 +00004682There are two different command line parsers available with U-Boot:
4683the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk6c59edc2004-05-03 20:45:30 +00004685Old, simple command line parser:
4686--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004687
wdenk6c59edc2004-05-03 20:45:30 +00004688- supports environment variables (through setenv / saveenv commands)
4689- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004690- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004691- special characters ('$', ';') can be escaped by prefixing with '\',
4692 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004693 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004694- You can also escape text by enclosing in single apostrophes, for example:
4695 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004696
wdenk6c59edc2004-05-03 20:45:30 +00004697Hush shell:
4698-----------
wdenkf4688a22003-05-28 08:06:31 +00004699
wdenk6c59edc2004-05-03 20:45:30 +00004700- similar to Bourne shell, with control structures like
4701 if...then...else...fi, for...do...done; while...do...done,
4702 until...do...done, ...
4703- supports environment ("global") variables (through setenv / saveenv
4704 commands) and local shell variables (through standard shell syntax
4705 "name=value"); only environment variables can be used with "run"
4706 command
wdenkf4688a22003-05-28 08:06:31 +00004707
wdenk6c59edc2004-05-03 20:45:30 +00004708General rules:
4709--------------
wdenkf4688a22003-05-28 08:06:31 +00004710
wdenk6c59edc2004-05-03 20:45:30 +00004711(1) If a command line (or an environment variable executed by a "run"
4712 command) contains several commands separated by semicolon, and
4713 one of these commands fails, then the remaining commands will be
4714 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004715
wdenk6c59edc2004-05-03 20:45:30 +00004716(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004717 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004718 command will cause "run" to terminate, i. e. the remaining
4719 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004720
wdenk6c59edc2004-05-03 20:45:30 +00004721Note for Redundant Ethernet Interfaces:
4722=======================================
wdenkf4688a22003-05-28 08:06:31 +00004723
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004724Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004725such configurations and is capable of automatic selection of a
4726"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004727
wdenk6c59edc2004-05-03 20:45:30 +00004728Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4729MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4730"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004731
wdenk6c59edc2004-05-03 20:45:30 +00004732If the network interface stores some valid MAC address (for instance
4733in SROM), this is used as default address if there is NO correspon-
4734ding setting in the environment; if the corresponding environment
4735variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004736
wdenk6c59edc2004-05-03 20:45:30 +00004737o If the SROM has a valid MAC address, and there is no address in the
4738 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004739
wdenk6c59edc2004-05-03 20:45:30 +00004740o If there is no valid address in the SROM, and a definition in the
4741 environment exists, then the value from the environment variable is
4742 used.
wdenkc6097192002-11-03 00:24:07 +00004743
wdenk6c59edc2004-05-03 20:45:30 +00004744o If both the SROM and the environment contain a MAC address, and
4745 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk6c59edc2004-05-03 20:45:30 +00004747o If both the SROM and the environment contain a MAC address, and the
4748 addresses differ, the value from the environment is used and a
4749 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk6c59edc2004-05-03 20:45:30 +00004751o If neither SROM nor the environment contain a MAC address, an error
4752 is raised.
wdenkc6097192002-11-03 00:24:07 +00004753
Ben Warren6db991a2010-04-26 11:11:46 -07004754If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004755will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004756may be skipped by setting the appropriate 'ethmacskip' environment variable.
4757The naming convention is as follows:
4758"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk6c59edc2004-05-03 20:45:30 +00004760Image Formats:
4761==============
wdenkc6097192002-11-03 00:24:07 +00004762
Marian Balakowicz18710b82008-03-12 12:13:13 +01004763U-Boot is capable of booting (and performing other auxiliary operations on)
4764images in two formats:
4765
4766New uImage format (FIT)
4767-----------------------
4768
4769Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4770to Flattened Device Tree). It allows the use of images with multiple
4771components (several kernels, ramdisks, etc.), with contents protected by
4772SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4773
4774
4775Old uImage format
4776-----------------
4777
4778Old image format is based on binary files which can be basically anything,
4779preceded by a special header; see the definitions in include/image.h for
4780details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk6c59edc2004-05-03 20:45:30 +00004782* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4783 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004784 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4785 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4786 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004787* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004788 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4789 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004790* Compression Type (uncompressed, gzip, bzip2)
4791* Load Address
4792* Entry Point
4793* Image Name
4794* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004795
wdenk6c59edc2004-05-03 20:45:30 +00004796The header is marked by a special Magic Number, and both the header
4797and the data portions of the image are secured against corruption by
4798CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004799
wdenkc6097192002-11-03 00:24:07 +00004800
wdenk6c59edc2004-05-03 20:45:30 +00004801Linux Support:
4802==============
wdenkc6097192002-11-03 00:24:07 +00004803
wdenk6c59edc2004-05-03 20:45:30 +00004804Although U-Boot should support any OS or standalone application
4805easily, the main focus has always been on Linux during the design of
4806U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk6c59edc2004-05-03 20:45:30 +00004808U-Boot includes many features that so far have been part of some
4809special "boot loader" code within the Linux kernel. Also, any
4810"initrd" images to be used are no longer part of one big Linux image;
4811instead, kernel and "initrd" are separate images. This implementation
4812serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004813
wdenk6c59edc2004-05-03 20:45:30 +00004814- the same features can be used for other OS or standalone
4815 applications (for instance: using compressed images to reduce the
4816 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004817
wdenk6c59edc2004-05-03 20:45:30 +00004818- it becomes much easier to port new Linux kernel versions because
4819 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004820
wdenk6c59edc2004-05-03 20:45:30 +00004821- the same Linux kernel image can now be used with different "initrd"
4822 images; of course this also means that different kernel images can
4823 be run with the same "initrd". This makes testing easier (you don't
4824 have to build a new "zImage.initrd" Linux image when you just
4825 change a file in your "initrd"). Also, a field-upgrade of the
4826 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004827
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk6c59edc2004-05-03 20:45:30 +00004829Linux HOWTO:
4830============
wdenkc6097192002-11-03 00:24:07 +00004831
wdenk6c59edc2004-05-03 20:45:30 +00004832Porting Linux to U-Boot based systems:
4833---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004834
wdenk6c59edc2004-05-03 20:45:30 +00004835U-Boot cannot save you from doing all the necessary modifications to
4836configure the Linux device drivers for use with your target hardware
4837(no, we don't intend to provide a full virtual machine interface to
4838Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004839
Stefan Roese88fbf932010-04-15 16:07:28 +02004840But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004841
wdenk6c59edc2004-05-03 20:45:30 +00004842Just make sure your machine specific header file (for instance
4843include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004844Information structure as we define in include/asm-<arch>/u-boot.h,
4845and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004846as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004847
wdenkc6097192002-11-03 00:24:07 +00004848
wdenk6c59edc2004-05-03 20:45:30 +00004849Configuring the Linux kernel:
4850-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004851
wdenk6c59edc2004-05-03 20:45:30 +00004852No specific requirements for U-Boot. Make sure you have some root
4853device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004854
wdenkc6097192002-11-03 00:24:07 +00004855
wdenk6c59edc2004-05-03 20:45:30 +00004856Building a Linux Image:
4857-----------------------
wdenkc6097192002-11-03 00:24:07 +00004858
wdenk6c59edc2004-05-03 20:45:30 +00004859With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4860not used. If you use recent kernel source, a new build target
4861"uImage" will exist which automatically builds an image usable by
4862U-Boot. Most older kernels also have support for a "pImage" target,
4863which was introduced for our predecessor project PPCBoot and uses a
4864100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk6c59edc2004-05-03 20:45:30 +00004866Example:
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk6c59edc2004-05-03 20:45:30 +00004868 make TQM850L_config
4869 make oldconfig
4870 make dep
4871 make uImage
wdenkc6097192002-11-03 00:24:07 +00004872
wdenk6c59edc2004-05-03 20:45:30 +00004873The "uImage" build target uses a special tool (in 'tools/mkimage') to
4874encapsulate a compressed Linux kernel image with header information,
4875CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004876
wdenk6c59edc2004-05-03 20:45:30 +00004877* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk6c59edc2004-05-03 20:45:30 +00004879* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881 ${CROSS_COMPILE}-objcopy -O binary \
4882 -R .note -R .comment \
4883 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004884
wdenk6c59edc2004-05-03 20:45:30 +00004885* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004886
wdenk6c59edc2004-05-03 20:45:30 +00004887 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004888
wdenk6c59edc2004-05-03 20:45:30 +00004889* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004890
wdenk6c59edc2004-05-03 20:45:30 +00004891 mkimage -A ppc -O linux -T kernel -C gzip \
4892 -a 0 -e 0 -n "Linux Kernel Image" \
4893 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004894
wdenkc6097192002-11-03 00:24:07 +00004895
wdenk6c59edc2004-05-03 20:45:30 +00004896The "mkimage" tool can also be used to create ramdisk images for use
4897with U-Boot, either separated from the Linux kernel image, or
4898combined into one file. "mkimage" encapsulates the images with a 64
4899byte header containing information about target architecture,
4900operating system, image type, compression method, entry points, time
4901stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004902
wdenk6c59edc2004-05-03 20:45:30 +00004903"mkimage" can be called in two ways: to verify existing images and
4904print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004905
wdenk6c59edc2004-05-03 20:45:30 +00004906In the first form (with "-l" option) mkimage lists the information
4907contained in the header of an existing U-Boot image; this includes
4908checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004909
wdenk6c59edc2004-05-03 20:45:30 +00004910 tools/mkimage -l image
4911 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004912
wdenk6c59edc2004-05-03 20:45:30 +00004913The second form (with "-d" option) is used to build a U-Boot image
4914from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004915
wdenk6c59edc2004-05-03 20:45:30 +00004916 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4917 -n name -d data_file image
4918 -A ==> set architecture to 'arch'
4919 -O ==> set operating system to 'os'
4920 -T ==> set image type to 'type'
4921 -C ==> set compression type 'comp'
4922 -a ==> set load address to 'addr' (hex)
4923 -e ==> set entry point to 'ep' (hex)
4924 -n ==> set image name to 'name'
4925 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004926
wdenkcd914452004-05-29 16:53:29 +00004927Right now, all Linux kernels for PowerPC systems use the same load
4928address (0x00000000), but the entry point address depends on the
4929kernel version:
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk6c59edc2004-05-03 20:45:30 +00004931- 2.2.x kernels have the entry point at 0x0000000C,
4932- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk6c59edc2004-05-03 20:45:30 +00004934So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk6c59edc2004-05-03 20:45:30 +00004936 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4937 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004938 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004939 > examples/uImage.TQM850L
4940 Image Name: 2.4.4 kernel for TQM850L
4941 Created: Wed Jul 19 02:34:59 2000
4942 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4943 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4944 Load Address: 0x00000000
4945 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004946
wdenk6c59edc2004-05-03 20:45:30 +00004947To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004948
wdenk6c59edc2004-05-03 20:45:30 +00004949 -> tools/mkimage -l examples/uImage.TQM850L
4950 Image Name: 2.4.4 kernel for TQM850L
4951 Created: Wed Jul 19 02:34:59 2000
4952 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4953 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4954 Load Address: 0x00000000
4955 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004956
wdenk6c59edc2004-05-03 20:45:30 +00004957NOTE: for embedded systems where boot time is critical you can trade
4958speed for memory and install an UNCOMPRESSED image instead: this
4959needs more space in Flash, but boots much faster since it does not
4960need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004961
Stefan Roese88fbf932010-04-15 16:07:28 +02004962 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004963 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4964 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004965 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004966 > examples/uImage.TQM850L-uncompressed
4967 Image Name: 2.4.4 kernel for TQM850L
4968 Created: Wed Jul 19 02:34:59 2000
4969 Image Type: PowerPC Linux Kernel Image (uncompressed)
4970 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4971 Load Address: 0x00000000
4972 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004973
wdenkc6097192002-11-03 00:24:07 +00004974
wdenk6c59edc2004-05-03 20:45:30 +00004975Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4976when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004977
wdenk6c59edc2004-05-03 20:45:30 +00004978 -> tools/mkimage -n 'Simple Ramdisk Image' \
4979 > -A ppc -O linux -T ramdisk -C gzip \
4980 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4981 Image Name: Simple Ramdisk Image
4982 Created: Wed Jan 12 14:01:50 2000
4983 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4984 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4985 Load Address: 0x00000000
4986 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004987
wdenkc6097192002-11-03 00:24:07 +00004988
wdenk6c59edc2004-05-03 20:45:30 +00004989Installing a Linux Image:
4990-------------------------
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992To downloading a U-Boot image over the serial (console) interface,
4993you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk6c59edc2004-05-03 20:45:30 +00004997The 'objcopy' does not understand the information in the U-Boot
4998image header, so the resulting S-Record file will be relative to
4999address 0x00000000. To load it to a given address, you need to
5000specify the target address as 'offset' parameter with the 'loads'
5001command.
wdenkc6097192002-11-03 00:24:07 +00005002
wdenk6c59edc2004-05-03 20:45:30 +00005003Example: install the image to address 0x40100000 (which on the
5004TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005005
wdenk6c59edc2004-05-03 20:45:30 +00005006 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +00005008 .......... done
5009 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk6c59edc2004-05-03 20:45:30 +00005011 => loads 40100000
5012 ## Ready for S-Record download ...
5013 ~>examples/image.srec
5014 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5015 ...
5016 15989 15990 15991 15992
5017 [file transfer complete]
5018 [connected]
5019 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005020
wdenkc6097192002-11-03 00:24:07 +00005021
wdenk6c59edc2004-05-03 20:45:30 +00005022You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005023this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005024corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk6c59edc2004-05-03 20:45:30 +00005028 ## Checking Image at 40100000 ...
5029 Image Name: 2.2.13 for initrd on TQM850L
5030 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5031 Data Size: 335725 Bytes = 327 kB = 0 MB
5032 Load Address: 00000000
5033 Entry Point: 0000000c
5034 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005035
5036
wdenk6c59edc2004-05-03 20:45:30 +00005037Boot Linux:
5038-----------
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk6c59edc2004-05-03 20:45:30 +00005040The "bootm" command is used to boot an application that is stored in
5041memory (RAM or Flash). In case of a Linux kernel image, the contents
5042of the "bootargs" environment variable is passed to the kernel as
5043parameters. You can check and modify this variable using the
5044"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005045
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk6c59edc2004-05-03 20:45:30 +00005047 => printenv bootargs
5048 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005049
wdenk6c59edc2004-05-03 20:45:30 +00005050 => 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 +00005051
wdenk6c59edc2004-05-03 20:45:30 +00005052 => printenv bootargs
5053 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 +00005054
wdenk6c59edc2004-05-03 20:45:30 +00005055 => bootm 40020000
5056 ## Booting Linux kernel at 40020000 ...
5057 Image Name: 2.2.13 for NFS on TQM850L
5058 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5059 Data Size: 381681 Bytes = 372 kB = 0 MB
5060 Load Address: 00000000
5061 Entry Point: 0000000c
5062 Verifying Checksum ... OK
5063 Uncompressing Kernel Image ... OK
5064 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
5065 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5066 time_init: decrementer frequency = 187500000/60
5067 Calibrating delay loop... 49.77 BogoMIPS
5068 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5069 ...
wdenkc6097192002-11-03 00:24:07 +00005070
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005071If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005072the memory addresses of both the kernel and the initrd image (PPBCOOT
5073format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005074
wdenk6c59edc2004-05-03 20:45:30 +00005075 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk6c59edc2004-05-03 20:45:30 +00005077 ## Checking Image at 40100000 ...
5078 Image Name: 2.2.13 for initrd on TQM850L
5079 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5080 Data Size: 335725 Bytes = 327 kB = 0 MB
5081 Load Address: 00000000
5082 Entry Point: 0000000c
5083 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005084
wdenk6c59edc2004-05-03 20:45:30 +00005085 ## Checking Image at 40200000 ...
5086 Image Name: Simple Ramdisk Image
5087 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5088 Data Size: 566530 Bytes = 553 kB = 0 MB
5089 Load Address: 00000000
5090 Entry Point: 00000000
5091 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk6c59edc2004-05-03 20:45:30 +00005093 => bootm 40100000 40200000
5094 ## Booting Linux kernel at 40100000 ...
5095 Image Name: 2.2.13 for initrd on TQM850L
5096 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5097 Data Size: 335725 Bytes = 327 kB = 0 MB
5098 Load Address: 00000000
5099 Entry Point: 0000000c
5100 Verifying Checksum ... OK
5101 Uncompressing Kernel Image ... OK
5102 ## Loading RAMDisk Image at 40200000 ...
5103 Image Name: Simple Ramdisk Image
5104 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5105 Data Size: 566530 Bytes = 553 kB = 0 MB
5106 Load Address: 00000000
5107 Entry Point: 00000000
5108 Verifying Checksum ... OK
5109 Loading Ramdisk ... OK
5110 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
5111 Boot arguments: root=/dev/ram
5112 time_init: decrementer frequency = 187500000/60
5113 Calibrating delay loop... 49.77 BogoMIPS
5114 ...
5115 RAMDISK: Compressed image found at block 0
5116 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118 bash#
wdenkc6097192002-11-03 00:24:07 +00005119
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005120Boot Linux and pass a flat device tree:
5121-----------
5122
5123First, U-Boot must be compiled with the appropriate defines. See the section
5124titled "Linux Kernel Interface" above for a more in depth explanation. The
5125following is an example of how to start a kernel and pass an updated
5126flat device tree:
5127
5128=> print oftaddr
5129oftaddr=0x300000
5130=> print oft
5131oft=oftrees/mpc8540ads.dtb
5132=> tftp $oftaddr $oft
5133Speed: 1000, full duplex
5134Using TSEC0 device
5135TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5136Filename 'oftrees/mpc8540ads.dtb'.
5137Load address: 0x300000
5138Loading: #
5139done
5140Bytes transferred = 4106 (100a hex)
5141=> tftp $loadaddr $bootfile
5142Speed: 1000, full duplex
5143Using TSEC0 device
5144TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5145Filename 'uImage'.
5146Load address: 0x200000
5147Loading:############
5148done
5149Bytes transferred = 1029407 (fb51f hex)
5150=> print loadaddr
5151loadaddr=200000
5152=> print oftaddr
5153oftaddr=0x300000
5154=> bootm $loadaddr - $oftaddr
5155## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005156 Image Name: Linux-2.6.17-dirty
5157 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5158 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005159 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005160 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005161 Verifying Checksum ... OK
5162 Uncompressing Kernel Image ... OK
5163Booting using flat device tree at 0x300000
5164Using MPC85xx ADS machine description
5165Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5166[snip]
5167
5168
wdenk6c59edc2004-05-03 20:45:30 +00005169More About U-Boot Image Types:
5170------------------------------
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk6c59edc2004-05-03 20:45:30 +00005172U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk6c59edc2004-05-03 20:45:30 +00005174 "Standalone Programs" are directly runnable in the environment
5175 provided by U-Boot; it is expected that (if they behave
5176 well) you can continue to work in U-Boot after return from
5177 the Standalone Program.
5178 "OS Kernel Images" are usually images of some Embedded OS which
5179 will take over control completely. Usually these programs
5180 will install their own set of exception handlers, device
5181 drivers, set up the MMU, etc. - this means, that you cannot
5182 expect to re-enter U-Boot except by resetting the CPU.
5183 "RAMDisk Images" are more or less just data blocks, and their
5184 parameters (address, size) are passed to an OS kernel that is
5185 being started.
5186 "Multi-File Images" contain several images, typically an OS
5187 (Linux) kernel image and one or more data images like
5188 RAMDisks. This construct is useful for instance when you want
5189 to boot over the network using BOOTP etc., where the boot
5190 server provides just a single image file, but you want to get
5191 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005192
wdenk6c59edc2004-05-03 20:45:30 +00005193 "Multi-File Images" start with a list of image sizes, each
5194 image size (in bytes) specified by an "uint32_t" in network
5195 byte order. This list is terminated by an "(uint32_t)0".
5196 Immediately after the terminating 0 follow the images, one by
5197 one, all aligned on "uint32_t" boundaries (size rounded up to
5198 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005199
wdenk6c59edc2004-05-03 20:45:30 +00005200 "Firmware Images" are binary images containing firmware (like
5201 U-Boot or FPGA images) which usually will be programmed to
5202 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005203
wdenk6c59edc2004-05-03 20:45:30 +00005204 "Script files" are command sequences that will be executed by
5205 U-Boot's command interpreter; this feature is especially
5206 useful when you configure U-Boot to use a real shell (hush)
5207 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005208
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005209Booting the Linux zImage:
5210-------------------------
5211
5212On some platforms, it's possible to boot Linux zImage. This is done
5213using the "bootz" command. The syntax of "bootz" command is the same
5214as the syntax of "bootm" command.
5215
Tom Rini45f46d12013-05-16 11:40:11 -04005216Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005217kernel with raw initrd images. The syntax is slightly different, the
5218address of the initrd must be augmented by it's size, in the following
5219format: "<initrd addres>:<initrd size>".
5220
stroeseb9c17c52003-04-04 15:53:41 +00005221
wdenk6c59edc2004-05-03 20:45:30 +00005222Standalone HOWTO:
5223=================
stroeseb9c17c52003-04-04 15:53:41 +00005224
wdenk6c59edc2004-05-03 20:45:30 +00005225One of the features of U-Boot is that you can dynamically load and
5226run "standalone" applications, which can use some resources of
5227U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005228
wdenk6c59edc2004-05-03 20:45:30 +00005229Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005230
wdenk6c59edc2004-05-03 20:45:30 +00005231"Hello World" Demo:
5232-------------------
wdenkc6097192002-11-03 00:24:07 +00005233
wdenk6c59edc2004-05-03 20:45:30 +00005234'examples/hello_world.c' contains a small "Hello World" Demo
5235application; it is automatically compiled when you build U-Boot.
5236It's configured to run at address 0x00040004, so you can play with it
5237like that:
wdenkc6097192002-11-03 00:24:07 +00005238
wdenk6c59edc2004-05-03 20:45:30 +00005239 => loads
5240 ## Ready for S-Record download ...
5241 ~>examples/hello_world.srec
5242 1 2 3 4 5 6 7 8 9 10 11 ...
5243 [file transfer complete]
5244 [connected]
5245 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005246
wdenk6c59edc2004-05-03 20:45:30 +00005247 => go 40004 Hello World! This is a test.
5248 ## Starting application at 0x00040004 ...
5249 Hello World
5250 argc = 7
5251 argv[0] = "40004"
5252 argv[1] = "Hello"
5253 argv[2] = "World!"
5254 argv[3] = "This"
5255 argv[4] = "is"
5256 argv[5] = "a"
5257 argv[6] = "test."
5258 argv[7] = "<NULL>"
5259 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk6c59edc2004-05-03 20:45:30 +00005261 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005262
wdenk6c59edc2004-05-03 20:45:30 +00005263Another example, which demonstrates how to register a CPM interrupt
5264handler with the U-Boot code, can be found in 'examples/timer.c'.
5265Here, a CPM timer is set up to generate an interrupt every second.
5266The interrupt service routine is trivial, just printing a '.'
5267character, but this is just a demo program. The application can be
5268controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270 ? - print current values og the CPM Timer registers
5271 b - enable interrupts and start timer
5272 e - stop timer and disable interrupts
5273 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk6c59edc2004-05-03 20:45:30 +00005275 => loads
5276 ## Ready for S-Record download ...
5277 ~>examples/timer.srec
5278 1 2 3 4 5 6 7 8 9 10 11 ...
5279 [file transfer complete]
5280 [connected]
5281 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk6c59edc2004-05-03 20:45:30 +00005283 => go 40004
5284 ## Starting application at 0x00040004 ...
5285 TIMERS=0xfff00980
5286 Using timer 1
5287 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk6c59edc2004-05-03 20:45:30 +00005289Hit 'b':
5290 [q, b, e, ?] Set interval 1000000 us
5291 Enabling timer
5292Hit '?':
5293 [q, b, e, ?] ........
5294 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5295Hit '?':
5296 [q, b, e, ?] .
5297 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5298Hit '?':
5299 [q, b, e, ?] .
5300 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5301Hit '?':
5302 [q, b, e, ?] .
5303 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5304Hit 'e':
5305 [q, b, e, ?] ...Stopping timer
5306Hit 'q':
5307 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005308
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk6c59edc2004-05-03 20:45:30 +00005310Minicom warning:
5311================
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk6c59edc2004-05-03 20:45:30 +00005313Over time, many people have reported problems when trying to use the
5314"minicom" terminal emulation program for serial download. I (wd)
5315consider minicom to be broken, and recommend not to use it. Under
5316Unix, I recommend to use C-Kermit for general purpose use (and
5317especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005318use "cu" for S-Record download ("loads" command). See
5319http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5320for help with kermit.
5321
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323Nevertheless, if you absolutely want to use it try adding this
5324configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005325
wdenk6c59edc2004-05-03 20:45:30 +00005326 Name Program Name U/D FullScr IO-Red. Multi
5327 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5328 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005329
wdenk8dba0502003-03-31 16:34:49 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331NetBSD Notes:
5332=============
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk6c59edc2004-05-03 20:45:30 +00005334Starting at version 0.9.2, U-Boot supports NetBSD both as host
5335(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005336
wdenk6c59edc2004-05-03 20:45:30 +00005337Building requires a cross environment; it is known to work on
5338NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5339need gmake since the Makefiles are not compatible with BSD make).
5340Note that the cross-powerpc package does not install include files;
5341attempting to build U-Boot will fail because <machine/ansi.h> is
5342missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005343
wdenk6c59edc2004-05-03 20:45:30 +00005344 # cd /usr/pkg/cross/powerpc-netbsd/include
5345 # mkdir powerpc
5346 # ln -s powerpc machine
5347 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5348 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005349
wdenk6c59edc2004-05-03 20:45:30 +00005350Native builds *don't* work due to incompatibilities between native
5351and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005352
wdenk6c59edc2004-05-03 20:45:30 +00005353Booting assumes that (the first part of) the image booted is a
5354stage-2 loader which in turn loads and then invokes the kernel
5355proper. Loader sources will eventually appear in the NetBSD source
5356tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005357meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005358
wdenkc6097192002-11-03 00:24:07 +00005359
wdenk6c59edc2004-05-03 20:45:30 +00005360Implementation Internals:
5361=========================
wdenkc6097192002-11-03 00:24:07 +00005362
wdenk6c59edc2004-05-03 20:45:30 +00005363The following is not intended to be a complete description of every
5364implementation detail. However, it should help to understand the
5365inner workings of U-Boot and make it easier to port it to custom
5366hardware.
wdenkc6097192002-11-03 00:24:07 +00005367
wdenkc6097192002-11-03 00:24:07 +00005368
wdenk6c59edc2004-05-03 20:45:30 +00005369Initial Stack, Global Data:
5370---------------------------
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372The implementation of U-Boot is complicated by the fact that U-Boot
5373starts running out of ROM (flash memory), usually without access to
5374system RAM (because the memory controller is not initialized yet).
5375This means that we don't have writable Data or BSS segments, and BSS
5376is not initialized as zero. To be able to get a C environment working
5377at all, we have to allocate at least a minimal stack. Implementation
5378options for this are defined and restricted by the CPU used: Some CPU
5379models provide on-chip memory (like the IMMR area on MPC8xx and
5380MPC826x processors), on others (parts of) the data cache can be
5381locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005382
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005383 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005384 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005385
wdenk6c59edc2004-05-03 20:45:30 +00005386 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5387 From: "Chris Hallinan" <clh@net1plus.com>
5388 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5389 ...
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391 Correct me if I'm wrong, folks, but the way I understand it
5392 is this: Using DCACHE as initial RAM for Stack, etc, does not
5393 require any physical RAM backing up the cache. The cleverness
5394 is that the cache is being used as a temporary supply of
5395 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005396 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005397 can see how this works by studying the cache architecture and
5398 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005399
wdenk6c59edc2004-05-03 20:45:30 +00005400 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5401 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005402 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005403 option should work for you. Using CS 4 should be fine if your
5404 board designers haven't used it for something that would
5405 cause you grief during the initial boot! It is frequently not
5406 used.
wdenkc6097192002-11-03 00:24:07 +00005407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005408 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005409 with your processor/board/system design. The default value
5410 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005411 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005412 than your SDRAM module. If you have a 64MB SDRAM module, set
5413 it above 400_0000. Just make sure your board has no resources
5414 that are supposed to respond to that address! That code in
5415 start.S has been around a while and should work as is when
5416 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005417
wdenk6c59edc2004-05-03 20:45:30 +00005418 -Chris Hallinan
5419 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005420
wdenk6c59edc2004-05-03 20:45:30 +00005421It is essential to remember this, since it has some impact on the C
5422code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005423
wdenk6c59edc2004-05-03 20:45:30 +00005424* Initialized global data (data segment) is read-only. Do not attempt
5425 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005426
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005427* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005428 as zero data - BSS segment) at all - this is undefined, initiali-
5429 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005430
wdenk6c59edc2004-05-03 20:45:30 +00005431* Stack space is very limited. Avoid big data buffers or things like
5432 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005433
wdenk6c59edc2004-05-03 20:45:30 +00005434Having only the stack as writable memory limits means we cannot use
5435normal global data to share information beween the code. But it
5436turned out that the implementation of U-Boot can be greatly
5437simplified by making a global data structure (gd_t) available to all
5438functions. We could pass a pointer to this data as argument to _all_
5439functions, but this would bloat the code. Instead we use a feature of
5440the GCC compiler (Global Register Variables) to share the data: we
5441place a pointer (gd) to the global data into a register which we
5442reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005443
wdenk6c59edc2004-05-03 20:45:30 +00005444When choosing a register for such a purpose we are restricted by the
5445relevant (E)ABI specifications for the current architecture, and by
5446GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk6c59edc2004-05-03 20:45:30 +00005448For PowerPC, the following registers have specific use:
5449 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005450 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005451 R3-R4: parameter passing and return values
5452 R5-R10: parameter passing
5453 R13: small data area pointer
5454 R30: GOT pointer
5455 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005456
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005457 (U-Boot also uses R12 as internal GOT pointer. r12
5458 is a volatile register so r12 needs to be reset when
5459 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005460
Wolfgang Denk69c09642008-02-14 22:43:22 +01005461 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005462
wdenk6c59edc2004-05-03 20:45:30 +00005463 Note: on PPC, we could use a static initializer (since the
5464 address of the global data structure is known at compile time),
5465 but it turned out that reserving a register results in somewhat
5466 smaller code - although the code savings are not that big (on
5467 average for all boards 752 bytes for the whole U-Boot image,
5468 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005469
Robin Getz2773d5f2009-08-17 15:23:02 +00005470On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005471 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5472
Robin Getz2773d5f2009-08-17 15:23:02 +00005473 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005474
wdenk6c59edc2004-05-03 20:45:30 +00005475On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005476
wdenk6c59edc2004-05-03 20:45:30 +00005477 R0: function argument word/integer result
5478 R1-R3: function argument word
5479 R9: GOT pointer
5480 R10: stack limit (used only if stack checking if enabled)
5481 R11: argument (frame) pointer
5482 R12: temporary workspace
5483 R13: stack pointer
5484 R14: link register
5485 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005486
wdenk6c59edc2004-05-03 20:45:30 +00005487 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005488
Thomas Chou8fa38582010-05-21 11:08:03 +08005489On Nios II, the ABI is documented here:
5490 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5491
5492 ==> U-Boot will use gp to hold a pointer to the global data
5493
5494 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5495 to access small data sections, so gp is free.
5496
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005497On NDS32, the following registers are used:
5498
5499 R0-R1: argument/return
5500 R2-R5: argument
5501 R15: temporary register for assembler
5502 R16: trampoline register
5503 R28: frame pointer (FP)
5504 R29: global pointer (GP)
5505 R30: link register (LP)
5506 R31: stack pointer (SP)
5507 PC: program counter (PC)
5508
5509 ==> U-Boot will use R10 to hold a pointer to the global data
5510
Wolfgang Denk6405a152006-03-31 18:32:53 +02005511NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5512or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005513
wdenk6c59edc2004-05-03 20:45:30 +00005514Memory Management:
5515------------------
wdenkc6097192002-11-03 00:24:07 +00005516
wdenk6c59edc2004-05-03 20:45:30 +00005517U-Boot runs in system state and uses physical addresses, i.e. the
5518MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520The available memory is mapped to fixed addresses using the memory
5521controller. In this process, a contiguous block is formed for each
5522memory type (Flash, SDRAM, SRAM), even when it consists of several
5523physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005524
wdenk6c59edc2004-05-03 20:45:30 +00005525U-Boot is installed in the first 128 kB of the first Flash bank (on
5526TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5527booting and sizing and initializing DRAM, the code relocates itself
5528to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005529memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005530configuration setting]. Below that, a structure with global Board
5531Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533Additionally, some exception handler code is copied to the low 8 kB
5534of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005535
wdenk6c59edc2004-05-03 20:45:30 +00005536So a typical memory configuration with 16 MB of DRAM could look like
5537this:
wdenkc6097192002-11-03 00:24:07 +00005538
wdenk6c59edc2004-05-03 20:45:30 +00005539 0x0000 0000 Exception Vector code
5540 :
5541 0x0000 1FFF
5542 0x0000 2000 Free for Application Use
5543 :
5544 :
wdenkc6097192002-11-03 00:24:07 +00005545
wdenk6c59edc2004-05-03 20:45:30 +00005546 :
5547 :
5548 0x00FB FF20 Monitor Stack (Growing downward)
5549 0x00FB FFAC Board Info Data and permanent copy of global data
5550 0x00FC 0000 Malloc Arena
5551 :
5552 0x00FD FFFF
5553 0x00FE 0000 RAM Copy of Monitor Code
5554 ... eventually: LCD or video framebuffer
5555 ... eventually: pRAM (Protected RAM - unchanged by reset)
5556 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005557
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559System Initialization:
5560----------------------
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk6c59edc2004-05-03 20:45:30 +00005562In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005563(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005564configuration for CS0# this is a mirror of the onboard Flash memory.
5565To be able to re-map memory U-Boot then jumps to its link address.
5566To be able to implement the initialization code in C, a (small!)
5567initial stack is set up in the internal Dual Ported RAM (in case CPUs
5568which provide such a feature like MPC8xx or MPC8260), or in a locked
5569part of the data cache. After that, U-Boot initializes the CPU core,
5570the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005571
wdenk6c59edc2004-05-03 20:45:30 +00005572Next, all (potentially) available memory banks are mapped using a
5573preliminary mapping. For example, we put them on 512 MB boundaries
5574(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5575on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5576programmed for SDRAM access. Using the temporary configuration, a
5577simple memory test is run that determines the size of the SDRAM
5578banks.
wdenkc6097192002-11-03 00:24:07 +00005579
wdenk6c59edc2004-05-03 20:45:30 +00005580When there is more than one SDRAM bank, and the banks are of
5581different size, the largest is mapped first. For equal size, the first
5582bank (CS2#) is mapped first. The first mapping is always for address
55830x00000000, with any additional banks following immediately to create
5584contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586Then, the monitor installs itself at the upper end of the SDRAM area
5587and allocates memory for use by malloc() and for the global Board
5588Info data; also, the exception vector code is copied to the low RAM
5589pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005590
wdenk6c59edc2004-05-03 20:45:30 +00005591Only after this relocation will you have a "normal" C environment;
5592until that you are restricted in several ways, mostly because you are
5593running from ROM, and because the code will have to be relocated to a
5594new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005595
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk6c59edc2004-05-03 20:45:30 +00005597U-Boot Porting Guide:
5598----------------------
wdenkc6097192002-11-03 00:24:07 +00005599
wdenk6c59edc2004-05-03 20:45:30 +00005600[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5601list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005602
wdenkc6097192002-11-03 00:24:07 +00005603
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005604int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005605{
5606 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005607
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005608 signal(SIGALRM, no_more_time);
5609 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005612 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005613 return 0;
5614 }
wdenkc6097192002-11-03 00:24:07 +00005615
wdenk6c59edc2004-05-03 20:45:30 +00005616 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005617
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005618 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005619
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005620 if (clueless)
5621 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005622
wdenk6c59edc2004-05-03 20:45:30 +00005623 while (learning) {
5624 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005625 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5626 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005627 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005628 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005629 }
wdenkc6097192002-11-03 00:24:07 +00005630
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005631 if (available_money > toLocalCurrency ($2500))
5632 Buy a BDI3000;
5633 else
wdenk6c59edc2004-05-03 20:45:30 +00005634 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005635
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005636 if (a similar board exists) { /* hopefully... */
5637 cp -a board/<similar> board/<myboard>
5638 cp include/configs/<similar>.h include/configs/<myboard>.h
5639 } else {
5640 Create your own board support subdirectory;
5641 Create your own board include/configs/<myboard>.h file;
5642 }
5643 Edit new board/<myboard> files
5644 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005645
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005646 while (!accepted) {
5647 while (!running) {
5648 do {
5649 Add / modify source code;
5650 } until (compiles);
5651 Debug;
5652 if (clueless)
5653 email("Hi, I am having problems...");
5654 }
5655 Send patch file to the U-Boot email list;
5656 if (reasonable critiques)
5657 Incorporate improvements from email list code review;
5658 else
5659 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005660 }
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk6c59edc2004-05-03 20:45:30 +00005662 return 0;
5663}
wdenkc6097192002-11-03 00:24:07 +00005664
wdenk6c59edc2004-05-03 20:45:30 +00005665void no_more_time (int sig)
5666{
5667 hire_a_guru();
5668}
wdenkc6097192002-11-03 00:24:07 +00005669
wdenkc6097192002-11-03 00:24:07 +00005670
wdenk6c59edc2004-05-03 20:45:30 +00005671Coding Standards:
5672-----------------
wdenkc6097192002-11-03 00:24:07 +00005673
wdenk6c59edc2004-05-03 20:45:30 +00005674All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005675coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005676"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005677
5678Source files originating from a different project (for example the
5679MTD subsystem) are generally exempt from these guidelines and are not
5680reformated to ease subsequent migration to newer versions of those
5681sources.
wdenkc6097192002-11-03 00:24:07 +00005682
Detlev Zundelaa63d482006-09-01 15:39:02 +02005683Please note that U-Boot is implemented in C (and to some small parts in
5684Assembler); no C++ is used, so please do not use C++ style comments (//)
5685in your code.
wdenkad276f22004-01-04 16:28:35 +00005686
wdenk6c59edc2004-05-03 20:45:30 +00005687Please also stick to the following formatting rules:
5688- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005689- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005690- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005691- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005692- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694Submissions which do not conform to the standards may be returned
5695with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005696
wdenkc6097192002-11-03 00:24:07 +00005697
wdenk6c59edc2004-05-03 20:45:30 +00005698Submitting Patches:
5699-------------------
wdenkc6097192002-11-03 00:24:07 +00005700
wdenk6c59edc2004-05-03 20:45:30 +00005701Since the number of patches for U-Boot is growing, we need to
5702establish some rules. Submissions which do not conform to these rules
5703may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005704
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005705Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005706
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005707Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5708see http://lists.denx.de/mailman/listinfo/u-boot
5709
wdenk6c59edc2004-05-03 20:45:30 +00005710When you send a patch, please include the following information with
5711it:
wdenkc6097192002-11-03 00:24:07 +00005712
wdenk6c59edc2004-05-03 20:45:30 +00005713* For bug fixes: a description of the bug and how your patch fixes
5714 this bug. Please try to include a way of demonstrating that the
5715 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk6c59edc2004-05-03 20:45:30 +00005717* For new features: a description of the feature and your
5718 implementation.
wdenkc6097192002-11-03 00:24:07 +00005719
wdenk6c59edc2004-05-03 20:45:30 +00005720* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005721
wdenk6c59edc2004-05-03 20:45:30 +00005722* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk6c59edc2004-05-03 20:45:30 +00005724* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005725 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727* If your patch adds new configuration options, don't forget to
5728 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005729
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005730* The patch itself. If you are using git (which is *strongly*
5731 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005732 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005733 the U-Boot mailing list, you will avoid most of the common problems
5734 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005735
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005736 If you cannot use git, use "diff -purN OLD NEW". If your version of
5737 diff does not support these options, then get the latest version of
5738 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005739
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005740 The current directory when running this command shall be the parent
5741 directory of the U-Boot source tree (i. e. please make sure that
5742 your patch includes sufficient directory information for the
5743 affected files).
5744
5745 We prefer patches as plain text. MIME attachments are discouraged,
5746 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005747
wdenk6c59edc2004-05-03 20:45:30 +00005748* If one logical set of modifications affects or creates several
5749 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005750
wdenk6c59edc2004-05-03 20:45:30 +00005751* Changesets that contain different, unrelated modifications shall be
5752 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005753
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk6c59edc2004-05-03 20:45:30 +00005755Notes:
wdenkc6097192002-11-03 00:24:07 +00005756
wdenk6c59edc2004-05-03 20:45:30 +00005757* Before sending the patch, run the MAKEALL script on your patched
5758 source tree and make sure that no errors or warnings are reported
5759 for any of the boards.
5760
5761* Keep your modifications to the necessary minimum: A patch
5762 containing several unrelated changes or arbitrary reformats will be
5763 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005764
wdenk6c59edc2004-05-03 20:45:30 +00005765* If you modify existing code, make sure that your new code does not
5766 add to the memory footprint of the code ;-) Small is beautiful!
5767 When adding new features, these should compile conditionally only
5768 (using #ifdef), and the resulting code with the new feature
5769 disabled must not need more memory than the old code without your
5770 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005771
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005772* Remember that there is a size limit of 100 kB per message on the
5773 u-boot mailing list. Bigger patches will be moderated. If they are
5774 reasonable and not too big, they will be acknowledged. But patches
5775 bigger than the size limit should be avoided.