blob: 6852080c4349bee851f643ad2b29cb6479d6013e [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
416 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418 This is the value to write into CCSR offset 0x18600
419 according to the A004510 workaround.
420
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000421- Generic CPU options:
422 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
423
424 Defines the endianess of the CPU. Implementation of those
425 values is arch specific.
426
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100427- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200428 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100429
430 Defines the Monahans run mode to oscillator
431 ratio. Valid values are 8, 16, 24, 31. The core
432 frequency is this value multiplied by 13 MHz.
433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200434 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200435
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100436 Defines the Monahans turbo mode to oscillator
437 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200438 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100439 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200440
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200441- MIPS CPU options:
442 CONFIG_SYS_INIT_SP_OFFSET
443
444 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
445 pointer. This is needed for the temporary stack before
446 relocation.
447
448 CONFIG_SYS_MIPS_CACHE_MODE
449
450 Cache operation mode for the MIPS CPU.
451 See also arch/mips/include/asm/mipsregs.h.
452 Possible values are:
453 CONF_CM_CACHABLE_NO_WA
454 CONF_CM_CACHABLE_WA
455 CONF_CM_UNCACHED
456 CONF_CM_CACHABLE_NONCOHERENT
457 CONF_CM_CACHABLE_CE
458 CONF_CM_CACHABLE_COW
459 CONF_CM_CACHABLE_CUW
460 CONF_CM_CACHABLE_ACCELERATED
461
462 CONFIG_SYS_XWAY_EBU_BOOTCFG
463
464 Special option for Lantiq XWAY SoCs for booting from NOR flash.
465 See also arch/mips/cpu/mips32/start.S.
466
467 CONFIG_XWAY_SWAP_BYTES
468
469 Enable compilation of tools/xway-swap-bytes needed for Lantiq
470 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
471 be swapped if a flash programmer is used.
472
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000473- ARM options:
474 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
475
476 Select high exception vectors of the ARM core, e.g., do not
477 clear the V bit of the c1 register of CP15.
478
Aneesh Vb8e40802012-03-08 07:20:19 +0000479 CONFIG_SYS_THUMB_BUILD
480
481 Use this flag to build U-Boot using the Thumb instruction
482 set for ARM architectures. Thumb instruction set provides
483 better code density. For ARM architectures that support
484 Thumb2 this flag will result in Thumb2 code generated by
485 GCC.
486
Stephen Warrenc63c3502013-03-04 13:29:40 +0000487 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000488 CONFIG_ARM_ERRATA_742230
489 CONFIG_ARM_ERRATA_743622
490 CONFIG_ARM_ERRATA_751472
491
492 If set, the workarounds for these ARM errata are applied early
493 during U-Boot startup. Note that these options force the
494 workarounds to be applied; no CPU-type/version detection
495 exists, unlike the similar options in the Linux kernel. Do not
496 set these options unless they apply!
497
Stephen Warren445d56c2013-03-27 17:06:41 +0000498- CPU timer options:
499 CONFIG_SYS_HZ
500
501 The frequency of the timer returned by get_timer().
502 get_timer() must operate in milliseconds and this CONFIG
503 option must be set to 1000.
504
wdenk9b7f3842003-10-09 20:09:04 +0000505- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000506 CONFIG_CLOCKS_IN_MHZ
507
508 U-Boot stores all clock information in Hz
509 internally. For binary compatibility with older Linux
510 kernels (which expect the clocks passed in the
511 bd_info data to be in MHz) the environment variable
512 "clocks_in_mhz" can be defined so that U-Boot
513 converts clock data to MHZ before passing it to the
514 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000515 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100516 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000517 default environment.
518
wdenk9b7f3842003-10-09 20:09:04 +0000519 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
520
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200521 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000522 expect it to be in bytes, others in MB.
523 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
524
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400525 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200526
527 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400528 passed using flattened device trees (based on open firmware
529 concepts).
530
531 CONFIG_OF_LIBFDT
532 * New libfdt-based support
533 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500534 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400535
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200536 OF_CPU - The proper name of the cpus node (only required for
537 MPC512X and MPC5xxx based boards).
538 OF_SOC - The proper name of the soc node (only required for
539 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200540 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600541 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200542
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200543 boards with QUICC Engines require OF_QE to set UCC MAC
544 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500545
Kumar Gala1e26aa52006-01-11 13:54:17 -0600546 CONFIG_OF_BOARD_SETUP
547
548 Board code has addition modification that it wants to make
549 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000550
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500551 CONFIG_OF_BOOT_CPU
552
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200553 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500554 param header, the default value is zero if undefined.
555
Heiko Schocherffb293a2009-09-23 07:56:08 +0200556 CONFIG_OF_IDE_FIXUP
557
558 U-Boot can detect if an IDE device is present or not.
559 If not, and this new config option is activated, U-Boot
560 removes the ATA node from the DTS before booting Linux,
561 so the Linux IDE driver does not probe the device and
562 crash. This is needed for buggy hardware (uc101) where
563 no pull down resistor is connected to the signal IDE5V_DD7.
564
Igor Grinberg06890672011-07-14 05:45:07 +0000565 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
566
567 This setting is mandatory for all boards that have only one
568 machine type and must be used to specify the machine type
569 number as it appears in the ARM machine registry
570 (see http://www.arm.linux.org.uk/developer/machines/).
571 Only boards that have multiple machine types supported
572 in a single configuration file and the machine type is
573 runtime discoverable, do not have to use this setting.
574
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100575- vxWorks boot parameters:
576
577 bootvx constructs a valid bootline using the following
578 environments variables: bootfile, ipaddr, serverip, hostname.
579 It loads the vxWorks image pointed bootfile.
580
581 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
582 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
583 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
584 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
585
586 CONFIG_SYS_VXWORKS_ADD_PARAMS
587
588 Add it at the end of the bootline. E.g "u=username pw=secret"
589
590 Note: If a "bootargs" environment is defined, it will overwride
591 the defaults discussed just above.
592
Aneesh V960f5c02011-06-16 23:30:47 +0000593- Cache Configuration:
594 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
595 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
596 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
597
Aneesh V686a0752011-06-16 23:30:51 +0000598- Cache Configuration for ARM:
599 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
600 controller
601 CONFIG_SYS_PL310_BASE - Physical base address of PL310
602 controller register space
603
wdenkda04a8b2004-08-02 23:22:59 +0000604- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200605 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000606
607 Define this if you want support for Amba PrimeCell PL010 UARTs.
608
Andreas Engel0813b122008-09-08 14:30:53 +0200609 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000610
611 Define this if you want support for Amba PrimeCell PL011 UARTs.
612
613 CONFIG_PL011_CLOCK
614
615 If you have Amba PrimeCell PL011 UARTs, set this variable to
616 the clock speed of the UARTs.
617
618 CONFIG_PL01x_PORTS
619
620 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
621 define this to a list of base addresses for each (supported)
622 port. See e.g. include/configs/versatile.h
623
John Rigby34e21ee2011-04-19 10:42:39 +0000624 CONFIG_PL011_SERIAL_RLCR
625
626 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
627 have separate receive and transmit line control registers. Set
628 this variable to initialize the extra register.
629
630 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
631
632 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
633 boot loader that has already initialized the UART. Define this
634 variable to flush the UART at init time.
635
wdenkda04a8b2004-08-02 23:22:59 +0000636
wdenkc6097192002-11-03 00:24:07 +0000637- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000638 Depending on board, define exactly one serial port
639 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
640 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
641 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000642
643 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
644 port routines must be defined elsewhere
645 (i.e. serial_init(), serial_getc(), ...)
646
647 CONFIG_CFB_CONSOLE
648 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000649 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000650 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
651 (default big endian)
652 VIDEO_HW_RECTFILL graphic chip supports
653 rectangle fill
654 (cf. smiLynxEM)
655 VIDEO_HW_BITBLT graphic chip supports
656 bit-blit (cf. smiLynxEM)
657 VIDEO_VISIBLE_COLS visible pixel columns
658 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000659 VIDEO_VISIBLE_ROWS visible pixel rows
660 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000661 VIDEO_DATA_FORMAT graphic data format
662 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000663 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000664 VIDEO_KBD_INIT_FCT keyboard int fct
665 (i.e. i8042_kbd_init())
666 VIDEO_TSTC_FCT test char fct
667 (i.e. i8042_tstc)
668 VIDEO_GETC_FCT get char fct
669 (i.e. i8042_getc)
670 CONFIG_CONSOLE_CURSOR cursor drawing on/off
671 (requires blink timer
672 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200673 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000674 CONFIG_CONSOLE_TIME display time/date info in
675 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500676 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000677 CONFIG_VIDEO_LOGO display Linux logo in
678 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000679 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
680 linux_logo.h for logo.
681 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000682 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200683 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000684 the logo
685
Pali Rohár4a57da32012-10-19 13:30:09 +0000686 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
687 a limited number of ANSI escape sequences (cursor control,
688 erase functions and limited graphics rendition control).
689
wdenk4a5c8a72003-03-06 00:02:04 +0000690 When CONFIG_CFB_CONSOLE is defined, video console is
691 default i/o. Serial console can be forced with
692 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000693
wdenk1ebf41e2004-01-02 14:00:00 +0000694 When CONFIG_SILENT_CONSOLE is defined, all console
695 messages (by U-Boot and Linux!) can be silenced with
696 the "silent" environment variable. See
697 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000698
wdenkc6097192002-11-03 00:24:07 +0000699- Console Baudrate:
700 CONFIG_BAUDRATE - in bps
701 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200702 CONFIG_SYS_BAUDRATE_TABLE, see below.
703 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000704
Heiko Schocher327480a2009-01-30 12:55:38 +0100705- Console Rx buffer length
706 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
707 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100708 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100709 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
710 must be defined, to setup the maximum idle timeout for
711 the SMC.
712
Graeme Russ3c28f482011-09-01 00:48:27 +0000713- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200714 Prior to the console being initialised (i.e. serial UART
715 initialised etc) all console output is silently discarded.
716 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
717 buffer any console messages prior to the console being
718 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
719 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
720 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200721 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200722 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000723
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200724 'Sane' compilers will generate smaller code if
725 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000726
Sonny Raocd55bde2011-11-02 09:52:08 +0000727- Safe printf() functions
728 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
729 the printf() functions. These are defined in
730 include/vsprintf.h and include snprintf(), vsnprintf() and
731 so on. Code size increase is approximately 300-500 bytes.
732 If this option is not given then these functions will
733 silently discard their buffer size argument - this means
734 you are not getting any overflow checking in this case.
735
wdenkc6097192002-11-03 00:24:07 +0000736- Boot Delay: CONFIG_BOOTDELAY - in seconds
737 Delay before automatically booting the default image;
738 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000739 set to -2 to autoboot with no delay and not check for abort
740 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000741
742 See doc/README.autoboot for these options that
743 work with CONFIG_BOOTDELAY. None are required.
744 CONFIG_BOOT_RETRY_TIME
745 CONFIG_BOOT_RETRY_MIN
746 CONFIG_AUTOBOOT_KEYED
747 CONFIG_AUTOBOOT_PROMPT
748 CONFIG_AUTOBOOT_DELAY_STR
749 CONFIG_AUTOBOOT_STOP_STR
750 CONFIG_AUTOBOOT_DELAY_STR2
751 CONFIG_AUTOBOOT_STOP_STR2
752 CONFIG_ZERO_BOOTDELAY_CHECK
753 CONFIG_RESET_TO_RETRY
754
755- Autoboot Command:
756 CONFIG_BOOTCOMMAND
757 Only needed when CONFIG_BOOTDELAY is enabled;
758 define a command string that is automatically executed
759 when no character is read on the console interface
760 within "Boot Delay" after reset.
761
762 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000763 This can be used to pass arguments to the bootm
764 command. The value of CONFIG_BOOTARGS goes into the
765 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000766
767 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000768 The value of these goes into the environment as
769 "ramboot" and "nfsboot" respectively, and can be used
770 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200771 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000772
773- Pre-Boot Commands:
774 CONFIG_PREBOOT
775
776 When this option is #defined, the existence of the
777 environment variable "preboot" will be checked
778 immediately before starting the CONFIG_BOOTDELAY
779 countdown and/or running the auto-boot command resp.
780 entering interactive mode.
781
782 This feature is especially useful when "preboot" is
783 automatically generated or modified. For an example
784 see the LWMON board specific code: here "preboot" is
785 modified when the user holds down a certain
786 combination of keys on the (special) keyboard when
787 booting the systems
788
789- Serial Download Echo Mode:
790 CONFIG_LOADS_ECHO
791 If defined to 1, all characters received during a
792 serial download (using the "loads" command) are
793 echoed back. This might be needed by some terminal
794 emulations (like "cu"), but may as well just take
795 time on others. This setting #define's the initial
796 value of the "loads_echo" environment variable.
797
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500798- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000799 CONFIG_KGDB_BAUDRATE
800 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200801 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000802
803- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500804 Monitor commands can be included or excluded
805 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000806 <config_cmd_all.h> and #undef'ing unwanted
807 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500808 and augmenting with additional #define's
809 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000810
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500811 The default command configuration includes all commands
812 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000813
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500814 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500815 CONFIG_CMD_BDI bdinfo
816 CONFIG_CMD_BEDBUG * Include BedBug Debugger
817 CONFIG_CMD_BMP * BMP support
818 CONFIG_CMD_BSP * Board specific commands
819 CONFIG_CMD_BOOTD bootd
820 CONFIG_CMD_CACHE * icache, dcache
821 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500822 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500823 CONFIG_CMD_DATE * support for RTC, date/time...
824 CONFIG_CMD_DHCP * DHCP support
825 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600826 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
827 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
828 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
829 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500830 CONFIG_CMD_DTT * Digital Therm and Thermostat
831 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500832 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500833 CONFIG_CMD_EEPROM * EEPROM read/write support
834 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600835 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600836 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500837 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000838 CONFIG_CMD_EXT2 * ext2 command support
839 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500840 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500841 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000842 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500843 CONFIG_CMD_FDOS * Dos diskette Support
844 CONFIG_CMD_FLASH flinfo, erase, protect
845 CONFIG_CMD_FPGA FPGA device initialization support
Benoît Thébaudeaua8e88552013-04-23 10:17:40 +0000846 CONFIG_CMD_FUSE Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000847 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500848 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000849 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000850 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500851 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
852 CONFIG_CMD_I2C * I2C serial bus support
853 CONFIG_CMD_IDE * IDE harddisk support
854 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000855 CONFIG_CMD_IMLS List all images found in NOR flash
856 CONFIG_CMD_IMLS_NAND List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500857 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500858 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000859 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500860 CONFIG_CMD_IRQ * irqinfo
861 CONFIG_CMD_ITEST Integer/string test of 2 values
862 CONFIG_CMD_JFFS2 * JFFS2 Support
863 CONFIG_CMD_KGDB * kgdb
Mike Frysingerfc6508a2010-12-26 12:34:49 -0500864 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000865 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
866 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500867 CONFIG_CMD_LOADB loadb
868 CONFIG_CMD_LOADS loads
Robin Getz93d6cb02009-07-27 00:07:59 -0400869 CONFIG_CMD_MD5SUM print md5 message digest
870 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000871 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500872 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000873 loop, loopw
874 CONFIG_CMD_MEMTEST mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500875 CONFIG_CMD_MISC Misc functions like sleep etc
876 CONFIG_CMD_MMC * MMC memory mapped support
877 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100878 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500879 CONFIG_CMD_NAND * NAND support
880 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tyser9902e422008-12-17 16:36:21 -0600881 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000882 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500883 CONFIG_CMD_PCI * pciinfo
884 CONFIG_CMD_PCMCIA * PCMCIA support
885 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
886 host
887 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000888 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500889 CONFIG_CMD_REGINFO * Register dump
890 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000891 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500892 CONFIG_CMD_SAVES * save S record dump
893 CONFIG_CMD_SCSI * SCSI Support
894 CONFIG_CMD_SDRAM * print SDRAM configuration information
895 (requires CONFIG_CMD_I2C)
896 CONFIG_CMD_SETGETDCR Support for DCR Register access
897 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700898 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Holler37ef5392011-01-18 09:48:08 +0100899 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400900 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800901 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200902 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500903 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000904 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000905 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000906 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
907 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500908 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500909 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000910 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000911
wdenkc6097192002-11-03 00:24:07 +0000912
913 EXAMPLE: If you want all functions except of network
914 support you can write:
915
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500916 #include "config_cmd_all.h"
917 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000918
Gerald Van Barend6abef42007-03-31 12:23:51 -0400919 Other Commands:
920 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000921
922 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500923 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000924 what you (and your U-Boot users) are doing. Data
925 cache cannot be enabled on systems like the 8xx or
926 8260 (where accesses to the IMMR region must be
927 uncached), and it cannot be disabled on all other
928 systems where we (mis-) use the data cache to hold an
929 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000930
931
932 XXX - this list needs to get updated!
933
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000934- Regular expression support:
935 CONFIG_REGEX
936 If this variable is defined, U-Boot is linked against
937 the SLRE (Super Light Regular Expression) library,
938 which adds regex support to some commands, as for
939 example "env grep" and "setexpr".
940
Simon Glass3d686442011-10-15 05:48:20 +0000941- Device tree:
942 CONFIG_OF_CONTROL
943 If this variable is defined, U-Boot will use a device tree
944 to configure its devices, instead of relying on statically
945 compiled #defines in the board file. This option is
946 experimental and only available on a few boards. The device
947 tree is available in the global data as gd->fdt_blob.
948
Simon Glass5cb34db2011-10-24 19:15:31 +0000949 U-Boot needs to get its device tree from somewhere. This can
950 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000951
952 CONFIG_OF_EMBED
953 If this variable is defined, U-Boot will embed a device tree
954 binary in its image. This device tree file should be in the
955 board directory and called <soc>-<board>.dts. The binary file
956 is then picked up in board_init_f() and made available through
957 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000958
Simon Glass5cb34db2011-10-24 19:15:31 +0000959 CONFIG_OF_SEPARATE
960 If this variable is defined, U-Boot will build a device tree
961 binary. It will be called u-boot.dtb. Architecture-specific
962 code will locate it at run-time. Generally this works by:
963
964 cat u-boot.bin u-boot.dtb >image.bin
965
966 and in fact, U-Boot does this for you, creating a file called
967 u-boot-dtb.bin which is useful in the common case. You can
968 still use the individual files if you need something more
969 exotic.
970
wdenkc6097192002-11-03 00:24:07 +0000971- Watchdog:
972 CONFIG_WATCHDOG
973 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000974 support for the SoC. There must be support in the SoC
975 specific code for a watchdog. For the 8xx and 8260
976 CPUs, the SIU Watchdog feature is enabled in the SYPCR
977 register. When supported for a specific SoC is
978 available, then no further board specific code should
979 be needed to use it.
980
981 CONFIG_HW_WATCHDOG
982 When using a watchdog circuitry external to the used
983 SoC, then define this variable and provide board
984 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000985
stroeseb9c17c52003-04-04 15:53:41 +0000986- U-Boot Version:
987 CONFIG_VERSION_VARIABLE
988 If this variable is defined, an environment variable
989 named "ver" is created by U-Boot showing the U-Boot
990 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200991 Any change to this variable will be reverted at the
992 next reset.
stroeseb9c17c52003-04-04 15:53:41 +0000993
wdenkc6097192002-11-03 00:24:07 +0000994- Real-Time Clock:
995
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500996 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000997 has to be selected, too. Define exactly one of the
998 following options:
999
1000 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1001 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001002 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001003 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001004 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001005 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001006 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +00001007 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001008 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001009 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001010 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001011 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1012 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001013
wdenkb9bbd242003-06-30 16:24:52 +00001014 Note that if the RTC uses I2C, then the I2C interface
1015 must also be configured. See I2C Support, below.
1016
Peter Tyser9902e422008-12-17 16:36:21 -06001017- GPIO Support:
1018 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1019 CONFIG_PCA953X_INFO - enable pca953x info command
1020
Chris Packham9b383202010-12-19 10:12:13 +00001021 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1022 chip-ngpio pairs that tell the PCA953X driver the number of
1023 pins supported by a particular chip.
1024
Peter Tyser9902e422008-12-17 16:36:21 -06001025 Note that if the GPIO device uses I2C, then the I2C interface
1026 must also be configured. See I2C Support, below.
1027
wdenkc6097192002-11-03 00:24:07 +00001028- Timestamp Support:
1029
wdenk4a5c8a72003-03-06 00:02:04 +00001030 When CONFIG_TIMESTAMP is selected, the timestamp
1031 (date and time) of an image is printed by image
1032 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001033 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001034
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001035- Partition Labels (disklabels) Supported:
1036 Zero or more of the following:
1037 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1038 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1039 Intel architecture, USB sticks, etc.
1040 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1041 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1042 bootloader. Note 2TB partition limit; see
1043 disk/part_efi.c
1044 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001045
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001046 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1047 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001048 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001049
1050- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001051 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1052 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001053
wdenk369d43d2004-03-14 14:09:05 +00001054 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1055 be performed by calling the function
1056 ide_set_reset(int reset)
1057 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001058
1059- ATAPI Support:
1060 CONFIG_ATAPI
1061
1062 Set this to enable ATAPI support.
1063
wdenkf602aa02004-03-13 23:29:43 +00001064- LBA48 Support
1065 CONFIG_LBA48
1066
1067 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001068 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001069 Whithout these , LBA48 support uses 32bit variables and will 'only'
1070 support disks up to 2.1TB.
1071
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001072 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001073 When enabled, makes the IDE subsystem use 64bit sector addresses.
1074 Default is 32bit.
1075
wdenkc6097192002-11-03 00:24:07 +00001076- SCSI Support:
1077 At the moment only there is only support for the
1078 SYM53C8XX SCSI controller; define
1079 CONFIG_SCSI_SYM53C8XX to enable it.
1080
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001081 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1082 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1083 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001084 maximum numbers of LUNs, SCSI ID's and target
1085 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001086 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001087
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001088 The environment variable 'scsidevs' is set to the number of
1089 SCSI devices found during the last scan.
1090
wdenkc6097192002-11-03 00:24:07 +00001091- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001092 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001093 Support for Intel 8254x/8257x gigabit chips.
1094
1095 CONFIG_E1000_SPI
1096 Utility code for direct access to the SPI bus on Intel 8257x.
1097 This does not do anything useful unless you set at least one
1098 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1099
1100 CONFIG_E1000_SPI_GENERIC
1101 Allow generic access to the SPI bus on the Intel 8257x, for
1102 example with the "sspi" command.
1103
1104 CONFIG_CMD_E1000
1105 Management command for E1000 devices. When used on devices
1106 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001107
Andre Schwarz68c2a302008-03-06 16:45:44 +01001108 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001109 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001110
wdenkc6097192002-11-03 00:24:07 +00001111 CONFIG_EEPRO100
1112 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001113 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001114 write routine for first time initialisation.
1115
1116 CONFIG_TULIP
1117 Support for Digital 2114x chips.
1118 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1119 modem chip initialisation (KS8761/QS6611).
1120
1121 CONFIG_NATSEMI
1122 Support for National dp83815 chips.
1123
1124 CONFIG_NS8382X
1125 Support for National dp8382[01] gigabit chips.
1126
wdenkaa603362003-05-12 21:50:16 +00001127- NETWORK Support (other):
1128
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001129 CONFIG_DRIVER_AT91EMAC
1130 Support for AT91RM9200 EMAC.
1131
1132 CONFIG_RMII
1133 Define this to use reduced MII inteface
1134
1135 CONFIG_DRIVER_AT91EMAC_QUIET
1136 If this defined, the driver is quiet.
1137 The driver doen't show link status messages.
1138
Rob Herringc9830dc2011-12-15 11:15:49 +00001139 CONFIG_CALXEDA_XGMAC
1140 Support for the Calxeda XGMAC device
1141
Ashok93fb8722012-10-15 06:20:47 +00001142 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001143 Support for SMSC's LAN91C96 chips.
1144
1145 CONFIG_LAN91C96_BASE
1146 Define this to hold the physical address
1147 of the LAN91C96's I/O space
1148
1149 CONFIG_LAN91C96_USE_32_BIT
1150 Define this to enable 32 bit addressing
1151
Ashok93fb8722012-10-15 06:20:47 +00001152 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001153 Support for SMSC's LAN91C111 chip
1154
1155 CONFIG_SMC91111_BASE
1156 Define this to hold the physical address
1157 of the device (I/O space)
1158
1159 CONFIG_SMC_USE_32_BIT
1160 Define this if data bus is 32 bits
1161
1162 CONFIG_SMC_USE_IOFUNCS
1163 Define this to use i/o functions instead of macros
1164 (some hardware wont work with macros)
1165
Heiko Schocher7d037f72011-11-15 10:00:04 -05001166 CONFIG_DRIVER_TI_EMAC
1167 Support for davinci emac
1168
1169 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1170 Define this if you have more then 3 PHYs.
1171
Macpaul Lin199c6252010-12-21 16:59:46 +08001172 CONFIG_FTGMAC100
1173 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1174
1175 CONFIG_FTGMAC100_EGIGA
1176 Define this to use GE link update with gigabit PHY.
1177 Define this if FTGMAC100 is connected to gigabit PHY.
1178 If your system has 10/100 PHY only, it might not occur
1179 wrong behavior. Because PHY usually return timeout or
1180 useless data when polling gigabit status and gigabit
1181 control registers. This behavior won't affect the
1182 correctnessof 10/100 link speed update.
1183
Mike Rapoportf4761af2009-11-11 10:03:03 +02001184 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001185 Support for SMSC's LAN911x and LAN921x chips
1186
Mike Rapoportf4761af2009-11-11 10:03:03 +02001187 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001188 Define this to hold the physical address
1189 of the device (I/O space)
1190
Mike Rapoportf4761af2009-11-11 10:03:03 +02001191 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001192 Define this if data bus is 32 bits
1193
Mike Rapoportf4761af2009-11-11 10:03:03 +02001194 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001195 Define this if data bus is 16 bits. If your processor
1196 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001197 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001198
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001199 CONFIG_SH_ETHER
1200 Support for Renesas on-chip Ethernet controller
1201
1202 CONFIG_SH_ETHER_USE_PORT
1203 Define the number of ports to be used
1204
1205 CONFIG_SH_ETHER_PHY_ADDR
1206 Define the ETH PHY's address
1207
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001208 CONFIG_SH_ETHER_CACHE_WRITEBACK
1209 If this option is set, the driver enables cache flush.
1210
Vadim Bendeburydac69642011-10-17 08:36:14 +00001211- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001212 CONFIG_TPM
1213 Support TPM devices.
1214
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001215 CONFIG_TPM_TIS_I2C
1216 Support for i2c bus TPM devices. Only one device
1217 per system is supported at this time.
1218
1219 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1220 Define the the i2c bus number for the TPM device
1221
1222 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1223 Define the TPM's address on the i2c bus
1224
1225 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1226 Define the burst count bytes upper limit
1227
Che-liang Chiouacea5702013-04-12 11:04:34 +00001228 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001229 Support for generic parallel port TPM devices. Only one device
1230 per system is supported at this time.
1231
1232 CONFIG_TPM_TIS_BASE_ADDRESS
1233 Base address where the generic TPM device is mapped
1234 to. Contemporary x86 systems usually map it at
1235 0xfed40000.
1236
wdenkc6097192002-11-03 00:24:07 +00001237- USB Support:
1238 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001239 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001240 CONFIG_USB_UHCI to enable it.
1241 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001242 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001243 storage devices.
1244 Note:
1245 Supported are USB Keyboards and USB Floppy drives
1246 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001247 MPC5200 USB requires additional defines:
1248 CONFIG_USB_CLOCK
1249 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001250 CONFIG_PSC3_USB
1251 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001252 CONFIG_USB_CONFIG
1253 for differential drivers: 0x00001000
1254 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001255 for differential drivers on PSC3: 0x00000100
1256 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001257 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001258 May be defined to allow interrupt polling
1259 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001260
Simon Glass5978cdb2012-02-27 10:52:47 +00001261 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1262 txfilltuning field in the EHCI controller on reset.
1263
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001264- USB Device:
1265 Define the below if you wish to use the USB console.
1266 Once firmware is rebuilt from a serial console issue the
1267 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001268 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001269 it has found a new device. The environment variable usbtty
1270 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001271 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001272 Common Device Class Abstract Control Model serial device.
1273 If you select usbtty = gserial you should be able to enumerate
1274 a Linux host by
1275 # modprobe usbserial vendor=0xVendorID product=0xProductID
1276 else if using cdc_acm, simply setting the environment
1277 variable usbtty to be cdc_acm should suffice. The following
1278 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001279
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001280 CONFIG_USB_DEVICE
1281 Define this to build a UDC device
1282
1283 CONFIG_USB_TTY
1284 Define this to have a tty type of device available to
1285 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001286
Vipin KUMARbdb17702012-03-26 15:38:06 +05301287 CONFIG_USBD_HS
1288 Define this to enable the high speed support for usb
1289 device and usbtty. If this feature is enabled, a routine
1290 int is_usbd_high_speed(void)
1291 also needs to be defined by the driver to dynamically poll
1292 whether the enumeration has succeded at high speed or full
1293 speed.
1294
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001295 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001296 Define this if you want stdin, stdout &/or stderr to
1297 be set to usbtty.
1298
1299 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001300 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001301 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001302 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001303
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001304 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001305 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001306 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001307
Wolfgang Denke2601822006-06-14 18:14:56 +02001308 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001309 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001310 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001311 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1312 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1313 should pretend to be a Linux device to it's target host.
1314
1315 CONFIG_USBD_MANUFACTURER
1316 Define this string as the name of your company for
1317 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001318
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001319 CONFIG_USBD_PRODUCT_NAME
1320 Define this string as the name of your product
1321 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001322
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001323 CONFIG_USBD_VENDORID
1324 Define this as your assigned Vendor ID from the USB
1325 Implementors Forum. This *must* be a genuine Vendor ID
1326 to avoid polluting the USB namespace.
1327 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001328
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001329 CONFIG_USBD_PRODUCTID
1330 Define this as the unique Product ID
1331 for your device
1332 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001333
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001334- ULPI Layer Support:
1335 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1336 the generic ULPI layer. The generic layer accesses the ULPI PHY
1337 via the platform viewport, so you need both the genric layer and
1338 the viewport enabled. Currently only Chipidea/ARC based
1339 viewport is supported.
1340 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1341 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001342 If your ULPI phy needs a different reference clock than the
1343 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1344 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001345
wdenk7a428cc2003-06-15 22:40:42 +00001346- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001347 The MMC controller on the Intel PXA is supported. To
1348 enable this define CONFIG_MMC. The MMC can be
1349 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001350 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001351 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1352 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001353
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001354 CONFIG_SH_MMCIF
1355 Support for Renesas on-chip MMCIF controller
1356
1357 CONFIG_SH_MMCIF_ADDR
1358 Define the base address of MMCIF registers
1359
1360 CONFIG_SH_MMCIF_CLK
1361 Define the clock frequency for MMCIF
1362
Tom Rini58a8d322013-03-14 05:32:47 +00001363- USB Device Firmware Update (DFU) class support:
1364 CONFIG_DFU_FUNCTION
1365 This enables the USB portion of the DFU USB class
1366
1367 CONFIG_CMD_DFU
1368 This enables the command "dfu" which is used to have
1369 U-Boot create a DFU class device via USB. This command
1370 requires that the "dfu_alt_info" environment variable be
1371 set and define the alt settings to expose to the host.
1372
1373 CONFIG_DFU_MMC
1374 This enables support for exposing (e)MMC devices via DFU.
1375
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001376 CONFIG_DFU_NAND
1377 This enables support for exposing NAND devices via DFU.
1378
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001379 CONFIG_SYS_DFU_MAX_FILE_SIZE
1380 When updating files rather than the raw storage device,
1381 we use a static buffer to copy the file into and then write
1382 the buffer once we've been given the whole file. Define
1383 this to the maximum filesize (in bytes) for the buffer.
1384 Default is 4 MiB if undefined.
1385
wdenkda04a8b2004-08-02 23:22:59 +00001386- Journaling Flash filesystem support:
1387 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1388 CONFIG_JFFS2_NAND_DEV
1389 Define these for a default partition on a NAND device
1390
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001391 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1392 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001393 Define these for a default partition on a NOR device
1394
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001395 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001396 Define this to create an own partition. You have to provide a
1397 function struct part_info* jffs2_part_info(int part_num)
1398
1399 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001400 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001401 to disable the command chpart. This is the default when you
1402 have not defined a custom partition
1403
Donggeun Kim8f814002011-10-24 21:15:28 +00001404- FAT(File Allocation Table) filesystem write function support:
1405 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001406
1407 Define this to enable support for saving memory data as a
1408 file in FAT formatted partition.
1409
1410 This will also enable the command "fatwrite" enabling the
1411 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001412
Gabe Black7f8574c2012-10-12 14:26:11 +00001413CBFS (Coreboot Filesystem) support
1414 CONFIG_CMD_CBFS
1415
1416 Define this to enable support for reading from a Coreboot
1417 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1418 and cbfsload.
1419
wdenkc6097192002-11-03 00:24:07 +00001420- Keyboard Support:
1421 CONFIG_ISA_KEYBOARD
1422
1423 Define this to enable standard (PC-Style) keyboard
1424 support
1425
1426 CONFIG_I8042_KBD
1427 Standard PC keyboard driver with US (is default) and
1428 GERMAN key layout (switch via environment 'keymap=de') support.
1429 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1430 for cfb_console. Supports cursor blinking.
1431
1432- Video support:
1433 CONFIG_VIDEO
1434
1435 Define this to enable video support (for output to
1436 video).
1437
1438 CONFIG_VIDEO_CT69000
1439
1440 Enable Chips & Technologies 69000 Video chip
1441
1442 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001443 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001444 video output is selected via environment 'videoout'
1445 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1446 assumed.
wdenkc6097192002-11-03 00:24:07 +00001447
wdenkd3602132004-03-25 15:14:43 +00001448 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001449 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001450 are possible:
1451 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001452 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001453
1454 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1455 -------------+---------------------------------------------
1456 8 bits | 0x301* 0x303 0x305 0x161 0x307
1457 15 bits | 0x310 0x313 0x316 0x162 0x319
1458 16 bits | 0x311 0x314 0x317 0x163 0x31A
1459 24 bits | 0x312 0x315 0x318 ? 0x31B
1460 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001461 (i.e. setenv videomode 317; saveenv; reset;)
1462
wdenkd3602132004-03-25 15:14:43 +00001463 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001464 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001465
1466
stroeseb9c17c52003-04-04 15:53:41 +00001467 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001468 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001469 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1470 or CONFIG_VIDEO_SED13806_16BPP
1471
Timur Tabi020edd22011-02-15 17:09:19 -06001472 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001473 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001474 SOCs that have a DIU should define this macro to enable DIU
1475 support, and should also define these other macros:
1476
1477 CONFIG_SYS_DIU_ADDR
1478 CONFIG_VIDEO
1479 CONFIG_CMD_BMP
1480 CONFIG_CFB_CONSOLE
1481 CONFIG_VIDEO_SW_CURSOR
1482 CONFIG_VGA_AS_SINGLE_DEVICE
1483 CONFIG_VIDEO_LOGO
1484 CONFIG_VIDEO_BMP_LOGO
1485
Timur Tabi32f709e2011-04-11 14:18:22 -05001486 The DIU driver will look for the 'video-mode' environment
1487 variable, and if defined, enable the DIU as a console during
1488 boot. See the documentation file README.video for a
1489 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001490
Simon Glass54df8ce2012-12-03 13:59:47 +00001491 CONFIG_VIDEO_VGA
1492
1493 Enable the VGA video / BIOS for x86. The alternative if you
1494 are using coreboot is to use the coreboot frame buffer
1495 driver.
1496
1497
wdenk4e112c12003-06-03 23:54:09 +00001498- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001499 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001500
wdenk57b2d802003-06-27 21:31:46 +00001501 Define this to enable a custom keyboard support.
1502 This simply calls drv_keyboard_init() which must be
1503 defined in your board-specific files.
1504 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001505
wdenkc6097192002-11-03 00:24:07 +00001506- LCD Support: CONFIG_LCD
1507
1508 Define this to enable LCD support (for output to LCD
1509 display); also select one of the supported displays
1510 by defining one of these:
1511
Stelian Popf6f86652008-05-09 21:57:18 +02001512 CONFIG_ATMEL_LCD:
1513
1514 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1515
wdenkc0d54ae2003-11-25 16:55:19 +00001516 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001517
wdenkc0d54ae2003-11-25 16:55:19 +00001518 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001519
wdenkc0d54ae2003-11-25 16:55:19 +00001520 CONFIG_NEC_NL6448BC20
1521
1522 NEC NL6448BC20-08. 6.5", 640x480.
1523 Active, color, single scan.
1524
1525 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001526
wdenkc0d54ae2003-11-25 16:55:19 +00001527 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001528 Active, color, single scan.
1529
1530 CONFIG_SHARP_16x9
1531
1532 Sharp 320x240. Active, color, single scan.
1533 It isn't 16x9, and I am not sure what it is.
1534
1535 CONFIG_SHARP_LQ64D341
1536
1537 Sharp LQ64D341 display, 640x480.
1538 Active, color, single scan.
1539
1540 CONFIG_HLD1045
1541
1542 HLD1045 display, 640x480.
1543 Active, color, single scan.
1544
1545 CONFIG_OPTREX_BW
1546
1547 Optrex CBL50840-2 NF-FW 99 22 M5
1548 or
1549 Hitachi LMG6912RPFC-00T
1550 or
1551 Hitachi SP14Q002
1552
1553 320x240. Black & white.
1554
1555 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001556 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001557
Simon Glass599a4df2012-10-17 13:24:54 +00001558 CONFIG_LCD_ALIGNMENT
1559
1560 Normally the LCD is page-aligned (tyically 4KB). If this is
1561 defined then the LCD will be aligned to this value instead.
1562 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1563 here, since it is cheaper to change data cache settings on
1564 a per-section basis.
1565
Simon Glassaf3e2802012-10-17 13:24:59 +00001566 CONFIG_CONSOLE_SCROLL_LINES
1567
1568 When the console need to be scrolled, this is the number of
1569 lines to scroll by. It defaults to 1. Increasing this makes
1570 the console jump but can help speed up operation when scrolling
1571 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001572
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001573 CONFIG_LCD_BMP_RLE8
1574
1575 Support drawing of RLE8-compressed bitmaps on the LCD.
1576
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001577 CONFIG_I2C_EDID
1578
1579 Enables an 'i2c edid' command which can read EDID
1580 information over I2C from an attached LCD display.
1581
wdenkeb20ad32003-09-05 23:19:14 +00001582- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001583
wdenk57b2d802003-06-27 21:31:46 +00001584 If this option is set, the environment is checked for
1585 a variable "splashimage". If found, the usual display
1586 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001587 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001588 specified in "splashimage" is loaded instead. The
1589 console is redirected to the "nulldev", too. This
1590 allows for a "silent" boot where a splash screen is
1591 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001592
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001593 CONFIG_SPLASHIMAGE_GUARD
1594
1595 If this option is set, then U-Boot will prevent the environment
1596 variable "splashimage" from being set to a problematic address
1597 (see README.displaying-bmps and README.arm-unaligned-accesses).
1598 This option is useful for targets where, due to alignment
1599 restrictions, an improperly aligned BMP image will cause a data
1600 abort. If you think you will not have problems with unaligned
1601 accesses (for example because your toolchain prevents them)
1602 there is no need to set this option.
1603
Matthias Weisser53884182009-07-09 16:07:30 +02001604 CONFIG_SPLASH_SCREEN_ALIGN
1605
1606 If this option is set the splash image can be freely positioned
1607 on the screen. Environment variable "splashpos" specifies the
1608 position as "x,y". If a positive number is given it is used as
1609 number of pixel from left/top. If a negative number is given it
1610 is used as number of pixel from right/bottom. You can also
1611 specify 'm' for centering the image.
1612
1613 Example:
1614 setenv splashpos m,m
1615 => image at center of screen
1616
1617 setenv splashpos 30,20
1618 => image at x = 30 and y = 20
1619
1620 setenv splashpos -10,m
1621 => vertically centered image
1622 at x = dspWidth - bmpWidth - 9
1623
Nikita Kiryanove0eba1f2013-01-30 21:39:57 +00001624 CONFIG_SPLASH_SCREEN_PREPARE
1625
1626 If this option is set then the board_splash_screen_prepare()
1627 function, which must be defined in your code, is called as part
1628 of the splash screen display sequence. It gives the board an
1629 opportunity to prepare the splash image data before it is
1630 processed and sent to the frame buffer by U-Boot.
1631
Stefan Roesed9d97742005-09-22 09:04:17 +02001632- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1633
1634 If this option is set, additionally to standard BMP
1635 images, gzipped BMP images can be displayed via the
1636 splashscreen support or the bmp command.
1637
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001638- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1639
1640 If this option is set, 8-bit RLE compressed BMP images
1641 can be displayed via the splashscreen support or the
1642 bmp command.
1643
Lei Wene4e248d2012-09-28 04:26:47 +00001644- Do compresssing for memory range:
1645 CONFIG_CMD_ZIP
1646
1647 If this option is set, it would use zlib deflate method
1648 to compress the specified memory at its best effort.
1649
wdenk710e3502003-08-29 20:57:53 +00001650- Compression support:
1651 CONFIG_BZIP2
1652
1653 If this option is set, support for bzip2 compressed
1654 images is included. If not, only uncompressed and gzip
1655 compressed images are supported.
1656
wdenk9c53f402003-10-15 23:53:47 +00001657 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001658 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001659 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001660
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001661 CONFIG_LZMA
1662
1663 If this option is set, support for lzma compressed
1664 images is included.
1665
1666 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1667 requires an amount of dynamic memory that is given by the
1668 formula:
1669
1670 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1671
1672 Where lc and lp stand for, respectively, Literal context bits
1673 and Literal pos bits.
1674
1675 This value is upper-bounded by 14MB in the worst case. Anyway,
1676 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1677 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1678 a very small buffer.
1679
1680 Use the lzmainfo tool to determinate the lc and lp values and
1681 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001682 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001683
wdenk0e2bd9c2004-06-06 21:51:03 +00001684- MII/PHY support:
1685 CONFIG_PHY_ADDR
1686
1687 The address of PHY on MII bus.
1688
1689 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1690
1691 The clock frequency of the MII bus
1692
1693 CONFIG_PHY_GIGE
1694
1695 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001696 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001697
1698 CONFIG_PHY_RESET_DELAY
1699
1700 Some PHY like Intel LXT971A need extra delay after
1701 reset before any MII register access is possible.
1702 For such PHY, set this option to the usec delay
1703 required. (minimum 300usec for LXT971A)
1704
1705 CONFIG_PHY_CMD_DELAY (ppc4xx)
1706
1707 Some PHY like Intel LXT971A need extra delay after
1708 command issued before MII status register can be read
1709
wdenkc6097192002-11-03 00:24:07 +00001710- Ethernet address:
1711 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001712 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001713 CONFIG_ETH2ADDR
1714 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001715 CONFIG_ETH4ADDR
1716 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001717
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001718 Define a default value for Ethernet address to use
1719 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001720 is not determined automatically.
1721
1722- IP address:
1723 CONFIG_IPADDR
1724
1725 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001726 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001727 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001728 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001729
1730- Server IP address:
1731 CONFIG_SERVERIP
1732
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001733 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001734 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001735 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001736
Robin Getz470a6d42009-07-21 12:15:28 -04001737 CONFIG_KEEP_SERVERADDR
1738
1739 Keeps the server's MAC address, in the env 'serveraddr'
1740 for passing to bootargs (like Linux's netconsole option)
1741
Wolfgang Denk26da2992011-10-26 10:21:22 +00001742- Gateway IP address:
1743 CONFIG_GATEWAYIP
1744
1745 Defines a default value for the IP address of the
1746 default router where packets to other networks are
1747 sent to.
1748 (Environment variable "gatewayip")
1749
1750- Subnet mask:
1751 CONFIG_NETMASK
1752
1753 Defines a default value for the subnet mask (or
1754 routing prefix) which is used to determine if an IP
1755 address belongs to the local subnet or needs to be
1756 forwarded through a router.
1757 (Environment variable "netmask")
1758
David Updegraff7280da72007-06-11 10:41:07 -05001759- Multicast TFTP Mode:
1760 CONFIG_MCAST_TFTP
1761
1762 Defines whether you want to support multicast TFTP as per
1763 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001764 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001765 driver in use must provide a function: mcast() to join/leave a
1766 multicast group.
1767
wdenkc6097192002-11-03 00:24:07 +00001768- BOOTP Recovery Mode:
1769 CONFIG_BOOTP_RANDOM_DELAY
1770
1771 If you have many targets in a network that try to
1772 boot using BOOTP, you may want to avoid that all
1773 systems send out BOOTP requests at precisely the same
1774 moment (which would happen for instance at recovery
1775 from a power failure, when all systems will try to
1776 boot, thus flooding the BOOTP server. Defining
1777 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1778 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001779 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001780
1781 1st BOOTP request: delay 0 ... 1 sec
1782 2nd BOOTP request: delay 0 ... 2 sec
1783 3rd BOOTP request: delay 0 ... 4 sec
1784 4th and following
1785 BOOTP requests: delay 0 ... 8 sec
1786
stroesee0aadfb2003-08-28 14:17:32 +00001787- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001788 You can fine tune the DHCP functionality by defining
1789 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001790
Jon Loeliger5336a762007-07-09 22:08:34 -05001791 CONFIG_BOOTP_SUBNETMASK
1792 CONFIG_BOOTP_GATEWAY
1793 CONFIG_BOOTP_HOSTNAME
1794 CONFIG_BOOTP_NISDOMAIN
1795 CONFIG_BOOTP_BOOTPATH
1796 CONFIG_BOOTP_BOOTFILESIZE
1797 CONFIG_BOOTP_DNS
1798 CONFIG_BOOTP_DNS2
1799 CONFIG_BOOTP_SEND_HOSTNAME
1800 CONFIG_BOOTP_NTPSERVER
1801 CONFIG_BOOTP_TIMEOFFSET
1802 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001803 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001804
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001805 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1806 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001807
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001808 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1809 after the configured retry count, the call will fail
1810 instead of starting over. This can be used to fail over
1811 to Link-local IP address configuration if the DHCP server
1812 is not available.
1813
stroesee0aadfb2003-08-28 14:17:32 +00001814 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1815 serverip from a DHCP server, it is possible that more
1816 than one DNS serverip is offered to the client.
1817 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1818 serverip will be stored in the additional environment
1819 variable "dnsip2". The first DNS serverip is always
1820 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001821 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001822
1823 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1824 to do a dynamic update of a DNS server. To do this, they
1825 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001826 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001827 of the "hostname" environment variable is passed as
1828 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001829
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001830 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1831
1832 A 32bit value in microseconds for a delay between
1833 receiving a "DHCP Offer" and sending the "DHCP Request".
1834 This fixes a problem with certain DHCP servers that don't
1835 respond 100% of the time to a "DHCP request". E.g. On an
1836 AT91RM9200 processor running at 180MHz, this delay needed
1837 to be *at least* 15,000 usec before a Windows Server 2003
1838 DHCP server would reply 100% of the time. I recommend at
1839 least 50,000 usec to be safe. The alternative is to hope
1840 that one of the retries will be successful but note that
1841 the DHCP timeout and retry process takes a longer than
1842 this delay.
1843
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001844 - Link-local IP address negotiation:
1845 Negotiate with other link-local clients on the local network
1846 for an address that doesn't require explicit configuration.
1847 This is especially useful if a DHCP server cannot be guaranteed
1848 to exist in all environments that the device must operate.
1849
1850 See doc/README.link-local for more information.
1851
wdenk145d2c12004-04-15 21:48:45 +00001852 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001853 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001854
1855 The device id used in CDP trigger frames.
1856
1857 CONFIG_CDP_DEVICE_ID_PREFIX
1858
1859 A two character string which is prefixed to the MAC address
1860 of the device.
1861
1862 CONFIG_CDP_PORT_ID
1863
1864 A printf format string which contains the ascii name of
1865 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001866 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001867
1868 CONFIG_CDP_CAPABILITIES
1869
1870 A 32bit integer which indicates the device capabilities;
1871 0x00000010 for a normal host which does not forwards.
1872
1873 CONFIG_CDP_VERSION
1874
1875 An ascii string containing the version of the software.
1876
1877 CONFIG_CDP_PLATFORM
1878
1879 An ascii string containing the name of the platform.
1880
1881 CONFIG_CDP_TRIGGER
1882
1883 A 32bit integer sent on the trigger.
1884
1885 CONFIG_CDP_POWER_CONSUMPTION
1886
1887 A 16bit integer containing the power consumption of the
1888 device in .1 of milliwatts.
1889
1890 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1891
1892 A byte containing the id of the VLAN.
1893
wdenkc6097192002-11-03 00:24:07 +00001894- Status LED: CONFIG_STATUS_LED
1895
1896 Several configurations allow to display the current
1897 status using a LED. For instance, the LED will blink
1898 fast while running U-Boot code, stop blinking as
1899 soon as a reply to a BOOTP request was received, and
1900 start blinking slow once the Linux kernel is running
1901 (supported by a status LED driver in the Linux
1902 kernel). Defining CONFIG_STATUS_LED enables this
1903 feature in U-Boot.
1904
1905- CAN Support: CONFIG_CAN_DRIVER
1906
1907 Defining CONFIG_CAN_DRIVER enables CAN driver support
1908 on those systems that support this (optional)
1909 feature, like the TQM8xxL modules.
1910
1911- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1912
wdenkb9bbd242003-06-30 16:24:52 +00001913 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001914 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001915 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001916
wdenk21136db2003-07-16 21:53:01 +00001917 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001918 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001919 CONFIG_COMMANDS) and communicate with i2c based realtime
1920 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001921 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001922
Ben Warren45657152006-09-07 16:50:54 -04001923 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001924
wdenk21136db2003-07-16 21:53:01 +00001925 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001926 bit-banging) driver instead of CPM or similar hardware
1927 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001928
wdenk21136db2003-07-16 21:53:01 +00001929 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001930 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001931
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001932 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001933 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001934 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001935 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001936
Peter Tysere4d1abc2010-04-12 22:28:21 -05001937 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001938 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001939 and so its address should therefore be cleared to 0 (See,
1940 eg, MPC823e User's Manual p.16-473). So, set
1941 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001942
Eric Millbrandt12990a42009-09-03 08:09:44 -05001943 CONFIG_SYS_I2C_INIT_MPC5XXX
1944
1945 When a board is reset during an i2c bus transfer
1946 chips might think that the current transfer is still
1947 in progress. Reset the slave devices by sending start
1948 commands until the slave device responds.
1949
wdenk21136db2003-07-16 21:53:01 +00001950 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001951
wdenkb9bbd242003-06-30 16:24:52 +00001952 If you use the software i2c interface (CONFIG_SOFT_I2C)
1953 then the following macros need to be defined (examples are
1954 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001955
1956 I2C_INIT
1957
wdenkb9bbd242003-06-30 16:24:52 +00001958 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001959 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001960
wdenk544e9732004-02-06 23:19:44 +00001961 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001962
wdenkc6097192002-11-03 00:24:07 +00001963 I2C_PORT
1964
wdenk4a5c8a72003-03-06 00:02:04 +00001965 (Only for MPC8260 CPU). The I/O port to use (the code
1966 assumes both bits are on the same port). Valid values
1967 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001968
1969 I2C_ACTIVE
1970
1971 The code necessary to make the I2C data line active
1972 (driven). If the data line is open collector, this
1973 define can be null.
1974
wdenkb9bbd242003-06-30 16:24:52 +00001975 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1976
wdenkc6097192002-11-03 00:24:07 +00001977 I2C_TRISTATE
1978
1979 The code necessary to make the I2C data line tri-stated
1980 (inactive). If the data line is open collector, this
1981 define can be null.
1982
wdenkb9bbd242003-06-30 16:24:52 +00001983 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1984
wdenkc6097192002-11-03 00:24:07 +00001985 I2C_READ
1986
York Sun4a598092013-04-01 11:29:11 -07001987 Code that returns true if the I2C data line is high,
1988 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001989
wdenkb9bbd242003-06-30 16:24:52 +00001990 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1991
wdenkc6097192002-11-03 00:24:07 +00001992 I2C_SDA(bit)
1993
York Sun4a598092013-04-01 11:29:11 -07001994 If <bit> is true, sets the I2C data line high. If it
1995 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001996
wdenkb9bbd242003-06-30 16:24:52 +00001997 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00001998 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00001999 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002000
wdenkc6097192002-11-03 00:24:07 +00002001 I2C_SCL(bit)
2002
York Sun4a598092013-04-01 11:29:11 -07002003 If <bit> is true, sets the I2C clock line high. If it
2004 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002005
wdenkb9bbd242003-06-30 16:24:52 +00002006 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002007 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002008 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002009
wdenkc6097192002-11-03 00:24:07 +00002010 I2C_DELAY
2011
2012 This delay is invoked four times per clock cycle so this
2013 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002014 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002015 like:
2016
wdenkb9bbd242003-06-30 16:24:52 +00002017 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002018
Mike Frysingeree12d542010-07-21 13:38:02 -04002019 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2020
2021 If your arch supports the generic GPIO framework (asm/gpio.h),
2022 then you may alternatively define the two GPIOs that are to be
2023 used as SCL / SDA. Any of the previous I2C_xxx macros will
2024 have GPIO-based defaults assigned to them as appropriate.
2025
2026 You should define these to the GPIO value as given directly to
2027 the generic GPIO functions.
2028
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002029 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002030
wdenk57b2d802003-06-27 21:31:46 +00002031 When a board is reset during an i2c bus transfer
2032 chips might think that the current transfer is still
2033 in progress. On some boards it is possible to access
2034 the i2c SCLK line directly, either by using the
2035 processor pin as a GPIO or by having a second pin
2036 connected to the bus. If this option is defined a
2037 custom i2c_init_board() routine in boards/xxx/board.c
2038 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002039
Richard Retanubundf0149c2010-04-12 15:08:17 -04002040 CONFIG_SYS_I2C_BOARD_LATE_INIT
2041
2042 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2043 defined a custom i2c_board_late_init() routine in
2044 boards/xxx/board.c is run AFTER the operations in i2c_init()
2045 is completed. This callpoint can be used to unreset i2c bus
2046 using CPU i2c controller register accesses for CPUs whose i2c
2047 controller provide such a method. It is called at the end of
2048 i2c_init() to allow i2c_init operations to setup the i2c bus
2049 controller on the CPU (e.g. setting bus speed & slave address).
2050
wdenk0e2bd9c2004-06-06 21:51:03 +00002051 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2052
2053 This option enables configuration of bi_iic_fast[] flags
2054 in u-boot bd_info structure based on u-boot environment
2055 variable "i2cfast". (see also i2cfast)
2056
Ben Warren45657152006-09-07 16:50:54 -04002057 CONFIG_I2C_MULTI_BUS
2058
2059 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002060 must have a controller. At any point in time, only one bus is
2061 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002062 Note that bus numbering is zero-based.
2063
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002064 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002065
2066 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002067 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002068 is set, specify a list of bus-device pairs. Otherwise, specify
2069 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002070
2071 e.g.
2072 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002073 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002074
2075 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2076
Wolfgang Denk092ae952011-10-26 10:21:21 +00002077 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002078 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002079
2080 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2081
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002082 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002083
2084 If defined, then this indicates the I2C bus number for DDR SPD.
2085 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2086
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002087 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002088
2089 If defined, then this indicates the I2C bus number for the RTC.
2090 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002092 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002093
2094 If defined, then this indicates the I2C bus number for the DTT.
2095 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002097 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002098
2099 If defined, specifies the I2C address of the DTT device.
2100 If not defined, then U-Boot uses predefined value for
2101 specified DTT device.
2102
Timur Tabiab347542006-11-03 19:15:00 -06002103 CONFIG_FSL_I2C
2104
2105 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01002106 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06002107
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002108 CONFIG_I2C_MUX
2109
2110 Define this option if you have I2C devices reached over 1 .. n
2111 I2C Muxes like the pca9544a. This option addes a new I2C
2112 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2113 new I2C Bus to the existing I2C Busses. If you select the
2114 new Bus with "i2c dev", u-bbot sends first the commandos for
2115 the muxes to activate this new "bus".
2116
2117 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2118 feature!
2119
2120 Example:
2121 Adding a new I2C Bus reached over 2 pca9544a muxes
2122 The First mux with address 70 and channel 6
2123 The Second mux with address 71 and channel 4
2124
2125 => i2c bus pca9544a:70:6:pca9544a:71:4
2126
2127 Use the "i2c bus" command without parameter, to get a list
2128 of I2C Busses with muxes:
2129
2130 => i2c bus
2131 Busses reached over muxes:
2132 Bus ID: 2
2133 reached over Mux(es):
2134 pca9544a@70 ch: 4
2135 Bus ID: 3
2136 reached over Mux(es):
2137 pca9544a@70 ch: 6
2138 pca9544a@71 ch: 4
2139 =>
2140
2141 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002142 u-boot first sends the command to the mux@70 to enable
2143 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002144 the channel 4.
2145
2146 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002147 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002148 the 2 muxes.
2149
2150 This option is actually implemented for the bitbanging
2151 algorithm in common/soft_i2c.c and for the Hardware I2C
2152 Bus on the MPC8260. But it should be not so difficult
2153 to add this option to other architectures.
2154
Andrew Dyer58c41f92008-12-29 17:36:01 -06002155 CONFIG_SOFT_I2C_READ_REPEATED_START
2156
2157 defining this will force the i2c_read() function in
2158 the soft_i2c driver to perform an I2C repeated start
2159 between writing the address pointer and reading the
2160 data. If this define is omitted the default behaviour
2161 of doing a stop-start sequence will be used. Most I2C
2162 devices can use either method, but some require one or
2163 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002164
wdenkc6097192002-11-03 00:24:07 +00002165- SPI Support: CONFIG_SPI
2166
2167 Enables SPI driver (so far only tested with
2168 SPI EEPROM, also an instance works with Crystal A/D and
2169 D/As on the SACSng board)
2170
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002171 CONFIG_SH_SPI
2172
2173 Enables the driver for SPI controller on SuperH. Currently
2174 only SH7757 is supported.
2175
wdenkc6097192002-11-03 00:24:07 +00002176 CONFIG_SPI_X
2177
2178 Enables extended (16-bit) SPI EEPROM addressing.
2179 (symmetrical to CONFIG_I2C_X)
2180
2181 CONFIG_SOFT_SPI
2182
wdenk4a5c8a72003-03-06 00:02:04 +00002183 Enables a software (bit-bang) SPI driver rather than
2184 using hardware support. This is a general purpose
2185 driver that only requires three general I/O port pins
2186 (two outputs, one input) to function. If this is
2187 defined, the board configuration must define several
2188 SPI configuration items (port pins to use, etc). For
2189 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002190
Ben Warren7efe9272008-01-16 22:37:35 -05002191 CONFIG_HARD_SPI
2192
2193 Enables a hardware SPI driver for general-purpose reads
2194 and writes. As with CONFIG_SOFT_SPI, the board configuration
2195 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002196 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002197 example, see include/configs/mpc8349emds.h.
2198
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002199 CONFIG_MXC_SPI
2200
2201 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002202 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002203
Matthias Fuchsa4400872007-12-27 17:12:34 +01002204- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002205
Matthias Fuchsa4400872007-12-27 17:12:34 +01002206 Enables FPGA subsystem.
2207
2208 CONFIG_FPGA_<vendor>
2209
2210 Enables support for specific chip vendors.
2211 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002212
Matthias Fuchsa4400872007-12-27 17:12:34 +01002213 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002214
Matthias Fuchsa4400872007-12-27 17:12:34 +01002215 Enables support for FPGA family.
2216 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2217
2218 CONFIG_FPGA_COUNT
2219
2220 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002222 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002223
wdenk57b2d802003-06-27 21:31:46 +00002224 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002225
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002226 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002227
wdenk4a5c8a72003-03-06 00:02:04 +00002228 Enable checks on FPGA configuration interface busy
2229 status by the configuration function. This option
2230 will require a board or device specific function to
2231 be written.
wdenkc6097192002-11-03 00:24:07 +00002232
2233 CONFIG_FPGA_DELAY
2234
2235 If defined, a function that provides delays in the FPGA
2236 configuration driver.
2237
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002238 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002239 Allow Control-C to interrupt FPGA configuration
2240
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002241 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002242
wdenk4a5c8a72003-03-06 00:02:04 +00002243 Check for configuration errors during FPGA bitfile
2244 loading. For example, abort during Virtex II
2245 configuration if the INIT_B line goes low (which
2246 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002247
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002248 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002249
wdenk4a5c8a72003-03-06 00:02:04 +00002250 Maximum time to wait for the INIT_B line to deassert
2251 after PROB_B has been deasserted during a Virtex II
2252 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002253 ms.
wdenkc6097192002-11-03 00:24:07 +00002254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002255 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002256
wdenk4a5c8a72003-03-06 00:02:04 +00002257 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002258 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002259
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002260 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002261
wdenk4a5c8a72003-03-06 00:02:04 +00002262 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002263 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002264
2265- Configuration Management:
2266 CONFIG_IDENT_STRING
2267
wdenk4a5c8a72003-03-06 00:02:04 +00002268 If defined, this string will be added to the U-Boot
2269 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002270
2271- Vendor Parameter Protection:
2272
wdenk4a5c8a72003-03-06 00:02:04 +00002273 U-Boot considers the values of the environment
2274 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002275 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002276 are set once by the board vendor / manufacturer, and
2277 protects these variables from casual modification by
2278 the user. Once set, these variables are read-only,
2279 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002280 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002281
2282 If CONFIG_ENV_OVERWRITE is #defined in your config
2283 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002284 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002285 these parameters.
2286
2287 Alternatively, if you #define _both_ CONFIG_ETHADDR
2288 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002289 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002290 which can be changed exactly ONCE by the user. [The
2291 serial# is unaffected by this, i. e. it remains
2292 read-only.]
2293
Joe Hershberger71497d02012-12-11 22:16:31 -06002294 The same can be accomplished in a more flexible way
2295 for any variable by configuring the type of access
2296 to allow for those variables in the ".flags" variable
2297 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2298
wdenkc6097192002-11-03 00:24:07 +00002299- Protected RAM:
2300 CONFIG_PRAM
2301
2302 Define this variable to enable the reservation of
2303 "protected RAM", i. e. RAM which is not overwritten
2304 by U-Boot. Define CONFIG_PRAM to hold the number of
2305 kB you want to reserve for pRAM. You can overwrite
2306 this default value by defining an environment
2307 variable "pram" to the number of kB you want to
2308 reserve. Note that the board info structure will
2309 still show the full amount of RAM. If pRAM is
2310 reserved, a new environment variable "mem" will
2311 automatically be defined to hold the amount of
2312 remaining RAM in a form that can be passed as boot
2313 argument to Linux, for instance like that:
2314
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002315 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002316 saveenv
2317
2318 This way you can tell Linux not to use this memory,
2319 either, which results in a memory region that will
2320 not be affected by reboots.
2321
2322 *WARNING* If your board configuration uses automatic
2323 detection of the RAM size, you must make sure that
2324 this memory test is non-destructive. So far, the
2325 following board configurations are known to be
2326 "pRAM-clean":
2327
Wolfgang Denk90326762012-10-24 02:36:15 +00002328 IVMS8, IVML24, SPD8xx, TQM8xxL,
2329 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002330 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002331
Gabe Blacka2f3a932012-12-02 04:55:18 +00002332- Access to physical memory region (> 4GB)
2333 Some basic support is provided for operations on memory not
2334 normally accessible to U-Boot - e.g. some architectures
2335 support access to more than 4GB of memory on 32-bit
2336 machines using physical address extension or similar.
2337 Define CONFIG_PHYSMEM to access this basic support, which
2338 currently only supports clearing the memory.
2339
wdenkc6097192002-11-03 00:24:07 +00002340- Error Recovery:
2341 CONFIG_PANIC_HANG
2342
2343 Define this variable to stop the system in case of a
2344 fatal error, so that you have to reset it manually.
2345 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002346 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002347 automatically as fast as possible, but it may be
2348 useful during development since you can try to debug
2349 the conditions that lead to the situation.
2350
2351 CONFIG_NET_RETRY_COUNT
2352
wdenk4a5c8a72003-03-06 00:02:04 +00002353 This variable defines the number of retries for
2354 network operations like ARP, RARP, TFTP, or BOOTP
2355 before giving up the operation. If not defined, a
2356 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002357
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002358 CONFIG_ARP_TIMEOUT
2359
2360 Timeout waiting for an ARP reply in milliseconds.
2361
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002362 CONFIG_NFS_TIMEOUT
2363
2364 Timeout in milliseconds used in NFS protocol.
2365 If you encounter "ERROR: Cannot umount" in nfs command,
2366 try longer timeout such as
2367 #define CONFIG_NFS_TIMEOUT 10000UL
2368
wdenkc6097192002-11-03 00:24:07 +00002369- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002370 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002371
2372 Enable auto completion of commands using TAB.
2373
Wolfgang Denk018147d2006-11-27 15:32:42 +01002374 Note that this feature has NOT been implemented yet
2375 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002376
2377
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002378 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002379
2380 Define this variable to enable the "hush" shell (from
2381 Busybox) as command line interpreter, thus enabling
2382 powerful command line syntax like
2383 if...then...else...fi conditionals or `&&' and '||'
2384 constructs ("shell scripts").
2385
2386 If undefined, you get the old, much simpler behaviour
2387 with a somewhat smaller memory footprint.
2388
2389
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002390 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002391
2392 This defines the secondary prompt string, which is
2393 printed when the command interpreter needs more input
2394 to complete a command. Usually "> ".
2395
2396 Note:
2397
wdenk57b2d802003-06-27 21:31:46 +00002398 In the current implementation, the local variables
2399 space and global environment variables space are
2400 separated. Local variables are those you define by
2401 simply typing `name=value'. To access a local
2402 variable later on, you have write `$name' or
2403 `${name}'; to execute the contents of a variable
2404 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002405
wdenk4a5c8a72003-03-06 00:02:04 +00002406 Global environment variables are those you use
2407 setenv/printenv to work with. To run a command stored
2408 in such a variable, you need to use the run command,
2409 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002410
2411 To store commands and special characters in a
2412 variable, please use double quotation marks
2413 surrounding the whole text of the variable, instead
2414 of the backslashes before semicolons and special
2415 symbols.
2416
Wolfgang Denk2039a072006-07-21 11:35:21 +02002417- Commandline Editing and History:
2418 CONFIG_CMDLINE_EDITING
2419
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002420 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002421 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002422
wdenkc0aa5c52003-12-06 19:49:23 +00002423- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002424 CONFIG_EXTRA_ENV_SETTINGS
2425
wdenk4a5c8a72003-03-06 00:02:04 +00002426 Define this to contain any number of null terminated
2427 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002428 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002429
wdenk4a5c8a72003-03-06 00:02:04 +00002430 For example, place something like this in your
2431 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002432
2433 #define CONFIG_EXTRA_ENV_SETTINGS \
2434 "myvar1=value1\0" \
2435 "myvar2=value2\0"
2436
wdenk4a5c8a72003-03-06 00:02:04 +00002437 Warning: This method is based on knowledge about the
2438 internal format how the environment is stored by the
2439 U-Boot code. This is NOT an official, exported
2440 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002441 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002442 You better know what you are doing here.
2443
wdenk4a5c8a72003-03-06 00:02:04 +00002444 Note: overly (ab)use of the default environment is
2445 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002446 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002447 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002448
Stephen Warren1465d5f2012-05-22 09:21:54 +00002449 CONFIG_ENV_VARS_UBOOT_CONFIG
2450
2451 Define this in order to add variables describing the
2452 U-Boot build configuration to the default environment.
2453 These will be named arch, cpu, board, vendor, and soc.
2454
2455 Enabling this option will cause the following to be defined:
2456
2457 - CONFIG_SYS_ARCH
2458 - CONFIG_SYS_CPU
2459 - CONFIG_SYS_BOARD
2460 - CONFIG_SYS_VENDOR
2461 - CONFIG_SYS_SOC
2462
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002463 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2464
2465 Define this in order to add variables describing certain
2466 run-time determined information about the hardware to the
2467 environment. These will be named board_name, board_rev.
2468
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002469 CONFIG_DELAY_ENVIRONMENT
2470
2471 Normally the environment is loaded when the board is
2472 intialised so that it is available to U-Boot. This inhibits
2473 that so that the environment is not available until
2474 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2475 this is instead controlled by the value of
2476 /config/load-environment.
2477
wdenkc0aa5c52003-12-06 19:49:23 +00002478- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002479 CONFIG_HAS_DATAFLASH
2480
wdenk57b2d802003-06-27 21:31:46 +00002481 Defining this option enables DataFlash features and
2482 allows to read/write in Dataflash via the standard
2483 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002484
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002485- Serial Flash support
2486 CONFIG_CMD_SF
2487
2488 Defining this option enables SPI flash commands
2489 'sf probe/read/write/erase/update'.
2490
2491 Usage requires an initial 'probe' to define the serial
2492 flash parameters, followed by read/write/erase/update
2493 commands.
2494
2495 The following defaults may be provided by the platform
2496 to handle the common case when only a single serial
2497 flash is present on the system.
2498
2499 CONFIG_SF_DEFAULT_BUS Bus identifier
2500 CONFIG_SF_DEFAULT_CS Chip-select
2501 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2502 CONFIG_SF_DEFAULT_SPEED in Hz
2503
Simon Glass4b5545e2012-10-08 13:16:02 +00002504 CONFIG_CMD_SF_TEST
2505
2506 Define this option to include a destructive SPI flash
2507 test ('sf test').
2508
wdenkef893942004-02-23 16:11:30 +00002509- SystemACE Support:
2510 CONFIG_SYSTEMACE
2511
2512 Adding this option adds support for Xilinx SystemACE
2513 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002514 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002515 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002516
2517 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002518 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002519
2520 When SystemACE support is added, the "ace" device type
2521 becomes available to the fat commands, i.e. fatls.
2522
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002523- TFTP Fixed UDP Port:
2524 CONFIG_TFTP_PORT
2525
Wolfgang Denk227b5192005-09-24 23:25:46 +02002526 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002527 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002528 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002529 number generator is used.
2530
Wolfgang Denk227b5192005-09-24 23:25:46 +02002531 Also, the environment variable tftpdstp is used to supply
2532 the TFTP UDP destination port value. If tftpdstp isn't
2533 defined, the normal port 69 is used.
2534
2535 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002536 blindly start the TFTP transfer using the pre-configured
2537 target IP address and UDP port. This has the effect of
2538 "punching through" the (Windows XP) firewall, allowing
2539 the remainder of the TFTP transfer to proceed normally.
2540 A better solution is to properly configure the firewall,
2541 but sometimes that is not allowed.
2542
Simon Glass058bb8d2012-12-05 14:46:38 +00002543- Hashing support:
2544 CONFIG_CMD_HASH
2545
2546 This enables a generic 'hash' command which can produce
2547 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2548
2549 CONFIG_HASH_VERIFY
2550
2551 Enable the hash verify command (hash -v). This adds to code
2552 size a little.
2553
2554 CONFIG_SHA1 - support SHA1 hashing
2555 CONFIG_SHA256 - support SHA256 hashing
2556
2557 Note: There is also a sha1sum command, which should perhaps
2558 be deprecated in favour of 'hash sha1'.
2559
wdenkc0aa5c52003-12-06 19:49:23 +00002560- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002561 CONFIG_SHOW_BOOT_PROGRESS
2562
wdenk4a5c8a72003-03-06 00:02:04 +00002563 Defining this option allows to add some board-
2564 specific code (calling a user-provided function
2565 "show_boot_progress(int)") that enables you to show
2566 the system's boot progress on some display (for
2567 example, some LED's) on your board. At the moment,
2568 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002569
Simon Glass31a870e2012-02-13 13:51:19 +00002570- Detailed boot stage timing
2571 CONFIG_BOOTSTAGE
2572 Define this option to get detailed timing of each stage
2573 of the boot process.
2574
2575 CONFIG_BOOTSTAGE_USER_COUNT
2576 This is the number of available user bootstage records.
2577 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2578 a new ID will be allocated from this stash. If you exceed
2579 the limit, recording will stop.
2580
2581 CONFIG_BOOTSTAGE_REPORT
2582 Define this to print a report before boot, similar to this:
2583
2584 Timer summary in microseconds:
2585 Mark Elapsed Stage
2586 0 0 reset
2587 3,575,678 3,575,678 board_init_f start
2588 3,575,695 17 arch_cpu_init A9
2589 3,575,777 82 arch_cpu_init done
2590 3,659,598 83,821 board_init_r start
2591 3,910,375 250,777 main_loop
2592 29,916,167 26,005,792 bootm_start
2593 30,361,327 445,160 start_kernel
2594
Simon Glass4afd88e2012-09-28 08:56:39 +00002595 CONFIG_CMD_BOOTSTAGE
2596 Add a 'bootstage' command which supports printing a report
2597 and un/stashing of bootstage data.
2598
Simon Glass0fa36a42012-09-28 08:56:37 +00002599 CONFIG_BOOTSTAGE_FDT
2600 Stash the bootstage information in the FDT. A root 'bootstage'
2601 node is created with each bootstage id as a child. Each child
2602 has a 'name' property and either 'mark' containing the
2603 mark time in microsecond, or 'accum' containing the
2604 accumulated time for that bootstage id in microseconds.
2605 For example:
2606
2607 bootstage {
2608 154 {
2609 name = "board_init_f";
2610 mark = <3575678>;
2611 };
2612 170 {
2613 name = "lcd";
2614 accum = <33482>;
2615 };
2616 };
2617
2618 Code in the Linux kernel can find this in /proc/devicetree.
2619
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002620Legacy uImage format:
2621
wdenkc6097192002-11-03 00:24:07 +00002622 Arg Where When
2623 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002624 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002625 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002626 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002627 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002628 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002629 4 common/cmd_bootm.c Image data has correct checksum
2630 -4 common/cmd_bootm.c Image is for unsupported architecture
2631 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002632 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002633 6 common/cmd_bootm.c Image Type check OK
2634 -6 common/cmd_bootm.c gunzip uncompression error
2635 -7 common/cmd_bootm.c Unimplemented compression type
2636 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002637 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002638 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002639
2640 9 common/image.c Start initial ramdisk verification
2641 -10 common/image.c Ramdisk header has bad magic number
2642 -11 common/image.c Ramdisk header has bad checksum
2643 10 common/image.c Ramdisk header is OK
2644 -12 common/image.c Ramdisk data has bad checksum
2645 11 common/image.c Ramdisk data has correct checksum
2646 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002647 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002648 13 common/image.c Start multifile image verification
2649 14 common/image.c No initial ramdisk, no multifile, continue.
2650
Wolfgang Denk092ae952011-10-26 10:21:21 +00002651 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002652
Stefan Roese88fbf932010-04-15 16:07:28 +02002653 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002654 -31 post/post.c POST test failed, detected by post_output_backlog()
2655 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002656
Heiko Schocher633e03a2007-06-22 19:11:54 +02002657 34 common/cmd_doc.c before loading a Image from a DOC device
2658 -35 common/cmd_doc.c Bad usage of "doc" command
2659 35 common/cmd_doc.c correct usage of "doc" command
2660 -36 common/cmd_doc.c No boot device
2661 36 common/cmd_doc.c correct boot device
2662 -37 common/cmd_doc.c Unknown Chip ID on boot device
2663 37 common/cmd_doc.c correct chip ID found, device available
2664 -38 common/cmd_doc.c Read Error on boot device
2665 38 common/cmd_doc.c reading Image header from DOC device OK
2666 -39 common/cmd_doc.c Image header has bad magic number
2667 39 common/cmd_doc.c Image header has correct magic number
2668 -40 common/cmd_doc.c Error reading Image from DOC device
2669 40 common/cmd_doc.c Image header has correct magic number
2670 41 common/cmd_ide.c before loading a Image from a IDE device
2671 -42 common/cmd_ide.c Bad usage of "ide" command
2672 42 common/cmd_ide.c correct usage of "ide" command
2673 -43 common/cmd_ide.c No boot device
2674 43 common/cmd_ide.c boot device found
2675 -44 common/cmd_ide.c Device not available
2676 44 common/cmd_ide.c Device available
2677 -45 common/cmd_ide.c wrong partition selected
2678 45 common/cmd_ide.c partition selected
2679 -46 common/cmd_ide.c Unknown partition table
2680 46 common/cmd_ide.c valid partition table found
2681 -47 common/cmd_ide.c Invalid partition type
2682 47 common/cmd_ide.c correct partition type
2683 -48 common/cmd_ide.c Error reading Image Header on boot device
2684 48 common/cmd_ide.c reading Image Header from IDE device OK
2685 -49 common/cmd_ide.c Image header has bad magic number
2686 49 common/cmd_ide.c Image header has correct magic number
2687 -50 common/cmd_ide.c Image header has bad checksum
2688 50 common/cmd_ide.c Image header has correct checksum
2689 -51 common/cmd_ide.c Error reading Image from IDE device
2690 51 common/cmd_ide.c reading Image from IDE device OK
2691 52 common/cmd_nand.c before loading a Image from a NAND device
2692 -53 common/cmd_nand.c Bad usage of "nand" command
2693 53 common/cmd_nand.c correct usage of "nand" command
2694 -54 common/cmd_nand.c No boot device
2695 54 common/cmd_nand.c boot device found
2696 -55 common/cmd_nand.c Unknown Chip ID on boot device
2697 55 common/cmd_nand.c correct chip ID found, device available
2698 -56 common/cmd_nand.c Error reading Image Header on boot device
2699 56 common/cmd_nand.c reading Image Header from NAND device OK
2700 -57 common/cmd_nand.c Image header has bad magic number
2701 57 common/cmd_nand.c Image header has correct magic number
2702 -58 common/cmd_nand.c Error reading Image from NAND device
2703 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002704
Heiko Schocher633e03a2007-06-22 19:11:54 +02002705 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002706
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002707 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002708 -64 net/eth.c no Ethernet found.
2709 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002710
Heiko Schocher633e03a2007-06-22 19:11:54 +02002711 -80 common/cmd_net.c usage wrong
2712 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002713 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002714 81 common/cmd_net.c NetLoop() back without error
2715 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2716 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002717 83 common/cmd_net.c running "source" command
2718 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002719 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002720
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002721FIT uImage format:
2722
2723 Arg Where When
2724 100 common/cmd_bootm.c Kernel FIT Image has correct format
2725 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2726 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2727 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2728 102 common/cmd_bootm.c Kernel unit name specified
2729 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002730 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002731 104 common/cmd_bootm.c Got kernel subimage node offset
2732 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2733 105 common/cmd_bootm.c Kernel subimage hash verification OK
2734 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2735 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002736 -106 common/cmd_bootm.c Kernel subimage has wrong type
2737 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002738 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2739 108 common/cmd_bootm.c Got kernel subimage data/size
2740 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2741 -109 common/cmd_bootm.c Can't get kernel subimage type
2742 -110 common/cmd_bootm.c Can't get kernel subimage comp
2743 -111 common/cmd_bootm.c Can't get kernel subimage os
2744 -112 common/cmd_bootm.c Can't get kernel subimage load address
2745 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2746
2747 120 common/image.c Start initial ramdisk verification
2748 -120 common/image.c Ramdisk FIT image has incorrect format
2749 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002750 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002751 -122 common/image.c Can't get configuration for ramdisk subimage
2752 123 common/image.c Ramdisk unit name specified
2753 -124 common/image.c Can't get ramdisk subimage node offset
2754 125 common/image.c Got ramdisk subimage node offset
2755 -125 common/image.c Ramdisk subimage hash verification failed
2756 126 common/image.c Ramdisk subimage hash verification OK
2757 -126 common/image.c Ramdisk subimage for unsupported architecture
2758 127 common/image.c Architecture check OK
2759 -127 common/image.c Can't get ramdisk subimage data/size
2760 128 common/image.c Got ramdisk subimage data/size
2761 129 common/image.c Can't get ramdisk load address
2762 -129 common/image.c Got ramdisk load address
2763
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002764 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002765 131 common/cmd_doc.c FIT image format OK
2766
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002767 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002768 141 common/cmd_ide.c FIT image format OK
2769
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002770 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002771 151 common/cmd_nand.c FIT image format OK
2772
Gabe Blackd572e162012-10-25 16:31:10 +00002773- FIT image support:
2774 CONFIG_FIT
2775 Enable support for the FIT uImage format.
2776
2777 CONFIG_FIT_BEST_MATCH
2778 When no configuration is explicitly selected, default to the
2779 one whose fdt's compatibility field best matches that of
2780 U-Boot itself. A match is considered "best" if it matches the
2781 most specific compatibility entry of U-Boot's fdt's root node.
2782 The order of entries in the configuration's fdt is ignored.
2783
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002784- Standalone program support:
2785 CONFIG_STANDALONE_LOAD_ADDR
2786
Wolfgang Denk23f78482011-10-09 21:06:34 +02002787 This option defines a board specific value for the
2788 address where standalone program gets loaded, thus
2789 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002790 settings.
2791
2792- Frame Buffer Address:
2793 CONFIG_FB_ADDR
2794
2795 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002796 address for frame buffer. This is typically the case
2797 when using a graphics controller has separate video
2798 memory. U-Boot will then place the frame buffer at
2799 the given address instead of dynamically reserving it
2800 in system RAM by calling lcd_setmem(), which grabs
2801 the memory for the frame buffer depending on the
2802 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002803
2804 Please see board_init_f function.
2805
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002806- Automatic software updates via TFTP server
2807 CONFIG_UPDATE_TFTP
2808 CONFIG_UPDATE_TFTP_CNT_MAX
2809 CONFIG_UPDATE_TFTP_MSEC_MAX
2810
2811 These options enable and control the auto-update feature;
2812 for a more detailed description refer to doc/README.update.
2813
2814- MTD Support (mtdparts command, UBI support)
2815 CONFIG_MTD_DEVICE
2816
2817 Adds the MTD device infrastructure from the Linux kernel.
2818 Needed for mtdparts command support.
2819
2820 CONFIG_MTD_PARTITIONS
2821
2822 Adds the MTD partitioning infrastructure from the Linux
2823 kernel. Needed for UBI support.
2824
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002825- UBI support
2826 CONFIG_CMD_UBI
2827
2828 Adds commands for interacting with MTD partitions formatted
2829 with the UBI flash translation layer
2830
2831 Requires also defining CONFIG_RBTREE
2832
Joe Hershberger47550fc2013-04-08 10:32:49 +00002833 CONFIG_UBI_SILENCE_MSG
2834
2835 Make the verbose messages from UBI stop printing. This leaves
2836 warnings and errors enabled.
2837
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002838- UBIFS support
2839 CONFIG_CMD_UBIFS
2840
2841 Adds commands for interacting with UBI volumes formatted as
2842 UBIFS. UBIFS is read-only in u-boot.
2843
2844 Requires UBI support as well as CONFIG_LZO
2845
Joe Hershberger47550fc2013-04-08 10:32:49 +00002846 CONFIG_UBIFS_SILENCE_MSG
2847
2848 Make the verbose messages from UBIFS stop printing. This leaves
2849 warnings and errors enabled.
2850
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002851- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002852 CONFIG_SPL
2853 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002854
Tom Rini36853852012-02-14 07:29:40 +00002855 CONFIG_SPL_LDSCRIPT
2856 LDSCRIPT for linking the SPL binary.
2857
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002858 CONFIG_SPL_MAX_FOOTPRINT
2859 Maximum size in memory allocated to the SPL, BSS included.
2860 When defined, the linker checks that the actual memory
2861 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002862 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002863 must not be both defined at the same time.
2864
Tom Rini36853852012-02-14 07:29:40 +00002865 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002866 Maximum size of the SPL image (text, data, rodata, and
2867 linker lists sections), BSS excluded.
2868 When defined, the linker checks that the actual size does
2869 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002870
Wolfgang Denk825223d2011-09-11 21:24:09 +02002871 CONFIG_SPL_TEXT_BASE
2872 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002873
Scott Woodc4f0d002012-09-20 19:05:12 -05002874 CONFIG_SPL_RELOC_TEXT_BASE
2875 Address to relocate to. If unspecified, this is equal to
2876 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2877
Tom Rini36853852012-02-14 07:29:40 +00002878 CONFIG_SPL_BSS_START_ADDR
2879 Link address for the BSS within the SPL binary.
2880
2881 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002882 Maximum size in memory allocated to the SPL BSS.
2883 When defined, the linker checks that the actual memory used
2884 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002885 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002886 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002887
2888 CONFIG_SPL_STACK
2889 Adress of the start of the stack SPL will use
2890
Scott Woodc4f0d002012-09-20 19:05:12 -05002891 CONFIG_SPL_RELOC_STACK
2892 Adress of the start of the stack SPL will use after
2893 relocation. If unspecified, this is equal to
2894 CONFIG_SPL_STACK.
2895
Tom Rini36853852012-02-14 07:29:40 +00002896 CONFIG_SYS_SPL_MALLOC_START
2897 Starting address of the malloc pool used in SPL.
2898
2899 CONFIG_SYS_SPL_MALLOC_SIZE
2900 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002901
Tom Rini28591df2012-08-13 12:03:19 -07002902 CONFIG_SPL_FRAMEWORK
2903 Enable the SPL framework under common/. This framework
2904 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2905 NAND loading of the Linux Kernel.
2906
Tom Rinife3b0c72012-08-13 11:37:56 -07002907 CONFIG_SPL_DISPLAY_PRINT
2908 For ARM, enable an optional function to print more information
2909 about the running system.
2910
Scott Wood7c810902012-09-20 16:35:21 -05002911 CONFIG_SPL_INIT_MINIMAL
2912 Arch init code should be built for a very small image
2913
Wolfgang Denk825223d2011-09-11 21:24:09 +02002914 CONFIG_SPL_LIBCOMMON_SUPPORT
2915 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002916
Wolfgang Denk825223d2011-09-11 21:24:09 +02002917 CONFIG_SPL_LIBDISK_SUPPORT
2918 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002919
Wolfgang Denk825223d2011-09-11 21:24:09 +02002920 CONFIG_SPL_I2C_SUPPORT
2921 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002922
Wolfgang Denk825223d2011-09-11 21:24:09 +02002923 CONFIG_SPL_GPIO_SUPPORT
2924 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002925
Wolfgang Denk825223d2011-09-11 21:24:09 +02002926 CONFIG_SPL_MMC_SUPPORT
2927 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002928
Tom Rini36853852012-02-14 07:29:40 +00002929 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2930 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2931 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2932 Address, size and partition on the MMC to load U-Boot from
2933 when the MMC is being used in raw mode.
2934
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002935 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2936 Sector to load kernel uImage from when MMC is being
2937 used in raw mode (for Falcon mode)
2938
2939 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2940 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2941 Sector and number of sectors to load kernel argument
2942 parameters from when MMC is being used in raw mode
2943 (for falcon mode)
2944
Tom Rini36853852012-02-14 07:29:40 +00002945 CONFIG_SPL_FAT_SUPPORT
2946 Support for fs/fat/libfat.o in SPL binary
2947
2948 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2949 Filename to read to load U-Boot when reading from FAT
2950
Peter Korsgaard465f1f82013-05-13 08:36:27 +00002951 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
2952 Filename to read to load kernel uImage when reading
2953 from FAT (for Falcon mode)
2954
2955 CONFIG_SPL_FAT_LOAD_ARGS_NAME
2956 Filename to read to load kernel argument parameters
2957 when reading from FAT (for Falcon mode)
2958
Scott Wood2b36fbb2012-12-06 13:33:17 +00002959 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2960 Set this for NAND SPL on PPC mpc83xx targets, so that
2961 start.S waits for the rest of the SPL to load before
2962 continuing (the hardware starts execution after just
2963 loading the first page rather than the full 4K).
2964
Scott Woodc352a0c2012-09-20 19:09:07 -05002965 CONFIG_SPL_NAND_BASE
2966 Include nand_base.c in the SPL. Requires
2967 CONFIG_SPL_NAND_DRIVERS.
2968
2969 CONFIG_SPL_NAND_DRIVERS
2970 SPL uses normal NAND drivers, not minimal drivers.
2971
2972 CONFIG_SPL_NAND_ECC
2973 Include standard software ECC in the SPL
2974
Tom Rini36853852012-02-14 07:29:40 +00002975 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05002976 Support for NAND boot using simple NAND drivers that
2977 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00002978
2979 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2980 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2981 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2982 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2983 CONFIG_SYS_NAND_ECCBYTES
2984 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05002985 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00002986
2987 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05002988 Location in NAND to read U-Boot from
2989
2990 CONFIG_SYS_NAND_U_BOOT_DST
2991 Location in memory to load U-Boot to
2992
2993 CONFIG_SYS_NAND_U_BOOT_SIZE
2994 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00002995
2996 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05002997 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00002998
2999 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3000 Define this if you need to first read the OOB and then the
3001 data. This is used for example on davinci plattforms.
3002
3003 CONFIG_SPL_OMAP3_ID_NAND
3004 Support for an OMAP3-specific set of functions to return the
3005 ID and MFR of the first attached NAND chip, if present.
3006
Wolfgang Denk825223d2011-09-11 21:24:09 +02003007 CONFIG_SPL_SERIAL_SUPPORT
3008 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003009
Wolfgang Denk825223d2011-09-11 21:24:09 +02003010 CONFIG_SPL_SPI_FLASH_SUPPORT
3011 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003012
Wolfgang Denk825223d2011-09-11 21:24:09 +02003013 CONFIG_SPL_SPI_SUPPORT
3014 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003015
Pavel Machekde997252012-08-30 22:42:11 +02003016 CONFIG_SPL_RAM_DEVICE
3017 Support for running image already present in ram, in SPL binary
3018
Wolfgang Denk825223d2011-09-11 21:24:09 +02003019 CONFIG_SPL_LIBGENERIC_SUPPORT
3020 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003021
Scott Woodeb7bd972012-12-06 13:33:16 +00003022 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003023 Image offset to which the SPL should be padded before appending
3024 the SPL payload. By default, this is defined as
3025 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3026 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3027 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003028
Scott Woodf147eb72012-09-21 16:27:32 -05003029 CONFIG_SPL_TARGET
3030 Final target image containing SPL and payload. Some SPLs
3031 use an arch-specific makefile fragment instead, for
3032 example if more than one image needs to be produced.
3033
Simon Glass82d94532013-05-08 08:05:59 +00003034 CONFIG_FIT_SPL_PRINT
3035 Printing information about a FIT image adds quite a bit of
3036 code to SPL. So this is normally disabled in SPL. Use this
3037 option to re-enable it. This will affect the output of the
3038 bootm command when booting a FIT image.
3039
wdenkc6097192002-11-03 00:24:07 +00003040Modem Support:
3041--------------
3042
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003043[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003044
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003045- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003046 CONFIG_MODEM_SUPPORT
3047
3048- RTS/CTS Flow control enable:
3049 CONFIG_HWFLOW
3050
3051- Modem debug support:
3052 CONFIG_MODEM_SUPPORT_DEBUG
3053
wdenk4a5c8a72003-03-06 00:02:04 +00003054 Enables debugging stuff (char screen[1024], dbg())
3055 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003056
wdenkc0aa5c52003-12-06 19:49:23 +00003057- Interrupt support (PPC):
3058
wdenk1ebf41e2004-01-02 14:00:00 +00003059 There are common interrupt_init() and timer_interrupt()
3060 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003061 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003062 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003063 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003064 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003065 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003066 specific handling. If board has watchdog / status_led
3067 / other_activity_monitor it works automatically from
3068 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003069
wdenkc6097192002-11-03 00:24:07 +00003070- General:
3071
wdenk4a5c8a72003-03-06 00:02:04 +00003072 In the target system modem support is enabled when a
3073 specific key (key combination) is pressed during
3074 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003075 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003076 board_init(). Currently key_pressed() is a dummy
3077 function, returning 1 and thus enabling modem
3078 initialization.
wdenkc6097192002-11-03 00:24:07 +00003079
wdenk4a5c8a72003-03-06 00:02:04 +00003080 If there are no modem init strings in the
3081 environment, U-Boot proceed to autoboot; the
3082 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003083 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003084
3085 See also: doc/README.Modem
3086
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003087Board initialization settings:
3088------------------------------
3089
3090During Initialization u-boot calls a number of board specific functions
3091to allow the preparation of board specific prerequisites, e.g. pin setup
3092before drivers are initialized. To enable these callbacks the
3093following configuration macros have to be defined. Currently this is
3094architecture specific, so please check arch/your_architecture/lib/board.c
3095typically in board_init_f() and board_init_r().
3096
3097- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3098- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3099- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3100- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003101
wdenkc6097192002-11-03 00:24:07 +00003102Configuration Settings:
3103-----------------------
3104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003105- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003106 undefine this when you're short of memory.
3107
Peter Tyserdfb72b82009-01-27 18:03:12 -06003108- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3109 width of the commands listed in the 'help' command output.
3110
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003111- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003112 prompt for user input.
3113
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003114- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003116- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003117
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003118- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003119
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003120- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003121 the application (usually a Linux kernel) when it is
3122 booted
3123
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003124- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003125 List of legal baudrate settings for this board.
3126
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003127- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003128 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003129
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003130- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003131 If the board specific function
3132 extern int overwrite_console (void);
3133 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003134 serial port, else the settings in the environment are used.
3135
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003136- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003137 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003138
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003139- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003140 Enable overwrite of previous console environment settings.
3141
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003142- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003143 Begin and End addresses of the area used by the
3144 simple memory test.
3145
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003146- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003147 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003148
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003149- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003150 Scratch address used by the alternate memory test
3151 You only need to set this if address zero isn't writeable
3152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003153- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3154 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003155 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003156 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003157 fixing up gd->ram_size the Linux kernel should gets passed
3158 the now "corrected" memory size and won't touch it either.
3159 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003160 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003161 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003162 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003163
3164 This option can be used as a workaround for the 440EPx/GRx
3165 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3166 be touched.
3167
3168 WARNING: Please make sure that this value is a multiple of
3169 the Linux page size (normally 4k). If this is not the case,
3170 then the end address of the Linux memory will be located at a
3171 non page size aligned address and this could cause major
3172 problems.
3173
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003174- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003175 Enable temporary baudrate change while serial download
3176
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003177- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003178 Physical start address of SDRAM. _Must_ be 0 here.
3179
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003180- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003181 Physical start address of Motherboard I/O (if using a
3182 Cogent motherboard)
3183
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003184- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003185 Physical start address of Flash memory.
3186
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003187- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003188 Physical start address of boot monitor code (set by
3189 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003190 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003191 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003192
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003193- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003194 Size of memory reserved for monitor code, used to
3195 determine _at_compile_time_ (!) if the environment is
3196 embedded within the U-Boot image, or in a separate
3197 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003198
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003199- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003200 Size of DRAM reserved for malloc() use.
3201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003202- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003203 Normally compressed uImages are limited to an
3204 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003205 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003206 to adjust this setting to your needs.
3207
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003208- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003209 Maximum size of memory mapped by the startup code of
3210 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003211 the Linux kernel (bd_info, boot arguments, FDT blob if
3212 used) must be put below this limit, unless "bootm_low"
3213 enviroment variable is defined and non-zero. In such case
3214 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003215 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003216 variable "bootm_mapsize" will override the value of
3217 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3218 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003219
John Rigbyeea8e692010-10-13 13:57:35 -06003220- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3221 Enable initrd_high functionality. If defined then the
3222 initrd_high feature is enabled and the bootm ramdisk subcommand
3223 is enabled.
3224
3225- CONFIG_SYS_BOOT_GET_CMDLINE:
3226 Enables allocating and saving kernel cmdline in space between
3227 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3228
3229- CONFIG_SYS_BOOT_GET_KBD:
3230 Enables allocating and saving a kernel copy of the bd_info in
3231 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3232
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003233- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003234 Max number of Flash memory banks
3235
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003236- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003237 Max number of sectors on a Flash chip
3238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003239- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003240 Timeout for Flash erase operations (in ms)
3241
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003242- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003243 Timeout for Flash write operations (in ms)
3244
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003245- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003246 Timeout for Flash set sector lock bit operation (in ms)
3247
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003248- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003249 Timeout for Flash clear lock bits operation (in ms)
3250
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003251- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003252 If defined, hardware flash sectors protection is used
3253 instead of U-Boot software protection.
3254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003255- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003256
3257 Enable TFTP transfers directly to flash memory;
3258 without this option such a download has to be
3259 performed in two steps: (1) download to RAM, and (2)
3260 copy from RAM to flash.
3261
3262 The two-step approach is usually more reliable, since
3263 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003264 the flash, but in some situations (when system RAM is
3265 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003266 downloaded image) this option may be very useful.
3267
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003268- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003269 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003270 common flash structure for storing flash geometry.
3271
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003272- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003273 This option also enables the building of the cfi_flash driver
3274 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003275
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003276- CONFIG_FLASH_CFI_MTD
3277 This option enables the building of the cfi_mtd driver
3278 in the drivers directory. The driver exports CFI flash
3279 to the MTD layer.
3280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003281- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003282 Use buffered writes to flash.
3283
3284- CONFIG_FLASH_SPANSION_S29WS_N
3285 s29ws-n MirrorBit flash has non-standard addresses for buffered
3286 write commands.
3287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003288- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003289 If this option is defined, the common CFI flash doesn't
3290 print it's warning upon not recognized FLASH banks. This
3291 is useful, if some of the configured banks are only
3292 optionally available.
3293
Jerry Van Barenaae73572008-03-08 13:48:01 -05003294- CONFIG_FLASH_SHOW_PROGRESS
3295 If defined (must be an integer), print out countdown
3296 digits and dots. Recommended value: 45 (9..1) for 80
3297 column displays, 15 (3..1) for 40 column displays.
3298
Stefan Roesed20cba52013-04-04 15:53:14 +02003299- CONFIG_FLASH_VERIFY
3300 If defined, the content of the flash (destination) is compared
3301 against the source after the write operation. An error message
3302 will be printed when the contents are not identical.
3303 Please note that this option is useless in nearly all cases,
3304 since such flash programming errors usually are detected earlier
3305 while unprotecting/erasing/programming. Please only enable
3306 this option if you really know what you are doing.
3307
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003308- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003309 Defines the number of Ethernet receive buffers. On some
3310 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003311 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3312 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003313 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003314 Defaults to 4 if not defined.
3315
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003316- CONFIG_ENV_MAX_ENTRIES
3317
Wolfgang Denk1136f692010-10-27 22:48:30 +02003318 Maximum number of entries in the hash table that is used
3319 internally to store the environment settings. The default
3320 setting is supposed to be generous and should work in most
3321 cases. This setting can be used to tune behaviour; see
3322 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003323
Joe Hershberger71497d02012-12-11 22:16:31 -06003324- CONFIG_ENV_FLAGS_LIST_DEFAULT
3325- CONFIG_ENV_FLAGS_LIST_STATIC
3326 Enable validation of the values given to enviroment variables when
3327 calling env set. Variables can be restricted to only decimal,
3328 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3329 the variables can also be restricted to IP address or MAC address.
3330
3331 The format of the list is:
3332 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003333 access_atribute = [a|r|o|c]
3334 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003335 entry = variable_name[:attributes]
3336 list = entry[,list]
3337
3338 The type attributes are:
3339 s - String (default)
3340 d - Decimal
3341 x - Hexadecimal
3342 b - Boolean ([1yYtT|0nNfF])
3343 i - IP address
3344 m - MAC address
3345
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003346 The access attributes are:
3347 a - Any (default)
3348 r - Read-only
3349 o - Write-once
3350 c - Change-default
3351
Joe Hershberger71497d02012-12-11 22:16:31 -06003352 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3353 Define this to a list (string) to define the ".flags"
3354 envirnoment variable in the default or embedded environment.
3355
3356 - CONFIG_ENV_FLAGS_LIST_STATIC
3357 Define this to a list (string) to define validation that
3358 should be done if an entry is not found in the ".flags"
3359 environment variable. To override a setting in the static
3360 list, simply add an entry for the same variable name to the
3361 ".flags" variable.
3362
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003363- CONFIG_ENV_ACCESS_IGNORE_FORCE
3364 If defined, don't allow the -f switch to env set override variable
3365 access flags.
3366
Simon Glass66828322013-03-08 13:45:27 +00003367- CONFIG_SYS_GENERIC_BOARD
3368 This selects the architecture-generic board system instead of the
3369 architecture-specific board files. It is intended to move boards
3370 to this new framework over time. Defining this will disable the
3371 arch/foo/lib/board.c file and use common/board_f.c and
3372 common/board_r.c instead. To use this option your architecture
3373 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3374 its config.mk file). If you find problems enabling this option on
3375 your board please report the problem and send patches!
3376
Simon Glass9c9f44a2013-03-11 07:06:48 +00003377- CONFIG_SYS_SYM_OFFSETS
3378 This is set by architectures that use offsets for link symbols
3379 instead of absolute values. So bss_start is obtained using an
3380 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3381 directly. You should not need to touch this setting.
3382
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003383- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3384 This is set by OMAP boards for the max time that reset should
3385 be asserted. See doc/README.omap-reset-time for details on how
3386 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003387
wdenkc6097192002-11-03 00:24:07 +00003388The following definitions that deal with the placement and management
3389of environment data (variable area); in general, we support the
3390following configurations:
3391
Mike Frysinger63b8f122011-07-08 10:44:25 +00003392- CONFIG_BUILD_ENVCRC:
3393
3394 Builds up envcrc with the target environment so that external utils
3395 may easily extract it and embed it in final U-Boot images.
3396
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003397- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003398
3399 Define this if the environment is in flash memory.
3400
3401 a) The environment occupies one whole flash sector, which is
3402 "embedded" in the text segment with the U-Boot code. This
3403 happens usually with "bottom boot sector" or "top boot
3404 sector" type flash chips, which have several smaller
3405 sectors at the start or the end. For instance, such a
3406 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3407 such a case you would place the environment in one of the
3408 4 kB sectors - with U-Boot code before and after it. With
3409 "top boot sector" type flash chips, you would put the
3410 environment in one of the last sectors, leaving a gap
3411 between U-Boot and the environment.
3412
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003413 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003414
3415 Offset of environment data (variable area) to the
3416 beginning of flash memory; for instance, with bottom boot
3417 type flash chips the second sector can be used: the offset
3418 for this sector is given here.
3419
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003420 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003421
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003422 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003423
3424 This is just another way to specify the start address of
3425 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003426 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003427
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003428 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003429
3430 Size of the sector containing the environment.
3431
3432
3433 b) Sometimes flash chips have few, equal sized, BIG sectors.
3434 In such a case you don't want to spend a whole sector for
3435 the environment.
3436
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003437 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003438
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003439 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003440 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003441 of this flash sector for the environment. This saves
3442 memory for the RAM copy of the environment.
3443
3444 It may also save flash memory if you decide to use this
3445 when your environment is "embedded" within U-Boot code,
3446 since then the remainder of the flash sector could be used
3447 for U-Boot code. It should be pointed out that this is
3448 STRONGLY DISCOURAGED from a robustness point of view:
3449 updating the environment in flash makes it always
3450 necessary to erase the WHOLE sector. If something goes
3451 wrong before the contents has been restored from a copy in
3452 RAM, your target system will be dead.
3453
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003454 - CONFIG_ENV_ADDR_REDUND
3455 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003456
wdenk4a5c8a72003-03-06 00:02:04 +00003457 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003458 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003459 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003460 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003461
3462BE CAREFUL! Any changes to the flash layout, and some changes to the
3463source code will make it necessary to adapt <board>/u-boot.lds*
3464accordingly!
3465
3466
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003467- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003468
3469 Define this if you have some non-volatile memory device
3470 (NVRAM, battery buffered SRAM) which you want to use for the
3471 environment.
3472
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003473 - CONFIG_ENV_ADDR:
3474 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003475
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003476 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003477 want to use for environment. It is assumed that this memory
3478 can just be read and written to, without any special
3479 provision.
3480
3481BE CAREFUL! The first access to the environment happens quite early
3482in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003483console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003484U-Boot will hang.
3485
3486Please note that even with NVRAM we still use a copy of the
3487environment in RAM: we could work on NVRAM directly, but we want to
3488keep settings there always unmodified except somebody uses "saveenv"
3489to save the current settings.
3490
3491
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003492- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003493
3494 Use this if you have an EEPROM or similar serial access
3495 device and a driver for it.
3496
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003497 - CONFIG_ENV_OFFSET:
3498 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003499
3500 These two #defines specify the offset and size of the
3501 environment area within the total memory of your EEPROM.
3502
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003503 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003504 If defined, specified the chip address of the EEPROM device.
3505 The default address is zero.
3506
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003507 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003508 If defined, the number of bits used to address bytes in a
3509 single page in the EEPROM device. A 64 byte page, for example
3510 would require six bits.
3511
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003512 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003513 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003514 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003515
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003516 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003517 The length in bytes of the EEPROM memory array address. Note
3518 that this is NOT the chip address length!
3519
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003520 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003521 EEPROM chips that implement "address overflow" are ones
3522 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3523 address and the extra bits end up in the "chip address" bit
3524 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3525 byte chips.
3526
3527 Note that we consider the length of the address field to
3528 still be one byte because the extra address bits are hidden
3529 in the chip address.
3530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003531 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003532 The size in bytes of the EEPROM device.
3533
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003534 - CONFIG_ENV_EEPROM_IS_ON_I2C
3535 define this, if you have I2C and SPI activated, and your
3536 EEPROM, which holds the environment, is on the I2C bus.
3537
3538 - CONFIG_I2C_ENV_EEPROM_BUS
3539 if you have an Environment on an EEPROM reached over
3540 I2C muxes, you can define here, how to reach this
3541 EEPROM. For example:
3542
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02003543 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003544
3545 EEPROM which holds the environment, is reached over
3546 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003547
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003548- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003549
wdenk1ebf41e2004-01-02 14:00:00 +00003550 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003551 want to use for the environment.
3552
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003553 - CONFIG_ENV_OFFSET:
3554 - CONFIG_ENV_ADDR:
3555 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003556
3557 These three #defines specify the offset and size of the
3558 environment area within the total memory of your DataFlash placed
3559 at the specified address.
3560
Liu Gang85bcd732012-03-08 00:33:20 +00003561- CONFIG_ENV_IS_IN_REMOTE:
3562
3563 Define this if you have a remote memory space which you
3564 want to use for the local device's environment.
3565
3566 - CONFIG_ENV_ADDR:
3567 - CONFIG_ENV_SIZE:
3568
3569 These two #defines specify the address and size of the
3570 environment area within the remote memory space. The
3571 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003572 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003573
3574BE CAREFUL! For some special cases, the local device can not use
3575"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003576environment stored in a remote NOR flash by SRIO or PCIE link,
3577but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003578
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003579- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003580
3581 Define this if you have a NAND device which you want to use
3582 for the environment.
3583
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003584 - CONFIG_ENV_OFFSET:
3585 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003586
3587 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003588 area within the first NAND device. CONFIG_ENV_OFFSET must be
3589 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003590
Scott Wood08239322010-09-17 14:38:37 -05003591 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003592
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003593 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003594 size used to hold a redundant copy of the environment data, so
3595 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003596 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003597 aligned to an erase block boundary.
3598
3599 - CONFIG_ENV_RANGE (optional):
3600
3601 Specifies the length of the region in which the environment
3602 can be written. This should be a multiple of the NAND device's
3603 block size. Specifying a range with more erase blocks than
3604 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3605 the range to be avoided.
3606
3607 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003608
Scott Wood08239322010-09-17 14:38:37 -05003609 Enables support for dynamically retrieving the offset of the
3610 environment from block zero's out-of-band data. The
3611 "nand env.oob" command can be used to record this offset.
3612 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3613 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003614
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003615- CONFIG_NAND_ENV_DST
3616
3617 Defines address in RAM to which the nand_spl code should copy the
3618 environment. If redundant environment is used, it will be copied to
3619 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3620
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003621- CONFIG_ENV_IS_IN_UBI:
3622
3623 Define this if you have an UBI volume that you want to use for the
3624 environment. This has the benefit of wear-leveling the environment
3625 accesses, which is important on NAND.
3626
3627 - CONFIG_ENV_UBI_PART:
3628
3629 Define this to a string that is the mtd partition containing the UBI.
3630
3631 - CONFIG_ENV_UBI_VOLUME:
3632
3633 Define this to the name of the volume that you want to store the
3634 environment in.
3635
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003636 - CONFIG_ENV_UBI_VOLUME_REDUND:
3637
3638 Define this to the name of another volume to store a second copy of
3639 the environment in. This will enable redundant environments in UBI.
3640 It is assumed that both volumes are in the same MTD partition.
3641
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003642 - CONFIG_UBI_SILENCE_MSG
3643 - CONFIG_UBIFS_SILENCE_MSG
3644
3645 You will probably want to define these to avoid a really noisy system
3646 when storing the env in UBI.
3647
Stephen Warreneedcacd2013-06-11 15:14:00 -06003648- CONFIG_ENV_IS_IN_MMC:
3649
3650 Define this if you have an MMC device which you want to use for the
3651 environment.
3652
3653 - CONFIG_SYS_MMC_ENV_DEV:
3654
3655 Specifies which MMC device the environment is stored in.
3656
3657 - CONFIG_SYS_MMC_ENV_PART (optional):
3658
3659 Specifies which MMC partition the environment is stored in. If not
3660 set, defaults to partition 0, the user area. Common values might be
3661 1 (first MMC boot partition), 2 (second MMC boot partition).
3662
3663 - CONFIG_ENV_OFFSET:
3664 - CONFIG_ENV_SIZE:
3665
3666 These two #defines specify the offset and size of the environment
3667 area within the specified MMC device.
3668
Stephen Warren24dc2032013-06-11 15:14:02 -06003669 If offset is positive (the usual case), it is treated as relative to
3670 the start of the MMC partition. If offset is negative, it is treated
3671 as relative to the end of the MMC partition. This can be useful if
3672 your board may be fitted with different MMC devices, which have
3673 different sizes for the MMC partitions, and you always want the
3674 environment placed at the very end of the partition, to leave the
3675 maximum possible space before it, to store other data.
3676
Stephen Warreneedcacd2013-06-11 15:14:00 -06003677 These two values are in units of bytes, but must be aligned to an
3678 MMC sector boundary.
3679
3680 - CONFIG_ENV_OFFSET_REDUND (optional):
3681
3682 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3683 hold a redundant copy of the environment data. This provides a
3684 valid backup copy in case the other copy is corrupted, e.g. due
3685 to a power failure during a "saveenv" operation.
3686
Stephen Warren24dc2032013-06-11 15:14:02 -06003687 This value may also be positive or negative; this is handled in the
3688 same way as CONFIG_ENV_OFFSET.
3689
Stephen Warreneedcacd2013-06-11 15:14:00 -06003690 This value is also in units of bytes, but must also be aligned to
3691 an MMC sector boundary.
3692
3693 - CONFIG_ENV_SIZE_REDUND (optional):
3694
3695 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3696 set. If this value is set, it must be set to the same value as
3697 CONFIG_ENV_SIZE.
3698
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003699- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003700
3701 Defines offset to the initial SPI buffer area in DPRAM. The
3702 area is used at an early stage (ROM part) if the environment
3703 is configured to reside in the SPI EEPROM: We need a 520 byte
3704 scratch DPRAM area. It is used between the two initialization
3705 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3706 to be a good choice since it makes it far enough from the
3707 start of the data area as well as from the stack pointer.
3708
Bruce Adleredecc942007-11-02 13:15:42 -07003709Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003710has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003711created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003712until then to read environment variables.
3713
wdenk8dba0502003-03-31 16:34:49 +00003714The environment is protected by a CRC32 checksum. Before the monitor
3715is relocated into RAM, as a result of a bad CRC you will be working
3716with the compiled-in default environment - *silently*!!! [This is
3717necessary, because the first environment variable we need is the
3718"baudrate" setting for the console - if we have a bad CRC, we don't
3719have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003720
3721Note: once the monitor has been relocated, then it will complain if
3722the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003723use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003724
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003725- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003726 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003727
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003728 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003729 also needs to be defined.
3730
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003731- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003732 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003733
Ron Madriddfa028a2009-02-18 14:30:44 -08003734- CONFIG_NS16550_MIN_FUNCTIONS:
3735 Define this if you desire to only have use of the NS16550_init
3736 and NS16550_putc functions for the serial driver located at
3737 drivers/serial/ns16550.c. This option is useful for saving
3738 space for already greatly restricted images, including but not
3739 limited to NAND_SPL configurations.
3740
Simon Glass28a9e332012-11-30 13:01:18 +00003741- CONFIG_DISPLAY_BOARDINFO
3742 Display information about the board that U-Boot is running on
3743 when U-Boot starts up. The board function checkboard() is called
3744 to do this.
3745
Simon Glasse8822012012-11-30 13:01:19 +00003746- CONFIG_DISPLAY_BOARDINFO_LATE
3747 Similar to the previous option, but display this information
3748 later, once stdio is running and output goes to the LCD, if
3749 present.
3750
wdenkc6097192002-11-03 00:24:07 +00003751Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003752---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003753
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003754- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003755 Cache Line Size of the CPU.
3756
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003757- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003758 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003759
wdenk9c53f402003-10-15 23:53:47 +00003760 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3761 and RPXsuper) to be able to adjust the position of
3762 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003763
Timur Tabid8f341c2011-08-04 18:03:41 -05003764- CONFIG_SYS_CCSRBAR_DEFAULT:
3765 Default (power-on reset) physical address of CCSR on Freescale
3766 PowerPC SOCs.
3767
3768- CONFIG_SYS_CCSRBAR:
3769 Virtual address of CCSR. On a 32-bit build, this is typically
3770 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3771
3772 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3773 for cross-platform code that uses that macro instead.
3774
3775- CONFIG_SYS_CCSRBAR_PHYS:
3776 Physical address of CCSR. CCSR can be relocated to a new
3777 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003778 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003779 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3780 is typically relocated on 36-bit builds. It is recommended
3781 that this macro be defined via the _HIGH and _LOW macros:
3782
3783 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3784 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3785
3786- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003787 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3788 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003789 used in assembly code, so it must not contain typecasts or
3790 integer size suffixes (e.g. "ULL").
3791
3792- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3793 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3794 used in assembly code, so it must not contain typecasts or
3795 integer size suffixes (e.g. "ULL").
3796
3797- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3798 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3799 forced to a value that ensures that CCSR is not relocated.
3800
wdenk1272e232002-11-10 22:06:23 +00003801- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003802 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003803
3804 the default drive number (default value 0)
3805
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003806 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003807
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003808 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003809 (default value 1)
3810
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003811 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003812
wdenk4a5c8a72003-03-06 00:02:04 +00003813 defines the offset of register from address. It
3814 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003815 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003816
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003817 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3818 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003819 default value.
wdenk1272e232002-11-10 22:06:23 +00003820
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003821 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003822 fdc_hw_init() is called at the beginning of the FDC
3823 setup. fdc_hw_init() must be provided by the board
3824 source code. It is used to make hardware dependant
3825 initializations.
wdenk1272e232002-11-10 22:06:23 +00003826
Macpaul Lind1e49942011-04-11 20:45:32 +00003827- CONFIG_IDE_AHB:
3828 Most IDE controllers were designed to be connected with PCI
3829 interface. Only few of them were designed for AHB interface.
3830 When software is doing ATA command and data transfer to
3831 IDE devices through IDE-AHB controller, some additional
3832 registers accessing to these kind of IDE-AHB controller
3833 is requierd.
3834
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003835- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003836 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003837 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003838
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003839- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003840
wdenkeb20ad32003-09-05 23:19:14 +00003841 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003842 initial data and stack; please note that this must be
3843 writable memory that is working WITHOUT special
3844 initialization, i. e. you CANNOT use normal RAM which
3845 will become available only after programming the
3846 memory controller and running certain initialization
3847 sequences.
3848
3849 U-Boot uses the following memory types:
3850 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3851 - MPC824X: data cache
3852 - PPC4xx: data cache
3853
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003854- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003855
3856 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003857 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3858 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003859 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003860 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003861 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3862 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3863 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003864
3865 Note:
3866 On the MPC824X (or other systems that use the data
3867 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003868 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003869 point to an otherwise UNUSED address space between
3870 the top of RAM and the start of the PCI space.
3871
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003872- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003873
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003874- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003875
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003876- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003878- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003879
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003880- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003882- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003883
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003884- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003885 SDRAM timing
3886
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003887- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003888 periodic timer for refresh
3889
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003890- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003891
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003892- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3893 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3894 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3895 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003896 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3897
3898- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003899 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3900 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003901 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3902
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003903- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3904 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003905 Machine Mode Register and Memory Periodic Timer
3906 Prescaler definitions (SDRAM timing)
3907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003908- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003909 enable I2C microcode relocation patch (MPC8xx);
3910 define relocation offset in DPRAM [DSP2]
3911
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003912- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003913 enable SMC microcode relocation patch (MPC8xx);
3914 define relocation offset in DPRAM [SMC1]
3915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003916- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003917 enable SPI microcode relocation patch (MPC8xx);
3918 define relocation offset in DPRAM [SCC4]
3919
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003920- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003921 Use OSCM clock mode on MBX8xx board. Be careful,
3922 wrong setting might damage your board. Read
3923 doc/README.MBX before setting this variable!
3924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003925- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003926 Offset of the bootmode word in DPRAM used by post
3927 (Power On Self Tests). This definition overrides
3928 #define'd default value in commproc.h resp.
3929 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003930
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003931- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3932 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3933 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3934 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3935 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3936 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3937 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3938 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02003939 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00003940
Dirk Eibach378d1ca2009-02-09 08:18:34 +01003941- CONFIG_PCI_DISABLE_PCIE:
3942 Disable PCI-Express on systems where it is supported but not
3943 required.
3944
Andrew Sharp61d47ca2012-08-29 14:16:32 +00003945- CONFIG_PCI_ENUM_ONLY
3946 Only scan through and get the devices on the busses.
3947 Don't do any setup work, presumably because someone or
3948 something has already done it, and we don't need to do it
3949 a second time. Useful for platforms that are pre-booted
3950 by coreboot or similar.
3951
Gabor Juhosb4458732013-05-30 07:06:12 +00003952- CONFIG_PCI_INDIRECT_BRIDGE:
3953 Enable support for indirect PCI bridges.
3954
Kumar Gala8975d7a2010-12-30 12:09:53 -06003955- CONFIG_SYS_SRIO:
3956 Chip has SRIO or not
3957
3958- CONFIG_SRIO1:
3959 Board has SRIO 1 port available
3960
3961- CONFIG_SRIO2:
3962 Board has SRIO 2 port available
3963
3964- CONFIG_SYS_SRIOn_MEM_VIRT:
3965 Virtual Address of SRIO port 'n' memory region
3966
3967- CONFIG_SYS_SRIOn_MEM_PHYS:
3968 Physical Address of SRIO port 'n' memory region
3969
3970- CONFIG_SYS_SRIOn_MEM_SIZE:
3971 Size of SRIO port 'n' memory region
3972
Fabio Estevamf17e8782013-04-11 09:35:34 +00003973- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3974 Defined to tell the NAND controller that the NAND chip is using
3975 a 16 bit bus.
3976 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00003977 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00003978 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00003979 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04003980
3981- CONFIG_SYS_NDFC_EBC0_CFG
3982 Sets the EBC0_CFG register for the NDFC. If not defined
3983 a default value will be used.
3984
Ben Warren45657152006-09-07 16:50:54 -04003985- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003986 Get DDR timing information from an I2C EEPROM. Common
3987 with pluggable memory modules such as SODIMMs
3988
Ben Warren45657152006-09-07 16:50:54 -04003989 SPD_EEPROM_ADDRESS
3990 I2C address of the SPD EEPROM
3991
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003992- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01003993 If SPD EEPROM is on an I2C bus other than the first
3994 one, specify here. Note that the value must resolve
3995 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04003996
York Sune73cc042011-06-07 09:42:16 +08003997- CONFIG_SYS_DDR_RAW_TIMING
3998 Get DDR timing information from other than SPD. Common with
3999 soldered DDR chips onboard without SPD. DDR raw timing
4000 parameters are extracted from datasheet and hard-coded into
4001 header files or board specific files.
4002
York Sunbd495cf2011-09-16 13:21:35 -07004003- CONFIG_FSL_DDR_INTERACTIVE
4004 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4005
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004006- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004007 Only for 83xx systems. If specified, then DDR should
4008 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004009
wdenk6203e402004-04-18 10:13:26 +00004010- CONFIG_ETHER_ON_FEC[12]
4011 Define to enable FEC[12] on a 8xx series processor.
4012
4013- CONFIG_FEC[12]_PHY
4014 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004015 to the given FEC; i. e.
4016 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004017 means that the PHY with address 4 is connected to FEC1
4018
4019 When set to -1, means to probe for first available.
4020
4021- CONFIG_FEC[12]_PHY_NORXERR
4022 The PHY does not have a RXERR line (RMII only).
4023 (so program the FEC to ignore it).
4024
4025- CONFIG_RMII
4026 Enable RMII mode for all FECs.
4027 Note that this is a global option, we can't
4028 have one FEC in standard MII mode and another in RMII mode.
4029
wdenk20c98a62004-04-23 20:32:05 +00004030- CONFIG_CRC32_VERIFY
4031 Add a verify option to the crc32 command.
4032 The syntax is:
4033
4034 => crc32 -v <address> <count> <crc32>
4035
4036 Where address/count indicate a memory area
4037 and crc32 is the correct crc32 which the
4038 area should have.
4039
wdenk64519362004-07-11 17:40:54 +00004040- CONFIG_LOOPW
4041 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004042 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004043
stroesecc3af832004-12-16 18:46:55 +00004044- CONFIG_MX_CYCLIC
4045 Add the "mdc" and "mwc" memory commands. These are cyclic
4046 "md/mw" commands.
4047 Examples:
4048
wdenk07d7e6b2004-12-16 21:44:03 +00004049 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004050 This command will print 4 bytes (10,11,12,13) each 500 ms.
4051
wdenk07d7e6b2004-12-16 21:44:03 +00004052 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004053 This command will write 12345678 to address 100 all 10 ms.
4054
wdenk07d7e6b2004-12-16 21:44:03 +00004055 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004056 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004057
wdenk3d3d99f2005-04-04 12:44:11 +00004058- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004059 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004060 low level initializations (like setting up the memory
4061 controller) are omitted and/or U-Boot does not
4062 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004063
Wolfgang Denk302141d2010-11-27 23:30:56 +01004064 Normally this variable MUST NOT be defined. The only
4065 exception is when U-Boot is loaded (to RAM) by some
4066 other boot loader or by a debugger which performs
4067 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004068
Aneesh V552a3192011-07-13 05:11:07 +00004069- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004070 Modifies the behaviour of start.S when compiling a loader
4071 that is executed before the actual U-Boot. E.g. when
4072 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004073
Simon Glass17dabf02013-02-24 17:33:14 +00004074- CONFIG_ARCH_MAP_SYSMEM
4075 Generally U-Boot (and in particular the md command) uses
4076 effective address. It is therefore not necessary to regard
4077 U-Boot address as virtual addresses that need to be translated
4078 to physical addresses. However, sandbox requires this, since
4079 it maintains its own little RAM buffer which contains all
4080 addressable memory. This option causes some memory accesses
4081 to be mapped through map_sysmem() / unmap_sysmem().
4082
Matthias Weisser93416c12011-03-10 21:36:32 +00004083- CONFIG_USE_ARCH_MEMCPY
4084 CONFIG_USE_ARCH_MEMSET
4085 If these options are used a optimized version of memcpy/memset will
4086 be used if available. These functions may be faster under some
4087 conditions but may increase the binary size.
4088
Simon Glassbfb59802013-02-14 04:18:54 +00004089- CONFIG_X86_RESET_VECTOR
4090 If defined, the x86 reset vector code is included. This is not
4091 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004092
Mark Jackson52b003c2013-03-04 01:27:20 +00004093- CONFIG_SYS_MPUCLK
4094 Defines the MPU clock speed (in MHz).
4095
4096 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004097
Timur Tabi275f4bb2011-11-22 09:21:25 -06004098Freescale QE/FMAN Firmware Support:
4099-----------------------------------
4100
4101The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4102loading of "firmware", which is encoded in the QE firmware binary format.
4103This firmware often needs to be loaded during U-Boot booting, so macros
4104are used to identify the storage device (NOR flash, SPI, etc) and the address
4105within that device.
4106
4107- CONFIG_SYS_QE_FMAN_FW_ADDR
4108 The address in the storage device where the firmware is located. The
4109 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4110 is also specified.
4111
4112- CONFIG_SYS_QE_FMAN_FW_LENGTH
4113 The maximum possible size of the firmware. The firmware binary format
4114 has a field that specifies the actual size of the firmware, but it
4115 might not be possible to read any part of the firmware unless some
4116 local storage is allocated to hold the entire firmware first.
4117
4118- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4119 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4120 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4121 virtual address in NOR flash.
4122
4123- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4124 Specifies that QE/FMAN firmware is located in NAND flash.
4125 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4126
4127- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4128 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4129 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4130
4131- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4132 Specifies that QE/FMAN firmware is located on the primary SPI
4133 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4134
Liu Gang1e084582012-03-08 00:33:18 +00004135- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4136 Specifies that QE/FMAN firmware is located in the remote (master)
4137 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004138 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4139 window->master inbound window->master LAW->the ucode address in
4140 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004141
wdenkc6097192002-11-03 00:24:07 +00004142Building the Software:
4143======================
4144
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004145Building U-Boot has been tested in several native build environments
4146and in many different cross environments. Of course we cannot support
4147all possibly existing versions of cross development tools in all
4148(potentially obsolete) versions. In case of tool chain problems we
4149recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4150which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004151
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004152If you are not using a native environment, it is assumed that you
4153have GNU cross compiling tools available in your path. In this case,
4154you must set the environment variable CROSS_COMPILE in your shell.
4155Note that no changes to the Makefile or any other source files are
4156necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004157
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004158 $ CROSS_COMPILE=ppc_4xx-
4159 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004160
Peter Tyserb06976d2009-03-13 18:54:51 -05004161Note: If you wish to generate Windows versions of the utilities in
4162 the tools directory you can use the MinGW toolchain
4163 (http://www.mingw.org). Set your HOST tools to the MinGW
4164 toolchain and execute 'make tools'. For example:
4165
4166 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4167
4168 Binaries such as tools/mkimage.exe will be created which can
4169 be executed on computers running Windows.
4170
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004171U-Boot is intended to be simple to build. After installing the
4172sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004173is done by typing:
4174
4175 make NAME_config
4176
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004177where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004178rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004179
wdenk6c59edc2004-05-03 20:45:30 +00004180Note: for some board special configuration names may exist; check if
4181 additional information is available from the board vendor; for
4182 instance, the TQM823L systems are available without (standard)
4183 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004184 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004185
wdenk6c59edc2004-05-03 20:45:30 +00004186 make TQM823L_config
4187 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004188
wdenk6c59edc2004-05-03 20:45:30 +00004189 make TQM823L_LCD_config
4190 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004191
wdenk6c59edc2004-05-03 20:45:30 +00004192 etc.
wdenkc6097192002-11-03 00:24:07 +00004193
wdenkc6097192002-11-03 00:24:07 +00004194
wdenk6c59edc2004-05-03 20:45:30 +00004195Finally, type "make all", and you should get some working U-Boot
4196images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004197
wdenk6c59edc2004-05-03 20:45:30 +00004198- "u-boot.bin" is a raw binary image
4199- "u-boot" is an image in ELF binary format
4200- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004201
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004202By default the build is performed locally and the objects are saved
4203in the source directory. One of the two methods can be used to change
4204this behavior and build U-Boot to some external directory:
4205
42061. Add O= to the make command line invocations:
4207
4208 make O=/tmp/build distclean
4209 make O=/tmp/build NAME_config
4210 make O=/tmp/build all
4211
42122. Set environment variable BUILD_DIR to point to the desired location:
4213
4214 export BUILD_DIR=/tmp/build
4215 make distclean
4216 make NAME_config
4217 make all
4218
4219Note that the command line "O=" setting overrides the BUILD_DIR environment
4220variable.
4221
wdenkc6097192002-11-03 00:24:07 +00004222
wdenk6c59edc2004-05-03 20:45:30 +00004223Please be aware that the Makefiles assume you are using GNU make, so
4224for instance on NetBSD you might need to use "gmake" instead of
4225native "make".
wdenkc6097192002-11-03 00:24:07 +00004226
wdenkc6097192002-11-03 00:24:07 +00004227
wdenk6c59edc2004-05-03 20:45:30 +00004228If the system board that you have is not listed, then you will need
4229to port U-Boot to your hardware platform. To do this, follow these
4230steps:
wdenkc6097192002-11-03 00:24:07 +00004231
wdenk6c59edc2004-05-03 20:45:30 +000042321. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004233 "boards.cfg" file, using the existing entries as examples.
4234 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000042352. Create a new directory to hold your board specific code. Add any
4236 files you need. In your board directory, you will need at least
4237 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
42383. Create a new configuration file "include/configs/<board>.h" for
4239 your board
42403. If you're porting U-Boot to a new CPU, then also create a new
4241 directory to hold your CPU specific code. Add any files you need.
42424. Run "make <board>_config" with your new name.
42435. Type "make", and you should get a working "u-boot.srec" file
4244 to be installed on your target system.
42456. Debug and solve any problems that might arise.
4246 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004247
wdenkc6097192002-11-03 00:24:07 +00004248
wdenk6c59edc2004-05-03 20:45:30 +00004249Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4250==============================================================
wdenkc6097192002-11-03 00:24:07 +00004251
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004252If you have modified U-Boot sources (for instance added a new board
4253or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004254provide feedback to the other developers. The feedback normally takes
4255the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004256official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004257
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004258But before you submit such a patch, please verify that your modifi-
4259cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004260the supported boards compile WITHOUT ANY compiler warnings. To do so,
4261just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004262for ALL supported system. Be warned, this will take a while. You can
4263select which (cross) compiler to use by passing a `CROSS_COMPILE'
4264environment variable to the script, i. e. to use the ELDK cross tools
4265you can type
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk6c59edc2004-05-03 20:45:30 +00004267 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004268
wdenk6c59edc2004-05-03 20:45:30 +00004269or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004270
wdenk6c59edc2004-05-03 20:45:30 +00004271 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004272
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004273When using the MAKEALL script, the default behaviour is to build
4274U-Boot in the source directory. This location can be changed by
4275setting the BUILD_DIR environment variable. Also, for each target
4276built, the MAKEALL script saves two log files (<target>.ERR and
4277<target>.MAKEALL) in the <source dir>/LOG directory. This default
4278location can be changed by setting the MAKEALL_LOGDIR environment
4279variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004280
4281 export BUILD_DIR=/tmp/build
4282 export MAKEALL_LOGDIR=/tmp/log
4283 CROSS_COMPILE=ppc_8xx- MAKEALL
4284
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004285With the above settings build objects are saved in the /tmp/build,
4286log files are saved in the /tmp/log and the source tree remains clean
4287during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004288
4289
wdenk6c59edc2004-05-03 20:45:30 +00004290See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004291
wdenkc6097192002-11-03 00:24:07 +00004292
wdenk6c59edc2004-05-03 20:45:30 +00004293Monitor Commands - Overview:
4294============================
wdenkc6097192002-11-03 00:24:07 +00004295
wdenk6c59edc2004-05-03 20:45:30 +00004296go - start application at address 'addr'
4297run - run commands in an environment variable
4298bootm - boot application image from memory
4299bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004300bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004301tftpboot- boot image via network using TFTP protocol
4302 and env variables "ipaddr" and "serverip"
4303 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004304tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004305rarpboot- boot image via network using RARP/TFTP protocol
4306diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4307loads - load S-Record file over serial line
4308loadb - load binary file over serial line (kermit mode)
4309md - memory display
4310mm - memory modify (auto-incrementing)
4311nm - memory modify (constant address)
4312mw - memory write (fill)
4313cp - memory copy
4314cmp - memory compare
4315crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004316i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004317sspi - SPI utility commands
4318base - print or set address offset
4319printenv- print environment variables
4320setenv - set environment variables
4321saveenv - save environment variables to persistent storage
4322protect - enable or disable FLASH write protection
4323erase - erase FLASH memory
4324flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004325nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004326bdinfo - print Board Info structure
4327iminfo - print header information for application image
4328coninfo - print console devices and informations
4329ide - IDE sub-system
4330loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004331loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004332mtest - simple RAM test
4333icache - enable or disable instruction cache
4334dcache - enable or disable data cache
4335reset - Perform RESET of the CPU
4336echo - echo args to console
4337version - print monitor version
4338help - print online help
4339? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004340
wdenkc6097192002-11-03 00:24:07 +00004341
wdenk6c59edc2004-05-03 20:45:30 +00004342Monitor Commands - Detailed Description:
4343========================================
wdenkc6097192002-11-03 00:24:07 +00004344
wdenk6c59edc2004-05-03 20:45:30 +00004345TODO.
wdenkc6097192002-11-03 00:24:07 +00004346
wdenk6c59edc2004-05-03 20:45:30 +00004347For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004348
4349
wdenk6c59edc2004-05-03 20:45:30 +00004350Environment Variables:
4351======================
wdenkc6097192002-11-03 00:24:07 +00004352
wdenk6c59edc2004-05-03 20:45:30 +00004353U-Boot supports user configuration using Environment Variables which
4354can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004355
wdenk6c59edc2004-05-03 20:45:30 +00004356Environment Variables are set using "setenv", printed using
4357"printenv", and saved to Flash using "saveenv". Using "setenv"
4358without a value can be used to delete a variable from the
4359environment. As long as you don't save the environment you are
4360working with an in-memory copy. In case the Flash area containing the
4361environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004362
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004363Some configuration options can be set using Environment Variables.
4364
4365List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004366
wdenk6c59edc2004-05-03 20:45:30 +00004367 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004368
wdenk6c59edc2004-05-03 20:45:30 +00004369 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004370
wdenk6c59edc2004-05-03 20:45:30 +00004371 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004372
wdenk6c59edc2004-05-03 20:45:30 +00004373 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004374
wdenk6c59edc2004-05-03 20:45:30 +00004375 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004376
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004377 bootm_low - Memory range available for image processing in the bootm
4378 command can be restricted. This variable is given as
4379 a hexadecimal number and defines lowest address allowed
4380 for use by the bootm command. See also "bootm_size"
4381 environment variable. Address defined by "bootm_low" is
4382 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004383 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4384 bootm_mapsize.
4385
Wolfgang Denk092ae952011-10-26 10:21:21 +00004386 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004387 This variable is given as a hexadecimal number and it
4388 defines the size of the memory region starting at base
4389 address bootm_low that is accessible by the Linux kernel
4390 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4391 as the default value if it is defined, and bootm_size is
4392 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004393
4394 bootm_size - Memory range available for image processing in the bootm
4395 command can be restricted. This variable is given as
4396 a hexadecimal number and defines the size of the region
4397 allowed for use by the bootm command. See also "bootm_low"
4398 environment variable.
4399
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004400 updatefile - Location of the software update file on a TFTP server, used
4401 by the automatic software update feature. Please refer to
4402 documentation in doc/README.update for more details.
4403
wdenk6c59edc2004-05-03 20:45:30 +00004404 autoload - if set to "no" (any string beginning with 'n'),
4405 "bootp" will just load perform a lookup of the
4406 configuration from the BOOTP server, but not try to
4407 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004408
wdenk6c59edc2004-05-03 20:45:30 +00004409 autostart - if set to "yes", an image loaded using the "bootp",
4410 "rarpboot", "tftpboot" or "diskboot" commands will
4411 be automatically started (by internally calling
4412 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004413
wdenk6c59edc2004-05-03 20:45:30 +00004414 If set to "no", a standalone image passed to the
4415 "bootm" command will be copied to the load address
4416 (and eventually uncompressed), but NOT be started.
4417 This can be used to load and uncompress arbitrary
4418 data.
wdenkc6097192002-11-03 00:24:07 +00004419
David A. Longd558a4e2011-07-09 16:40:19 -04004420 fdt_high - if set this restricts the maximum address that the
4421 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004422 For example, if you have a system with 1 GB memory
4423 at physical address 0x10000000, while Linux kernel
4424 only recognizes the first 704 MB as low memory, you
4425 may need to set fdt_high as 0x3C000000 to have the
4426 device tree blob be copied to the maximum address
4427 of the 704 MB low memory, so that Linux kernel can
4428 access it during the boot procedure.
4429
David A. Longd558a4e2011-07-09 16:40:19 -04004430 If this is set to the special value 0xFFFFFFFF then
4431 the fdt will not be copied at all on boot. For this
4432 to work it must reside in writable memory, have
4433 sufficient padding on the end of it for u-boot to
4434 add the information it needs into it, and the memory
4435 must be accessible by the kernel.
4436
Simon Glassdc6fa642011-10-24 19:15:34 +00004437 fdtcontroladdr- if set this is the address of the control flattened
4438 device tree used by U-Boot when CONFIG_OF_CONTROL is
4439 defined.
4440
wdenk0e2bd9c2004-06-06 21:51:03 +00004441 i2cfast - (PPC405GP|PPC405EP only)
4442 if set to 'y' configures Linux I2C driver for fast
4443 mode (400kHZ). This environment variable is used in
4444 initialization code. So, for changes to be effective
4445 it must be saved and board must be reset.
4446
wdenk6c59edc2004-05-03 20:45:30 +00004447 initrd_high - restrict positioning of initrd images:
4448 If this variable is not set, initrd images will be
4449 copied to the highest possible address in RAM; this
4450 is usually what you want since it allows for
4451 maximum initrd size. If for some reason you want to
4452 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004453 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004454 variable to a value of "no" or "off" or "0".
4455 Alternatively, you can set it to a maximum upper
4456 address to use (U-Boot will still check that it
4457 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004458
wdenk6c59edc2004-05-03 20:45:30 +00004459 For instance, when you have a system with 16 MB
4460 RAM, and want to reserve 4 MB from use by Linux,
4461 you can do this by adding "mem=12M" to the value of
4462 the "bootargs" variable. However, now you must make
4463 sure that the initrd image is placed in the first
4464 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004465
wdenk6c59edc2004-05-03 20:45:30 +00004466 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004467
wdenk6c59edc2004-05-03 20:45:30 +00004468 If you set initrd_high to 0xFFFFFFFF, this is an
4469 indication to U-Boot that all addresses are legal
4470 for the Linux kernel, including addresses in flash
4471 memory. In this case U-Boot will NOT COPY the
4472 ramdisk at all. This may be useful to reduce the
4473 boot time on your system, but requires that this
4474 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004475
wdenk6c59edc2004-05-03 20:45:30 +00004476 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004477
wdenk6c59edc2004-05-03 20:45:30 +00004478 loadaddr - Default load address for commands like "bootp",
4479 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004480
wdenk6c59edc2004-05-03 20:45:30 +00004481 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004482
wdenk6c59edc2004-05-03 20:45:30 +00004483 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004484
wdenk6c59edc2004-05-03 20:45:30 +00004485 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004486
wdenk6c59edc2004-05-03 20:45:30 +00004487 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004488
wdenk6c59edc2004-05-03 20:45:30 +00004489 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004490
Mike Frysingera23230c2011-10-02 10:01:27 +00004491 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004492
Mike Frysingera23230c2011-10-02 10:01:27 +00004493 ethact - controls which interface is currently active.
4494 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004495
Heiko Schocherc5e84052010-07-20 17:45:02 +02004496 => setenv ethact FEC
4497 => ping 192.168.0.1 # traffic sent on FEC
4498 => setenv ethact SCC
4499 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004500
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004501 ethrotate - When set to "no" U-Boot does not go through all
4502 available network interfaces.
4503 It just stays at the currently selected interface.
4504
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004505 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004506 either succeed or fail without retrying.
4507 When set to "once" the network operation will
4508 fail when all the available network interfaces
4509 are tried once without success.
4510 Useful on scripts which control the retry operation
4511 themselves.
wdenkc6097192002-11-03 00:24:07 +00004512
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004513 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004514
Wolfgang Denk227b5192005-09-24 23:25:46 +02004515 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004516 UDP source port.
4517
Wolfgang Denk227b5192005-09-24 23:25:46 +02004518 tftpdstport - If this is set, the value is used for TFTP's UDP
4519 destination port instead of the Well Know Port 69.
4520
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004521 tftpblocksize - Block size to use for TFTP transfers; if not set,
4522 we use the TFTP server's default block size
4523
4524 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4525 seconds, minimum value is 1000 = 1 second). Defines
4526 when a packet is considered to be lost so it has to
4527 be retransmitted. The default is 5000 = 5 seconds.
4528 Lowering this value may make downloads succeed
4529 faster in networks with high packet loss rates or
4530 with unreliable TFTP servers.
4531
4532 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004533 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004534 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004535
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004536The following image location variables contain the location of images
4537used in booting. The "Image" column gives the role of the image and is
4538not an environment variable name. The other columns are environment
4539variable names. "File Name" gives the name of the file on a TFTP
4540server, "RAM Address" gives the location in RAM the image will be
4541loaded to, and "Flash Location" gives the image's address in NOR
4542flash or offset in NAND flash.
4543
4544*Note* - these variables don't have to be defined for all boards, some
4545boards currenlty use other variables for these purposes, and some
4546boards use these variables for other purposes.
4547
Wolfgang Denk092ae952011-10-26 10:21:21 +00004548Image File Name RAM Address Flash Location
4549----- --------- ----------- --------------
4550u-boot u-boot u-boot_addr_r u-boot_addr
4551Linux kernel bootfile kernel_addr_r kernel_addr
4552device tree blob fdtfile fdt_addr_r fdt_addr
4553ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004554
wdenk6c59edc2004-05-03 20:45:30 +00004555The following environment variables may be used and automatically
4556updated by the network boot commands ("bootp" and "rarpboot"),
4557depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004558
wdenk6c59edc2004-05-03 20:45:30 +00004559 bootfile - see above
4560 dnsip - IP address of your Domain Name Server
4561 dnsip2 - IP address of your secondary Domain Name Server
4562 gatewayip - IP address of the Gateway (Router) to use
4563 hostname - Target hostname
4564 ipaddr - see above
4565 netmask - Subnet Mask
4566 rootpath - Pathname of the root filesystem on the NFS server
4567 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004568
wdenk145d2c12004-04-15 21:48:45 +00004569
wdenk6c59edc2004-05-03 20:45:30 +00004570There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004571
wdenk6c59edc2004-05-03 20:45:30 +00004572 serial# - contains hardware identification information such
4573 as type string and/or serial number
4574 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004575
wdenk6c59edc2004-05-03 20:45:30 +00004576These variables can be set only once (usually during manufacturing of
4577the board). U-Boot refuses to delete or overwrite these variables
4578once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004579
4580
wdenk6c59edc2004-05-03 20:45:30 +00004581Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk6c59edc2004-05-03 20:45:30 +00004583 ver - Contains the U-Boot version string as printed
4584 with the "version" command. This variable is
4585 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004586
wdenkc6097192002-11-03 00:24:07 +00004587
wdenk6c59edc2004-05-03 20:45:30 +00004588Please note that changes to some configuration parameters may take
4589only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004590
stroeseb9c17c52003-04-04 15:53:41 +00004591
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004592Callback functions for environment variables:
4593---------------------------------------------
4594
4595For some environment variables, the behavior of u-boot needs to change
4596when their values are changed. This functionailty allows functions to
4597be associated with arbitrary variables. On creation, overwrite, or
4598deletion, the callback will provide the opportunity for some side
4599effect to happen or for the change to be rejected.
4600
4601The callbacks are named and associated with a function using the
4602U_BOOT_ENV_CALLBACK macro in your board or driver code.
4603
4604These callbacks are associated with variables in one of two ways. The
4605static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4606in the board configuration to a string that defines a list of
4607associations. The list must be in the following format:
4608
4609 entry = variable_name[:callback_name]
4610 list = entry[,list]
4611
4612If the callback name is not specified, then the callback is deleted.
4613Spaces are also allowed anywhere in the list.
4614
4615Callbacks can also be associated by defining the ".callbacks" variable
4616with the same list format above. Any association in ".callbacks" will
4617override any association in the static list. You can define
4618CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4619".callbacks" envirnoment variable in the default or embedded environment.
4620
4621
wdenk6c59edc2004-05-03 20:45:30 +00004622Command Line Parsing:
4623=====================
stroeseb9c17c52003-04-04 15:53:41 +00004624
wdenk6c59edc2004-05-03 20:45:30 +00004625There are two different command line parsers available with U-Boot:
4626the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004627
wdenk6c59edc2004-05-03 20:45:30 +00004628Old, simple command line parser:
4629--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004630
wdenk6c59edc2004-05-03 20:45:30 +00004631- supports environment variables (through setenv / saveenv commands)
4632- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004633- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004634- special characters ('$', ';') can be escaped by prefixing with '\',
4635 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004636 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004637- You can also escape text by enclosing in single apostrophes, for example:
4638 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk6c59edc2004-05-03 20:45:30 +00004640Hush shell:
4641-----------
wdenkf4688a22003-05-28 08:06:31 +00004642
wdenk6c59edc2004-05-03 20:45:30 +00004643- similar to Bourne shell, with control structures like
4644 if...then...else...fi, for...do...done; while...do...done,
4645 until...do...done, ...
4646- supports environment ("global") variables (through setenv / saveenv
4647 commands) and local shell variables (through standard shell syntax
4648 "name=value"); only environment variables can be used with "run"
4649 command
wdenkf4688a22003-05-28 08:06:31 +00004650
wdenk6c59edc2004-05-03 20:45:30 +00004651General rules:
4652--------------
wdenkf4688a22003-05-28 08:06:31 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654(1) If a command line (or an environment variable executed by a "run"
4655 command) contains several commands separated by semicolon, and
4656 one of these commands fails, then the remaining commands will be
4657 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004658
wdenk6c59edc2004-05-03 20:45:30 +00004659(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004660 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004661 command will cause "run" to terminate, i. e. the remaining
4662 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004663
wdenk6c59edc2004-05-03 20:45:30 +00004664Note for Redundant Ethernet Interfaces:
4665=======================================
wdenkf4688a22003-05-28 08:06:31 +00004666
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004667Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004668such configurations and is capable of automatic selection of a
4669"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004670
wdenk6c59edc2004-05-03 20:45:30 +00004671Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4672MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4673"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004674
wdenk6c59edc2004-05-03 20:45:30 +00004675If the network interface stores some valid MAC address (for instance
4676in SROM), this is used as default address if there is NO correspon-
4677ding setting in the environment; if the corresponding environment
4678variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004679
wdenk6c59edc2004-05-03 20:45:30 +00004680o If the SROM has a valid MAC address, and there is no address in the
4681 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004682
wdenk6c59edc2004-05-03 20:45:30 +00004683o If there is no valid address in the SROM, and a definition in the
4684 environment exists, then the value from the environment variable is
4685 used.
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk6c59edc2004-05-03 20:45:30 +00004687o If both the SROM and the environment contain a MAC address, and
4688 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004689
wdenk6c59edc2004-05-03 20:45:30 +00004690o If both the SROM and the environment contain a MAC address, and the
4691 addresses differ, the value from the environment is used and a
4692 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004693
wdenk6c59edc2004-05-03 20:45:30 +00004694o If neither SROM nor the environment contain a MAC address, an error
4695 is raised.
wdenkc6097192002-11-03 00:24:07 +00004696
Ben Warren6db991a2010-04-26 11:11:46 -07004697If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004698will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004699may be skipped by setting the appropriate 'ethmacskip' environment variable.
4700The naming convention is as follows:
4701"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004702
wdenk6c59edc2004-05-03 20:45:30 +00004703Image Formats:
4704==============
wdenkc6097192002-11-03 00:24:07 +00004705
Marian Balakowicz18710b82008-03-12 12:13:13 +01004706U-Boot is capable of booting (and performing other auxiliary operations on)
4707images in two formats:
4708
4709New uImage format (FIT)
4710-----------------------
4711
4712Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4713to Flattened Device Tree). It allows the use of images with multiple
4714components (several kernels, ramdisks, etc.), with contents protected by
4715SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4716
4717
4718Old uImage format
4719-----------------
4720
4721Old image format is based on binary files which can be basically anything,
4722preceded by a special header; see the definitions in include/image.h for
4723details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004724
wdenk6c59edc2004-05-03 20:45:30 +00004725* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4726 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004727 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4728 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4729 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004730* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004731 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4732 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004733* Compression Type (uncompressed, gzip, bzip2)
4734* Load Address
4735* Entry Point
4736* Image Name
4737* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004738
wdenk6c59edc2004-05-03 20:45:30 +00004739The header is marked by a special Magic Number, and both the header
4740and the data portions of the image are secured against corruption by
4741CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004742
wdenkc6097192002-11-03 00:24:07 +00004743
wdenk6c59edc2004-05-03 20:45:30 +00004744Linux Support:
4745==============
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk6c59edc2004-05-03 20:45:30 +00004747Although U-Boot should support any OS or standalone application
4748easily, the main focus has always been on Linux during the design of
4749U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk6c59edc2004-05-03 20:45:30 +00004751U-Boot includes many features that so far have been part of some
4752special "boot loader" code within the Linux kernel. Also, any
4753"initrd" images to be used are no longer part of one big Linux image;
4754instead, kernel and "initrd" are separate images. This implementation
4755serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004756
wdenk6c59edc2004-05-03 20:45:30 +00004757- the same features can be used for other OS or standalone
4758 applications (for instance: using compressed images to reduce the
4759 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk6c59edc2004-05-03 20:45:30 +00004761- it becomes much easier to port new Linux kernel versions because
4762 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004763
wdenk6c59edc2004-05-03 20:45:30 +00004764- the same Linux kernel image can now be used with different "initrd"
4765 images; of course this also means that different kernel images can
4766 be run with the same "initrd". This makes testing easier (you don't
4767 have to build a new "zImage.initrd" Linux image when you just
4768 change a file in your "initrd"). Also, a field-upgrade of the
4769 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004770
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk6c59edc2004-05-03 20:45:30 +00004772Linux HOWTO:
4773============
wdenkc6097192002-11-03 00:24:07 +00004774
wdenk6c59edc2004-05-03 20:45:30 +00004775Porting Linux to U-Boot based systems:
4776---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004777
wdenk6c59edc2004-05-03 20:45:30 +00004778U-Boot cannot save you from doing all the necessary modifications to
4779configure the Linux device drivers for use with your target hardware
4780(no, we don't intend to provide a full virtual machine interface to
4781Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004782
Stefan Roese88fbf932010-04-15 16:07:28 +02004783But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004784
wdenk6c59edc2004-05-03 20:45:30 +00004785Just make sure your machine specific header file (for instance
4786include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004787Information structure as we define in include/asm-<arch>/u-boot.h,
4788and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004789as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004790
wdenkc6097192002-11-03 00:24:07 +00004791
wdenk6c59edc2004-05-03 20:45:30 +00004792Configuring the Linux kernel:
4793-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004794
wdenk6c59edc2004-05-03 20:45:30 +00004795No specific requirements for U-Boot. Make sure you have some root
4796device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004797
wdenkc6097192002-11-03 00:24:07 +00004798
wdenk6c59edc2004-05-03 20:45:30 +00004799Building a Linux Image:
4800-----------------------
wdenkc6097192002-11-03 00:24:07 +00004801
wdenk6c59edc2004-05-03 20:45:30 +00004802With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4803not used. If you use recent kernel source, a new build target
4804"uImage" will exist which automatically builds an image usable by
4805U-Boot. Most older kernels also have support for a "pImage" target,
4806which was introduced for our predecessor project PPCBoot and uses a
4807100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004808
wdenk6c59edc2004-05-03 20:45:30 +00004809Example:
wdenkc6097192002-11-03 00:24:07 +00004810
wdenk6c59edc2004-05-03 20:45:30 +00004811 make TQM850L_config
4812 make oldconfig
4813 make dep
4814 make uImage
wdenkc6097192002-11-03 00:24:07 +00004815
wdenk6c59edc2004-05-03 20:45:30 +00004816The "uImage" build target uses a special tool (in 'tools/mkimage') to
4817encapsulate a compressed Linux kernel image with header information,
4818CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004821
wdenk6c59edc2004-05-03 20:45:30 +00004822* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004823
wdenk6c59edc2004-05-03 20:45:30 +00004824 ${CROSS_COMPILE}-objcopy -O binary \
4825 -R .note -R .comment \
4826 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004827
wdenk6c59edc2004-05-03 20:45:30 +00004828* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004829
wdenk6c59edc2004-05-03 20:45:30 +00004830 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004831
wdenk6c59edc2004-05-03 20:45:30 +00004832* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004833
wdenk6c59edc2004-05-03 20:45:30 +00004834 mkimage -A ppc -O linux -T kernel -C gzip \
4835 -a 0 -e 0 -n "Linux Kernel Image" \
4836 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004837
wdenkc6097192002-11-03 00:24:07 +00004838
wdenk6c59edc2004-05-03 20:45:30 +00004839The "mkimage" tool can also be used to create ramdisk images for use
4840with U-Boot, either separated from the Linux kernel image, or
4841combined into one file. "mkimage" encapsulates the images with a 64
4842byte header containing information about target architecture,
4843operating system, image type, compression method, entry points, time
4844stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004845
wdenk6c59edc2004-05-03 20:45:30 +00004846"mkimage" can be called in two ways: to verify existing images and
4847print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004848
wdenk6c59edc2004-05-03 20:45:30 +00004849In the first form (with "-l" option) mkimage lists the information
4850contained in the header of an existing U-Boot image; this includes
4851checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004852
wdenk6c59edc2004-05-03 20:45:30 +00004853 tools/mkimage -l image
4854 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004855
wdenk6c59edc2004-05-03 20:45:30 +00004856The second form (with "-d" option) is used to build a U-Boot image
4857from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004858
wdenk6c59edc2004-05-03 20:45:30 +00004859 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4860 -n name -d data_file image
4861 -A ==> set architecture to 'arch'
4862 -O ==> set operating system to 'os'
4863 -T ==> set image type to 'type'
4864 -C ==> set compression type 'comp'
4865 -a ==> set load address to 'addr' (hex)
4866 -e ==> set entry point to 'ep' (hex)
4867 -n ==> set image name to 'name'
4868 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004869
wdenkcd914452004-05-29 16:53:29 +00004870Right now, all Linux kernels for PowerPC systems use the same load
4871address (0x00000000), but the entry point address depends on the
4872kernel version:
wdenkc6097192002-11-03 00:24:07 +00004873
wdenk6c59edc2004-05-03 20:45:30 +00004874- 2.2.x kernels have the entry point at 0x0000000C,
4875- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004876
wdenk6c59edc2004-05-03 20:45:30 +00004877So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004878
wdenk6c59edc2004-05-03 20:45:30 +00004879 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4880 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004881 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004882 > examples/uImage.TQM850L
4883 Image Name: 2.4.4 kernel for TQM850L
4884 Created: Wed Jul 19 02:34:59 2000
4885 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4886 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4887 Load Address: 0x00000000
4888 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk6c59edc2004-05-03 20:45:30 +00004890To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004891
wdenk6c59edc2004-05-03 20:45:30 +00004892 -> tools/mkimage -l examples/uImage.TQM850L
4893 Image Name: 2.4.4 kernel for TQM850L
4894 Created: Wed Jul 19 02:34:59 2000
4895 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4896 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4897 Load Address: 0x00000000
4898 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004899
wdenk6c59edc2004-05-03 20:45:30 +00004900NOTE: for embedded systems where boot time is critical you can trade
4901speed for memory and install an UNCOMPRESSED image instead: this
4902needs more space in Flash, but boots much faster since it does not
4903need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004904
Stefan Roese88fbf932010-04-15 16:07:28 +02004905 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004906 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4907 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004908 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004909 > examples/uImage.TQM850L-uncompressed
4910 Image Name: 2.4.4 kernel for TQM850L
4911 Created: Wed Jul 19 02:34:59 2000
4912 Image Type: PowerPC Linux Kernel Image (uncompressed)
4913 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4914 Load Address: 0x00000000
4915 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004916
wdenkc6097192002-11-03 00:24:07 +00004917
wdenk6c59edc2004-05-03 20:45:30 +00004918Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4919when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk6c59edc2004-05-03 20:45:30 +00004921 -> tools/mkimage -n 'Simple Ramdisk Image' \
4922 > -A ppc -O linux -T ramdisk -C gzip \
4923 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4924 Image Name: Simple Ramdisk Image
4925 Created: Wed Jan 12 14:01:50 2000
4926 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4927 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4928 Load Address: 0x00000000
4929 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004930
wdenkc6097192002-11-03 00:24:07 +00004931
wdenk6c59edc2004-05-03 20:45:30 +00004932Installing a Linux Image:
4933-------------------------
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk6c59edc2004-05-03 20:45:30 +00004935To downloading a U-Boot image over the serial (console) interface,
4936you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00004937
wdenk6c59edc2004-05-03 20:45:30 +00004938 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00004939
wdenk6c59edc2004-05-03 20:45:30 +00004940The 'objcopy' does not understand the information in the U-Boot
4941image header, so the resulting S-Record file will be relative to
4942address 0x00000000. To load it to a given address, you need to
4943specify the target address as 'offset' parameter with the 'loads'
4944command.
wdenkc6097192002-11-03 00:24:07 +00004945
wdenk6c59edc2004-05-03 20:45:30 +00004946Example: install the image to address 0x40100000 (which on the
4947TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004948
wdenk6c59edc2004-05-03 20:45:30 +00004949 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004950
wdenk6c59edc2004-05-03 20:45:30 +00004951 .......... done
4952 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004953
wdenk6c59edc2004-05-03 20:45:30 +00004954 => loads 40100000
4955 ## Ready for S-Record download ...
4956 ~>examples/image.srec
4957 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4958 ...
4959 15989 15990 15991 15992
4960 [file transfer complete]
4961 [connected]
4962 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004963
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk6c59edc2004-05-03 20:45:30 +00004965You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004966this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00004967corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk6c59edc2004-05-03 20:45:30 +00004969 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004970
wdenk6c59edc2004-05-03 20:45:30 +00004971 ## Checking Image at 40100000 ...
4972 Image Name: 2.2.13 for initrd on TQM850L
4973 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4974 Data Size: 335725 Bytes = 327 kB = 0 MB
4975 Load Address: 00000000
4976 Entry Point: 0000000c
4977 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004978
4979
wdenk6c59edc2004-05-03 20:45:30 +00004980Boot Linux:
4981-----------
wdenkc6097192002-11-03 00:24:07 +00004982
wdenk6c59edc2004-05-03 20:45:30 +00004983The "bootm" command is used to boot an application that is stored in
4984memory (RAM or Flash). In case of a Linux kernel image, the contents
4985of the "bootargs" environment variable is passed to the kernel as
4986parameters. You can check and modify this variable using the
4987"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004988
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990 => printenv bootargs
4991 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004992
wdenk6c59edc2004-05-03 20:45:30 +00004993 => 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 +00004994
wdenk6c59edc2004-05-03 20:45:30 +00004995 => printenv bootargs
4996 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 +00004997
wdenk6c59edc2004-05-03 20:45:30 +00004998 => bootm 40020000
4999 ## Booting Linux kernel at 40020000 ...
5000 Image Name: 2.2.13 for NFS on TQM850L
5001 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5002 Data Size: 381681 Bytes = 372 kB = 0 MB
5003 Load Address: 00000000
5004 Entry Point: 0000000c
5005 Verifying Checksum ... OK
5006 Uncompressing Kernel Image ... OK
5007 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
5008 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5009 time_init: decrementer frequency = 187500000/60
5010 Calibrating delay loop... 49.77 BogoMIPS
5011 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5012 ...
wdenkc6097192002-11-03 00:24:07 +00005013
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005014If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005015the memory addresses of both the kernel and the initrd image (PPBCOOT
5016format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk6c59edc2004-05-03 20:45:30 +00005018 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005019
wdenk6c59edc2004-05-03 20:45:30 +00005020 ## Checking Image at 40100000 ...
5021 Image Name: 2.2.13 for initrd on TQM850L
5022 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5023 Data Size: 335725 Bytes = 327 kB = 0 MB
5024 Load Address: 00000000
5025 Entry Point: 0000000c
5026 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk6c59edc2004-05-03 20:45:30 +00005028 ## Checking Image at 40200000 ...
5029 Image Name: Simple Ramdisk Image
5030 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5031 Data Size: 566530 Bytes = 553 kB = 0 MB
5032 Load Address: 00000000
5033 Entry Point: 00000000
5034 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk6c59edc2004-05-03 20:45:30 +00005036 => bootm 40100000 40200000
5037 ## Booting Linux kernel at 40100000 ...
5038 Image Name: 2.2.13 for initrd on TQM850L
5039 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5040 Data Size: 335725 Bytes = 327 kB = 0 MB
5041 Load Address: 00000000
5042 Entry Point: 0000000c
5043 Verifying Checksum ... OK
5044 Uncompressing Kernel Image ... OK
5045 ## Loading RAMDisk Image at 40200000 ...
5046 Image Name: Simple Ramdisk Image
5047 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5048 Data Size: 566530 Bytes = 553 kB = 0 MB
5049 Load Address: 00000000
5050 Entry Point: 00000000
5051 Verifying Checksum ... OK
5052 Loading Ramdisk ... OK
5053 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
5054 Boot arguments: root=/dev/ram
5055 time_init: decrementer frequency = 187500000/60
5056 Calibrating delay loop... 49.77 BogoMIPS
5057 ...
5058 RAMDISK: Compressed image found at block 0
5059 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005060
wdenk6c59edc2004-05-03 20:45:30 +00005061 bash#
wdenkc6097192002-11-03 00:24:07 +00005062
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005063Boot Linux and pass a flat device tree:
5064-----------
5065
5066First, U-Boot must be compiled with the appropriate defines. See the section
5067titled "Linux Kernel Interface" above for a more in depth explanation. The
5068following is an example of how to start a kernel and pass an updated
5069flat device tree:
5070
5071=> print oftaddr
5072oftaddr=0x300000
5073=> print oft
5074oft=oftrees/mpc8540ads.dtb
5075=> tftp $oftaddr $oft
5076Speed: 1000, full duplex
5077Using TSEC0 device
5078TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5079Filename 'oftrees/mpc8540ads.dtb'.
5080Load address: 0x300000
5081Loading: #
5082done
5083Bytes transferred = 4106 (100a hex)
5084=> tftp $loadaddr $bootfile
5085Speed: 1000, full duplex
5086Using TSEC0 device
5087TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5088Filename 'uImage'.
5089Load address: 0x200000
5090Loading:############
5091done
5092Bytes transferred = 1029407 (fb51f hex)
5093=> print loadaddr
5094loadaddr=200000
5095=> print oftaddr
5096oftaddr=0x300000
5097=> bootm $loadaddr - $oftaddr
5098## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005099 Image Name: Linux-2.6.17-dirty
5100 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5101 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005102 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005103 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005104 Verifying Checksum ... OK
5105 Uncompressing Kernel Image ... OK
5106Booting using flat device tree at 0x300000
5107Using MPC85xx ADS machine description
5108Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5109[snip]
5110
5111
wdenk6c59edc2004-05-03 20:45:30 +00005112More About U-Boot Image Types:
5113------------------------------
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk6c59edc2004-05-03 20:45:30 +00005115U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005116
wdenk6c59edc2004-05-03 20:45:30 +00005117 "Standalone Programs" are directly runnable in the environment
5118 provided by U-Boot; it is expected that (if they behave
5119 well) you can continue to work in U-Boot after return from
5120 the Standalone Program.
5121 "OS Kernel Images" are usually images of some Embedded OS which
5122 will take over control completely. Usually these programs
5123 will install their own set of exception handlers, device
5124 drivers, set up the MMU, etc. - this means, that you cannot
5125 expect to re-enter U-Boot except by resetting the CPU.
5126 "RAMDisk Images" are more or less just data blocks, and their
5127 parameters (address, size) are passed to an OS kernel that is
5128 being started.
5129 "Multi-File Images" contain several images, typically an OS
5130 (Linux) kernel image and one or more data images like
5131 RAMDisks. This construct is useful for instance when you want
5132 to boot over the network using BOOTP etc., where the boot
5133 server provides just a single image file, but you want to get
5134 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005135
wdenk6c59edc2004-05-03 20:45:30 +00005136 "Multi-File Images" start with a list of image sizes, each
5137 image size (in bytes) specified by an "uint32_t" in network
5138 byte order. This list is terminated by an "(uint32_t)0".
5139 Immediately after the terminating 0 follow the images, one by
5140 one, all aligned on "uint32_t" boundaries (size rounded up to
5141 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005142
wdenk6c59edc2004-05-03 20:45:30 +00005143 "Firmware Images" are binary images containing firmware (like
5144 U-Boot or FPGA images) which usually will be programmed to
5145 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005146
wdenk6c59edc2004-05-03 20:45:30 +00005147 "Script files" are command sequences that will be executed by
5148 U-Boot's command interpreter; this feature is especially
5149 useful when you configure U-Boot to use a real shell (hush)
5150 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005151
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005152Booting the Linux zImage:
5153-------------------------
5154
5155On some platforms, it's possible to boot Linux zImage. This is done
5156using the "bootz" command. The syntax of "bootz" command is the same
5157as the syntax of "bootm" command.
5158
Tom Rini45f46d12013-05-16 11:40:11 -04005159Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005160kernel with raw initrd images. The syntax is slightly different, the
5161address of the initrd must be augmented by it's size, in the following
5162format: "<initrd addres>:<initrd size>".
5163
stroeseb9c17c52003-04-04 15:53:41 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165Standalone HOWTO:
5166=================
stroeseb9c17c52003-04-04 15:53:41 +00005167
wdenk6c59edc2004-05-03 20:45:30 +00005168One of the features of U-Boot is that you can dynamically load and
5169run "standalone" applications, which can use some resources of
5170U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005171
wdenk6c59edc2004-05-03 20:45:30 +00005172Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005173
wdenk6c59edc2004-05-03 20:45:30 +00005174"Hello World" Demo:
5175-------------------
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk6c59edc2004-05-03 20:45:30 +00005177'examples/hello_world.c' contains a small "Hello World" Demo
5178application; it is automatically compiled when you build U-Boot.
5179It's configured to run at address 0x00040004, so you can play with it
5180like that:
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182 => loads
5183 ## Ready for S-Record download ...
5184 ~>examples/hello_world.srec
5185 1 2 3 4 5 6 7 8 9 10 11 ...
5186 [file transfer complete]
5187 [connected]
5188 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005189
wdenk6c59edc2004-05-03 20:45:30 +00005190 => go 40004 Hello World! This is a test.
5191 ## Starting application at 0x00040004 ...
5192 Hello World
5193 argc = 7
5194 argv[0] = "40004"
5195 argv[1] = "Hello"
5196 argv[2] = "World!"
5197 argv[3] = "This"
5198 argv[4] = "is"
5199 argv[5] = "a"
5200 argv[6] = "test."
5201 argv[7] = "<NULL>"
5202 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk6c59edc2004-05-03 20:45:30 +00005204 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005205
wdenk6c59edc2004-05-03 20:45:30 +00005206Another example, which demonstrates how to register a CPM interrupt
5207handler with the U-Boot code, can be found in 'examples/timer.c'.
5208Here, a CPM timer is set up to generate an interrupt every second.
5209The interrupt service routine is trivial, just printing a '.'
5210character, but this is just a demo program. The application can be
5211controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk6c59edc2004-05-03 20:45:30 +00005213 ? - print current values og the CPM Timer registers
5214 b - enable interrupts and start timer
5215 e - stop timer and disable interrupts
5216 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218 => loads
5219 ## Ready for S-Record download ...
5220 ~>examples/timer.srec
5221 1 2 3 4 5 6 7 8 9 10 11 ...
5222 [file transfer complete]
5223 [connected]
5224 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk6c59edc2004-05-03 20:45:30 +00005226 => go 40004
5227 ## Starting application at 0x00040004 ...
5228 TIMERS=0xfff00980
5229 Using timer 1
5230 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk6c59edc2004-05-03 20:45:30 +00005232Hit 'b':
5233 [q, b, e, ?] Set interval 1000000 us
5234 Enabling timer
5235Hit '?':
5236 [q, b, e, ?] ........
5237 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5238Hit '?':
5239 [q, b, e, ?] .
5240 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5241Hit '?':
5242 [q, b, e, ?] .
5243 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5244Hit '?':
5245 [q, b, e, ?] .
5246 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5247Hit 'e':
5248 [q, b, e, ?] ...Stopping timer
5249Hit 'q':
5250 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005251
wdenkc6097192002-11-03 00:24:07 +00005252
wdenk6c59edc2004-05-03 20:45:30 +00005253Minicom warning:
5254================
wdenkc6097192002-11-03 00:24:07 +00005255
wdenk6c59edc2004-05-03 20:45:30 +00005256Over time, many people have reported problems when trying to use the
5257"minicom" terminal emulation program for serial download. I (wd)
5258consider minicom to be broken, and recommend not to use it. Under
5259Unix, I recommend to use C-Kermit for general purpose use (and
5260especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005261use "cu" for S-Record download ("loads" command). See
5262http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5263for help with kermit.
5264
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk6c59edc2004-05-03 20:45:30 +00005266Nevertheless, if you absolutely want to use it try adding this
5267configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk6c59edc2004-05-03 20:45:30 +00005269 Name Program Name U/D FullScr IO-Red. Multi
5270 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5271 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005272
wdenk8dba0502003-03-31 16:34:49 +00005273
wdenk6c59edc2004-05-03 20:45:30 +00005274NetBSD Notes:
5275=============
wdenkc6097192002-11-03 00:24:07 +00005276
wdenk6c59edc2004-05-03 20:45:30 +00005277Starting at version 0.9.2, U-Boot supports NetBSD both as host
5278(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005279
wdenk6c59edc2004-05-03 20:45:30 +00005280Building requires a cross environment; it is known to work on
5281NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5282need gmake since the Makefiles are not compatible with BSD make).
5283Note that the cross-powerpc package does not install include files;
5284attempting to build U-Boot will fail because <machine/ansi.h> is
5285missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287 # cd /usr/pkg/cross/powerpc-netbsd/include
5288 # mkdir powerpc
5289 # ln -s powerpc machine
5290 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5291 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005292
wdenk6c59edc2004-05-03 20:45:30 +00005293Native builds *don't* work due to incompatibilities between native
5294and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005295
wdenk6c59edc2004-05-03 20:45:30 +00005296Booting assumes that (the first part of) the image booted is a
5297stage-2 loader which in turn loads and then invokes the kernel
5298proper. Loader sources will eventually appear in the NetBSD source
5299tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005300meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005301
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk6c59edc2004-05-03 20:45:30 +00005303Implementation Internals:
5304=========================
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk6c59edc2004-05-03 20:45:30 +00005306The following is not intended to be a complete description of every
5307implementation detail. However, it should help to understand the
5308inner workings of U-Boot and make it easier to port it to custom
5309hardware.
wdenkc6097192002-11-03 00:24:07 +00005310
wdenkc6097192002-11-03 00:24:07 +00005311
wdenk6c59edc2004-05-03 20:45:30 +00005312Initial Stack, Global Data:
5313---------------------------
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk6c59edc2004-05-03 20:45:30 +00005315The implementation of U-Boot is complicated by the fact that U-Boot
5316starts running out of ROM (flash memory), usually without access to
5317system RAM (because the memory controller is not initialized yet).
5318This means that we don't have writable Data or BSS segments, and BSS
5319is not initialized as zero. To be able to get a C environment working
5320at all, we have to allocate at least a minimal stack. Implementation
5321options for this are defined and restricted by the CPU used: Some CPU
5322models provide on-chip memory (like the IMMR area on MPC8xx and
5323MPC826x processors), on others (parts of) the data cache can be
5324locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005325
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005326 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005327 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005328
wdenk6c59edc2004-05-03 20:45:30 +00005329 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5330 From: "Chris Hallinan" <clh@net1plus.com>
5331 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5332 ...
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk6c59edc2004-05-03 20:45:30 +00005334 Correct me if I'm wrong, folks, but the way I understand it
5335 is this: Using DCACHE as initial RAM for Stack, etc, does not
5336 require any physical RAM backing up the cache. The cleverness
5337 is that the cache is being used as a temporary supply of
5338 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005339 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005340 can see how this works by studying the cache architecture and
5341 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk6c59edc2004-05-03 20:45:30 +00005343 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5344 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005345 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005346 option should work for you. Using CS 4 should be fine if your
5347 board designers haven't used it for something that would
5348 cause you grief during the initial boot! It is frequently not
5349 used.
wdenkc6097192002-11-03 00:24:07 +00005350
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005351 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005352 with your processor/board/system design. The default value
5353 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005354 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005355 than your SDRAM module. If you have a 64MB SDRAM module, set
5356 it above 400_0000. Just make sure your board has no resources
5357 that are supposed to respond to that address! That code in
5358 start.S has been around a while and should work as is when
5359 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005360
wdenk6c59edc2004-05-03 20:45:30 +00005361 -Chris Hallinan
5362 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005363
wdenk6c59edc2004-05-03 20:45:30 +00005364It is essential to remember this, since it has some impact on the C
5365code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005366
wdenk6c59edc2004-05-03 20:45:30 +00005367* Initialized global data (data segment) is read-only. Do not attempt
5368 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005369
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005370* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005371 as zero data - BSS segment) at all - this is undefined, initiali-
5372 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005373
wdenk6c59edc2004-05-03 20:45:30 +00005374* Stack space is very limited. Avoid big data buffers or things like
5375 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005376
wdenk6c59edc2004-05-03 20:45:30 +00005377Having only the stack as writable memory limits means we cannot use
5378normal global data to share information beween the code. But it
5379turned out that the implementation of U-Boot can be greatly
5380simplified by making a global data structure (gd_t) available to all
5381functions. We could pass a pointer to this data as argument to _all_
5382functions, but this would bloat the code. Instead we use a feature of
5383the GCC compiler (Global Register Variables) to share the data: we
5384place a pointer (gd) to the global data into a register which we
5385reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005386
wdenk6c59edc2004-05-03 20:45:30 +00005387When choosing a register for such a purpose we are restricted by the
5388relevant (E)ABI specifications for the current architecture, and by
5389GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391For PowerPC, the following registers have specific use:
5392 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005393 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005394 R3-R4: parameter passing and return values
5395 R5-R10: parameter passing
5396 R13: small data area pointer
5397 R30: GOT pointer
5398 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005399
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005400 (U-Boot also uses R12 as internal GOT pointer. r12
5401 is a volatile register so r12 needs to be reset when
5402 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005403
Wolfgang Denk69c09642008-02-14 22:43:22 +01005404 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005405
wdenk6c59edc2004-05-03 20:45:30 +00005406 Note: on PPC, we could use a static initializer (since the
5407 address of the global data structure is known at compile time),
5408 but it turned out that reserving a register results in somewhat
5409 smaller code - although the code savings are not that big (on
5410 average for all boards 752 bytes for the whole U-Boot image,
5411 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005412
Robin Getz2773d5f2009-08-17 15:23:02 +00005413On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005414 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5415
Robin Getz2773d5f2009-08-17 15:23:02 +00005416 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005417
wdenk6c59edc2004-05-03 20:45:30 +00005418On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420 R0: function argument word/integer result
5421 R1-R3: function argument word
5422 R9: GOT pointer
5423 R10: stack limit (used only if stack checking if enabled)
5424 R11: argument (frame) pointer
5425 R12: temporary workspace
5426 R13: stack pointer
5427 R14: link register
5428 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005429
wdenk6c59edc2004-05-03 20:45:30 +00005430 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005431
Thomas Chou8fa38582010-05-21 11:08:03 +08005432On Nios II, the ABI is documented here:
5433 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5434
5435 ==> U-Boot will use gp to hold a pointer to the global data
5436
5437 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5438 to access small data sections, so gp is free.
5439
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005440On NDS32, the following registers are used:
5441
5442 R0-R1: argument/return
5443 R2-R5: argument
5444 R15: temporary register for assembler
5445 R16: trampoline register
5446 R28: frame pointer (FP)
5447 R29: global pointer (GP)
5448 R30: link register (LP)
5449 R31: stack pointer (SP)
5450 PC: program counter (PC)
5451
5452 ==> U-Boot will use R10 to hold a pointer to the global data
5453
Wolfgang Denk6405a152006-03-31 18:32:53 +02005454NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5455or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005456
wdenk6c59edc2004-05-03 20:45:30 +00005457Memory Management:
5458------------------
wdenkc6097192002-11-03 00:24:07 +00005459
wdenk6c59edc2004-05-03 20:45:30 +00005460U-Boot runs in system state and uses physical addresses, i.e. the
5461MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005462
wdenk6c59edc2004-05-03 20:45:30 +00005463The available memory is mapped to fixed addresses using the memory
5464controller. In this process, a contiguous block is formed for each
5465memory type (Flash, SDRAM, SRAM), even when it consists of several
5466physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk6c59edc2004-05-03 20:45:30 +00005468U-Boot is installed in the first 128 kB of the first Flash bank (on
5469TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5470booting and sizing and initializing DRAM, the code relocates itself
5471to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005472memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005473configuration setting]. Below that, a structure with global Board
5474Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005475
wdenk6c59edc2004-05-03 20:45:30 +00005476Additionally, some exception handler code is copied to the low 8 kB
5477of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005478
wdenk6c59edc2004-05-03 20:45:30 +00005479So a typical memory configuration with 16 MB of DRAM could look like
5480this:
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk6c59edc2004-05-03 20:45:30 +00005482 0x0000 0000 Exception Vector code
5483 :
5484 0x0000 1FFF
5485 0x0000 2000 Free for Application Use
5486 :
5487 :
wdenkc6097192002-11-03 00:24:07 +00005488
wdenk6c59edc2004-05-03 20:45:30 +00005489 :
5490 :
5491 0x00FB FF20 Monitor Stack (Growing downward)
5492 0x00FB FFAC Board Info Data and permanent copy of global data
5493 0x00FC 0000 Malloc Arena
5494 :
5495 0x00FD FFFF
5496 0x00FE 0000 RAM Copy of Monitor Code
5497 ... eventually: LCD or video framebuffer
5498 ... eventually: pRAM (Protected RAM - unchanged by reset)
5499 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005500
wdenkc6097192002-11-03 00:24:07 +00005501
wdenk6c59edc2004-05-03 20:45:30 +00005502System Initialization:
5503----------------------
wdenkc6097192002-11-03 00:24:07 +00005504
wdenk6c59edc2004-05-03 20:45:30 +00005505In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005506(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005507configuration for CS0# this is a mirror of the onboard Flash memory.
5508To be able to re-map memory U-Boot then jumps to its link address.
5509To be able to implement the initialization code in C, a (small!)
5510initial stack is set up in the internal Dual Ported RAM (in case CPUs
5511which provide such a feature like MPC8xx or MPC8260), or in a locked
5512part of the data cache. After that, U-Boot initializes the CPU core,
5513the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005514
wdenk6c59edc2004-05-03 20:45:30 +00005515Next, all (potentially) available memory banks are mapped using a
5516preliminary mapping. For example, we put them on 512 MB boundaries
5517(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5518on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5519programmed for SDRAM access. Using the temporary configuration, a
5520simple memory test is run that determines the size of the SDRAM
5521banks.
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523When there is more than one SDRAM bank, and the banks are of
5524different size, the largest is mapped first. For equal size, the first
5525bank (CS2#) is mapped first. The first mapping is always for address
55260x00000000, with any additional banks following immediately to create
5527contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk6c59edc2004-05-03 20:45:30 +00005529Then, the monitor installs itself at the upper end of the SDRAM area
5530and allocates memory for use by malloc() and for the global Board
5531Info data; also, the exception vector code is copied to the low RAM
5532pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005533
wdenk6c59edc2004-05-03 20:45:30 +00005534Only after this relocation will you have a "normal" C environment;
5535until that you are restricted in several ways, mostly because you are
5536running from ROM, and because the code will have to be relocated to a
5537new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005538
wdenkc6097192002-11-03 00:24:07 +00005539
wdenk6c59edc2004-05-03 20:45:30 +00005540U-Boot Porting Guide:
5541----------------------
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5544list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005545
wdenkc6097192002-11-03 00:24:07 +00005546
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005547int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005548{
5549 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005550
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005551 signal(SIGALRM, no_more_time);
5552 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005553
wdenk6c59edc2004-05-03 20:45:30 +00005554 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005555 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005556 return 0;
5557 }
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005560
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005561 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005562
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005563 if (clueless)
5564 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005565
wdenk6c59edc2004-05-03 20:45:30 +00005566 while (learning) {
5567 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005568 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5569 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005570 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005571 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005572 }
wdenkc6097192002-11-03 00:24:07 +00005573
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005574 if (available_money > toLocalCurrency ($2500))
5575 Buy a BDI3000;
5576 else
wdenk6c59edc2004-05-03 20:45:30 +00005577 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005578
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005579 if (a similar board exists) { /* hopefully... */
5580 cp -a board/<similar> board/<myboard>
5581 cp include/configs/<similar>.h include/configs/<myboard>.h
5582 } else {
5583 Create your own board support subdirectory;
5584 Create your own board include/configs/<myboard>.h file;
5585 }
5586 Edit new board/<myboard> files
5587 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005588
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005589 while (!accepted) {
5590 while (!running) {
5591 do {
5592 Add / modify source code;
5593 } until (compiles);
5594 Debug;
5595 if (clueless)
5596 email("Hi, I am having problems...");
5597 }
5598 Send patch file to the U-Boot email list;
5599 if (reasonable critiques)
5600 Incorporate improvements from email list code review;
5601 else
5602 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005603 }
wdenkc6097192002-11-03 00:24:07 +00005604
wdenk6c59edc2004-05-03 20:45:30 +00005605 return 0;
5606}
wdenkc6097192002-11-03 00:24:07 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608void no_more_time (int sig)
5609{
5610 hire_a_guru();
5611}
wdenkc6097192002-11-03 00:24:07 +00005612
wdenkc6097192002-11-03 00:24:07 +00005613
wdenk6c59edc2004-05-03 20:45:30 +00005614Coding Standards:
5615-----------------
wdenkc6097192002-11-03 00:24:07 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005618coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005619"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005620
5621Source files originating from a different project (for example the
5622MTD subsystem) are generally exempt from these guidelines and are not
5623reformated to ease subsequent migration to newer versions of those
5624sources.
wdenkc6097192002-11-03 00:24:07 +00005625
Detlev Zundelaa63d482006-09-01 15:39:02 +02005626Please note that U-Boot is implemented in C (and to some small parts in
5627Assembler); no C++ is used, so please do not use C++ style comments (//)
5628in your code.
wdenkad276f22004-01-04 16:28:35 +00005629
wdenk6c59edc2004-05-03 20:45:30 +00005630Please also stick to the following formatting rules:
5631- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005632- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005633- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005634- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005635- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005636
wdenk6c59edc2004-05-03 20:45:30 +00005637Submissions which do not conform to the standards may be returned
5638with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005639
wdenkc6097192002-11-03 00:24:07 +00005640
wdenk6c59edc2004-05-03 20:45:30 +00005641Submitting Patches:
5642-------------------
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk6c59edc2004-05-03 20:45:30 +00005644Since the number of patches for U-Boot is growing, we need to
5645establish some rules. Submissions which do not conform to these rules
5646may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005647
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005648Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005649
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005650Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5651see http://lists.denx.de/mailman/listinfo/u-boot
5652
wdenk6c59edc2004-05-03 20:45:30 +00005653When you send a patch, please include the following information with
5654it:
wdenkc6097192002-11-03 00:24:07 +00005655
wdenk6c59edc2004-05-03 20:45:30 +00005656* For bug fixes: a description of the bug and how your patch fixes
5657 this bug. Please try to include a way of demonstrating that the
5658 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005659
wdenk6c59edc2004-05-03 20:45:30 +00005660* For new features: a description of the feature and your
5661 implementation.
wdenkc6097192002-11-03 00:24:07 +00005662
wdenk6c59edc2004-05-03 20:45:30 +00005663* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005664
wdenk6c59edc2004-05-03 20:45:30 +00005665* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005666
wdenk6c59edc2004-05-03 20:45:30 +00005667* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005668 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00005669
wdenk6c59edc2004-05-03 20:45:30 +00005670* If your patch adds new configuration options, don't forget to
5671 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005672
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005673* The patch itself. If you are using git (which is *strongly*
5674 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005675 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005676 the U-Boot mailing list, you will avoid most of the common problems
5677 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005678
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005679 If you cannot use git, use "diff -purN OLD NEW". If your version of
5680 diff does not support these options, then get the latest version of
5681 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005682
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005683 The current directory when running this command shall be the parent
5684 directory of the U-Boot source tree (i. e. please make sure that
5685 your patch includes sufficient directory information for the
5686 affected files).
5687
5688 We prefer patches as plain text. MIME attachments are discouraged,
5689 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005690
wdenk6c59edc2004-05-03 20:45:30 +00005691* If one logical set of modifications affects or creates several
5692 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694* Changesets that contain different, unrelated modifications shall be
5695 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005696
wdenkc6097192002-11-03 00:24:07 +00005697
wdenk6c59edc2004-05-03 20:45:30 +00005698Notes:
wdenkc6097192002-11-03 00:24:07 +00005699
wdenk6c59edc2004-05-03 20:45:30 +00005700* Before sending the patch, run the MAKEALL script on your patched
5701 source tree and make sure that no errors or warnings are reported
5702 for any of the boards.
5703
5704* Keep your modifications to the necessary minimum: A patch
5705 containing several unrelated changes or arbitrary reformats will be
5706 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005707
wdenk6c59edc2004-05-03 20:45:30 +00005708* If you modify existing code, make sure that your new code does not
5709 add to the memory footprint of the code ;-) Small is beautiful!
5710 When adding new features, these should compile conditionally only
5711 (using #ifdef), and the resulting code with the new feature
5712 disabled must not need more memory than the old code without your
5713 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005714
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005715* Remember that there is a size limit of 100 kB per message on the
5716 u-boot mailing list. Bigger patches will be moderated. If they are
5717 reasonable and not too big, they will be acknowledged. But patches
5718 bigger than the size limit should be avoided.