blob: 3941725c43ab516ffb1582324a2415e986340476 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk8c831282012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denkb240aef2008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000057Note: There is no CHANGELOG file in the actual U-Boot source tree;
58it can be created dynamically from the Git log using:
59
60 make CHANGELOG
61
wdenkc6097192002-11-03 00:24:07 +000062
63Where to get help:
64==================
65
wdenk24ee89b2002-11-03 17:56:27 +000066In case you have questions about, problems with or contributions for
67U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050068<u-boot@lists.denx.de>. There is also an archive of previous traffic
69on the mailing list - please search the archive before asking FAQ's.
70Please see http://lists.denx.de/pipermail/u-boot and
71http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000072
73
Wolfgang Denkb240aef2008-03-26 10:40:12 +010074Where to get source code:
75=========================
76
77The U-Boot source code is maintained in the git repository at
78git://www.denx.de/git/u-boot.git ; you can browse it online at
79http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
80
81The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschin08337f32008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010087ftp://ftp.denx.de/pub/u-boot/images/
88
89
wdenkc6097192002-11-03 00:24:07 +000090Where we come from:
91===================
92
93- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000094- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000095- clean up code
96- make it easier to add custom boards
97- make it possible to add other [PowerPC] CPUs
98- extend functions, especially:
99 * Provide extended interface to Linux boot loader
100 * S-Record download
101 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200102 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +0000103- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +0000104- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000105- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +0200106- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000107
108
109Names and Spelling:
110===================
111
112The "official" name of this project is "Das U-Boot". The spelling
113"U-Boot" shall be used in all written text (documentation, comments
114in source files etc.). Example:
115
116 This is the README file for the U-Boot project.
117
118File names etc. shall be based on the string "u-boot". Examples:
119
120 include/asm-ppc/u-boot.h
121
122 #include <asm/u-boot.h>
123
124Variable names, preprocessor constants etc. shall be either based on
125the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000126
wdenk24ee89b2002-11-03 17:56:27 +0000127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
129
wdenkc6097192002-11-03 00:24:07 +0000130
wdenk7474aca2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Webere89e6282010-09-28 08:06:25 +0200134Starting with the release in October 2008, the names of the releases
135were changed from numerical release numbers without deeper meaning
136into a time stamp based numbering. Regular releases are identified by
137names consisting of the calendar year and month of the release date.
138Additional fields (if present) indicate release candidates or bug fix
139releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000140
Thomas Webere89e6282010-09-28 08:06:25 +0200141Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200143 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
144 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150/arch Architecture specific files
151 /arm Files generic to ARM architecture
152 /cpu CPU specific files
153 /arm720t Files specific to ARM 720 CPUs
154 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmannd9a9d562011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk16fa98a2010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500158 /arm925t Files specific to ARM 925 CPUs
159 /arm926ejs Files specific to ARM 926 CPUs
160 /arm1136 Files specific to ARM 1136 CPUs
161 /ixp Files specific to Intel XScale IXP CPUs
162 /pxa Files specific to Intel XScale PXA CPUs
163 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
164 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
165 /lib Architecture specific library files
166 /avr32 Files generic to AVR32 architecture
167 /cpu CPU specific files
168 /lib Architecture specific library files
169 /blackfin Files generic to Analog Devices Blackfin architecture
170 /cpu CPU specific files
171 /lib Architecture specific library files
Graeme Russcbfce1d2011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500173 /cpu CPU specific files
174 /lib Architecture specific library files
175 /m68k Files generic to m68k architecture
176 /cpu CPU specific files
177 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
178 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
179 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
180 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
181 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
182 /lib Architecture specific library files
183 /microblaze Files generic to microblaze architecture
184 /cpu CPU specific files
185 /lib Architecture specific library files
186 /mips Files generic to MIPS architecture
187 /cpu CPU specific files
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu2f46d422011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000191 /nds32 Files generic to NDS32 architecture
192 /cpu CPU specific files
193 /n1213 Files specific to Andes Technology N1213 CPUs
194 /lib Architecture specific library files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500195 /nios2 Files generic to Altera NIOS2 architecture
196 /cpu CPU specific files
197 /lib Architecture specific library files
Stefan Roese88fbf932010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500199 /cpu CPU specific files
200 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
201 /mpc5xx Files specific to Freescale MPC5xx CPUs
202 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
203 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tysere4d1abc2010-04-12 22:28:21 -0500204 /mpc824x Files specific to Freescale MPC824x CPUs
205 /mpc8260 Files specific to Freescale MPC8260 CPUs
206 /mpc85xx Files specific to Freescale MPC85xx CPUs
207 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
208 /lib Architecture specific library files
209 /sh Files generic to SH architecture
210 /cpu CPU specific files
211 /sh2 Files specific to sh2 CPUs
212 /sh3 Files specific to sh3 CPUs
213 /sh4 Files specific to sh4 CPUs
214 /lib Architecture specific library files
215 /sparc Files generic to SPARC architecture
216 /cpu CPU specific files
217 /leon2 Files specific to Gaisler LEON2 SPARC CPU
218 /leon3 Files specific to Gaisler LEON3 SPARC CPU
219 /lib Architecture specific library files
220/api Machine/arch independent API for external apps
221/board Board dependent files
222/common Misc architecture independent functions
223/disk Code for disk drive partition handling
224/doc Documentation (don't expect too much)
225/drivers Commonly used device drivers
226/examples Example code for standalone applications, etc.
227/fs Filesystem code (cramfs, ext2, jffs2, etc.)
228/include Header Files
229/lib Files generic to all architectures
230 /libfdt Library files to support flattened device trees
231 /lzma Library files to support LZMA decompression
232 /lzo Library files to support LZO decompression
233/net Networking code
234/post Power On Self Test
235/rtc Real Time Clock drivers
236/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000237
wdenkc6097192002-11-03 00:24:07 +0000238Software Configuration:
239=======================
240
241Configuration is usually done using C preprocessor defines; the
242rationale behind that is to avoid dead code whenever possible.
243
244There are two classes of configuration variables:
245
246* Configuration _OPTIONS_:
247 These are selectable by the user and have names beginning with
248 "CONFIG_".
249
250* Configuration _SETTINGS_:
251 These depend on the hardware etc. and should not be meddled with if
252 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200253 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000254
255Later we will add a configuration tool - probably similar to or even
256identical to what's used for the Linux kernel. Right now, we have to
257do the configuration by hand, which means creating some symbolic
258links and editing some configuration files. We use the TQM8xxL boards
259as an example here.
260
261
262Selection of Processor Architecture and Board Type:
263---------------------------------------------------
264
265For all supported boards there are ready-to-use default
266configurations available; just type "make <board_name>_config".
267
268Example: For a TQM823L module type:
269
270 cd u-boot
271 make TQM823L_config
272
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200273For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000274e.g. "make cogent_mpc8xx_config". And also configure the cogent
275directory according to the instructions in cogent/README.
276
277
278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk1272e232002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips203fee32007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips203fee32007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
wdenk2bb11052003-07-17 23:16:40 +0000324- Board flavour: (if CONFIG_MPC8260ADS is defined)
325 CONFIG_ADSTYPE
326 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200327 CONFIG_SYS_8260ADS - original MPC8260ADS
328 CONFIG_SYS_8266ADS - MPC8266ADS
329 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
330 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2bb11052003-07-17 23:16:40 +0000331
Lei Wen20014762011-02-09 18:06:58 +0530332- Marvell Family Member
333 CONFIG_SYS_MVFS - define it if you want to enable
334 multiple fs option at one time
335 for marvell soc family
336
wdenkc6097192002-11-03 00:24:07 +0000337- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk9b7f3842003-10-09 20:09:04 +0000338 Define exactly one of
339 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000340
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200341- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000342 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
343 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000344 e.g. if there is no 32KHz
345 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000346 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
347 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000348
wdenk20bddb32004-09-28 17:59:53 +0000349- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200350 CONFIG_SYS_8xx_CPUCLK_MIN
351 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000352 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000353 See doc/README.MPC866
354
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200355 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000356
wdenk544e9732004-02-06 23:19:44 +0000357 Define this to measure the actual CPU clock instead
358 of relying on the correctness of the configured
359 values. Mostly useful for board bringup to make sure
360 the PLL is locked at the intended frequency. Note
361 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200362 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000363
Heiko Schocher734f0272009-03-12 07:37:15 +0100364 CONFIG_SYS_DELAYED_ICACHE
365
366 Define this option if you want to enable the
367 ICache only when Code runs from RAM.
368
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600369- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000370 CONFIG_SYS_PPC64
371
372 Specifies that the core is a 64-bit PowerPC implementation (implements
373 the "64" category of the Power ISA). This is necessary for ePAPR
374 compliance, among other possible reasons.
375
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600376 CONFIG_SYS_FSL_TBCLK_DIV
377
378 Defines the core time base clock divider ratio compared to the
379 system clock. On most PQ3 devices this is 8, on newer QorIQ
380 devices it can be 16 or 32. The ratio varies from SoC to Soc.
381
Kumar Gala179b1b22011-05-20 00:39:21 -0500382 CONFIG_SYS_FSL_PCIE_COMPAT
383
384 Defines the string to utilize when trying to match PCIe device
385 tree nodes for the given platform.
386
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000387 CONFIG_SYS_PPC_E500_DEBUG_TLB
388
389 Enables a temporary TLB entry to be used during boot to work
390 around limitations in e500v1 and e500v2 external debugger
391 support. This reduces the portions of the boot code where
392 breakpoints and single stepping do not work. The value of this
393 symbol should be set to the TLB1 entry to be used for this
394 purpose.
395
Scott Wood80806962012-08-14 10:14:53 +0000396 CONFIG_SYS_FSL_ERRATUM_A004510
397
398 Enables a workaround for erratum A004510. If set,
399 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
400 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
401
402 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
403 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
404
405 Defines one or two SoC revisions (low 8 bits of SVR)
406 for which the A004510 workaround should be applied.
407
408 The rest of SVR is either not relevant to the decision
409 of whether the erratum is present (e.g. p2040 versus
410 p2041) or is implied by the build target, which controls
411 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
412
413 See Freescale App Note 4493 for more information about
414 this erratum.
415
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530416 CONFIG_A003399_NOR_WORKAROUND
417 Enables a workaround for IFC erratum A003399. It is only
418 requred during NOR boot.
419
Scott Wood80806962012-08-14 10:14:53 +0000420 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
421
422 This is the value to write into CCSR offset 0x18600
423 according to the A004510 workaround.
424
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530425 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426 This value denotes start offset of M2 memory
427 which is directly connected to the DSP core.
428
429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000432- Generic CPU options:
433 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
434
435 Defines the endianess of the CPU. Implementation of those
436 values is arch specific.
437
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100438- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200439 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100440
441 Defines the Monahans run mode to oscillator
442 ratio. Valid values are 8, 16, 24, 31. The core
443 frequency is this value multiplied by 13 MHz.
444
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200445 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200446
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100447 Defines the Monahans turbo mode to oscillator
448 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200449 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100450 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200451
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200452- MIPS CPU options:
453 CONFIG_SYS_INIT_SP_OFFSET
454
455 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
456 pointer. This is needed for the temporary stack before
457 relocation.
458
459 CONFIG_SYS_MIPS_CACHE_MODE
460
461 Cache operation mode for the MIPS CPU.
462 See also arch/mips/include/asm/mipsregs.h.
463 Possible values are:
464 CONF_CM_CACHABLE_NO_WA
465 CONF_CM_CACHABLE_WA
466 CONF_CM_UNCACHED
467 CONF_CM_CACHABLE_NONCOHERENT
468 CONF_CM_CACHABLE_CE
469 CONF_CM_CACHABLE_COW
470 CONF_CM_CACHABLE_CUW
471 CONF_CM_CACHABLE_ACCELERATED
472
473 CONFIG_SYS_XWAY_EBU_BOOTCFG
474
475 Special option for Lantiq XWAY SoCs for booting from NOR flash.
476 See also arch/mips/cpu/mips32/start.S.
477
478 CONFIG_XWAY_SWAP_BYTES
479
480 Enable compilation of tools/xway-swap-bytes needed for Lantiq
481 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
482 be swapped if a flash programmer is used.
483
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000484- ARM options:
485 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
486
487 Select high exception vectors of the ARM core, e.g., do not
488 clear the V bit of the c1 register of CP15.
489
Aneesh Vb8e40802012-03-08 07:20:19 +0000490 CONFIG_SYS_THUMB_BUILD
491
492 Use this flag to build U-Boot using the Thumb instruction
493 set for ARM architectures. Thumb instruction set provides
494 better code density. For ARM architectures that support
495 Thumb2 this flag will result in Thumb2 code generated by
496 GCC.
497
Stephen Warrenc63c3502013-03-04 13:29:40 +0000498 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000499 CONFIG_ARM_ERRATA_742230
500 CONFIG_ARM_ERRATA_743622
501 CONFIG_ARM_ERRATA_751472
502
503 If set, the workarounds for these ARM errata are applied early
504 during U-Boot startup. Note that these options force the
505 workarounds to be applied; no CPU-type/version detection
506 exists, unlike the similar options in the Linux kernel. Do not
507 set these options unless they apply!
508
Stephen Warren445d56c2013-03-27 17:06:41 +0000509- CPU timer options:
510 CONFIG_SYS_HZ
511
512 The frequency of the timer returned by get_timer().
513 get_timer() must operate in milliseconds and this CONFIG
514 option must be set to 1000.
515
wdenk9b7f3842003-10-09 20:09:04 +0000516- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000517 CONFIG_CLOCKS_IN_MHZ
518
519 U-Boot stores all clock information in Hz
520 internally. For binary compatibility with older Linux
521 kernels (which expect the clocks passed in the
522 bd_info data to be in MHz) the environment variable
523 "clocks_in_mhz" can be defined so that U-Boot
524 converts clock data to MHZ before passing it to the
525 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000526 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100527 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000528 default environment.
529
wdenk9b7f3842003-10-09 20:09:04 +0000530 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
531
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200532 When transferring memsize parameter to linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000533 expect it to be in bytes, others in MB.
534 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
535
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400536 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200537
538 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400539 passed using flattened device trees (based on open firmware
540 concepts).
541
542 CONFIG_OF_LIBFDT
543 * New libfdt-based support
544 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500545 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400546
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200547 OF_CPU - The proper name of the cpus node (only required for
548 MPC512X and MPC5xxx based boards).
549 OF_SOC - The proper name of the soc node (only required for
550 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200551 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600552 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200553
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200554 boards with QUICC Engines require OF_QE to set UCC MAC
555 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500556
Kumar Gala1e26aa52006-01-11 13:54:17 -0600557 CONFIG_OF_BOARD_SETUP
558
559 Board code has addition modification that it wants to make
560 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000561
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500562 CONFIG_OF_BOOT_CPU
563
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200564 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500565 param header, the default value is zero if undefined.
566
Heiko Schocherffb293a2009-09-23 07:56:08 +0200567 CONFIG_OF_IDE_FIXUP
568
569 U-Boot can detect if an IDE device is present or not.
570 If not, and this new config option is activated, U-Boot
571 removes the ATA node from the DTS before booting Linux,
572 so the Linux IDE driver does not probe the device and
573 crash. This is needed for buggy hardware (uc101) where
574 no pull down resistor is connected to the signal IDE5V_DD7.
575
Igor Grinberg06890672011-07-14 05:45:07 +0000576 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
577
578 This setting is mandatory for all boards that have only one
579 machine type and must be used to specify the machine type
580 number as it appears in the ARM machine registry
581 (see http://www.arm.linux.org.uk/developer/machines/).
582 Only boards that have multiple machine types supported
583 in a single configuration file and the machine type is
584 runtime discoverable, do not have to use this setting.
585
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100586- vxWorks boot parameters:
587
588 bootvx constructs a valid bootline using the following
589 environments variables: bootfile, ipaddr, serverip, hostname.
590 It loads the vxWorks image pointed bootfile.
591
592 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
593 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
594 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
595 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
596
597 CONFIG_SYS_VXWORKS_ADD_PARAMS
598
599 Add it at the end of the bootline. E.g "u=username pw=secret"
600
601 Note: If a "bootargs" environment is defined, it will overwride
602 the defaults discussed just above.
603
Aneesh V960f5c02011-06-16 23:30:47 +0000604- Cache Configuration:
605 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
606 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
607 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
608
Aneesh V686a0752011-06-16 23:30:51 +0000609- Cache Configuration for ARM:
610 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
611 controller
612 CONFIG_SYS_PL310_BASE - Physical base address of PL310
613 controller register space
614
wdenkda04a8b2004-08-02 23:22:59 +0000615- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200616 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000617
618 Define this if you want support for Amba PrimeCell PL010 UARTs.
619
Andreas Engel0813b122008-09-08 14:30:53 +0200620 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000621
622 Define this if you want support for Amba PrimeCell PL011 UARTs.
623
624 CONFIG_PL011_CLOCK
625
626 If you have Amba PrimeCell PL011 UARTs, set this variable to
627 the clock speed of the UARTs.
628
629 CONFIG_PL01x_PORTS
630
631 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
632 define this to a list of base addresses for each (supported)
633 port. See e.g. include/configs/versatile.h
634
John Rigby34e21ee2011-04-19 10:42:39 +0000635 CONFIG_PL011_SERIAL_RLCR
636
637 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
638 have separate receive and transmit line control registers. Set
639 this variable to initialize the extra register.
640
641 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
642
643 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
644 boot loader that has already initialized the UART. Define this
645 variable to flush the UART at init time.
646
wdenkda04a8b2004-08-02 23:22:59 +0000647
wdenkc6097192002-11-03 00:24:07 +0000648- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000649 Depending on board, define exactly one serial port
650 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
651 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
652 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000653
654 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
655 port routines must be defined elsewhere
656 (i.e. serial_init(), serial_getc(), ...)
657
658 CONFIG_CFB_CONSOLE
659 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000660 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000661 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
662 (default big endian)
663 VIDEO_HW_RECTFILL graphic chip supports
664 rectangle fill
665 (cf. smiLynxEM)
666 VIDEO_HW_BITBLT graphic chip supports
667 bit-blit (cf. smiLynxEM)
668 VIDEO_VISIBLE_COLS visible pixel columns
669 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000670 VIDEO_VISIBLE_ROWS visible pixel rows
671 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000672 VIDEO_DATA_FORMAT graphic data format
673 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000674 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000675 VIDEO_KBD_INIT_FCT keyboard int fct
676 (i.e. i8042_kbd_init())
677 VIDEO_TSTC_FCT test char fct
678 (i.e. i8042_tstc)
679 VIDEO_GETC_FCT get char fct
680 (i.e. i8042_getc)
681 CONFIG_CONSOLE_CURSOR cursor drawing on/off
682 (requires blink timer
683 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200684 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000685 CONFIG_CONSOLE_TIME display time/date info in
686 upper right corner
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500687 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000688 CONFIG_VIDEO_LOGO display Linux logo in
689 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000690 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
691 linux_logo.h for logo.
692 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000693 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200694 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000695 the logo
696
Pali Rohár4a57da32012-10-19 13:30:09 +0000697 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
698 a limited number of ANSI escape sequences (cursor control,
699 erase functions and limited graphics rendition control).
700
wdenk4a5c8a72003-03-06 00:02:04 +0000701 When CONFIG_CFB_CONSOLE is defined, video console is
702 default i/o. Serial console can be forced with
703 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000704
wdenk1ebf41e2004-01-02 14:00:00 +0000705 When CONFIG_SILENT_CONSOLE is defined, all console
706 messages (by U-Boot and Linux!) can be silenced with
707 the "silent" environment variable. See
708 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000709
wdenkc6097192002-11-03 00:24:07 +0000710- Console Baudrate:
711 CONFIG_BAUDRATE - in bps
712 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200713 CONFIG_SYS_BAUDRATE_TABLE, see below.
714 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000715
Heiko Schocher327480a2009-01-30 12:55:38 +0100716- Console Rx buffer length
717 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
718 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100719 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100720 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
721 must be defined, to setup the maximum idle timeout for
722 the SMC.
723
Graeme Russ3c28f482011-09-01 00:48:27 +0000724- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200725 Prior to the console being initialised (i.e. serial UART
726 initialised etc) all console output is silently discarded.
727 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
728 buffer any console messages prior to the console being
729 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
730 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
731 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200732 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200733 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000734
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200735 'Sane' compilers will generate smaller code if
736 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000737
Sonny Raocd55bde2011-11-02 09:52:08 +0000738- Safe printf() functions
739 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
740 the printf() functions. These are defined in
741 include/vsprintf.h and include snprintf(), vsnprintf() and
742 so on. Code size increase is approximately 300-500 bytes.
743 If this option is not given then these functions will
744 silently discard their buffer size argument - this means
745 you are not getting any overflow checking in this case.
746
wdenkc6097192002-11-03 00:24:07 +0000747- Boot Delay: CONFIG_BOOTDELAY - in seconds
748 Delay before automatically booting the default image;
749 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000750 set to -2 to autoboot with no delay and not check for abort
751 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000752
753 See doc/README.autoboot for these options that
754 work with CONFIG_BOOTDELAY. None are required.
755 CONFIG_BOOT_RETRY_TIME
756 CONFIG_BOOT_RETRY_MIN
757 CONFIG_AUTOBOOT_KEYED
758 CONFIG_AUTOBOOT_PROMPT
759 CONFIG_AUTOBOOT_DELAY_STR
760 CONFIG_AUTOBOOT_STOP_STR
761 CONFIG_AUTOBOOT_DELAY_STR2
762 CONFIG_AUTOBOOT_STOP_STR2
763 CONFIG_ZERO_BOOTDELAY_CHECK
764 CONFIG_RESET_TO_RETRY
765
766- Autoboot Command:
767 CONFIG_BOOTCOMMAND
768 Only needed when CONFIG_BOOTDELAY is enabled;
769 define a command string that is automatically executed
770 when no character is read on the console interface
771 within "Boot Delay" after reset.
772
773 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000774 This can be used to pass arguments to the bootm
775 command. The value of CONFIG_BOOTARGS goes into the
776 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000777
778 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000779 The value of these goes into the environment as
780 "ramboot" and "nfsboot" respectively, and can be used
781 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200782 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000783
784- Pre-Boot Commands:
785 CONFIG_PREBOOT
786
787 When this option is #defined, the existence of the
788 environment variable "preboot" will be checked
789 immediately before starting the CONFIG_BOOTDELAY
790 countdown and/or running the auto-boot command resp.
791 entering interactive mode.
792
793 This feature is especially useful when "preboot" is
794 automatically generated or modified. For an example
795 see the LWMON board specific code: here "preboot" is
796 modified when the user holds down a certain
797 combination of keys on the (special) keyboard when
798 booting the systems
799
800- Serial Download Echo Mode:
801 CONFIG_LOADS_ECHO
802 If defined to 1, all characters received during a
803 serial download (using the "loads" command) are
804 echoed back. This might be needed by some terminal
805 emulations (like "cu"), but may as well just take
806 time on others. This setting #define's the initial
807 value of the "loads_echo" environment variable.
808
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500809- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000810 CONFIG_KGDB_BAUDRATE
811 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200812 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000813
814- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500815 Monitor commands can be included or excluded
816 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000817 <config_cmd_all.h> and #undef'ing unwanted
818 commands, or using <config_cmd_default.h>
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500819 and augmenting with additional #define's
820 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000821
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500822 The default command configuration includes all commands
823 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000824
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500825 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500826 CONFIG_CMD_BDI bdinfo
827 CONFIG_CMD_BEDBUG * Include BedBug Debugger
828 CONFIG_CMD_BMP * BMP support
829 CONFIG_CMD_BSP * Board specific commands
830 CONFIG_CMD_BOOTD bootd
831 CONFIG_CMD_CACHE * icache, dcache
832 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500833 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500834 CONFIG_CMD_DATE * support for RTC, date/time...
835 CONFIG_CMD_DHCP * DHCP support
836 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600837 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
838 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
839 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
840 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500841 CONFIG_CMD_DTT * Digital Therm and Thermostat
842 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500843 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500844 CONFIG_CMD_EEPROM * EEPROM read/write support
845 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600846 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600847 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500848 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000849 CONFIG_CMD_EXT2 * ext2 command support
850 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500851 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500852 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000853 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500854 CONFIG_CMD_FDOS * Dos diskette Support
855 CONFIG_CMD_FLASH flinfo, erase, protect
856 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200857 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000858 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500859 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000860 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000861 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
863 CONFIG_CMD_I2C * I2C serial bus support
864 CONFIG_CMD_IDE * IDE harddisk support
865 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000866 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200867 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500868 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500869 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000870 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500871 CONFIG_CMD_IRQ * irqinfo
872 CONFIG_CMD_ITEST Integer/string test of 2 values
873 CONFIG_CMD_JFFS2 * JFFS2 Support
874 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200875 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000876 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
877 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500878 CONFIG_CMD_LOADB loadb
879 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200880 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400881 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000882 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500883 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000884 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200885 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500886 CONFIG_CMD_MISC Misc functions like sleep etc
887 CONFIG_CMD_MMC * MMC memory mapped support
888 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100889 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500890 CONFIG_CMD_NAND * NAND support
891 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200892 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600893 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000894 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500895 CONFIG_CMD_PCI * pciinfo
896 CONFIG_CMD_PCMCIA * PCMCIA support
897 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
898 host
899 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000900 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500901 CONFIG_CMD_REGINFO * Register dump
902 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000903 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500904 CONFIG_CMD_SAVES * save S record dump
905 CONFIG_CMD_SCSI * SCSI Support
906 CONFIG_CMD_SDRAM * print SDRAM configuration information
907 (requires CONFIG_CMD_I2C)
908 CONFIG_CMD_SETGETDCR Support for DCR Register access
909 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700910 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200911 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400912 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800913 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200914 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500915 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000916 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000917 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000918 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
919 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500920 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500921 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000922 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200923 CONFIG_CMD_XIMG Load part of Multi Image
wdenkc6097192002-11-03 00:24:07 +0000924
wdenkc6097192002-11-03 00:24:07 +0000925
926 EXAMPLE: If you want all functions except of network
927 support you can write:
928
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500929 #include "config_cmd_all.h"
930 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000931
Gerald Van Barend6abef42007-03-31 12:23:51 -0400932 Other Commands:
933 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000934
935 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500936 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000937 what you (and your U-Boot users) are doing. Data
938 cache cannot be enabled on systems like the 8xx or
939 8260 (where accesses to the IMMR region must be
940 uncached), and it cannot be disabled on all other
941 systems where we (mis-) use the data cache to hold an
942 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000943
944
945 XXX - this list needs to get updated!
946
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000947- Regular expression support:
948 CONFIG_REGEX
949 If this variable is defined, U-Boot is linked against
950 the SLRE (Super Light Regular Expression) library,
951 which adds regex support to some commands, as for
952 example "env grep" and "setexpr".
953
Simon Glass3d686442011-10-15 05:48:20 +0000954- Device tree:
955 CONFIG_OF_CONTROL
956 If this variable is defined, U-Boot will use a device tree
957 to configure its devices, instead of relying on statically
958 compiled #defines in the board file. This option is
959 experimental and only available on a few boards. The device
960 tree is available in the global data as gd->fdt_blob.
961
Simon Glass5cb34db2011-10-24 19:15:31 +0000962 U-Boot needs to get its device tree from somewhere. This can
963 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000964
965 CONFIG_OF_EMBED
966 If this variable is defined, U-Boot will embed a device tree
967 binary in its image. This device tree file should be in the
968 board directory and called <soc>-<board>.dts. The binary file
969 is then picked up in board_init_f() and made available through
970 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000971
Simon Glass5cb34db2011-10-24 19:15:31 +0000972 CONFIG_OF_SEPARATE
973 If this variable is defined, U-Boot will build a device tree
974 binary. It will be called u-boot.dtb. Architecture-specific
975 code will locate it at run-time. Generally this works by:
976
977 cat u-boot.bin u-boot.dtb >image.bin
978
979 and in fact, U-Boot does this for you, creating a file called
980 u-boot-dtb.bin which is useful in the common case. You can
981 still use the individual files if you need something more
982 exotic.
983
wdenkc6097192002-11-03 00:24:07 +0000984- Watchdog:
985 CONFIG_WATCHDOG
986 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000987 support for the SoC. There must be support in the SoC
988 specific code for a watchdog. For the 8xx and 8260
989 CPUs, the SIU Watchdog feature is enabled in the SYPCR
990 register. When supported for a specific SoC is
991 available, then no further board specific code should
992 be needed to use it.
993
994 CONFIG_HW_WATCHDOG
995 When using a watchdog circuitry external to the used
996 SoC, then define this variable and provide board
997 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000998
stroeseb9c17c52003-04-04 15:53:41 +0000999- U-Boot Version:
1000 CONFIG_VERSION_VARIABLE
1001 If this variable is defined, an environment variable
1002 named "ver" is created by U-Boot showing the U-Boot
1003 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001004 Any change to this variable will be reverted at the
1005 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001006
wdenkc6097192002-11-03 00:24:07 +00001007- Real-Time Clock:
1008
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001009 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001010 has to be selected, too. Define exactly one of the
1011 following options:
1012
1013 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1014 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001015 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001016 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001017 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001018 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001019 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenkef5fe752003-03-12 10:41:04 +00001020 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001021 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001022 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001023 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001024 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1025 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001026
wdenkb9bbd242003-06-30 16:24:52 +00001027 Note that if the RTC uses I2C, then the I2C interface
1028 must also be configured. See I2C Support, below.
1029
Peter Tyser9902e422008-12-17 16:36:21 -06001030- GPIO Support:
1031 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1032 CONFIG_PCA953X_INFO - enable pca953x info command
1033
Chris Packham9b383202010-12-19 10:12:13 +00001034 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1035 chip-ngpio pairs that tell the PCA953X driver the number of
1036 pins supported by a particular chip.
1037
Peter Tyser9902e422008-12-17 16:36:21 -06001038 Note that if the GPIO device uses I2C, then the I2C interface
1039 must also be configured. See I2C Support, below.
1040
wdenkc6097192002-11-03 00:24:07 +00001041- Timestamp Support:
1042
wdenk4a5c8a72003-03-06 00:02:04 +00001043 When CONFIG_TIMESTAMP is selected, the timestamp
1044 (date and time) of an image is printed by image
1045 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001046 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001047
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001048- Partition Labels (disklabels) Supported:
1049 Zero or more of the following:
1050 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1051 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1052 Intel architecture, USB sticks, etc.
1053 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1054 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1055 bootloader. Note 2TB partition limit; see
1056 disk/part_efi.c
1057 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001058
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001059 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1060 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001061 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001062
1063- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001064 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1065 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001066
wdenk369d43d2004-03-14 14:09:05 +00001067 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1068 be performed by calling the function
1069 ide_set_reset(int reset)
1070 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001071
1072- ATAPI Support:
1073 CONFIG_ATAPI
1074
1075 Set this to enable ATAPI support.
1076
wdenkf602aa02004-03-13 23:29:43 +00001077- LBA48 Support
1078 CONFIG_LBA48
1079
1080 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001081 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001082 Whithout these , LBA48 support uses 32bit variables and will 'only'
1083 support disks up to 2.1TB.
1084
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001085 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001086 When enabled, makes the IDE subsystem use 64bit sector addresses.
1087 Default is 32bit.
1088
wdenkc6097192002-11-03 00:24:07 +00001089- SCSI Support:
1090 At the moment only there is only support for the
1091 SYM53C8XX SCSI controller; define
1092 CONFIG_SCSI_SYM53C8XX to enable it.
1093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001094 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1095 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1096 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001097 maximum numbers of LUNs, SCSI ID's and target
1098 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001099 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001100
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001101 The environment variable 'scsidevs' is set to the number of
1102 SCSI devices found during the last scan.
1103
wdenkc6097192002-11-03 00:24:07 +00001104- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001105 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001106 Support for Intel 8254x/8257x gigabit chips.
1107
1108 CONFIG_E1000_SPI
1109 Utility code for direct access to the SPI bus on Intel 8257x.
1110 This does not do anything useful unless you set at least one
1111 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1112
1113 CONFIG_E1000_SPI_GENERIC
1114 Allow generic access to the SPI bus on the Intel 8257x, for
1115 example with the "sspi" command.
1116
1117 CONFIG_CMD_E1000
1118 Management command for E1000 devices. When used on devices
1119 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001120
Andre Schwarz68c2a302008-03-06 16:45:44 +01001121 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001122 default MAC for empty EEPROM after production.
Andre Schwarz68c2a302008-03-06 16:45:44 +01001123
wdenkc6097192002-11-03 00:24:07 +00001124 CONFIG_EEPRO100
1125 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001126 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001127 write routine for first time initialisation.
1128
1129 CONFIG_TULIP
1130 Support for Digital 2114x chips.
1131 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1132 modem chip initialisation (KS8761/QS6611).
1133
1134 CONFIG_NATSEMI
1135 Support for National dp83815 chips.
1136
1137 CONFIG_NS8382X
1138 Support for National dp8382[01] gigabit chips.
1139
wdenkaa603362003-05-12 21:50:16 +00001140- NETWORK Support (other):
1141
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001142 CONFIG_DRIVER_AT91EMAC
1143 Support for AT91RM9200 EMAC.
1144
1145 CONFIG_RMII
1146 Define this to use reduced MII inteface
1147
1148 CONFIG_DRIVER_AT91EMAC_QUIET
1149 If this defined, the driver is quiet.
1150 The driver doen't show link status messages.
1151
Rob Herringc9830dc2011-12-15 11:15:49 +00001152 CONFIG_CALXEDA_XGMAC
1153 Support for the Calxeda XGMAC device
1154
Ashok93fb8722012-10-15 06:20:47 +00001155 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001156 Support for SMSC's LAN91C96 chips.
1157
1158 CONFIG_LAN91C96_BASE
1159 Define this to hold the physical address
1160 of the LAN91C96's I/O space
1161
1162 CONFIG_LAN91C96_USE_32_BIT
1163 Define this to enable 32 bit addressing
1164
Ashok93fb8722012-10-15 06:20:47 +00001165 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001166 Support for SMSC's LAN91C111 chip
1167
1168 CONFIG_SMC91111_BASE
1169 Define this to hold the physical address
1170 of the device (I/O space)
1171
1172 CONFIG_SMC_USE_32_BIT
1173 Define this if data bus is 32 bits
1174
1175 CONFIG_SMC_USE_IOFUNCS
1176 Define this to use i/o functions instead of macros
1177 (some hardware wont work with macros)
1178
Heiko Schocher7d037f72011-11-15 10:00:04 -05001179 CONFIG_DRIVER_TI_EMAC
1180 Support for davinci emac
1181
1182 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1183 Define this if you have more then 3 PHYs.
1184
Macpaul Lin199c6252010-12-21 16:59:46 +08001185 CONFIG_FTGMAC100
1186 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1187
1188 CONFIG_FTGMAC100_EGIGA
1189 Define this to use GE link update with gigabit PHY.
1190 Define this if FTGMAC100 is connected to gigabit PHY.
1191 If your system has 10/100 PHY only, it might not occur
1192 wrong behavior. Because PHY usually return timeout or
1193 useless data when polling gigabit status and gigabit
1194 control registers. This behavior won't affect the
1195 correctnessof 10/100 link speed update.
1196
Mike Rapoportf4761af2009-11-11 10:03:03 +02001197 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001198 Support for SMSC's LAN911x and LAN921x chips
1199
Mike Rapoportf4761af2009-11-11 10:03:03 +02001200 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001201 Define this to hold the physical address
1202 of the device (I/O space)
1203
Mike Rapoportf4761af2009-11-11 10:03:03 +02001204 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001205 Define this if data bus is 32 bits
1206
Mike Rapoportf4761af2009-11-11 10:03:03 +02001207 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001208 Define this if data bus is 16 bits. If your processor
1209 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001210 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001211
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001212 CONFIG_SH_ETHER
1213 Support for Renesas on-chip Ethernet controller
1214
1215 CONFIG_SH_ETHER_USE_PORT
1216 Define the number of ports to be used
1217
1218 CONFIG_SH_ETHER_PHY_ADDR
1219 Define the ETH PHY's address
1220
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001221 CONFIG_SH_ETHER_CACHE_WRITEBACK
1222 If this option is set, the driver enables cache flush.
1223
Vadim Bendeburydac69642011-10-17 08:36:14 +00001224- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001225 CONFIG_TPM
1226 Support TPM devices.
1227
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001228 CONFIG_TPM_TIS_I2C
1229 Support for i2c bus TPM devices. Only one device
1230 per system is supported at this time.
1231
1232 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1233 Define the the i2c bus number for the TPM device
1234
1235 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1236 Define the TPM's address on the i2c bus
1237
1238 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1239 Define the burst count bytes upper limit
1240
Che-liang Chiouacea5702013-04-12 11:04:34 +00001241 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001242 Support for generic parallel port TPM devices. Only one device
1243 per system is supported at this time.
1244
1245 CONFIG_TPM_TIS_BASE_ADDRESS
1246 Base address where the generic TPM device is mapped
1247 to. Contemporary x86 systems usually map it at
1248 0xfed40000.
1249
Reinhard Pfau4fece432013-06-26 15:55:13 +02001250 CONFIG_CMD_TPM
1251 Add tpm monitor functions.
1252 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1253 provides monitor access to authorized functions.
1254
1255 CONFIG_TPM
1256 Define this to enable the TPM support library which provides
1257 functional interfaces to some TPM commands.
1258 Requires support for a TPM device.
1259
1260 CONFIG_TPM_AUTH_SESSIONS
1261 Define this to enable authorized functions in the TPM library.
1262 Requires CONFIG_TPM and CONFIG_SHA1.
1263
wdenkc6097192002-11-03 00:24:07 +00001264- USB Support:
1265 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001266 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001267 CONFIG_USB_UHCI to enable it.
1268 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001269 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001270 storage devices.
1271 Note:
1272 Supported are USB Keyboards and USB Floppy drives
1273 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001274 MPC5200 USB requires additional defines:
1275 CONFIG_USB_CLOCK
1276 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001277 CONFIG_PSC3_USB
1278 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001279 CONFIG_USB_CONFIG
1280 for differential drivers: 0x00001000
1281 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001282 for differential drivers on PSC3: 0x00000100
1283 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001284 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001285 May be defined to allow interrupt polling
1286 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001287
Simon Glass5978cdb2012-02-27 10:52:47 +00001288 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1289 txfilltuning field in the EHCI controller on reset.
1290
Kuo-Jung Su4e5923f2013-05-15 15:29:22 +08001291 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1292 interval for usb hub power-on delay.(minimum 100msec)
1293
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001294- USB Device:
1295 Define the below if you wish to use the USB console.
1296 Once firmware is rebuilt from a serial console issue the
1297 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001298 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001299 it has found a new device. The environment variable usbtty
1300 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001301 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001302 Common Device Class Abstract Control Model serial device.
1303 If you select usbtty = gserial you should be able to enumerate
1304 a Linux host by
1305 # modprobe usbserial vendor=0xVendorID product=0xProductID
1306 else if using cdc_acm, simply setting the environment
1307 variable usbtty to be cdc_acm should suffice. The following
1308 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001309
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001310 CONFIG_USB_DEVICE
1311 Define this to build a UDC device
1312
1313 CONFIG_USB_TTY
1314 Define this to have a tty type of device available to
1315 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001316
Vipin KUMARbdb17702012-03-26 15:38:06 +05301317 CONFIG_USBD_HS
1318 Define this to enable the high speed support for usb
1319 device and usbtty. If this feature is enabled, a routine
1320 int is_usbd_high_speed(void)
1321 also needs to be defined by the driver to dynamically poll
1322 whether the enumeration has succeded at high speed or full
1323 speed.
1324
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001325 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001326 Define this if you want stdin, stdout &/or stderr to
1327 be set to usbtty.
1328
1329 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001330 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001331 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001332 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001333
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001334 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001335 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001336 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001337
Wolfgang Denke2601822006-06-14 18:14:56 +02001338 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001339 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001340 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001341 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1342 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1343 should pretend to be a Linux device to it's target host.
1344
1345 CONFIG_USBD_MANUFACTURER
1346 Define this string as the name of your company for
1347 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001348
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001349 CONFIG_USBD_PRODUCT_NAME
1350 Define this string as the name of your product
1351 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001352
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001353 CONFIG_USBD_VENDORID
1354 Define this as your assigned Vendor ID from the USB
1355 Implementors Forum. This *must* be a genuine Vendor ID
1356 to avoid polluting the USB namespace.
1357 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001358
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001359 CONFIG_USBD_PRODUCTID
1360 Define this as the unique Product ID
1361 for your device
1362 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001363
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001364- ULPI Layer Support:
1365 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1366 the generic ULPI layer. The generic layer accesses the ULPI PHY
1367 via the platform viewport, so you need both the genric layer and
1368 the viewport enabled. Currently only Chipidea/ARC based
1369 viewport is supported.
1370 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1371 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001372 If your ULPI phy needs a different reference clock than the
1373 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1374 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001375
wdenk7a428cc2003-06-15 22:40:42 +00001376- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001377 The MMC controller on the Intel PXA is supported. To
1378 enable this define CONFIG_MMC. The MMC can be
1379 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001380 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001381 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1382 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001383
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001384 CONFIG_SH_MMCIF
1385 Support for Renesas on-chip MMCIF controller
1386
1387 CONFIG_SH_MMCIF_ADDR
1388 Define the base address of MMCIF registers
1389
1390 CONFIG_SH_MMCIF_CLK
1391 Define the clock frequency for MMCIF
1392
Tom Rini58a8d322013-03-14 05:32:47 +00001393- USB Device Firmware Update (DFU) class support:
1394 CONFIG_DFU_FUNCTION
1395 This enables the USB portion of the DFU USB class
1396
1397 CONFIG_CMD_DFU
1398 This enables the command "dfu" which is used to have
1399 U-Boot create a DFU class device via USB. This command
1400 requires that the "dfu_alt_info" environment variable be
1401 set and define the alt settings to expose to the host.
1402
1403 CONFIG_DFU_MMC
1404 This enables support for exposing (e)MMC devices via DFU.
1405
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001406 CONFIG_DFU_NAND
1407 This enables support for exposing NAND devices via DFU.
1408
Heiko Schochera2f831e2013-06-12 06:05:51 +02001409 CONFIG_SYS_DFU_DATA_BUF_SIZE
1410 Dfu transfer uses a buffer before writing data to the
1411 raw storage device. Make the size (in bytes) of this buffer
1412 configurable. The size of this buffer is also configurable
1413 through the "dfu_bufsiz" environment variable.
1414
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001415 CONFIG_SYS_DFU_MAX_FILE_SIZE
1416 When updating files rather than the raw storage device,
1417 we use a static buffer to copy the file into and then write
1418 the buffer once we've been given the whole file. Define
1419 this to the maximum filesize (in bytes) for the buffer.
1420 Default is 4 MiB if undefined.
1421
wdenkda04a8b2004-08-02 23:22:59 +00001422- Journaling Flash filesystem support:
1423 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1424 CONFIG_JFFS2_NAND_DEV
1425 Define these for a default partition on a NAND device
1426
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001427 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1428 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001429 Define these for a default partition on a NOR device
1430
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001431 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001432 Define this to create an own partition. You have to provide a
1433 function struct part_info* jffs2_part_info(int part_num)
1434
1435 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001436 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001437 to disable the command chpart. This is the default when you
1438 have not defined a custom partition
1439
Donggeun Kim8f814002011-10-24 21:15:28 +00001440- FAT(File Allocation Table) filesystem write function support:
1441 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001442
1443 Define this to enable support for saving memory data as a
1444 file in FAT formatted partition.
1445
1446 This will also enable the command "fatwrite" enabling the
1447 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001448
Gabe Black7f8574c2012-10-12 14:26:11 +00001449CBFS (Coreboot Filesystem) support
1450 CONFIG_CMD_CBFS
1451
1452 Define this to enable support for reading from a Coreboot
1453 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1454 and cbfsload.
1455
wdenkc6097192002-11-03 00:24:07 +00001456- Keyboard Support:
1457 CONFIG_ISA_KEYBOARD
1458
1459 Define this to enable standard (PC-Style) keyboard
1460 support
1461
1462 CONFIG_I8042_KBD
1463 Standard PC keyboard driver with US (is default) and
1464 GERMAN key layout (switch via environment 'keymap=de') support.
1465 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1466 for cfb_console. Supports cursor blinking.
1467
Hung-ying Tyan4a48bcf2013-05-15 18:27:32 +08001468 CONFIG_CROS_EC_KEYB
1469 Enables a Chrome OS keyboard using the CROS_EC interface.
1470 This uses CROS_EC to communicate with a second microcontroller
1471 which provides key scans on request.
1472
wdenkc6097192002-11-03 00:24:07 +00001473- Video support:
1474 CONFIG_VIDEO
1475
1476 Define this to enable video support (for output to
1477 video).
1478
1479 CONFIG_VIDEO_CT69000
1480
1481 Enable Chips & Technologies 69000 Video chip
1482
1483 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001484 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001485 video output is selected via environment 'videoout'
1486 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1487 assumed.
wdenkc6097192002-11-03 00:24:07 +00001488
wdenkd3602132004-03-25 15:14:43 +00001489 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001490 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001491 are possible:
1492 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001493 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001494
1495 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1496 -------------+---------------------------------------------
1497 8 bits | 0x301* 0x303 0x305 0x161 0x307
1498 15 bits | 0x310 0x313 0x316 0x162 0x319
1499 16 bits | 0x311 0x314 0x317 0x163 0x31A
1500 24 bits | 0x312 0x315 0x318 ? 0x31B
1501 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001502 (i.e. setenv videomode 317; saveenv; reset;)
1503
wdenkd3602132004-03-25 15:14:43 +00001504 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001505 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001506
1507
stroeseb9c17c52003-04-04 15:53:41 +00001508 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001509 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001510 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1511 or CONFIG_VIDEO_SED13806_16BPP
1512
Timur Tabi020edd22011-02-15 17:09:19 -06001513 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001514 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001515 SOCs that have a DIU should define this macro to enable DIU
1516 support, and should also define these other macros:
1517
1518 CONFIG_SYS_DIU_ADDR
1519 CONFIG_VIDEO
1520 CONFIG_CMD_BMP
1521 CONFIG_CFB_CONSOLE
1522 CONFIG_VIDEO_SW_CURSOR
1523 CONFIG_VGA_AS_SINGLE_DEVICE
1524 CONFIG_VIDEO_LOGO
1525 CONFIG_VIDEO_BMP_LOGO
1526
Timur Tabi32f709e2011-04-11 14:18:22 -05001527 The DIU driver will look for the 'video-mode' environment
1528 variable, and if defined, enable the DIU as a console during
1529 boot. See the documentation file README.video for a
1530 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001531
Simon Glass54df8ce2012-12-03 13:59:47 +00001532 CONFIG_VIDEO_VGA
1533
1534 Enable the VGA video / BIOS for x86. The alternative if you
1535 are using coreboot is to use the coreboot frame buffer
1536 driver.
1537
1538
wdenk4e112c12003-06-03 23:54:09 +00001539- Keyboard Support:
wdenk57b2d802003-06-27 21:31:46 +00001540 CONFIG_KEYBOARD
wdenk4e112c12003-06-03 23:54:09 +00001541
wdenk57b2d802003-06-27 21:31:46 +00001542 Define this to enable a custom keyboard support.
1543 This simply calls drv_keyboard_init() which must be
1544 defined in your board-specific files.
1545 The only board using this so far is RBC823.
wdenk9dd2b882002-12-03 21:28:10 +00001546
wdenkc6097192002-11-03 00:24:07 +00001547- LCD Support: CONFIG_LCD
1548
1549 Define this to enable LCD support (for output to LCD
1550 display); also select one of the supported displays
1551 by defining one of these:
1552
Stelian Popf6f86652008-05-09 21:57:18 +02001553 CONFIG_ATMEL_LCD:
1554
1555 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1556
wdenkc0d54ae2003-11-25 16:55:19 +00001557 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001558
wdenkc0d54ae2003-11-25 16:55:19 +00001559 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001560
wdenkc0d54ae2003-11-25 16:55:19 +00001561 CONFIG_NEC_NL6448BC20
1562
1563 NEC NL6448BC20-08. 6.5", 640x480.
1564 Active, color, single scan.
1565
1566 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001567
wdenkc0d54ae2003-11-25 16:55:19 +00001568 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001569 Active, color, single scan.
1570
1571 CONFIG_SHARP_16x9
1572
1573 Sharp 320x240. Active, color, single scan.
1574 It isn't 16x9, and I am not sure what it is.
1575
1576 CONFIG_SHARP_LQ64D341
1577
1578 Sharp LQ64D341 display, 640x480.
1579 Active, color, single scan.
1580
1581 CONFIG_HLD1045
1582
1583 HLD1045 display, 640x480.
1584 Active, color, single scan.
1585
1586 CONFIG_OPTREX_BW
1587
1588 Optrex CBL50840-2 NF-FW 99 22 M5
1589 or
1590 Hitachi LMG6912RPFC-00T
1591 or
1592 Hitachi SP14Q002
1593
1594 320x240. Black & white.
1595
1596 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001597 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001598
Simon Glass599a4df2012-10-17 13:24:54 +00001599 CONFIG_LCD_ALIGNMENT
1600
1601 Normally the LCD is page-aligned (tyically 4KB). If this is
1602 defined then the LCD will be aligned to this value instead.
1603 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1604 here, since it is cheaper to change data cache settings on
1605 a per-section basis.
1606
Simon Glassaf3e2802012-10-17 13:24:59 +00001607 CONFIG_CONSOLE_SCROLL_LINES
1608
1609 When the console need to be scrolled, this is the number of
1610 lines to scroll by. It defaults to 1. Increasing this makes
1611 the console jump but can help speed up operation when scrolling
1612 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001613
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001614 CONFIG_LCD_BMP_RLE8
1615
1616 Support drawing of RLE8-compressed bitmaps on the LCD.
1617
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001618 CONFIG_I2C_EDID
1619
1620 Enables an 'i2c edid' command which can read EDID
1621 information over I2C from an attached LCD display.
1622
wdenkeb20ad32003-09-05 23:19:14 +00001623- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001624
wdenk57b2d802003-06-27 21:31:46 +00001625 If this option is set, the environment is checked for
1626 a variable "splashimage". If found, the usual display
1627 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001628 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001629 specified in "splashimage" is loaded instead. The
1630 console is redirected to the "nulldev", too. This
1631 allows for a "silent" boot where a splash screen is
1632 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001633
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001634 CONFIG_SPLASHIMAGE_GUARD
1635
1636 If this option is set, then U-Boot will prevent the environment
1637 variable "splashimage" from being set to a problematic address
1638 (see README.displaying-bmps and README.arm-unaligned-accesses).
1639 This option is useful for targets where, due to alignment
1640 restrictions, an improperly aligned BMP image will cause a data
1641 abort. If you think you will not have problems with unaligned
1642 accesses (for example because your toolchain prevents them)
1643 there is no need to set this option.
1644
Matthias Weisser53884182009-07-09 16:07:30 +02001645 CONFIG_SPLASH_SCREEN_ALIGN
1646
1647 If this option is set the splash image can be freely positioned
1648 on the screen. Environment variable "splashpos" specifies the
1649 position as "x,y". If a positive number is given it is used as
1650 number of pixel from left/top. If a negative number is given it
1651 is used as number of pixel from right/bottom. You can also
1652 specify 'm' for centering the image.
1653
1654 Example:
1655 setenv splashpos m,m
1656 => image at center of screen
1657
1658 setenv splashpos 30,20
1659 => image at x = 30 and y = 20
1660
1661 setenv splashpos -10,m
1662 => vertically centered image
1663 at x = dspWidth - bmpWidth - 9
1664
Stefan Roesed9d97742005-09-22 09:04:17 +02001665- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1666
1667 If this option is set, additionally to standard BMP
1668 images, gzipped BMP images can be displayed via the
1669 splashscreen support or the bmp command.
1670
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001671- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1672
1673 If this option is set, 8-bit RLE compressed BMP images
1674 can be displayed via the splashscreen support or the
1675 bmp command.
1676
Lei Wene4e248d2012-09-28 04:26:47 +00001677- Do compresssing for memory range:
1678 CONFIG_CMD_ZIP
1679
1680 If this option is set, it would use zlib deflate method
1681 to compress the specified memory at its best effort.
1682
wdenk710e3502003-08-29 20:57:53 +00001683- Compression support:
1684 CONFIG_BZIP2
1685
1686 If this option is set, support for bzip2 compressed
1687 images is included. If not, only uncompressed and gzip
1688 compressed images are supported.
1689
wdenk9c53f402003-10-15 23:53:47 +00001690 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001691 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001692 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001693
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001694 CONFIG_LZMA
1695
1696 If this option is set, support for lzma compressed
1697 images is included.
1698
1699 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1700 requires an amount of dynamic memory that is given by the
1701 formula:
1702
1703 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1704
1705 Where lc and lp stand for, respectively, Literal context bits
1706 and Literal pos bits.
1707
1708 This value is upper-bounded by 14MB in the worst case. Anyway,
1709 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1710 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1711 a very small buffer.
1712
1713 Use the lzmainfo tool to determinate the lc and lp values and
1714 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001715 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001716
wdenk0e2bd9c2004-06-06 21:51:03 +00001717- MII/PHY support:
1718 CONFIG_PHY_ADDR
1719
1720 The address of PHY on MII bus.
1721
1722 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1723
1724 The clock frequency of the MII bus
1725
1726 CONFIG_PHY_GIGE
1727
1728 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001729 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001730
1731 CONFIG_PHY_RESET_DELAY
1732
1733 Some PHY like Intel LXT971A need extra delay after
1734 reset before any MII register access is possible.
1735 For such PHY, set this option to the usec delay
1736 required. (minimum 300usec for LXT971A)
1737
1738 CONFIG_PHY_CMD_DELAY (ppc4xx)
1739
1740 Some PHY like Intel LXT971A need extra delay after
1741 command issued before MII status register can be read
1742
wdenkc6097192002-11-03 00:24:07 +00001743- Ethernet address:
1744 CONFIG_ETHADDR
richardretanubune5167f12008-09-29 18:28:23 -04001745 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001746 CONFIG_ETH2ADDR
1747 CONFIG_ETH3ADDR
richardretanubune5167f12008-09-29 18:28:23 -04001748 CONFIG_ETH4ADDR
1749 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001750
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001751 Define a default value for Ethernet address to use
1752 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001753 is not determined automatically.
1754
1755- IP address:
1756 CONFIG_IPADDR
1757
1758 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001759 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001760 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001761 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001762
1763- Server IP address:
1764 CONFIG_SERVERIP
1765
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001766 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001767 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001768 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001769
Robin Getz470a6d42009-07-21 12:15:28 -04001770 CONFIG_KEEP_SERVERADDR
1771
1772 Keeps the server's MAC address, in the env 'serveraddr'
1773 for passing to bootargs (like Linux's netconsole option)
1774
Wolfgang Denk26da2992011-10-26 10:21:22 +00001775- Gateway IP address:
1776 CONFIG_GATEWAYIP
1777
1778 Defines a default value for the IP address of the
1779 default router where packets to other networks are
1780 sent to.
1781 (Environment variable "gatewayip")
1782
1783- Subnet mask:
1784 CONFIG_NETMASK
1785
1786 Defines a default value for the subnet mask (or
1787 routing prefix) which is used to determine if an IP
1788 address belongs to the local subnet or needs to be
1789 forwarded through a router.
1790 (Environment variable "netmask")
1791
David Updegraff7280da72007-06-11 10:41:07 -05001792- Multicast TFTP Mode:
1793 CONFIG_MCAST_TFTP
1794
1795 Defines whether you want to support multicast TFTP as per
1796 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001797 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001798 driver in use must provide a function: mcast() to join/leave a
1799 multicast group.
1800
wdenkc6097192002-11-03 00:24:07 +00001801- BOOTP Recovery Mode:
1802 CONFIG_BOOTP_RANDOM_DELAY
1803
1804 If you have many targets in a network that try to
1805 boot using BOOTP, you may want to avoid that all
1806 systems send out BOOTP requests at precisely the same
1807 moment (which would happen for instance at recovery
1808 from a power failure, when all systems will try to
1809 boot, thus flooding the BOOTP server. Defining
1810 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1811 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001812 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001813
1814 1st BOOTP request: delay 0 ... 1 sec
1815 2nd BOOTP request: delay 0 ... 2 sec
1816 3rd BOOTP request: delay 0 ... 4 sec
1817 4th and following
1818 BOOTP requests: delay 0 ... 8 sec
1819
stroesee0aadfb2003-08-28 14:17:32 +00001820- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001821 You can fine tune the DHCP functionality by defining
1822 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001823
Jon Loeliger5336a762007-07-09 22:08:34 -05001824 CONFIG_BOOTP_SUBNETMASK
1825 CONFIG_BOOTP_GATEWAY
1826 CONFIG_BOOTP_HOSTNAME
1827 CONFIG_BOOTP_NISDOMAIN
1828 CONFIG_BOOTP_BOOTPATH
1829 CONFIG_BOOTP_BOOTFILESIZE
1830 CONFIG_BOOTP_DNS
1831 CONFIG_BOOTP_DNS2
1832 CONFIG_BOOTP_SEND_HOSTNAME
1833 CONFIG_BOOTP_NTPSERVER
1834 CONFIG_BOOTP_TIMEOFFSET
1835 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001836 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001837
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001838 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1839 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001840
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001841 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1842 after the configured retry count, the call will fail
1843 instead of starting over. This can be used to fail over
1844 to Link-local IP address configuration if the DHCP server
1845 is not available.
1846
stroesee0aadfb2003-08-28 14:17:32 +00001847 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1848 serverip from a DHCP server, it is possible that more
1849 than one DNS serverip is offered to the client.
1850 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1851 serverip will be stored in the additional environment
1852 variable "dnsip2". The first DNS serverip is always
1853 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001854 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001855
1856 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1857 to do a dynamic update of a DNS server. To do this, they
1858 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001859 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001860 of the "hostname" environment variable is passed as
1861 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001862
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001863 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1864
1865 A 32bit value in microseconds for a delay between
1866 receiving a "DHCP Offer" and sending the "DHCP Request".
1867 This fixes a problem with certain DHCP servers that don't
1868 respond 100% of the time to a "DHCP request". E.g. On an
1869 AT91RM9200 processor running at 180MHz, this delay needed
1870 to be *at least* 15,000 usec before a Windows Server 2003
1871 DHCP server would reply 100% of the time. I recommend at
1872 least 50,000 usec to be safe. The alternative is to hope
1873 that one of the retries will be successful but note that
1874 the DHCP timeout and retry process takes a longer than
1875 this delay.
1876
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001877 - Link-local IP address negotiation:
1878 Negotiate with other link-local clients on the local network
1879 for an address that doesn't require explicit configuration.
1880 This is especially useful if a DHCP server cannot be guaranteed
1881 to exist in all environments that the device must operate.
1882
1883 See doc/README.link-local for more information.
1884
wdenk145d2c12004-04-15 21:48:45 +00001885 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001886 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001887
1888 The device id used in CDP trigger frames.
1889
1890 CONFIG_CDP_DEVICE_ID_PREFIX
1891
1892 A two character string which is prefixed to the MAC address
1893 of the device.
1894
1895 CONFIG_CDP_PORT_ID
1896
1897 A printf format string which contains the ascii name of
1898 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001899 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001900
1901 CONFIG_CDP_CAPABILITIES
1902
1903 A 32bit integer which indicates the device capabilities;
1904 0x00000010 for a normal host which does not forwards.
1905
1906 CONFIG_CDP_VERSION
1907
1908 An ascii string containing the version of the software.
1909
1910 CONFIG_CDP_PLATFORM
1911
1912 An ascii string containing the name of the platform.
1913
1914 CONFIG_CDP_TRIGGER
1915
1916 A 32bit integer sent on the trigger.
1917
1918 CONFIG_CDP_POWER_CONSUMPTION
1919
1920 A 16bit integer containing the power consumption of the
1921 device in .1 of milliwatts.
1922
1923 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1924
1925 A byte containing the id of the VLAN.
1926
wdenkc6097192002-11-03 00:24:07 +00001927- Status LED: CONFIG_STATUS_LED
1928
1929 Several configurations allow to display the current
1930 status using a LED. For instance, the LED will blink
1931 fast while running U-Boot code, stop blinking as
1932 soon as a reply to a BOOTP request was received, and
1933 start blinking slow once the Linux kernel is running
1934 (supported by a status LED driver in the Linux
1935 kernel). Defining CONFIG_STATUS_LED enables this
1936 feature in U-Boot.
1937
1938- CAN Support: CONFIG_CAN_DRIVER
1939
1940 Defining CONFIG_CAN_DRIVER enables CAN driver support
1941 on those systems that support this (optional)
1942 feature, like the TQM8xxL modules.
1943
1944- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1945
wdenkb9bbd242003-06-30 16:24:52 +00001946 These enable I2C serial bus commands. Defining either of
wdenk21136db2003-07-16 21:53:01 +00001947 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001948 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001949
wdenk21136db2003-07-16 21:53:01 +00001950 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001951 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00001952 CONFIG_COMMANDS) and communicate with i2c based realtime
1953 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00001954 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001955
Ben Warren45657152006-09-07 16:50:54 -04001956 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00001957
wdenk21136db2003-07-16 21:53:01 +00001958 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb9bbd242003-06-30 16:24:52 +00001959 bit-banging) driver instead of CPM or similar hardware
1960 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001961
wdenk21136db2003-07-16 21:53:01 +00001962 There are several other quantities that must also be
wdenkb9bbd242003-06-30 16:24:52 +00001963 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001964
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001965 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00001966 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001967 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001968 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00001969
Peter Tysere4d1abc2010-04-12 22:28:21 -05001970 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02001971 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05001972 and so its address should therefore be cleared to 0 (See,
1973 eg, MPC823e User's Manual p.16-473). So, set
1974 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001975
Eric Millbrandt12990a42009-09-03 08:09:44 -05001976 CONFIG_SYS_I2C_INIT_MPC5XXX
1977
1978 When a board is reset during an i2c bus transfer
1979 chips might think that the current transfer is still
1980 in progress. Reset the slave devices by sending start
1981 commands until the slave device responds.
1982
wdenk21136db2003-07-16 21:53:01 +00001983 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00001984
wdenkb9bbd242003-06-30 16:24:52 +00001985 If you use the software i2c interface (CONFIG_SOFT_I2C)
1986 then the following macros need to be defined (examples are
1987 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001988
1989 I2C_INIT
1990
wdenkb9bbd242003-06-30 16:24:52 +00001991 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00001992 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001993
wdenk544e9732004-02-06 23:19:44 +00001994 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00001995
wdenkc6097192002-11-03 00:24:07 +00001996 I2C_PORT
1997
wdenk4a5c8a72003-03-06 00:02:04 +00001998 (Only for MPC8260 CPU). The I/O port to use (the code
1999 assumes both bits are on the same port). Valid values
2000 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002001
2002 I2C_ACTIVE
2003
2004 The code necessary to make the I2C data line active
2005 (driven). If the data line is open collector, this
2006 define can be null.
2007
wdenkb9bbd242003-06-30 16:24:52 +00002008 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2009
wdenkc6097192002-11-03 00:24:07 +00002010 I2C_TRISTATE
2011
2012 The code necessary to make the I2C data line tri-stated
2013 (inactive). If the data line is open collector, this
2014 define can be null.
2015
wdenkb9bbd242003-06-30 16:24:52 +00002016 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2017
wdenkc6097192002-11-03 00:24:07 +00002018 I2C_READ
2019
York Sun4a598092013-04-01 11:29:11 -07002020 Code that returns true if the I2C data line is high,
2021 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002022
wdenkb9bbd242003-06-30 16:24:52 +00002023 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2024
wdenkc6097192002-11-03 00:24:07 +00002025 I2C_SDA(bit)
2026
York Sun4a598092013-04-01 11:29:11 -07002027 If <bit> is true, sets the I2C data line high. If it
2028 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002029
wdenkb9bbd242003-06-30 16:24:52 +00002030 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002031 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002032 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002033
wdenkc6097192002-11-03 00:24:07 +00002034 I2C_SCL(bit)
2035
York Sun4a598092013-04-01 11:29:11 -07002036 If <bit> is true, sets the I2C clock line high. If it
2037 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002038
wdenkb9bbd242003-06-30 16:24:52 +00002039 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002040 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002041 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002042
wdenkc6097192002-11-03 00:24:07 +00002043 I2C_DELAY
2044
2045 This delay is invoked four times per clock cycle so this
2046 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002047 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002048 like:
2049
wdenkb9bbd242003-06-30 16:24:52 +00002050 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002051
Mike Frysingeree12d542010-07-21 13:38:02 -04002052 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2053
2054 If your arch supports the generic GPIO framework (asm/gpio.h),
2055 then you may alternatively define the two GPIOs that are to be
2056 used as SCL / SDA. Any of the previous I2C_xxx macros will
2057 have GPIO-based defaults assigned to them as appropriate.
2058
2059 You should define these to the GPIO value as given directly to
2060 the generic GPIO functions.
2061
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002062 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002063
wdenk57b2d802003-06-27 21:31:46 +00002064 When a board is reset during an i2c bus transfer
2065 chips might think that the current transfer is still
2066 in progress. On some boards it is possible to access
2067 the i2c SCLK line directly, either by using the
2068 processor pin as a GPIO or by having a second pin
2069 connected to the bus. If this option is defined a
2070 custom i2c_init_board() routine in boards/xxx/board.c
2071 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002072
Richard Retanubundf0149c2010-04-12 15:08:17 -04002073 CONFIG_SYS_I2C_BOARD_LATE_INIT
2074
2075 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2076 defined a custom i2c_board_late_init() routine in
2077 boards/xxx/board.c is run AFTER the operations in i2c_init()
2078 is completed. This callpoint can be used to unreset i2c bus
2079 using CPU i2c controller register accesses for CPUs whose i2c
2080 controller provide such a method. It is called at the end of
2081 i2c_init() to allow i2c_init operations to setup the i2c bus
2082 controller on the CPU (e.g. setting bus speed & slave address).
2083
wdenk0e2bd9c2004-06-06 21:51:03 +00002084 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2085
2086 This option enables configuration of bi_iic_fast[] flags
2087 in u-boot bd_info structure based on u-boot environment
2088 variable "i2cfast". (see also i2cfast)
2089
Ben Warren45657152006-09-07 16:50:54 -04002090 CONFIG_I2C_MULTI_BUS
2091
2092 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002093 must have a controller. At any point in time, only one bus is
2094 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002095 Note that bus numbering is zero-based.
2096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002097 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002098
2099 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002100 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002101 is set, specify a list of bus-device pairs. Otherwise, specify
2102 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002103
2104 e.g.
2105 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002106 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002107
2108 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2109
Wolfgang Denk092ae952011-10-26 10:21:21 +00002110 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002111 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002112
2113 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2114
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002115 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002116
2117 If defined, then this indicates the I2C bus number for DDR SPD.
2118 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2119
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002120 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002121
2122 If defined, then this indicates the I2C bus number for the RTC.
2123 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2124
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002125 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002126
2127 If defined, then this indicates the I2C bus number for the DTT.
2128 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2129
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002130 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002131
2132 If defined, specifies the I2C address of the DTT device.
2133 If not defined, then U-Boot uses predefined value for
2134 specified DTT device.
2135
Timur Tabiab347542006-11-03 19:15:00 -06002136 CONFIG_FSL_I2C
2137
2138 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswileraea68562007-12-30 03:30:46 +01002139 drivers/i2c/fsl_i2c.c.
Timur Tabiab347542006-11-03 19:15:00 -06002140
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002141 CONFIG_I2C_MUX
2142
2143 Define this option if you have I2C devices reached over 1 .. n
2144 I2C Muxes like the pca9544a. This option addes a new I2C
2145 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2146 new I2C Bus to the existing I2C Busses. If you select the
2147 new Bus with "i2c dev", u-bbot sends first the commandos for
2148 the muxes to activate this new "bus".
2149
2150 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2151 feature!
2152
2153 Example:
2154 Adding a new I2C Bus reached over 2 pca9544a muxes
2155 The First mux with address 70 and channel 6
2156 The Second mux with address 71 and channel 4
2157
2158 => i2c bus pca9544a:70:6:pca9544a:71:4
2159
2160 Use the "i2c bus" command without parameter, to get a list
2161 of I2C Busses with muxes:
2162
2163 => i2c bus
2164 Busses reached over muxes:
2165 Bus ID: 2
2166 reached over Mux(es):
2167 pca9544a@70 ch: 4
2168 Bus ID: 3
2169 reached over Mux(es):
2170 pca9544a@70 ch: 6
2171 pca9544a@71 ch: 4
2172 =>
2173
2174 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002175 u-boot first sends the command to the mux@70 to enable
2176 channel 6, and then the command to the mux@71 to enable
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002177 the channel 4.
2178
2179 After that, you can use the "normal" i2c commands as
Michael Jones9c5ef8d2011-07-14 22:09:28 +00002180 usual to communicate with your I2C devices behind
Heiko Schocher6ee861b2008-10-15 09:39:47 +02002181 the 2 muxes.
2182
2183 This option is actually implemented for the bitbanging
2184 algorithm in common/soft_i2c.c and for the Hardware I2C
2185 Bus on the MPC8260. But it should be not so difficult
2186 to add this option to other architectures.
2187
Andrew Dyer58c41f92008-12-29 17:36:01 -06002188 CONFIG_SOFT_I2C_READ_REPEATED_START
2189
2190 defining this will force the i2c_read() function in
2191 the soft_i2c driver to perform an I2C repeated start
2192 between writing the address pointer and reading the
2193 data. If this define is omitted the default behaviour
2194 of doing a stop-start sequence will be used. Most I2C
2195 devices can use either method, but some require one or
2196 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002197
wdenkc6097192002-11-03 00:24:07 +00002198- SPI Support: CONFIG_SPI
2199
2200 Enables SPI driver (so far only tested with
2201 SPI EEPROM, also an instance works with Crystal A/D and
2202 D/As on the SACSng board)
2203
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002204 CONFIG_SH_SPI
2205
2206 Enables the driver for SPI controller on SuperH. Currently
2207 only SH7757 is supported.
2208
wdenkc6097192002-11-03 00:24:07 +00002209 CONFIG_SPI_X
2210
2211 Enables extended (16-bit) SPI EEPROM addressing.
2212 (symmetrical to CONFIG_I2C_X)
2213
2214 CONFIG_SOFT_SPI
2215
wdenk4a5c8a72003-03-06 00:02:04 +00002216 Enables a software (bit-bang) SPI driver rather than
2217 using hardware support. This is a general purpose
2218 driver that only requires three general I/O port pins
2219 (two outputs, one input) to function. If this is
2220 defined, the board configuration must define several
2221 SPI configuration items (port pins to use, etc). For
2222 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002223
Ben Warren7efe9272008-01-16 22:37:35 -05002224 CONFIG_HARD_SPI
2225
2226 Enables a hardware SPI driver for general-purpose reads
2227 and writes. As with CONFIG_SOFT_SPI, the board configuration
2228 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002229 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002230 example, see include/configs/mpc8349emds.h.
2231
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002232 CONFIG_MXC_SPI
2233
2234 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002235 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002236
Matthias Fuchsa4400872007-12-27 17:12:34 +01002237- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002238
Matthias Fuchsa4400872007-12-27 17:12:34 +01002239 Enables FPGA subsystem.
2240
2241 CONFIG_FPGA_<vendor>
2242
2243 Enables support for specific chip vendors.
2244 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002245
Matthias Fuchsa4400872007-12-27 17:12:34 +01002246 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002247
Matthias Fuchsa4400872007-12-27 17:12:34 +01002248 Enables support for FPGA family.
2249 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2250
2251 CONFIG_FPGA_COUNT
2252
2253 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002255 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002256
wdenk57b2d802003-06-27 21:31:46 +00002257 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002258
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002259 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002260
wdenk4a5c8a72003-03-06 00:02:04 +00002261 Enable checks on FPGA configuration interface busy
2262 status by the configuration function. This option
2263 will require a board or device specific function to
2264 be written.
wdenkc6097192002-11-03 00:24:07 +00002265
2266 CONFIG_FPGA_DELAY
2267
2268 If defined, a function that provides delays in the FPGA
2269 configuration driver.
2270
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002271 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002272 Allow Control-C to interrupt FPGA configuration
2273
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002274 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002275
wdenk4a5c8a72003-03-06 00:02:04 +00002276 Check for configuration errors during FPGA bitfile
2277 loading. For example, abort during Virtex II
2278 configuration if the INIT_B line goes low (which
2279 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002281 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002282
wdenk4a5c8a72003-03-06 00:02:04 +00002283 Maximum time to wait for the INIT_B line to deassert
2284 after PROB_B has been deasserted during a Virtex II
2285 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002286 ms.
wdenkc6097192002-11-03 00:24:07 +00002287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002288 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002289
wdenk4a5c8a72003-03-06 00:02:04 +00002290 Maximum time to wait for BUSY to deassert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002291 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002293 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002294
wdenk4a5c8a72003-03-06 00:02:04 +00002295 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002296 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002297
2298- Configuration Management:
2299 CONFIG_IDENT_STRING
2300
wdenk4a5c8a72003-03-06 00:02:04 +00002301 If defined, this string will be added to the U-Boot
2302 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002303
2304- Vendor Parameter Protection:
2305
wdenk4a5c8a72003-03-06 00:02:04 +00002306 U-Boot considers the values of the environment
2307 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002308 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002309 are set once by the board vendor / manufacturer, and
2310 protects these variables from casual modification by
2311 the user. Once set, these variables are read-only,
2312 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002313 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002314
2315 If CONFIG_ENV_OVERWRITE is #defined in your config
2316 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002317 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002318 these parameters.
2319
2320 Alternatively, if you #define _both_ CONFIG_ETHADDR
2321 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002322 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002323 which can be changed exactly ONCE by the user. [The
2324 serial# is unaffected by this, i. e. it remains
2325 read-only.]
2326
Joe Hershberger71497d02012-12-11 22:16:31 -06002327 The same can be accomplished in a more flexible way
2328 for any variable by configuring the type of access
2329 to allow for those variables in the ".flags" variable
2330 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2331
wdenkc6097192002-11-03 00:24:07 +00002332- Protected RAM:
2333 CONFIG_PRAM
2334
2335 Define this variable to enable the reservation of
2336 "protected RAM", i. e. RAM which is not overwritten
2337 by U-Boot. Define CONFIG_PRAM to hold the number of
2338 kB you want to reserve for pRAM. You can overwrite
2339 this default value by defining an environment
2340 variable "pram" to the number of kB you want to
2341 reserve. Note that the board info structure will
2342 still show the full amount of RAM. If pRAM is
2343 reserved, a new environment variable "mem" will
2344 automatically be defined to hold the amount of
2345 remaining RAM in a form that can be passed as boot
2346 argument to Linux, for instance like that:
2347
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002348 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002349 saveenv
2350
2351 This way you can tell Linux not to use this memory,
2352 either, which results in a memory region that will
2353 not be affected by reboots.
2354
2355 *WARNING* If your board configuration uses automatic
2356 detection of the RAM size, you must make sure that
2357 this memory test is non-destructive. So far, the
2358 following board configurations are known to be
2359 "pRAM-clean":
2360
Wolfgang Denk90326762012-10-24 02:36:15 +00002361 IVMS8, IVML24, SPD8xx, TQM8xxL,
2362 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002363 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002364
Gabe Blacka2f3a932012-12-02 04:55:18 +00002365- Access to physical memory region (> 4GB)
2366 Some basic support is provided for operations on memory not
2367 normally accessible to U-Boot - e.g. some architectures
2368 support access to more than 4GB of memory on 32-bit
2369 machines using physical address extension or similar.
2370 Define CONFIG_PHYSMEM to access this basic support, which
2371 currently only supports clearing the memory.
2372
wdenkc6097192002-11-03 00:24:07 +00002373- Error Recovery:
2374 CONFIG_PANIC_HANG
2375
2376 Define this variable to stop the system in case of a
2377 fatal error, so that you have to reset it manually.
2378 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002379 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002380 automatically as fast as possible, but it may be
2381 useful during development since you can try to debug
2382 the conditions that lead to the situation.
2383
2384 CONFIG_NET_RETRY_COUNT
2385
wdenk4a5c8a72003-03-06 00:02:04 +00002386 This variable defines the number of retries for
2387 network operations like ARP, RARP, TFTP, or BOOTP
2388 before giving up the operation. If not defined, a
2389 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002390
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002391 CONFIG_ARP_TIMEOUT
2392
2393 Timeout waiting for an ARP reply in milliseconds.
2394
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002395 CONFIG_NFS_TIMEOUT
2396
2397 Timeout in milliseconds used in NFS protocol.
2398 If you encounter "ERROR: Cannot umount" in nfs command,
2399 try longer timeout such as
2400 #define CONFIG_NFS_TIMEOUT 10000UL
2401
wdenkc6097192002-11-03 00:24:07 +00002402- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002403 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002404
2405 Enable auto completion of commands using TAB.
2406
Wolfgang Denk018147d2006-11-27 15:32:42 +01002407 Note that this feature has NOT been implemented yet
2408 for the "hush" shell.
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002409
2410
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002411 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002412
2413 Define this variable to enable the "hush" shell (from
2414 Busybox) as command line interpreter, thus enabling
2415 powerful command line syntax like
2416 if...then...else...fi conditionals or `&&' and '||'
2417 constructs ("shell scripts").
2418
2419 If undefined, you get the old, much simpler behaviour
2420 with a somewhat smaller memory footprint.
2421
2422
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002423 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002424
2425 This defines the secondary prompt string, which is
2426 printed when the command interpreter needs more input
2427 to complete a command. Usually "> ".
2428
2429 Note:
2430
wdenk57b2d802003-06-27 21:31:46 +00002431 In the current implementation, the local variables
2432 space and global environment variables space are
2433 separated. Local variables are those you define by
2434 simply typing `name=value'. To access a local
2435 variable later on, you have write `$name' or
2436 `${name}'; to execute the contents of a variable
2437 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002438
wdenk4a5c8a72003-03-06 00:02:04 +00002439 Global environment variables are those you use
2440 setenv/printenv to work with. To run a command stored
2441 in such a variable, you need to use the run command,
2442 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002443
2444 To store commands and special characters in a
2445 variable, please use double quotation marks
2446 surrounding the whole text of the variable, instead
2447 of the backslashes before semicolons and special
2448 symbols.
2449
Wolfgang Denk2039a072006-07-21 11:35:21 +02002450- Commandline Editing and History:
2451 CONFIG_CMDLINE_EDITING
2452
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002453 Enable editing and History functions for interactive
Wolfgang Denkc80857e2006-07-21 11:56:05 +02002454 commandline input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002455
wdenkc0aa5c52003-12-06 19:49:23 +00002456- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002457 CONFIG_EXTRA_ENV_SETTINGS
2458
wdenk4a5c8a72003-03-06 00:02:04 +00002459 Define this to contain any number of null terminated
2460 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002461 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002462
wdenk4a5c8a72003-03-06 00:02:04 +00002463 For example, place something like this in your
2464 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002465
2466 #define CONFIG_EXTRA_ENV_SETTINGS \
2467 "myvar1=value1\0" \
2468 "myvar2=value2\0"
2469
wdenk4a5c8a72003-03-06 00:02:04 +00002470 Warning: This method is based on knowledge about the
2471 internal format how the environment is stored by the
2472 U-Boot code. This is NOT an official, exported
2473 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002474 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002475 You better know what you are doing here.
2476
wdenk4a5c8a72003-03-06 00:02:04 +00002477 Note: overly (ab)use of the default environment is
2478 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002479 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002480 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002481
Stephen Warren1465d5f2012-05-22 09:21:54 +00002482 CONFIG_ENV_VARS_UBOOT_CONFIG
2483
2484 Define this in order to add variables describing the
2485 U-Boot build configuration to the default environment.
2486 These will be named arch, cpu, board, vendor, and soc.
2487
2488 Enabling this option will cause the following to be defined:
2489
2490 - CONFIG_SYS_ARCH
2491 - CONFIG_SYS_CPU
2492 - CONFIG_SYS_BOARD
2493 - CONFIG_SYS_VENDOR
2494 - CONFIG_SYS_SOC
2495
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002496 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2497
2498 Define this in order to add variables describing certain
2499 run-time determined information about the hardware to the
2500 environment. These will be named board_name, board_rev.
2501
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002502 CONFIG_DELAY_ENVIRONMENT
2503
2504 Normally the environment is loaded when the board is
2505 intialised so that it is available to U-Boot. This inhibits
2506 that so that the environment is not available until
2507 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2508 this is instead controlled by the value of
2509 /config/load-environment.
2510
wdenkc0aa5c52003-12-06 19:49:23 +00002511- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002512 CONFIG_HAS_DATAFLASH
2513
wdenk57b2d802003-06-27 21:31:46 +00002514 Defining this option enables DataFlash features and
2515 allows to read/write in Dataflash via the standard
2516 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002517
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002518- Serial Flash support
2519 CONFIG_CMD_SF
2520
2521 Defining this option enables SPI flash commands
2522 'sf probe/read/write/erase/update'.
2523
2524 Usage requires an initial 'probe' to define the serial
2525 flash parameters, followed by read/write/erase/update
2526 commands.
2527
2528 The following defaults may be provided by the platform
2529 to handle the common case when only a single serial
2530 flash is present on the system.
2531
2532 CONFIG_SF_DEFAULT_BUS Bus identifier
2533 CONFIG_SF_DEFAULT_CS Chip-select
2534 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2535 CONFIG_SF_DEFAULT_SPEED in Hz
2536
Simon Glass4b5545e2012-10-08 13:16:02 +00002537 CONFIG_CMD_SF_TEST
2538
2539 Define this option to include a destructive SPI flash
2540 test ('sf test').
2541
Jagannadha Sutradharudu Tekic6d173d2013-06-19 15:33:58 +05302542 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2543
2544 Define this option to use the Bank addr/Extended addr
2545 support on SPI flashes which has size > 16Mbytes.
2546
wdenkef893942004-02-23 16:11:30 +00002547- SystemACE Support:
2548 CONFIG_SYSTEMACE
2549
2550 Adding this option adds support for Xilinx SystemACE
2551 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002552 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002553 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002554
2555 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002556 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002557
2558 When SystemACE support is added, the "ace" device type
2559 becomes available to the fat commands, i.e. fatls.
2560
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002561- TFTP Fixed UDP Port:
2562 CONFIG_TFTP_PORT
2563
Wolfgang Denk227b5192005-09-24 23:25:46 +02002564 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002565 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002566 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002567 number generator is used.
2568
Wolfgang Denk227b5192005-09-24 23:25:46 +02002569 Also, the environment variable tftpdstp is used to supply
2570 the TFTP UDP destination port value. If tftpdstp isn't
2571 defined, the normal port 69 is used.
2572
2573 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002574 blindly start the TFTP transfer using the pre-configured
2575 target IP address and UDP port. This has the effect of
2576 "punching through" the (Windows XP) firewall, allowing
2577 the remainder of the TFTP transfer to proceed normally.
2578 A better solution is to properly configure the firewall,
2579 but sometimes that is not allowed.
2580
Simon Glass058bb8d2012-12-05 14:46:38 +00002581- Hashing support:
2582 CONFIG_CMD_HASH
2583
2584 This enables a generic 'hash' command which can produce
2585 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2586
2587 CONFIG_HASH_VERIFY
2588
2589 Enable the hash verify command (hash -v). This adds to code
2590 size a little.
2591
2592 CONFIG_SHA1 - support SHA1 hashing
2593 CONFIG_SHA256 - support SHA256 hashing
2594
2595 Note: There is also a sha1sum command, which should perhaps
2596 be deprecated in favour of 'hash sha1'.
2597
Simon Glass35191a32013-06-13 15:10:02 -07002598- Signing support:
2599 CONFIG_RSA
2600
2601 This enables the RSA algorithm used for FIT image verification
2602 in U-Boot. See doc/uImage/signature for more information.
2603
2604 The signing part is build into mkimage regardless of this
2605 option.
2606
2607
wdenkc0aa5c52003-12-06 19:49:23 +00002608- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002609 CONFIG_SHOW_BOOT_PROGRESS
2610
wdenk4a5c8a72003-03-06 00:02:04 +00002611 Defining this option allows to add some board-
2612 specific code (calling a user-provided function
2613 "show_boot_progress(int)") that enables you to show
2614 the system's boot progress on some display (for
2615 example, some LED's) on your board. At the moment,
2616 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002617
Simon Glass31a870e2012-02-13 13:51:19 +00002618- Detailed boot stage timing
2619 CONFIG_BOOTSTAGE
2620 Define this option to get detailed timing of each stage
2621 of the boot process.
2622
2623 CONFIG_BOOTSTAGE_USER_COUNT
2624 This is the number of available user bootstage records.
2625 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2626 a new ID will be allocated from this stash. If you exceed
2627 the limit, recording will stop.
2628
2629 CONFIG_BOOTSTAGE_REPORT
2630 Define this to print a report before boot, similar to this:
2631
2632 Timer summary in microseconds:
2633 Mark Elapsed Stage
2634 0 0 reset
2635 3,575,678 3,575,678 board_init_f start
2636 3,575,695 17 arch_cpu_init A9
2637 3,575,777 82 arch_cpu_init done
2638 3,659,598 83,821 board_init_r start
2639 3,910,375 250,777 main_loop
2640 29,916,167 26,005,792 bootm_start
2641 30,361,327 445,160 start_kernel
2642
Simon Glass4afd88e2012-09-28 08:56:39 +00002643 CONFIG_CMD_BOOTSTAGE
2644 Add a 'bootstage' command which supports printing a report
2645 and un/stashing of bootstage data.
2646
Simon Glass0fa36a42012-09-28 08:56:37 +00002647 CONFIG_BOOTSTAGE_FDT
2648 Stash the bootstage information in the FDT. A root 'bootstage'
2649 node is created with each bootstage id as a child. Each child
2650 has a 'name' property and either 'mark' containing the
2651 mark time in microsecond, or 'accum' containing the
2652 accumulated time for that bootstage id in microseconds.
2653 For example:
2654
2655 bootstage {
2656 154 {
2657 name = "board_init_f";
2658 mark = <3575678>;
2659 };
2660 170 {
2661 name = "lcd";
2662 accum = <33482>;
2663 };
2664 };
2665
2666 Code in the Linux kernel can find this in /proc/devicetree.
2667
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002668Legacy uImage format:
2669
wdenkc6097192002-11-03 00:24:07 +00002670 Arg Where When
2671 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002672 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002673 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002674 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002675 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002676 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002677 4 common/cmd_bootm.c Image data has correct checksum
2678 -4 common/cmd_bootm.c Image is for unsupported architecture
2679 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002680 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002681 6 common/cmd_bootm.c Image Type check OK
2682 -6 common/cmd_bootm.c gunzip uncompression error
2683 -7 common/cmd_bootm.c Unimplemented compression type
2684 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002685 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002686 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002687
2688 9 common/image.c Start initial ramdisk verification
2689 -10 common/image.c Ramdisk header has bad magic number
2690 -11 common/image.c Ramdisk header has bad checksum
2691 10 common/image.c Ramdisk header is OK
2692 -12 common/image.c Ramdisk data has bad checksum
2693 11 common/image.c Ramdisk data has correct checksum
2694 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002695 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002696 13 common/image.c Start multifile image verification
2697 14 common/image.c No initial ramdisk, no multifile, continue.
2698
Wolfgang Denk092ae952011-10-26 10:21:21 +00002699 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002700
Stefan Roese88fbf932010-04-15 16:07:28 +02002701 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002702 -31 post/post.c POST test failed, detected by post_output_backlog()
2703 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002704
Heiko Schocher633e03a2007-06-22 19:11:54 +02002705 34 common/cmd_doc.c before loading a Image from a DOC device
2706 -35 common/cmd_doc.c Bad usage of "doc" command
2707 35 common/cmd_doc.c correct usage of "doc" command
2708 -36 common/cmd_doc.c No boot device
2709 36 common/cmd_doc.c correct boot device
2710 -37 common/cmd_doc.c Unknown Chip ID on boot device
2711 37 common/cmd_doc.c correct chip ID found, device available
2712 -38 common/cmd_doc.c Read Error on boot device
2713 38 common/cmd_doc.c reading Image header from DOC device OK
2714 -39 common/cmd_doc.c Image header has bad magic number
2715 39 common/cmd_doc.c Image header has correct magic number
2716 -40 common/cmd_doc.c Error reading Image from DOC device
2717 40 common/cmd_doc.c Image header has correct magic number
2718 41 common/cmd_ide.c before loading a Image from a IDE device
2719 -42 common/cmd_ide.c Bad usage of "ide" command
2720 42 common/cmd_ide.c correct usage of "ide" command
2721 -43 common/cmd_ide.c No boot device
2722 43 common/cmd_ide.c boot device found
2723 -44 common/cmd_ide.c Device not available
2724 44 common/cmd_ide.c Device available
2725 -45 common/cmd_ide.c wrong partition selected
2726 45 common/cmd_ide.c partition selected
2727 -46 common/cmd_ide.c Unknown partition table
2728 46 common/cmd_ide.c valid partition table found
2729 -47 common/cmd_ide.c Invalid partition type
2730 47 common/cmd_ide.c correct partition type
2731 -48 common/cmd_ide.c Error reading Image Header on boot device
2732 48 common/cmd_ide.c reading Image Header from IDE device OK
2733 -49 common/cmd_ide.c Image header has bad magic number
2734 49 common/cmd_ide.c Image header has correct magic number
2735 -50 common/cmd_ide.c Image header has bad checksum
2736 50 common/cmd_ide.c Image header has correct checksum
2737 -51 common/cmd_ide.c Error reading Image from IDE device
2738 51 common/cmd_ide.c reading Image from IDE device OK
2739 52 common/cmd_nand.c before loading a Image from a NAND device
2740 -53 common/cmd_nand.c Bad usage of "nand" command
2741 53 common/cmd_nand.c correct usage of "nand" command
2742 -54 common/cmd_nand.c No boot device
2743 54 common/cmd_nand.c boot device found
2744 -55 common/cmd_nand.c Unknown Chip ID on boot device
2745 55 common/cmd_nand.c correct chip ID found, device available
2746 -56 common/cmd_nand.c Error reading Image Header on boot device
2747 56 common/cmd_nand.c reading Image Header from NAND device OK
2748 -57 common/cmd_nand.c Image header has bad magic number
2749 57 common/cmd_nand.c Image header has correct magic number
2750 -58 common/cmd_nand.c Error reading Image from NAND device
2751 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002752
Heiko Schocher633e03a2007-06-22 19:11:54 +02002753 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002754
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002755 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002756 -64 net/eth.c no Ethernet found.
2757 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002758
Heiko Schocher633e03a2007-06-22 19:11:54 +02002759 -80 common/cmd_net.c usage wrong
2760 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002761 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher633e03a2007-06-22 19:11:54 +02002762 81 common/cmd_net.c NetLoop() back without error
2763 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2764 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002765 83 common/cmd_net.c running "source" command
2766 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002767 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002768
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002769FIT uImage format:
2770
2771 Arg Where When
2772 100 common/cmd_bootm.c Kernel FIT Image has correct format
2773 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2774 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2775 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2776 102 common/cmd_bootm.c Kernel unit name specified
2777 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002778 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002779 104 common/cmd_bootm.c Got kernel subimage node offset
2780 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2781 105 common/cmd_bootm.c Kernel subimage hash verification OK
2782 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2783 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002784 -106 common/cmd_bootm.c Kernel subimage has wrong type
2785 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002786 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2787 108 common/cmd_bootm.c Got kernel subimage data/size
2788 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2789 -109 common/cmd_bootm.c Can't get kernel subimage type
2790 -110 common/cmd_bootm.c Can't get kernel subimage comp
2791 -111 common/cmd_bootm.c Can't get kernel subimage os
2792 -112 common/cmd_bootm.c Can't get kernel subimage load address
2793 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2794
2795 120 common/image.c Start initial ramdisk verification
2796 -120 common/image.c Ramdisk FIT image has incorrect format
2797 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002798 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002799 -122 common/image.c Can't get configuration for ramdisk subimage
2800 123 common/image.c Ramdisk unit name specified
2801 -124 common/image.c Can't get ramdisk subimage node offset
2802 125 common/image.c Got ramdisk subimage node offset
2803 -125 common/image.c Ramdisk subimage hash verification failed
2804 126 common/image.c Ramdisk subimage hash verification OK
2805 -126 common/image.c Ramdisk subimage for unsupported architecture
2806 127 common/image.c Architecture check OK
2807 -127 common/image.c Can't get ramdisk subimage data/size
2808 128 common/image.c Got ramdisk subimage data/size
2809 129 common/image.c Can't get ramdisk load address
2810 -129 common/image.c Got ramdisk load address
2811
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002812 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002813 131 common/cmd_doc.c FIT image format OK
2814
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002815 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002816 141 common/cmd_ide.c FIT image format OK
2817
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002818 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002819 151 common/cmd_nand.c FIT image format OK
2820
Gabe Blackd572e162012-10-25 16:31:10 +00002821- FIT image support:
2822 CONFIG_FIT
2823 Enable support for the FIT uImage format.
2824
2825 CONFIG_FIT_BEST_MATCH
2826 When no configuration is explicitly selected, default to the
2827 one whose fdt's compatibility field best matches that of
2828 U-Boot itself. A match is considered "best" if it matches the
2829 most specific compatibility entry of U-Boot's fdt's root node.
2830 The order of entries in the configuration's fdt is ignored.
2831
Simon Glass58fe7e52013-06-13 15:10:00 -07002832 CONFIG_FIT_SIGNATURE
2833 This option enables signature verification of FIT uImages,
2834 using a hash signed and verified using RSA. See
2835 doc/uImage.FIT/signature.txt for more details.
2836
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002837- Standalone program support:
2838 CONFIG_STANDALONE_LOAD_ADDR
2839
Wolfgang Denk23f78482011-10-09 21:06:34 +02002840 This option defines a board specific value for the
2841 address where standalone program gets loaded, thus
2842 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002843 settings.
2844
2845- Frame Buffer Address:
2846 CONFIG_FB_ADDR
2847
2848 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002849 address for frame buffer. This is typically the case
2850 when using a graphics controller has separate video
2851 memory. U-Boot will then place the frame buffer at
2852 the given address instead of dynamically reserving it
2853 in system RAM by calling lcd_setmem(), which grabs
2854 the memory for the frame buffer depending on the
2855 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002856
2857 Please see board_init_f function.
2858
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002859- Automatic software updates via TFTP server
2860 CONFIG_UPDATE_TFTP
2861 CONFIG_UPDATE_TFTP_CNT_MAX
2862 CONFIG_UPDATE_TFTP_MSEC_MAX
2863
2864 These options enable and control the auto-update feature;
2865 for a more detailed description refer to doc/README.update.
2866
2867- MTD Support (mtdparts command, UBI support)
2868 CONFIG_MTD_DEVICE
2869
2870 Adds the MTD device infrastructure from the Linux kernel.
2871 Needed for mtdparts command support.
2872
2873 CONFIG_MTD_PARTITIONS
2874
2875 Adds the MTD partitioning infrastructure from the Linux
2876 kernel. Needed for UBI support.
2877
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002878- UBI support
2879 CONFIG_CMD_UBI
2880
2881 Adds commands for interacting with MTD partitions formatted
2882 with the UBI flash translation layer
2883
2884 Requires also defining CONFIG_RBTREE
2885
Joe Hershberger47550fc2013-04-08 10:32:49 +00002886 CONFIG_UBI_SILENCE_MSG
2887
2888 Make the verbose messages from UBI stop printing. This leaves
2889 warnings and errors enabled.
2890
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002891- UBIFS support
2892 CONFIG_CMD_UBIFS
2893
2894 Adds commands for interacting with UBI volumes formatted as
2895 UBIFS. UBIFS is read-only in u-boot.
2896
2897 Requires UBI support as well as CONFIG_LZO
2898
Joe Hershberger47550fc2013-04-08 10:32:49 +00002899 CONFIG_UBIFS_SILENCE_MSG
2900
2901 Make the verbose messages from UBIFS stop printing. This leaves
2902 warnings and errors enabled.
2903
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002904- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002905 CONFIG_SPL
2906 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002907
Tom Rini36853852012-02-14 07:29:40 +00002908 CONFIG_SPL_LDSCRIPT
2909 LDSCRIPT for linking the SPL binary.
2910
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002911 CONFIG_SPL_MAX_FOOTPRINT
2912 Maximum size in memory allocated to the SPL, BSS included.
2913 When defined, the linker checks that the actual memory
2914 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002915 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002916 must not be both defined at the same time.
2917
Tom Rini36853852012-02-14 07:29:40 +00002918 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002919 Maximum size of the SPL image (text, data, rodata, and
2920 linker lists sections), BSS excluded.
2921 When defined, the linker checks that the actual size does
2922 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00002923
Wolfgang Denk825223d2011-09-11 21:24:09 +02002924 CONFIG_SPL_TEXT_BASE
2925 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002926
Scott Woodc4f0d002012-09-20 19:05:12 -05002927 CONFIG_SPL_RELOC_TEXT_BASE
2928 Address to relocate to. If unspecified, this is equal to
2929 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2930
Tom Rini36853852012-02-14 07:29:40 +00002931 CONFIG_SPL_BSS_START_ADDR
2932 Link address for the BSS within the SPL binary.
2933
2934 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002935 Maximum size in memory allocated to the SPL BSS.
2936 When defined, the linker checks that the actual memory used
2937 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002938 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002939 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00002940
2941 CONFIG_SPL_STACK
2942 Adress of the start of the stack SPL will use
2943
Scott Woodc4f0d002012-09-20 19:05:12 -05002944 CONFIG_SPL_RELOC_STACK
2945 Adress of the start of the stack SPL will use after
2946 relocation. If unspecified, this is equal to
2947 CONFIG_SPL_STACK.
2948
Tom Rini36853852012-02-14 07:29:40 +00002949 CONFIG_SYS_SPL_MALLOC_START
2950 Starting address of the malloc pool used in SPL.
2951
2952 CONFIG_SYS_SPL_MALLOC_SIZE
2953 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002954
Tom Rini28591df2012-08-13 12:03:19 -07002955 CONFIG_SPL_FRAMEWORK
2956 Enable the SPL framework under common/. This framework
2957 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2958 NAND loading of the Linux Kernel.
2959
Tom Rinife3b0c72012-08-13 11:37:56 -07002960 CONFIG_SPL_DISPLAY_PRINT
2961 For ARM, enable an optional function to print more information
2962 about the running system.
2963
Scott Wood7c810902012-09-20 16:35:21 -05002964 CONFIG_SPL_INIT_MINIMAL
2965 Arch init code should be built for a very small image
2966
Wolfgang Denk825223d2011-09-11 21:24:09 +02002967 CONFIG_SPL_LIBCOMMON_SUPPORT
2968 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002969
Wolfgang Denk825223d2011-09-11 21:24:09 +02002970 CONFIG_SPL_LIBDISK_SUPPORT
2971 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002972
Wolfgang Denk825223d2011-09-11 21:24:09 +02002973 CONFIG_SPL_I2C_SUPPORT
2974 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002975
Wolfgang Denk825223d2011-09-11 21:24:09 +02002976 CONFIG_SPL_GPIO_SUPPORT
2977 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002978
Wolfgang Denk825223d2011-09-11 21:24:09 +02002979 CONFIG_SPL_MMC_SUPPORT
2980 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002981
Tom Rini36853852012-02-14 07:29:40 +00002982 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2983 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2984 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2985 Address, size and partition on the MMC to load U-Boot from
2986 when the MMC is being used in raw mode.
2987
Peter Korsgaard01b542f2013-05-13 08:36:29 +00002988 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2989 Sector to load kernel uImage from when MMC is being
2990 used in raw mode (for Falcon mode)
2991
2992 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2993 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2994 Sector and number of sectors to load kernel argument
2995 parameters from when MMC is being used in raw mode
2996 (for falcon mode)
2997
Tom Rini36853852012-02-14 07:29:40 +00002998 CONFIG_SPL_FAT_SUPPORT
2999 Support for fs/fat/libfat.o in SPL binary
3000
3001 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
3002 Filename to read to load U-Boot when reading from FAT
3003
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003004 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
3005 Filename to read to load kernel uImage when reading
3006 from FAT (for Falcon mode)
3007
3008 CONFIG_SPL_FAT_LOAD_ARGS_NAME
3009 Filename to read to load kernel argument parameters
3010 when reading from FAT (for Falcon mode)
3011
Scott Wood2b36fbb2012-12-06 13:33:17 +00003012 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3013 Set this for NAND SPL on PPC mpc83xx targets, so that
3014 start.S waits for the rest of the SPL to load before
3015 continuing (the hardware starts execution after just
3016 loading the first page rather than the full 4K).
3017
Scott Woodc352a0c2012-09-20 19:09:07 -05003018 CONFIG_SPL_NAND_BASE
3019 Include nand_base.c in the SPL. Requires
3020 CONFIG_SPL_NAND_DRIVERS.
3021
3022 CONFIG_SPL_NAND_DRIVERS
3023 SPL uses normal NAND drivers, not minimal drivers.
3024
3025 CONFIG_SPL_NAND_ECC
3026 Include standard software ECC in the SPL
3027
Tom Rini36853852012-02-14 07:29:40 +00003028 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003029 Support for NAND boot using simple NAND drivers that
3030 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003031
3032 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3033 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3034 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3035 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3036 CONFIG_SYS_NAND_ECCBYTES
3037 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003038 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003039
3040 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003041 Location in NAND to read U-Boot from
3042
3043 CONFIG_SYS_NAND_U_BOOT_DST
3044 Location in memory to load U-Boot to
3045
3046 CONFIG_SYS_NAND_U_BOOT_SIZE
3047 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003048
3049 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003050 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003051
3052 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3053 Define this if you need to first read the OOB and then the
3054 data. This is used for example on davinci plattforms.
3055
3056 CONFIG_SPL_OMAP3_ID_NAND
3057 Support for an OMAP3-specific set of functions to return the
3058 ID and MFR of the first attached NAND chip, if present.
3059
Wolfgang Denk825223d2011-09-11 21:24:09 +02003060 CONFIG_SPL_SERIAL_SUPPORT
3061 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003062
Wolfgang Denk825223d2011-09-11 21:24:09 +02003063 CONFIG_SPL_SPI_FLASH_SUPPORT
3064 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003065
Wolfgang Denk825223d2011-09-11 21:24:09 +02003066 CONFIG_SPL_SPI_SUPPORT
3067 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003068
Pavel Machekde997252012-08-30 22:42:11 +02003069 CONFIG_SPL_RAM_DEVICE
3070 Support for running image already present in ram, in SPL binary
3071
Wolfgang Denk825223d2011-09-11 21:24:09 +02003072 CONFIG_SPL_LIBGENERIC_SUPPORT
3073 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003074
Ying Zhang602f7d32013-05-20 14:07:25 +08003075 CONFIG_SPL_ENV_SUPPORT
3076 Support for the environment operating in SPL binary
3077
3078 CONFIG_SPL_NET_SUPPORT
3079 Support for the net/libnet.o in SPL binary.
3080 It conflicts with SPL env from storage medium specified by
3081 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3082
Scott Woodeb7bd972012-12-06 13:33:16 +00003083 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003084 Image offset to which the SPL should be padded before appending
3085 the SPL payload. By default, this is defined as
3086 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3087 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3088 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003089
Scott Woodf147eb72012-09-21 16:27:32 -05003090 CONFIG_SPL_TARGET
3091 Final target image containing SPL and payload. Some SPLs
3092 use an arch-specific makefile fragment instead, for
3093 example if more than one image needs to be produced.
3094
Simon Glass82d94532013-05-08 08:05:59 +00003095 CONFIG_FIT_SPL_PRINT
3096 Printing information about a FIT image adds quite a bit of
3097 code to SPL. So this is normally disabled in SPL. Use this
3098 option to re-enable it. This will affect the output of the
3099 bootm command when booting a FIT image.
3100
wdenkc6097192002-11-03 00:24:07 +00003101Modem Support:
3102--------------
3103
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003104[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003105
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003106- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003107 CONFIG_MODEM_SUPPORT
3108
3109- RTS/CTS Flow control enable:
3110 CONFIG_HWFLOW
3111
3112- Modem debug support:
3113 CONFIG_MODEM_SUPPORT_DEBUG
3114
wdenk4a5c8a72003-03-06 00:02:04 +00003115 Enables debugging stuff (char screen[1024], dbg())
3116 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003117
wdenkc0aa5c52003-12-06 19:49:23 +00003118- Interrupt support (PPC):
3119
wdenk1ebf41e2004-01-02 14:00:00 +00003120 There are common interrupt_init() and timer_interrupt()
3121 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003122 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003123 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003124 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003125 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003126 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003127 specific handling. If board has watchdog / status_led
3128 / other_activity_monitor it works automatically from
3129 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003130
wdenkc6097192002-11-03 00:24:07 +00003131- General:
3132
wdenk4a5c8a72003-03-06 00:02:04 +00003133 In the target system modem support is enabled when a
3134 specific key (key combination) is pressed during
3135 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003136 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003137 board_init(). Currently key_pressed() is a dummy
3138 function, returning 1 and thus enabling modem
3139 initialization.
wdenkc6097192002-11-03 00:24:07 +00003140
wdenk4a5c8a72003-03-06 00:02:04 +00003141 If there are no modem init strings in the
3142 environment, U-Boot proceed to autoboot; the
3143 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003144 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003145
3146 See also: doc/README.Modem
3147
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003148Board initialization settings:
3149------------------------------
3150
3151During Initialization u-boot calls a number of board specific functions
3152to allow the preparation of board specific prerequisites, e.g. pin setup
3153before drivers are initialized. To enable these callbacks the
3154following configuration macros have to be defined. Currently this is
3155architecture specific, so please check arch/your_architecture/lib/board.c
3156typically in board_init_f() and board_init_r().
3157
3158- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3159- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3160- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3161- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003162
wdenkc6097192002-11-03 00:24:07 +00003163Configuration Settings:
3164-----------------------
3165
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003166- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003167 undefine this when you're short of memory.
3168
Peter Tyserdfb72b82009-01-27 18:03:12 -06003169- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3170 width of the commands listed in the 'help' command output.
3171
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003172- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003173 prompt for user input.
3174
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003175- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003176
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003177- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003178
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003179- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003180
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003181- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003182 the application (usually a Linux kernel) when it is
3183 booted
3184
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003185- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003186 List of legal baudrate settings for this board.
3187
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003188- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003189 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003190
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003191- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003192 If the board specific function
3193 extern int overwrite_console (void);
3194 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003195 serial port, else the settings in the environment are used.
3196
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003197- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003198 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003199
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003200- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003201 Enable overwrite of previous console environment settings.
3202
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003203- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003204 Begin and End addresses of the area used by the
3205 simple memory test.
3206
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003207- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003208 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003209
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003210- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003211 Scratch address used by the alternate memory test
3212 You only need to set this if address zero isn't writeable
3213
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003214- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3215 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003216 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003217 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003218 fixing up gd->ram_size the Linux kernel should gets passed
3219 the now "corrected" memory size and won't touch it either.
3220 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003221 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003222 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003223 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003224
3225 This option can be used as a workaround for the 440EPx/GRx
3226 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3227 be touched.
3228
3229 WARNING: Please make sure that this value is a multiple of
3230 the Linux page size (normally 4k). If this is not the case,
3231 then the end address of the Linux memory will be located at a
3232 non page size aligned address and this could cause major
3233 problems.
3234
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003235- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003236 Enable temporary baudrate change while serial download
3237
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003238- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003239 Physical start address of SDRAM. _Must_ be 0 here.
3240
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003241- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003242 Physical start address of Motherboard I/O (if using a
3243 Cogent motherboard)
3244
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003245- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003246 Physical start address of Flash memory.
3247
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003248- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003249 Physical start address of boot monitor code (set by
3250 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003251 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003252 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003253
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003254- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003255 Size of memory reserved for monitor code, used to
3256 determine _at_compile_time_ (!) if the environment is
3257 embedded within the U-Boot image, or in a separate
3258 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003259
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003260- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003261 Size of DRAM reserved for malloc() use.
3262
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003263- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003264 Normally compressed uImages are limited to an
3265 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003266 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003267 to adjust this setting to your needs.
3268
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003269- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003270 Maximum size of memory mapped by the startup code of
3271 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003272 the Linux kernel (bd_info, boot arguments, FDT blob if
3273 used) must be put below this limit, unless "bootm_low"
3274 enviroment variable is defined and non-zero. In such case
3275 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003276 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003277 variable "bootm_mapsize" will override the value of
3278 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3279 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003280
John Rigbyeea8e692010-10-13 13:57:35 -06003281- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3282 Enable initrd_high functionality. If defined then the
3283 initrd_high feature is enabled and the bootm ramdisk subcommand
3284 is enabled.
3285
3286- CONFIG_SYS_BOOT_GET_CMDLINE:
3287 Enables allocating and saving kernel cmdline in space between
3288 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3289
3290- CONFIG_SYS_BOOT_GET_KBD:
3291 Enables allocating and saving a kernel copy of the bd_info in
3292 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3293
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003294- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003295 Max number of Flash memory banks
3296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003297- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003298 Max number of sectors on a Flash chip
3299
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003300- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003301 Timeout for Flash erase operations (in ms)
3302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003303- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003304 Timeout for Flash write operations (in ms)
3305
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003306- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003307 Timeout for Flash set sector lock bit operation (in ms)
3308
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003309- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003310 Timeout for Flash clear lock bits operation (in ms)
3311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003312- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003313 If defined, hardware flash sectors protection is used
3314 instead of U-Boot software protection.
3315
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003316- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003317
3318 Enable TFTP transfers directly to flash memory;
3319 without this option such a download has to be
3320 performed in two steps: (1) download to RAM, and (2)
3321 copy from RAM to flash.
3322
3323 The two-step approach is usually more reliable, since
3324 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003325 the flash, but in some situations (when system RAM is
3326 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003327 downloaded image) this option may be very useful.
3328
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003329- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003330 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003331 common flash structure for storing flash geometry.
3332
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003333- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003334 This option also enables the building of the cfi_flash driver
3335 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003336
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003337- CONFIG_FLASH_CFI_MTD
3338 This option enables the building of the cfi_mtd driver
3339 in the drivers directory. The driver exports CFI flash
3340 to the MTD layer.
3341
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003342- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003343 Use buffered writes to flash.
3344
3345- CONFIG_FLASH_SPANSION_S29WS_N
3346 s29ws-n MirrorBit flash has non-standard addresses for buffered
3347 write commands.
3348
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003349- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003350 If this option is defined, the common CFI flash doesn't
3351 print it's warning upon not recognized FLASH banks. This
3352 is useful, if some of the configured banks are only
3353 optionally available.
3354
Jerry Van Barenaae73572008-03-08 13:48:01 -05003355- CONFIG_FLASH_SHOW_PROGRESS
3356 If defined (must be an integer), print out countdown
3357 digits and dots. Recommended value: 45 (9..1) for 80
3358 column displays, 15 (3..1) for 40 column displays.
3359
Stefan Roesed20cba52013-04-04 15:53:14 +02003360- CONFIG_FLASH_VERIFY
3361 If defined, the content of the flash (destination) is compared
3362 against the source after the write operation. An error message
3363 will be printed when the contents are not identical.
3364 Please note that this option is useless in nearly all cases,
3365 since such flash programming errors usually are detected earlier
3366 while unprotecting/erasing/programming. Please only enable
3367 this option if you really know what you are doing.
3368
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003369- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003370 Defines the number of Ethernet receive buffers. On some
3371 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003372 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3373 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003374 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003375 Defaults to 4 if not defined.
3376
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003377- CONFIG_ENV_MAX_ENTRIES
3378
Wolfgang Denk1136f692010-10-27 22:48:30 +02003379 Maximum number of entries in the hash table that is used
3380 internally to store the environment settings. The default
3381 setting is supposed to be generous and should work in most
3382 cases. This setting can be used to tune behaviour; see
3383 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003384
Joe Hershberger71497d02012-12-11 22:16:31 -06003385- CONFIG_ENV_FLAGS_LIST_DEFAULT
3386- CONFIG_ENV_FLAGS_LIST_STATIC
3387 Enable validation of the values given to enviroment variables when
3388 calling env set. Variables can be restricted to only decimal,
3389 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3390 the variables can also be restricted to IP address or MAC address.
3391
3392 The format of the list is:
3393 type_attribute = [s|d|x|b|i|m]
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003394 access_atribute = [a|r|o|c]
3395 attributes = type_attribute[access_atribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003396 entry = variable_name[:attributes]
3397 list = entry[,list]
3398
3399 The type attributes are:
3400 s - String (default)
3401 d - Decimal
3402 x - Hexadecimal
3403 b - Boolean ([1yYtT|0nNfF])
3404 i - IP address
3405 m - MAC address
3406
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003407 The access attributes are:
3408 a - Any (default)
3409 r - Read-only
3410 o - Write-once
3411 c - Change-default
3412
Joe Hershberger71497d02012-12-11 22:16:31 -06003413 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3414 Define this to a list (string) to define the ".flags"
3415 envirnoment variable in the default or embedded environment.
3416
3417 - CONFIG_ENV_FLAGS_LIST_STATIC
3418 Define this to a list (string) to define validation that
3419 should be done if an entry is not found in the ".flags"
3420 environment variable. To override a setting in the static
3421 list, simply add an entry for the same variable name to the
3422 ".flags" variable.
3423
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003424- CONFIG_ENV_ACCESS_IGNORE_FORCE
3425 If defined, don't allow the -f switch to env set override variable
3426 access flags.
3427
Simon Glass66828322013-03-08 13:45:27 +00003428- CONFIG_SYS_GENERIC_BOARD
3429 This selects the architecture-generic board system instead of the
3430 architecture-specific board files. It is intended to move boards
3431 to this new framework over time. Defining this will disable the
3432 arch/foo/lib/board.c file and use common/board_f.c and
3433 common/board_r.c instead. To use this option your architecture
3434 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3435 its config.mk file). If you find problems enabling this option on
3436 your board please report the problem and send patches!
3437
Simon Glass9c9f44a2013-03-11 07:06:48 +00003438- CONFIG_SYS_SYM_OFFSETS
3439 This is set by architectures that use offsets for link symbols
3440 instead of absolute values. So bss_start is obtained using an
3441 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3442 directly. You should not need to touch this setting.
3443
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003444- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3445 This is set by OMAP boards for the max time that reset should
3446 be asserted. See doc/README.omap-reset-time for details on how
3447 the value can be calulated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003448
wdenkc6097192002-11-03 00:24:07 +00003449The following definitions that deal with the placement and management
3450of environment data (variable area); in general, we support the
3451following configurations:
3452
Mike Frysinger63b8f122011-07-08 10:44:25 +00003453- CONFIG_BUILD_ENVCRC:
3454
3455 Builds up envcrc with the target environment so that external utils
3456 may easily extract it and embed it in final U-Boot images.
3457
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003458- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003459
3460 Define this if the environment is in flash memory.
3461
3462 a) The environment occupies one whole flash sector, which is
3463 "embedded" in the text segment with the U-Boot code. This
3464 happens usually with "bottom boot sector" or "top boot
3465 sector" type flash chips, which have several smaller
3466 sectors at the start or the end. For instance, such a
3467 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3468 such a case you would place the environment in one of the
3469 4 kB sectors - with U-Boot code before and after it. With
3470 "top boot sector" type flash chips, you would put the
3471 environment in one of the last sectors, leaving a gap
3472 between U-Boot and the environment.
3473
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003474 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003475
3476 Offset of environment data (variable area) to the
3477 beginning of flash memory; for instance, with bottom boot
3478 type flash chips the second sector can be used: the offset
3479 for this sector is given here.
3480
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003481 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003482
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003483 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003484
3485 This is just another way to specify the start address of
3486 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003487 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003488
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003489 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003490
3491 Size of the sector containing the environment.
3492
3493
3494 b) Sometimes flash chips have few, equal sized, BIG sectors.
3495 In such a case you don't want to spend a whole sector for
3496 the environment.
3497
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003498 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003499
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003500 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003501 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003502 of this flash sector for the environment. This saves
3503 memory for the RAM copy of the environment.
3504
3505 It may also save flash memory if you decide to use this
3506 when your environment is "embedded" within U-Boot code,
3507 since then the remainder of the flash sector could be used
3508 for U-Boot code. It should be pointed out that this is
3509 STRONGLY DISCOURAGED from a robustness point of view:
3510 updating the environment in flash makes it always
3511 necessary to erase the WHOLE sector. If something goes
3512 wrong before the contents has been restored from a copy in
3513 RAM, your target system will be dead.
3514
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003515 - CONFIG_ENV_ADDR_REDUND
3516 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003517
wdenk4a5c8a72003-03-06 00:02:04 +00003518 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003519 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003520 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003521 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003522
3523BE CAREFUL! Any changes to the flash layout, and some changes to the
3524source code will make it necessary to adapt <board>/u-boot.lds*
3525accordingly!
3526
3527
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003528- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003529
3530 Define this if you have some non-volatile memory device
3531 (NVRAM, battery buffered SRAM) which you want to use for the
3532 environment.
3533
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003534 - CONFIG_ENV_ADDR:
3535 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003536
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003537 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003538 want to use for environment. It is assumed that this memory
3539 can just be read and written to, without any special
3540 provision.
3541
3542BE CAREFUL! The first access to the environment happens quite early
3543in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003544console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003545U-Boot will hang.
3546
3547Please note that even with NVRAM we still use a copy of the
3548environment in RAM: we could work on NVRAM directly, but we want to
3549keep settings there always unmodified except somebody uses "saveenv"
3550to save the current settings.
3551
3552
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003553- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003554
3555 Use this if you have an EEPROM or similar serial access
3556 device and a driver for it.
3557
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003558 - CONFIG_ENV_OFFSET:
3559 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003560
3561 These two #defines specify the offset and size of the
3562 environment area within the total memory of your EEPROM.
3563
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003564 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003565 If defined, specified the chip address of the EEPROM device.
3566 The default address is zero.
3567
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003568 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003569 If defined, the number of bits used to address bytes in a
3570 single page in the EEPROM device. A 64 byte page, for example
3571 would require six bits.
3572
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003573 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003574 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003575 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003577 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003578 The length in bytes of the EEPROM memory array address. Note
3579 that this is NOT the chip address length!
3580
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003581 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003582 EEPROM chips that implement "address overflow" are ones
3583 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3584 address and the extra bits end up in the "chip address" bit
3585 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3586 byte chips.
3587
3588 Note that we consider the length of the address field to
3589 still be one byte because the extra address bits are hidden
3590 in the chip address.
3591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003592 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003593 The size in bytes of the EEPROM device.
3594
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003595 - CONFIG_ENV_EEPROM_IS_ON_I2C
3596 define this, if you have I2C and SPI activated, and your
3597 EEPROM, which holds the environment, is on the I2C bus.
3598
3599 - CONFIG_I2C_ENV_EEPROM_BUS
3600 if you have an Environment on an EEPROM reached over
3601 I2C muxes, you can define here, how to reach this
3602 EEPROM. For example:
3603
Wolfgang Denk16fa98a2010-06-13 17:48:15 +02003604 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003605
3606 EEPROM which holds the environment, is reached over
3607 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003608
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003609- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003610
wdenk1ebf41e2004-01-02 14:00:00 +00003611 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003612 want to use for the environment.
3613
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003614 - CONFIG_ENV_OFFSET:
3615 - CONFIG_ENV_ADDR:
3616 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003617
3618 These three #defines specify the offset and size of the
3619 environment area within the total memory of your DataFlash placed
3620 at the specified address.
3621
Liu Gang85bcd732012-03-08 00:33:20 +00003622- CONFIG_ENV_IS_IN_REMOTE:
3623
3624 Define this if you have a remote memory space which you
3625 want to use for the local device's environment.
3626
3627 - CONFIG_ENV_ADDR:
3628 - CONFIG_ENV_SIZE:
3629
3630 These two #defines specify the address and size of the
3631 environment area within the remote memory space. The
3632 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003633 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003634
3635BE CAREFUL! For some special cases, the local device can not use
3636"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003637environment stored in a remote NOR flash by SRIO or PCIE link,
3638but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003639
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003640- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003641
3642 Define this if you have a NAND device which you want to use
3643 for the environment.
3644
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003645 - CONFIG_ENV_OFFSET:
3646 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003647
3648 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003649 area within the first NAND device. CONFIG_ENV_OFFSET must be
3650 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003651
Scott Wood08239322010-09-17 14:38:37 -05003652 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003653
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003654 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003655 size used to hold a redundant copy of the environment data, so
3656 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00003657 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003658 aligned to an erase block boundary.
3659
3660 - CONFIG_ENV_RANGE (optional):
3661
3662 Specifies the length of the region in which the environment
3663 can be written. This should be a multiple of the NAND device's
3664 block size. Specifying a range with more erase blocks than
3665 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3666 the range to be avoided.
3667
3668 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003669
Scott Wood08239322010-09-17 14:38:37 -05003670 Enables support for dynamically retrieving the offset of the
3671 environment from block zero's out-of-band data. The
3672 "nand env.oob" command can be used to record this offset.
3673 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3674 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003675
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003676- CONFIG_NAND_ENV_DST
3677
3678 Defines address in RAM to which the nand_spl code should copy the
3679 environment. If redundant environment is used, it will be copied to
3680 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3681
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003682- CONFIG_ENV_IS_IN_UBI:
3683
3684 Define this if you have an UBI volume that you want to use for the
3685 environment. This has the benefit of wear-leveling the environment
3686 accesses, which is important on NAND.
3687
3688 - CONFIG_ENV_UBI_PART:
3689
3690 Define this to a string that is the mtd partition containing the UBI.
3691
3692 - CONFIG_ENV_UBI_VOLUME:
3693
3694 Define this to the name of the volume that you want to store the
3695 environment in.
3696
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003697 - CONFIG_ENV_UBI_VOLUME_REDUND:
3698
3699 Define this to the name of another volume to store a second copy of
3700 the environment in. This will enable redundant environments in UBI.
3701 It is assumed that both volumes are in the same MTD partition.
3702
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003703 - CONFIG_UBI_SILENCE_MSG
3704 - CONFIG_UBIFS_SILENCE_MSG
3705
3706 You will probably want to define these to avoid a really noisy system
3707 when storing the env in UBI.
3708
Stephen Warreneedcacd2013-06-11 15:14:00 -06003709- CONFIG_ENV_IS_IN_MMC:
3710
3711 Define this if you have an MMC device which you want to use for the
3712 environment.
3713
3714 - CONFIG_SYS_MMC_ENV_DEV:
3715
3716 Specifies which MMC device the environment is stored in.
3717
3718 - CONFIG_SYS_MMC_ENV_PART (optional):
3719
3720 Specifies which MMC partition the environment is stored in. If not
3721 set, defaults to partition 0, the user area. Common values might be
3722 1 (first MMC boot partition), 2 (second MMC boot partition).
3723
3724 - CONFIG_ENV_OFFSET:
3725 - CONFIG_ENV_SIZE:
3726
3727 These two #defines specify the offset and size of the environment
3728 area within the specified MMC device.
3729
Stephen Warren24dc2032013-06-11 15:14:02 -06003730 If offset is positive (the usual case), it is treated as relative to
3731 the start of the MMC partition. If offset is negative, it is treated
3732 as relative to the end of the MMC partition. This can be useful if
3733 your board may be fitted with different MMC devices, which have
3734 different sizes for the MMC partitions, and you always want the
3735 environment placed at the very end of the partition, to leave the
3736 maximum possible space before it, to store other data.
3737
Stephen Warreneedcacd2013-06-11 15:14:00 -06003738 These two values are in units of bytes, but must be aligned to an
3739 MMC sector boundary.
3740
3741 - CONFIG_ENV_OFFSET_REDUND (optional):
3742
3743 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3744 hold a redundant copy of the environment data. This provides a
3745 valid backup copy in case the other copy is corrupted, e.g. due
3746 to a power failure during a "saveenv" operation.
3747
Stephen Warren24dc2032013-06-11 15:14:02 -06003748 This value may also be positive or negative; this is handled in the
3749 same way as CONFIG_ENV_OFFSET.
3750
Stephen Warreneedcacd2013-06-11 15:14:00 -06003751 This value is also in units of bytes, but must also be aligned to
3752 an MMC sector boundary.
3753
3754 - CONFIG_ENV_SIZE_REDUND (optional):
3755
3756 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3757 set. If this value is set, it must be set to the same value as
3758 CONFIG_ENV_SIZE.
3759
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003760- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003761
3762 Defines offset to the initial SPI buffer area in DPRAM. The
3763 area is used at an early stage (ROM part) if the environment
3764 is configured to reside in the SPI EEPROM: We need a 520 byte
3765 scratch DPRAM area. It is used between the two initialization
3766 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3767 to be a good choice since it makes it far enough from the
3768 start of the data area as well as from the stack pointer.
3769
Bruce Adleredecc942007-11-02 13:15:42 -07003770Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003771has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003772created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003773until then to read environment variables.
3774
wdenk8dba0502003-03-31 16:34:49 +00003775The environment is protected by a CRC32 checksum. Before the monitor
3776is relocated into RAM, as a result of a bad CRC you will be working
3777with the compiled-in default environment - *silently*!!! [This is
3778necessary, because the first environment variable we need is the
3779"baudrate" setting for the console - if we have a bad CRC, we don't
3780have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003781
3782Note: once the monitor has been relocated, then it will complain if
3783the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003784use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003785
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003786- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003787 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003788
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003789 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003790 also needs to be defined.
3791
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003792- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003793 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003794
Ron Madriddfa028a2009-02-18 14:30:44 -08003795- CONFIG_NS16550_MIN_FUNCTIONS:
3796 Define this if you desire to only have use of the NS16550_init
3797 and NS16550_putc functions for the serial driver located at
3798 drivers/serial/ns16550.c. This option is useful for saving
3799 space for already greatly restricted images, including but not
3800 limited to NAND_SPL configurations.
3801
Simon Glass28a9e332012-11-30 13:01:18 +00003802- CONFIG_DISPLAY_BOARDINFO
3803 Display information about the board that U-Boot is running on
3804 when U-Boot starts up. The board function checkboard() is called
3805 to do this.
3806
Simon Glasse8822012012-11-30 13:01:19 +00003807- CONFIG_DISPLAY_BOARDINFO_LATE
3808 Similar to the previous option, but display this information
3809 later, once stdio is running and output goes to the LCD, if
3810 present.
3811
wdenkc6097192002-11-03 00:24:07 +00003812Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003813---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003814
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003815- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003816 Cache Line Size of the CPU.
3817
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003818- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003819 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003820
wdenk9c53f402003-10-15 23:53:47 +00003821 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3822 and RPXsuper) to be able to adjust the position of
3823 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003824
Timur Tabid8f341c2011-08-04 18:03:41 -05003825- CONFIG_SYS_CCSRBAR_DEFAULT:
3826 Default (power-on reset) physical address of CCSR on Freescale
3827 PowerPC SOCs.
3828
3829- CONFIG_SYS_CCSRBAR:
3830 Virtual address of CCSR. On a 32-bit build, this is typically
3831 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3832
3833 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3834 for cross-platform code that uses that macro instead.
3835
3836- CONFIG_SYS_CCSRBAR_PHYS:
3837 Physical address of CCSR. CCSR can be relocated to a new
3838 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003839 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003840 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3841 is typically relocated on 36-bit builds. It is recommended
3842 that this macro be defined via the _HIGH and _LOW macros:
3843
3844 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3845 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3846
3847- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003848 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3849 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05003850 used in assembly code, so it must not contain typecasts or
3851 integer size suffixes (e.g. "ULL").
3852
3853- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3854 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3855 used in assembly code, so it must not contain typecasts or
3856 integer size suffixes (e.g. "ULL").
3857
3858- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3859 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3860 forced to a value that ensures that CCSR is not relocated.
3861
wdenk1272e232002-11-10 22:06:23 +00003862- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003863 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00003864
3865 the default drive number (default value 0)
3866
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003867 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00003868
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003869 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00003870 (default value 1)
3871
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003872 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00003873
wdenk4a5c8a72003-03-06 00:02:04 +00003874 defines the offset of register from address. It
3875 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003876 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00003877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003878 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3879 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00003880 default value.
wdenk1272e232002-11-10 22:06:23 +00003881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003882 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00003883 fdc_hw_init() is called at the beginning of the FDC
3884 setup. fdc_hw_init() must be provided by the board
3885 source code. It is used to make hardware dependant
3886 initializations.
wdenk1272e232002-11-10 22:06:23 +00003887
Macpaul Lind1e49942011-04-11 20:45:32 +00003888- CONFIG_IDE_AHB:
3889 Most IDE controllers were designed to be connected with PCI
3890 interface. Only few of them were designed for AHB interface.
3891 When software is doing ATA command and data transfer to
3892 IDE devices through IDE-AHB controller, some additional
3893 registers accessing to these kind of IDE-AHB controller
3894 is requierd.
3895
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003896- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00003897 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00003898 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003899
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003900- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003901
wdenkeb20ad32003-09-05 23:19:14 +00003902 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003903 initial data and stack; please note that this must be
3904 writable memory that is working WITHOUT special
3905 initialization, i. e. you CANNOT use normal RAM which
3906 will become available only after programming the
3907 memory controller and running certain initialization
3908 sequences.
3909
3910 U-Boot uses the following memory types:
3911 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3912 - MPC824X: data cache
3913 - PPC4xx: data cache
3914
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003915- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003916
3917 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003918 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3919 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003920 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02003921 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003922 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3923 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3924 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003925
3926 Note:
3927 On the MPC824X (or other systems that use the data
3928 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003929 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003930 point to an otherwise UNUSED address space between
3931 the top of RAM and the start of the PCI space.
3932
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003933- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003935- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003936
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003937- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003939- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003940
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003941- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003942
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003943- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003944
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003945- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003946 SDRAM timing
3947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003948- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003949 periodic timer for refresh
3950
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003951- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003952
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003953- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3954 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3955 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3956 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003957 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3958
3959- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003960 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3961 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003962 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3963
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003964- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3965 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003966 Machine Mode Register and Memory Periodic Timer
3967 Prescaler definitions (SDRAM timing)
3968
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003969- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003970 enable I2C microcode relocation patch (MPC8xx);
3971 define relocation offset in DPRAM [DSP2]
3972
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003973- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01003974 enable SMC microcode relocation patch (MPC8xx);
3975 define relocation offset in DPRAM [SMC1]
3976
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003977- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003978 enable SPI microcode relocation patch (MPC8xx);
3979 define relocation offset in DPRAM [SCC4]
3980
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003981- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003982 Use OSCM clock mode on MBX8xx board. Be careful,
3983 wrong setting might damage your board. Read
3984 doc/README.MBX before setting this variable!
3985
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003986- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00003987 Offset of the bootmode word in DPRAM used by post
3988 (Power On Self Tests). This definition overrides
3989 #define'd default value in commproc.h resp.
3990 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00003991
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003992- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3993 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3994 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3995 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3996 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3997 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3998 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3999 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004000 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004001
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004002- CONFIG_PCI_DISABLE_PCIE:
4003 Disable PCI-Express on systems where it is supported but not
4004 required.
4005
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004006- CONFIG_PCI_ENUM_ONLY
4007 Only scan through and get the devices on the busses.
4008 Don't do any setup work, presumably because someone or
4009 something has already done it, and we don't need to do it
4010 a second time. Useful for platforms that are pre-booted
4011 by coreboot or similar.
4012
Gabor Juhosb4458732013-05-30 07:06:12 +00004013- CONFIG_PCI_INDIRECT_BRIDGE:
4014 Enable support for indirect PCI bridges.
4015
Kumar Gala8975d7a2010-12-30 12:09:53 -06004016- CONFIG_SYS_SRIO:
4017 Chip has SRIO or not
4018
4019- CONFIG_SRIO1:
4020 Board has SRIO 1 port available
4021
4022- CONFIG_SRIO2:
4023 Board has SRIO 2 port available
4024
Liu Gang27afb9c2013-05-07 16:30:46 +08004025- CONFIG_SRIO_PCIE_BOOT_MASTER
4026 Board can support master function for Boot from SRIO and PCIE
4027
Kumar Gala8975d7a2010-12-30 12:09:53 -06004028- CONFIG_SYS_SRIOn_MEM_VIRT:
4029 Virtual Address of SRIO port 'n' memory region
4030
4031- CONFIG_SYS_SRIOn_MEM_PHYS:
4032 Physical Address of SRIO port 'n' memory region
4033
4034- CONFIG_SYS_SRIOn_MEM_SIZE:
4035 Size of SRIO port 'n' memory region
4036
Fabio Estevamf17e8782013-04-11 09:35:34 +00004037- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4038 Defined to tell the NAND controller that the NAND chip is using
4039 a 16 bit bus.
4040 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004041 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004042 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004043 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004044
4045- CONFIG_SYS_NDFC_EBC0_CFG
4046 Sets the EBC0_CFG register for the NDFC. If not defined
4047 a default value will be used.
4048
Ben Warren45657152006-09-07 16:50:54 -04004049- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004050 Get DDR timing information from an I2C EEPROM. Common
4051 with pluggable memory modules such as SODIMMs
4052
Ben Warren45657152006-09-07 16:50:54 -04004053 SPD_EEPROM_ADDRESS
4054 I2C address of the SPD EEPROM
4055
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004056- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004057 If SPD EEPROM is on an I2C bus other than the first
4058 one, specify here. Note that the value must resolve
4059 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004060
York Sune73cc042011-06-07 09:42:16 +08004061- CONFIG_SYS_DDR_RAW_TIMING
4062 Get DDR timing information from other than SPD. Common with
4063 soldered DDR chips onboard without SPD. DDR raw timing
4064 parameters are extracted from datasheet and hard-coded into
4065 header files or board specific files.
4066
York Sunbd495cf2011-09-16 13:21:35 -07004067- CONFIG_FSL_DDR_INTERACTIVE
4068 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4069
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004070- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004071 Only for 83xx systems. If specified, then DDR should
4072 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004073
wdenk6203e402004-04-18 10:13:26 +00004074- CONFIG_ETHER_ON_FEC[12]
4075 Define to enable FEC[12] on a 8xx series processor.
4076
4077- CONFIG_FEC[12]_PHY
4078 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004079 to the given FEC; i. e.
4080 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004081 means that the PHY with address 4 is connected to FEC1
4082
4083 When set to -1, means to probe for first available.
4084
4085- CONFIG_FEC[12]_PHY_NORXERR
4086 The PHY does not have a RXERR line (RMII only).
4087 (so program the FEC to ignore it).
4088
4089- CONFIG_RMII
4090 Enable RMII mode for all FECs.
4091 Note that this is a global option, we can't
4092 have one FEC in standard MII mode and another in RMII mode.
4093
wdenk20c98a62004-04-23 20:32:05 +00004094- CONFIG_CRC32_VERIFY
4095 Add a verify option to the crc32 command.
4096 The syntax is:
4097
4098 => crc32 -v <address> <count> <crc32>
4099
4100 Where address/count indicate a memory area
4101 and crc32 is the correct crc32 which the
4102 area should have.
4103
wdenk64519362004-07-11 17:40:54 +00004104- CONFIG_LOOPW
4105 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004106 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004107
stroesecc3af832004-12-16 18:46:55 +00004108- CONFIG_MX_CYCLIC
4109 Add the "mdc" and "mwc" memory commands. These are cyclic
4110 "md/mw" commands.
4111 Examples:
4112
wdenk07d7e6b2004-12-16 21:44:03 +00004113 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004114 This command will print 4 bytes (10,11,12,13) each 500 ms.
4115
wdenk07d7e6b2004-12-16 21:44:03 +00004116 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004117 This command will write 12345678 to address 100 all 10 ms.
4118
wdenk07d7e6b2004-12-16 21:44:03 +00004119 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004120 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004121
wdenk3d3d99f2005-04-04 12:44:11 +00004122- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004123 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004124 low level initializations (like setting up the memory
4125 controller) are omitted and/or U-Boot does not
4126 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004127
Wolfgang Denk302141d2010-11-27 23:30:56 +01004128 Normally this variable MUST NOT be defined. The only
4129 exception is when U-Boot is loaded (to RAM) by some
4130 other boot loader or by a debugger which performs
4131 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004132
Aneesh V552a3192011-07-13 05:11:07 +00004133- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004134 Modifies the behaviour of start.S when compiling a loader
4135 that is executed before the actual U-Boot. E.g. when
4136 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004137
Ying Zhang0d4f5442013-05-20 14:07:23 +08004138- CONFIG_SYS_MPC85XX_NO_RESETVEC
4139 Only for 85xx systems. If this variable is specified, the section
4140 .resetvec is not kept and the section .bootpg is placed in the
4141 previous 4k of the .text section.
4142
Simon Glass17dabf02013-02-24 17:33:14 +00004143- CONFIG_ARCH_MAP_SYSMEM
4144 Generally U-Boot (and in particular the md command) uses
4145 effective address. It is therefore not necessary to regard
4146 U-Boot address as virtual addresses that need to be translated
4147 to physical addresses. However, sandbox requires this, since
4148 it maintains its own little RAM buffer which contains all
4149 addressable memory. This option causes some memory accesses
4150 to be mapped through map_sysmem() / unmap_sysmem().
4151
Matthias Weisser93416c12011-03-10 21:36:32 +00004152- CONFIG_USE_ARCH_MEMCPY
4153 CONFIG_USE_ARCH_MEMSET
4154 If these options are used a optimized version of memcpy/memset will
4155 be used if available. These functions may be faster under some
4156 conditions but may increase the binary size.
4157
Simon Glassbfb59802013-02-14 04:18:54 +00004158- CONFIG_X86_RESET_VECTOR
4159 If defined, the x86 reset vector code is included. This is not
4160 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004161
Mark Jackson52b003c2013-03-04 01:27:20 +00004162- CONFIG_SYS_MPUCLK
4163 Defines the MPU clock speed (in MHz).
4164
4165 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004166
Timur Tabi275f4bb2011-11-22 09:21:25 -06004167Freescale QE/FMAN Firmware Support:
4168-----------------------------------
4169
4170The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4171loading of "firmware", which is encoded in the QE firmware binary format.
4172This firmware often needs to be loaded during U-Boot booting, so macros
4173are used to identify the storage device (NOR flash, SPI, etc) and the address
4174within that device.
4175
4176- CONFIG_SYS_QE_FMAN_FW_ADDR
4177 The address in the storage device where the firmware is located. The
4178 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4179 is also specified.
4180
4181- CONFIG_SYS_QE_FMAN_FW_LENGTH
4182 The maximum possible size of the firmware. The firmware binary format
4183 has a field that specifies the actual size of the firmware, but it
4184 might not be possible to read any part of the firmware unless some
4185 local storage is allocated to hold the entire firmware first.
4186
4187- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4188 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4189 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4190 virtual address in NOR flash.
4191
4192- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4193 Specifies that QE/FMAN firmware is located in NAND flash.
4194 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4195
4196- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4197 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4198 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4199
4200- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4201 Specifies that QE/FMAN firmware is located on the primary SPI
4202 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4203
Liu Gang1e084582012-03-08 00:33:18 +00004204- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4205 Specifies that QE/FMAN firmware is located in the remote (master)
4206 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004207 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4208 window->master inbound window->master LAW->the ucode address in
4209 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004210
wdenkc6097192002-11-03 00:24:07 +00004211Building the Software:
4212======================
4213
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004214Building U-Boot has been tested in several native build environments
4215and in many different cross environments. Of course we cannot support
4216all possibly existing versions of cross development tools in all
4217(potentially obsolete) versions. In case of tool chain problems we
4218recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4219which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004220
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004221If you are not using a native environment, it is assumed that you
4222have GNU cross compiling tools available in your path. In this case,
4223you must set the environment variable CROSS_COMPILE in your shell.
4224Note that no changes to the Makefile or any other source files are
4225necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004226
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004227 $ CROSS_COMPILE=ppc_4xx-
4228 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004229
Peter Tyserb06976d2009-03-13 18:54:51 -05004230Note: If you wish to generate Windows versions of the utilities in
4231 the tools directory you can use the MinGW toolchain
4232 (http://www.mingw.org). Set your HOST tools to the MinGW
4233 toolchain and execute 'make tools'. For example:
4234
4235 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4236
4237 Binaries such as tools/mkimage.exe will be created which can
4238 be executed on computers running Windows.
4239
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004240U-Boot is intended to be simple to build. After installing the
4241sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004242is done by typing:
4243
4244 make NAME_config
4245
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004246where "NAME_config" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004247rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004248
wdenk6c59edc2004-05-03 20:45:30 +00004249Note: for some board special configuration names may exist; check if
4250 additional information is available from the board vendor; for
4251 instance, the TQM823L systems are available without (standard)
4252 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004253 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004254
wdenk6c59edc2004-05-03 20:45:30 +00004255 make TQM823L_config
4256 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004257
wdenk6c59edc2004-05-03 20:45:30 +00004258 make TQM823L_LCD_config
4259 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk6c59edc2004-05-03 20:45:30 +00004261 etc.
wdenkc6097192002-11-03 00:24:07 +00004262
wdenkc6097192002-11-03 00:24:07 +00004263
wdenk6c59edc2004-05-03 20:45:30 +00004264Finally, type "make all", and you should get some working U-Boot
4265images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk6c59edc2004-05-03 20:45:30 +00004267- "u-boot.bin" is a raw binary image
4268- "u-boot" is an image in ELF binary format
4269- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004270
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004271By default the build is performed locally and the objects are saved
4272in the source directory. One of the two methods can be used to change
4273this behavior and build U-Boot to some external directory:
4274
42751. Add O= to the make command line invocations:
4276
4277 make O=/tmp/build distclean
4278 make O=/tmp/build NAME_config
4279 make O=/tmp/build all
4280
42812. Set environment variable BUILD_DIR to point to the desired location:
4282
4283 export BUILD_DIR=/tmp/build
4284 make distclean
4285 make NAME_config
4286 make all
4287
4288Note that the command line "O=" setting overrides the BUILD_DIR environment
4289variable.
4290
wdenkc6097192002-11-03 00:24:07 +00004291
wdenk6c59edc2004-05-03 20:45:30 +00004292Please be aware that the Makefiles assume you are using GNU make, so
4293for instance on NetBSD you might need to use "gmake" instead of
4294native "make".
wdenkc6097192002-11-03 00:24:07 +00004295
wdenkc6097192002-11-03 00:24:07 +00004296
wdenk6c59edc2004-05-03 20:45:30 +00004297If the system board that you have is not listed, then you will need
4298to port U-Boot to your hardware platform. To do this, follow these
4299steps:
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk6c59edc2004-05-03 20:45:30 +000043011. Add a new configuration option for your board to the toplevel
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004302 "boards.cfg" file, using the existing entries as examples.
4303 Follow the instructions there to keep the boards in order.
wdenk6c59edc2004-05-03 20:45:30 +000043042. Create a new directory to hold your board specific code. Add any
4305 files you need. In your board directory, you will need at least
4306 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
43073. Create a new configuration file "include/configs/<board>.h" for
4308 your board
43093. If you're porting U-Boot to a new CPU, then also create a new
4310 directory to hold your CPU specific code. Add any files you need.
43114. Run "make <board>_config" with your new name.
43125. Type "make", and you should get a working "u-boot.srec" file
4313 to be installed on your target system.
43146. Debug and solve any problems that might arise.
4315 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004316
wdenkc6097192002-11-03 00:24:07 +00004317
wdenk6c59edc2004-05-03 20:45:30 +00004318Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4319==============================================================
wdenkc6097192002-11-03 00:24:07 +00004320
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004321If you have modified U-Boot sources (for instance added a new board
4322or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004323provide feedback to the other developers. The feedback normally takes
4324the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004325official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004326
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004327But before you submit such a patch, please verify that your modifi-
4328cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004329the supported boards compile WITHOUT ANY compiler warnings. To do so,
4330just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004331for ALL supported system. Be warned, this will take a while. You can
4332select which (cross) compiler to use by passing a `CROSS_COMPILE'
4333environment variable to the script, i. e. to use the ELDK cross tools
4334you can type
wdenkc6097192002-11-03 00:24:07 +00004335
wdenk6c59edc2004-05-03 20:45:30 +00004336 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004337
wdenk6c59edc2004-05-03 20:45:30 +00004338or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004339
wdenk6c59edc2004-05-03 20:45:30 +00004340 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004341
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004342When using the MAKEALL script, the default behaviour is to build
4343U-Boot in the source directory. This location can be changed by
4344setting the BUILD_DIR environment variable. Also, for each target
4345built, the MAKEALL script saves two log files (<target>.ERR and
4346<target>.MAKEALL) in the <source dir>/LOG directory. This default
4347location can be changed by setting the MAKEALL_LOGDIR environment
4348variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004349
4350 export BUILD_DIR=/tmp/build
4351 export MAKEALL_LOGDIR=/tmp/log
4352 CROSS_COMPILE=ppc_8xx- MAKEALL
4353
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004354With the above settings build objects are saved in the /tmp/build,
4355log files are saved in the /tmp/log and the source tree remains clean
4356during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004357
4358
wdenk6c59edc2004-05-03 20:45:30 +00004359See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004360
wdenkc6097192002-11-03 00:24:07 +00004361
wdenk6c59edc2004-05-03 20:45:30 +00004362Monitor Commands - Overview:
4363============================
wdenkc6097192002-11-03 00:24:07 +00004364
wdenk6c59edc2004-05-03 20:45:30 +00004365go - start application at address 'addr'
4366run - run commands in an environment variable
4367bootm - boot application image from memory
4368bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004369bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004370tftpboot- boot image via network using TFTP protocol
4371 and env variables "ipaddr" and "serverip"
4372 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004373tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004374rarpboot- boot image via network using RARP/TFTP protocol
4375diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4376loads - load S-Record file over serial line
4377loadb - load binary file over serial line (kermit mode)
4378md - memory display
4379mm - memory modify (auto-incrementing)
4380nm - memory modify (constant address)
4381mw - memory write (fill)
4382cp - memory copy
4383cmp - memory compare
4384crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004385i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004386sspi - SPI utility commands
4387base - print or set address offset
4388printenv- print environment variables
4389setenv - set environment variables
4390saveenv - save environment variables to persistent storage
4391protect - enable or disable FLASH write protection
4392erase - erase FLASH memory
4393flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004394nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004395bdinfo - print Board Info structure
4396iminfo - print header information for application image
4397coninfo - print console devices and informations
4398ide - IDE sub-system
4399loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004400loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004401mtest - simple RAM test
4402icache - enable or disable instruction cache
4403dcache - enable or disable data cache
4404reset - Perform RESET of the CPU
4405echo - echo args to console
4406version - print monitor version
4407help - print online help
4408? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004409
wdenkc6097192002-11-03 00:24:07 +00004410
wdenk6c59edc2004-05-03 20:45:30 +00004411Monitor Commands - Detailed Description:
4412========================================
wdenkc6097192002-11-03 00:24:07 +00004413
wdenk6c59edc2004-05-03 20:45:30 +00004414TODO.
wdenkc6097192002-11-03 00:24:07 +00004415
wdenk6c59edc2004-05-03 20:45:30 +00004416For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004417
4418
wdenk6c59edc2004-05-03 20:45:30 +00004419Environment Variables:
4420======================
wdenkc6097192002-11-03 00:24:07 +00004421
wdenk6c59edc2004-05-03 20:45:30 +00004422U-Boot supports user configuration using Environment Variables which
4423can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004424
wdenk6c59edc2004-05-03 20:45:30 +00004425Environment Variables are set using "setenv", printed using
4426"printenv", and saved to Flash using "saveenv". Using "setenv"
4427without a value can be used to delete a variable from the
4428environment. As long as you don't save the environment you are
4429working with an in-memory copy. In case the Flash area containing the
4430environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004431
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004432Some configuration options can be set using Environment Variables.
4433
4434List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004435
wdenk6c59edc2004-05-03 20:45:30 +00004436 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004437
wdenk6c59edc2004-05-03 20:45:30 +00004438 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004439
wdenk6c59edc2004-05-03 20:45:30 +00004440 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004441
wdenk6c59edc2004-05-03 20:45:30 +00004442 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004443
wdenk6c59edc2004-05-03 20:45:30 +00004444 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004445
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004446 bootm_low - Memory range available for image processing in the bootm
4447 command can be restricted. This variable is given as
4448 a hexadecimal number and defines lowest address allowed
4449 for use by the bootm command. See also "bootm_size"
4450 environment variable. Address defined by "bootm_low" is
4451 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004452 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4453 bootm_mapsize.
4454
Wolfgang Denk092ae952011-10-26 10:21:21 +00004455 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004456 This variable is given as a hexadecimal number and it
4457 defines the size of the memory region starting at base
4458 address bootm_low that is accessible by the Linux kernel
4459 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4460 as the default value if it is defined, and bootm_size is
4461 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004462
4463 bootm_size - Memory range available for image processing in the bootm
4464 command can be restricted. This variable is given as
4465 a hexadecimal number and defines the size of the region
4466 allowed for use by the bootm command. See also "bootm_low"
4467 environment variable.
4468
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004469 updatefile - Location of the software update file on a TFTP server, used
4470 by the automatic software update feature. Please refer to
4471 documentation in doc/README.update for more details.
4472
wdenk6c59edc2004-05-03 20:45:30 +00004473 autoload - if set to "no" (any string beginning with 'n'),
4474 "bootp" will just load perform a lookup of the
4475 configuration from the BOOTP server, but not try to
4476 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004477
wdenk6c59edc2004-05-03 20:45:30 +00004478 autostart - if set to "yes", an image loaded using the "bootp",
4479 "rarpboot", "tftpboot" or "diskboot" commands will
4480 be automatically started (by internally calling
4481 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004482
wdenk6c59edc2004-05-03 20:45:30 +00004483 If set to "no", a standalone image passed to the
4484 "bootm" command will be copied to the load address
4485 (and eventually uncompressed), but NOT be started.
4486 This can be used to load and uncompress arbitrary
4487 data.
wdenkc6097192002-11-03 00:24:07 +00004488
David A. Longd558a4e2011-07-09 16:40:19 -04004489 fdt_high - if set this restricts the maximum address that the
4490 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004491 For example, if you have a system with 1 GB memory
4492 at physical address 0x10000000, while Linux kernel
4493 only recognizes the first 704 MB as low memory, you
4494 may need to set fdt_high as 0x3C000000 to have the
4495 device tree blob be copied to the maximum address
4496 of the 704 MB low memory, so that Linux kernel can
4497 access it during the boot procedure.
4498
David A. Longd558a4e2011-07-09 16:40:19 -04004499 If this is set to the special value 0xFFFFFFFF then
4500 the fdt will not be copied at all on boot. For this
4501 to work it must reside in writable memory, have
4502 sufficient padding on the end of it for u-boot to
4503 add the information it needs into it, and the memory
4504 must be accessible by the kernel.
4505
Simon Glassdc6fa642011-10-24 19:15:34 +00004506 fdtcontroladdr- if set this is the address of the control flattened
4507 device tree used by U-Boot when CONFIG_OF_CONTROL is
4508 defined.
4509
wdenk0e2bd9c2004-06-06 21:51:03 +00004510 i2cfast - (PPC405GP|PPC405EP only)
4511 if set to 'y' configures Linux I2C driver for fast
4512 mode (400kHZ). This environment variable is used in
4513 initialization code. So, for changes to be effective
4514 it must be saved and board must be reset.
4515
wdenk6c59edc2004-05-03 20:45:30 +00004516 initrd_high - restrict positioning of initrd images:
4517 If this variable is not set, initrd images will be
4518 copied to the highest possible address in RAM; this
4519 is usually what you want since it allows for
4520 maximum initrd size. If for some reason you want to
4521 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004522 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004523 variable to a value of "no" or "off" or "0".
4524 Alternatively, you can set it to a maximum upper
4525 address to use (U-Boot will still check that it
4526 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004527
wdenk6c59edc2004-05-03 20:45:30 +00004528 For instance, when you have a system with 16 MB
4529 RAM, and want to reserve 4 MB from use by Linux,
4530 you can do this by adding "mem=12M" to the value of
4531 the "bootargs" variable. However, now you must make
4532 sure that the initrd image is placed in the first
4533 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004534
wdenk6c59edc2004-05-03 20:45:30 +00004535 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004536
wdenk6c59edc2004-05-03 20:45:30 +00004537 If you set initrd_high to 0xFFFFFFFF, this is an
4538 indication to U-Boot that all addresses are legal
4539 for the Linux kernel, including addresses in flash
4540 memory. In this case U-Boot will NOT COPY the
4541 ramdisk at all. This may be useful to reduce the
4542 boot time on your system, but requires that this
4543 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004544
wdenk6c59edc2004-05-03 20:45:30 +00004545 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk6c59edc2004-05-03 20:45:30 +00004547 loadaddr - Default load address for commands like "bootp",
4548 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004551
wdenk6c59edc2004-05-03 20:45:30 +00004552 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004553
wdenk6c59edc2004-05-03 20:45:30 +00004554 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004555
wdenk6c59edc2004-05-03 20:45:30 +00004556 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk6c59edc2004-05-03 20:45:30 +00004558 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004559
Mike Frysingera23230c2011-10-02 10:01:27 +00004560 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004561
Mike Frysingera23230c2011-10-02 10:01:27 +00004562 ethact - controls which interface is currently active.
4563 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004564
Heiko Schocherc5e84052010-07-20 17:45:02 +02004565 => setenv ethact FEC
4566 => ping 192.168.0.1 # traffic sent on FEC
4567 => setenv ethact SCC
4568 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004569
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004570 ethrotate - When set to "no" U-Boot does not go through all
4571 available network interfaces.
4572 It just stays at the currently selected interface.
4573
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004574 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004575 either succeed or fail without retrying.
4576 When set to "once" the network operation will
4577 fail when all the available network interfaces
4578 are tried once without success.
4579 Useful on scripts which control the retry operation
4580 themselves.
wdenkc6097192002-11-03 00:24:07 +00004581
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004582 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004583
Wolfgang Denk227b5192005-09-24 23:25:46 +02004584 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004585 UDP source port.
4586
Wolfgang Denk227b5192005-09-24 23:25:46 +02004587 tftpdstport - If this is set, the value is used for TFTP's UDP
4588 destination port instead of the Well Know Port 69.
4589
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004590 tftpblocksize - Block size to use for TFTP transfers; if not set,
4591 we use the TFTP server's default block size
4592
4593 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4594 seconds, minimum value is 1000 = 1 second). Defines
4595 when a packet is considered to be lost so it has to
4596 be retransmitted. The default is 5000 = 5 seconds.
4597 Lowering this value may make downloads succeed
4598 faster in networks with high packet loss rates or
4599 with unreliable TFTP servers.
4600
4601 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004602 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004603 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004604
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004605The following image location variables contain the location of images
4606used in booting. The "Image" column gives the role of the image and is
4607not an environment variable name. The other columns are environment
4608variable names. "File Name" gives the name of the file on a TFTP
4609server, "RAM Address" gives the location in RAM the image will be
4610loaded to, and "Flash Location" gives the image's address in NOR
4611flash or offset in NAND flash.
4612
4613*Note* - these variables don't have to be defined for all boards, some
4614boards currenlty use other variables for these purposes, and some
4615boards use these variables for other purposes.
4616
Wolfgang Denk092ae952011-10-26 10:21:21 +00004617Image File Name RAM Address Flash Location
4618----- --------- ----------- --------------
4619u-boot u-boot u-boot_addr_r u-boot_addr
4620Linux kernel bootfile kernel_addr_r kernel_addr
4621device tree blob fdtfile fdt_addr_r fdt_addr
4622ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004623
wdenk6c59edc2004-05-03 20:45:30 +00004624The following environment variables may be used and automatically
4625updated by the network boot commands ("bootp" and "rarpboot"),
4626depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004627
wdenk6c59edc2004-05-03 20:45:30 +00004628 bootfile - see above
4629 dnsip - IP address of your Domain Name Server
4630 dnsip2 - IP address of your secondary Domain Name Server
4631 gatewayip - IP address of the Gateway (Router) to use
4632 hostname - Target hostname
4633 ipaddr - see above
4634 netmask - Subnet Mask
4635 rootpath - Pathname of the root filesystem on the NFS server
4636 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004637
wdenk145d2c12004-04-15 21:48:45 +00004638
wdenk6c59edc2004-05-03 20:45:30 +00004639There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004640
wdenk6c59edc2004-05-03 20:45:30 +00004641 serial# - contains hardware identification information such
4642 as type string and/or serial number
4643 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk6c59edc2004-05-03 20:45:30 +00004645These variables can be set only once (usually during manufacturing of
4646the board). U-Boot refuses to delete or overwrite these variables
4647once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004648
4649
wdenk6c59edc2004-05-03 20:45:30 +00004650Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004651
wdenk6c59edc2004-05-03 20:45:30 +00004652 ver - Contains the U-Boot version string as printed
4653 with the "version" command. This variable is
4654 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004655
wdenkc6097192002-11-03 00:24:07 +00004656
wdenk6c59edc2004-05-03 20:45:30 +00004657Please note that changes to some configuration parameters may take
4658only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004659
stroeseb9c17c52003-04-04 15:53:41 +00004660
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004661Callback functions for environment variables:
4662---------------------------------------------
4663
4664For some environment variables, the behavior of u-boot needs to change
4665when their values are changed. This functionailty allows functions to
4666be associated with arbitrary variables. On creation, overwrite, or
4667deletion, the callback will provide the opportunity for some side
4668effect to happen or for the change to be rejected.
4669
4670The callbacks are named and associated with a function using the
4671U_BOOT_ENV_CALLBACK macro in your board or driver code.
4672
4673These callbacks are associated with variables in one of two ways. The
4674static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4675in the board configuration to a string that defines a list of
4676associations. The list must be in the following format:
4677
4678 entry = variable_name[:callback_name]
4679 list = entry[,list]
4680
4681If the callback name is not specified, then the callback is deleted.
4682Spaces are also allowed anywhere in the list.
4683
4684Callbacks can also be associated by defining the ".callbacks" variable
4685with the same list format above. Any association in ".callbacks" will
4686override any association in the static list. You can define
4687CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4688".callbacks" envirnoment variable in the default or embedded environment.
4689
4690
wdenk6c59edc2004-05-03 20:45:30 +00004691Command Line Parsing:
4692=====================
stroeseb9c17c52003-04-04 15:53:41 +00004693
wdenk6c59edc2004-05-03 20:45:30 +00004694There are two different command line parsers available with U-Boot:
4695the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004696
wdenk6c59edc2004-05-03 20:45:30 +00004697Old, simple command line parser:
4698--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004699
wdenk6c59edc2004-05-03 20:45:30 +00004700- supports environment variables (through setenv / saveenv commands)
4701- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004702- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004703- special characters ('$', ';') can be escaped by prefixing with '\',
4704 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004705 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004706- You can also escape text by enclosing in single apostrophes, for example:
4707 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004708
wdenk6c59edc2004-05-03 20:45:30 +00004709Hush shell:
4710-----------
wdenkf4688a22003-05-28 08:06:31 +00004711
wdenk6c59edc2004-05-03 20:45:30 +00004712- similar to Bourne shell, with control structures like
4713 if...then...else...fi, for...do...done; while...do...done,
4714 until...do...done, ...
4715- supports environment ("global") variables (through setenv / saveenv
4716 commands) and local shell variables (through standard shell syntax
4717 "name=value"); only environment variables can be used with "run"
4718 command
wdenkf4688a22003-05-28 08:06:31 +00004719
wdenk6c59edc2004-05-03 20:45:30 +00004720General rules:
4721--------------
wdenkf4688a22003-05-28 08:06:31 +00004722
wdenk6c59edc2004-05-03 20:45:30 +00004723(1) If a command line (or an environment variable executed by a "run"
4724 command) contains several commands separated by semicolon, and
4725 one of these commands fails, then the remaining commands will be
4726 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004727
wdenk6c59edc2004-05-03 20:45:30 +00004728(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004729 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004730 command will cause "run" to terminate, i. e. the remaining
4731 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004732
wdenk6c59edc2004-05-03 20:45:30 +00004733Note for Redundant Ethernet Interfaces:
4734=======================================
wdenkf4688a22003-05-28 08:06:31 +00004735
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004736Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004737such configurations and is capable of automatic selection of a
4738"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004739
wdenk6c59edc2004-05-03 20:45:30 +00004740Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4741MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4742"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004743
wdenk6c59edc2004-05-03 20:45:30 +00004744If the network interface stores some valid MAC address (for instance
4745in SROM), this is used as default address if there is NO correspon-
4746ding setting in the environment; if the corresponding environment
4747variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004748
wdenk6c59edc2004-05-03 20:45:30 +00004749o If the SROM has a valid MAC address, and there is no address in the
4750 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk6c59edc2004-05-03 20:45:30 +00004752o If there is no valid address in the SROM, and a definition in the
4753 environment exists, then the value from the environment variable is
4754 used.
wdenkc6097192002-11-03 00:24:07 +00004755
wdenk6c59edc2004-05-03 20:45:30 +00004756o If both the SROM and the environment contain a MAC address, and
4757 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004758
wdenk6c59edc2004-05-03 20:45:30 +00004759o If both the SROM and the environment contain a MAC address, and the
4760 addresses differ, the value from the environment is used and a
4761 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004762
wdenk6c59edc2004-05-03 20:45:30 +00004763o If neither SROM nor the environment contain a MAC address, an error
4764 is raised.
wdenkc6097192002-11-03 00:24:07 +00004765
Ben Warren6db991a2010-04-26 11:11:46 -07004766If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004767will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004768may be skipped by setting the appropriate 'ethmacskip' environment variable.
4769The naming convention is as follows:
4770"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk6c59edc2004-05-03 20:45:30 +00004772Image Formats:
4773==============
wdenkc6097192002-11-03 00:24:07 +00004774
Marian Balakowicz18710b82008-03-12 12:13:13 +01004775U-Boot is capable of booting (and performing other auxiliary operations on)
4776images in two formats:
4777
4778New uImage format (FIT)
4779-----------------------
4780
4781Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4782to Flattened Device Tree). It allows the use of images with multiple
4783components (several kernels, ramdisks, etc.), with contents protected by
4784SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4785
4786
4787Old uImage format
4788-----------------
4789
4790Old image format is based on binary files which can be basically anything,
4791preceded by a special header; see the definitions in include/image.h for
4792details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004793
wdenk6c59edc2004-05-03 20:45:30 +00004794* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4795 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004796 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4797 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4798 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004799* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004800 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4801 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004802* Compression Type (uncompressed, gzip, bzip2)
4803* Load Address
4804* Entry Point
4805* Image Name
4806* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk6c59edc2004-05-03 20:45:30 +00004808The header is marked by a special Magic Number, and both the header
4809and the data portions of the image are secured against corruption by
4810CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004811
wdenkc6097192002-11-03 00:24:07 +00004812
wdenk6c59edc2004-05-03 20:45:30 +00004813Linux Support:
4814==============
wdenkc6097192002-11-03 00:24:07 +00004815
wdenk6c59edc2004-05-03 20:45:30 +00004816Although U-Boot should support any OS or standalone application
4817easily, the main focus has always been on Linux during the design of
4818U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820U-Boot includes many features that so far have been part of some
4821special "boot loader" code within the Linux kernel. Also, any
4822"initrd" images to be used are no longer part of one big Linux image;
4823instead, kernel and "initrd" are separate images. This implementation
4824serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004825
wdenk6c59edc2004-05-03 20:45:30 +00004826- the same features can be used for other OS or standalone
4827 applications (for instance: using compressed images to reduce the
4828 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk6c59edc2004-05-03 20:45:30 +00004830- it becomes much easier to port new Linux kernel versions because
4831 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004832
wdenk6c59edc2004-05-03 20:45:30 +00004833- the same Linux kernel image can now be used with different "initrd"
4834 images; of course this also means that different kernel images can
4835 be run with the same "initrd". This makes testing easier (you don't
4836 have to build a new "zImage.initrd" Linux image when you just
4837 change a file in your "initrd"). Also, a field-upgrade of the
4838 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004839
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk6c59edc2004-05-03 20:45:30 +00004841Linux HOWTO:
4842============
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk6c59edc2004-05-03 20:45:30 +00004844Porting Linux to U-Boot based systems:
4845---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004846
wdenk6c59edc2004-05-03 20:45:30 +00004847U-Boot cannot save you from doing all the necessary modifications to
4848configure the Linux device drivers for use with your target hardware
4849(no, we don't intend to provide a full virtual machine interface to
4850Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004851
Stefan Roese88fbf932010-04-15 16:07:28 +02004852But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004853
wdenk6c59edc2004-05-03 20:45:30 +00004854Just make sure your machine specific header file (for instance
4855include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02004856Information structure as we define in include/asm-<arch>/u-boot.h,
4857and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004858as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004859
wdenkc6097192002-11-03 00:24:07 +00004860
wdenk6c59edc2004-05-03 20:45:30 +00004861Configuring the Linux kernel:
4862-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004863
wdenk6c59edc2004-05-03 20:45:30 +00004864No specific requirements for U-Boot. Make sure you have some root
4865device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004866
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk6c59edc2004-05-03 20:45:30 +00004868Building a Linux Image:
4869-----------------------
wdenkc6097192002-11-03 00:24:07 +00004870
wdenk6c59edc2004-05-03 20:45:30 +00004871With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4872not used. If you use recent kernel source, a new build target
4873"uImage" will exist which automatically builds an image usable by
4874U-Boot. Most older kernels also have support for a "pImage" target,
4875which was introduced for our predecessor project PPCBoot and uses a
4876100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004877
wdenk6c59edc2004-05-03 20:45:30 +00004878Example:
wdenkc6097192002-11-03 00:24:07 +00004879
wdenk6c59edc2004-05-03 20:45:30 +00004880 make TQM850L_config
4881 make oldconfig
4882 make dep
4883 make uImage
wdenkc6097192002-11-03 00:24:07 +00004884
wdenk6c59edc2004-05-03 20:45:30 +00004885The "uImage" build target uses a special tool (in 'tools/mkimage') to
4886encapsulate a compressed Linux kernel image with header information,
4887CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk6c59edc2004-05-03 20:45:30 +00004889* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004890
wdenk6c59edc2004-05-03 20:45:30 +00004891* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893 ${CROSS_COMPILE}-objcopy -O binary \
4894 -R .note -R .comment \
4895 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004896
wdenk6c59edc2004-05-03 20:45:30 +00004897* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00004898
wdenk6c59edc2004-05-03 20:45:30 +00004899 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00004900
wdenk6c59edc2004-05-03 20:45:30 +00004901* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004902
wdenk6c59edc2004-05-03 20:45:30 +00004903 mkimage -A ppc -O linux -T kernel -C gzip \
4904 -a 0 -e 0 -n "Linux Kernel Image" \
4905 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00004906
wdenkc6097192002-11-03 00:24:07 +00004907
wdenk6c59edc2004-05-03 20:45:30 +00004908The "mkimage" tool can also be used to create ramdisk images for use
4909with U-Boot, either separated from the Linux kernel image, or
4910combined into one file. "mkimage" encapsulates the images with a 64
4911byte header containing information about target architecture,
4912operating system, image type, compression method, entry points, time
4913stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00004914
wdenk6c59edc2004-05-03 20:45:30 +00004915"mkimage" can be called in two ways: to verify existing images and
4916print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004917
wdenk6c59edc2004-05-03 20:45:30 +00004918In the first form (with "-l" option) mkimage lists the information
4919contained in the header of an existing U-Boot image; this includes
4920checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004921
wdenk6c59edc2004-05-03 20:45:30 +00004922 tools/mkimage -l image
4923 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004924
wdenk6c59edc2004-05-03 20:45:30 +00004925The second form (with "-d" option) is used to build a U-Boot image
4926from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004927
wdenk6c59edc2004-05-03 20:45:30 +00004928 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4929 -n name -d data_file image
4930 -A ==> set architecture to 'arch'
4931 -O ==> set operating system to 'os'
4932 -T ==> set image type to 'type'
4933 -C ==> set compression type 'comp'
4934 -a ==> set load address to 'addr' (hex)
4935 -e ==> set entry point to 'ep' (hex)
4936 -n ==> set image name to 'name'
4937 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004938
wdenkcd914452004-05-29 16:53:29 +00004939Right now, all Linux kernels for PowerPC systems use the same load
4940address (0x00000000), but the entry point address depends on the
4941kernel version:
wdenkc6097192002-11-03 00:24:07 +00004942
wdenk6c59edc2004-05-03 20:45:30 +00004943- 2.2.x kernels have the entry point at 0x0000000C,
4944- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004945
wdenk6c59edc2004-05-03 20:45:30 +00004946So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004947
wdenk6c59edc2004-05-03 20:45:30 +00004948 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4949 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004950 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00004951 > examples/uImage.TQM850L
4952 Image Name: 2.4.4 kernel for TQM850L
4953 Created: Wed Jul 19 02:34:59 2000
4954 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4955 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4956 Load Address: 0x00000000
4957 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004958
wdenk6c59edc2004-05-03 20:45:30 +00004959To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004960
wdenk6c59edc2004-05-03 20:45:30 +00004961 -> tools/mkimage -l examples/uImage.TQM850L
4962 Image Name: 2.4.4 kernel for TQM850L
4963 Created: Wed Jul 19 02:34:59 2000
4964 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4965 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4966 Load Address: 0x00000000
4967 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004968
wdenk6c59edc2004-05-03 20:45:30 +00004969NOTE: for embedded systems where boot time is critical you can trade
4970speed for memory and install an UNCOMPRESSED image instead: this
4971needs more space in Flash, but boots much faster since it does not
4972need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004973
Stefan Roese88fbf932010-04-15 16:07:28 +02004974 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00004975 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4976 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02004977 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00004978 > examples/uImage.TQM850L-uncompressed
4979 Image Name: 2.4.4 kernel for TQM850L
4980 Created: Wed Jul 19 02:34:59 2000
4981 Image Type: PowerPC Linux Kernel Image (uncompressed)
4982 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4983 Load Address: 0x00000000
4984 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004985
wdenkc6097192002-11-03 00:24:07 +00004986
wdenk6c59edc2004-05-03 20:45:30 +00004987Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4988when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990 -> tools/mkimage -n 'Simple Ramdisk Image' \
4991 > -A ppc -O linux -T ramdisk -C gzip \
4992 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4993 Image Name: Simple Ramdisk Image
4994 Created: Wed Jan 12 14:01:50 2000
4995 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4996 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4997 Load Address: 0x00000000
4998 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004999
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001Installing a Linux Image:
5002-------------------------
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk6c59edc2004-05-03 20:45:30 +00005004To downloading a U-Boot image over the serial (console) interface,
5005you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005006
wdenk6c59edc2004-05-03 20:45:30 +00005007 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005008
wdenk6c59edc2004-05-03 20:45:30 +00005009The 'objcopy' does not understand the information in the U-Boot
5010image header, so the resulting S-Record file will be relative to
5011address 0x00000000. To load it to a given address, you need to
5012specify the target address as 'offset' parameter with the 'loads'
5013command.
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk6c59edc2004-05-03 20:45:30 +00005015Example: install the image to address 0x40100000 (which on the
5016TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk6c59edc2004-05-03 20:45:30 +00005018 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005019
wdenk6c59edc2004-05-03 20:45:30 +00005020 .......... done
5021 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005022
wdenk6c59edc2004-05-03 20:45:30 +00005023 => loads 40100000
5024 ## Ready for S-Record download ...
5025 ~>examples/image.srec
5026 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5027 ...
5028 15989 15990 15991 15992
5029 [file transfer complete]
5030 [connected]
5031 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005032
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk6c59edc2004-05-03 20:45:30 +00005034You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005035this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005036corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005037
wdenk6c59edc2004-05-03 20:45:30 +00005038 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk6c59edc2004-05-03 20:45:30 +00005040 ## Checking Image at 40100000 ...
5041 Image Name: 2.2.13 for initrd on TQM850L
5042 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5043 Data Size: 335725 Bytes = 327 kB = 0 MB
5044 Load Address: 00000000
5045 Entry Point: 0000000c
5046 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005047
5048
wdenk6c59edc2004-05-03 20:45:30 +00005049Boot Linux:
5050-----------
wdenkc6097192002-11-03 00:24:07 +00005051
wdenk6c59edc2004-05-03 20:45:30 +00005052The "bootm" command is used to boot an application that is stored in
5053memory (RAM or Flash). In case of a Linux kernel image, the contents
5054of the "bootargs" environment variable is passed to the kernel as
5055parameters. You can check and modify this variable using the
5056"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005057
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk6c59edc2004-05-03 20:45:30 +00005059 => printenv bootargs
5060 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062 => 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 +00005063
wdenk6c59edc2004-05-03 20:45:30 +00005064 => printenv bootargs
5065 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 +00005066
wdenk6c59edc2004-05-03 20:45:30 +00005067 => bootm 40020000
5068 ## Booting Linux kernel at 40020000 ...
5069 Image Name: 2.2.13 for NFS on TQM850L
5070 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5071 Data Size: 381681 Bytes = 372 kB = 0 MB
5072 Load Address: 00000000
5073 Entry Point: 0000000c
5074 Verifying Checksum ... OK
5075 Uncompressing Kernel Image ... OK
5076 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
5077 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5078 time_init: decrementer frequency = 187500000/60
5079 Calibrating delay loop... 49.77 BogoMIPS
5080 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5081 ...
wdenkc6097192002-11-03 00:24:07 +00005082
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005083If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005084the memory addresses of both the kernel and the initrd image (PPBCOOT
5085format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005086
wdenk6c59edc2004-05-03 20:45:30 +00005087 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005088
wdenk6c59edc2004-05-03 20:45:30 +00005089 ## Checking Image at 40100000 ...
5090 Image Name: 2.2.13 for initrd on TQM850L
5091 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5092 Data Size: 335725 Bytes = 327 kB = 0 MB
5093 Load Address: 00000000
5094 Entry Point: 0000000c
5095 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk6c59edc2004-05-03 20:45:30 +00005097 ## Checking Image at 40200000 ...
5098 Image Name: Simple Ramdisk Image
5099 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5100 Data Size: 566530 Bytes = 553 kB = 0 MB
5101 Load Address: 00000000
5102 Entry Point: 00000000
5103 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005104
wdenk6c59edc2004-05-03 20:45:30 +00005105 => bootm 40100000 40200000
5106 ## Booting Linux kernel at 40100000 ...
5107 Image Name: 2.2.13 for initrd on TQM850L
5108 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5109 Data Size: 335725 Bytes = 327 kB = 0 MB
5110 Load Address: 00000000
5111 Entry Point: 0000000c
5112 Verifying Checksum ... OK
5113 Uncompressing Kernel Image ... OK
5114 ## Loading RAMDisk Image at 40200000 ...
5115 Image Name: Simple Ramdisk Image
5116 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5117 Data Size: 566530 Bytes = 553 kB = 0 MB
5118 Load Address: 00000000
5119 Entry Point: 00000000
5120 Verifying Checksum ... OK
5121 Loading Ramdisk ... OK
5122 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
5123 Boot arguments: root=/dev/ram
5124 time_init: decrementer frequency = 187500000/60
5125 Calibrating delay loop... 49.77 BogoMIPS
5126 ...
5127 RAMDISK: Compressed image found at block 0
5128 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005129
wdenk6c59edc2004-05-03 20:45:30 +00005130 bash#
wdenkc6097192002-11-03 00:24:07 +00005131
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005132Boot Linux and pass a flat device tree:
5133-----------
5134
5135First, U-Boot must be compiled with the appropriate defines. See the section
5136titled "Linux Kernel Interface" above for a more in depth explanation. The
5137following is an example of how to start a kernel and pass an updated
5138flat device tree:
5139
5140=> print oftaddr
5141oftaddr=0x300000
5142=> print oft
5143oft=oftrees/mpc8540ads.dtb
5144=> tftp $oftaddr $oft
5145Speed: 1000, full duplex
5146Using TSEC0 device
5147TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5148Filename 'oftrees/mpc8540ads.dtb'.
5149Load address: 0x300000
5150Loading: #
5151done
5152Bytes transferred = 4106 (100a hex)
5153=> tftp $loadaddr $bootfile
5154Speed: 1000, full duplex
5155Using TSEC0 device
5156TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5157Filename 'uImage'.
5158Load address: 0x200000
5159Loading:############
5160done
5161Bytes transferred = 1029407 (fb51f hex)
5162=> print loadaddr
5163loadaddr=200000
5164=> print oftaddr
5165oftaddr=0x300000
5166=> bootm $loadaddr - $oftaddr
5167## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005168 Image Name: Linux-2.6.17-dirty
5169 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5170 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005171 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005172 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005173 Verifying Checksum ... OK
5174 Uncompressing Kernel Image ... OK
5175Booting using flat device tree at 0x300000
5176Using MPC85xx ADS machine description
5177Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5178[snip]
5179
5180
wdenk6c59edc2004-05-03 20:45:30 +00005181More About U-Boot Image Types:
5182------------------------------
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005185
wdenk6c59edc2004-05-03 20:45:30 +00005186 "Standalone Programs" are directly runnable in the environment
5187 provided by U-Boot; it is expected that (if they behave
5188 well) you can continue to work in U-Boot after return from
5189 the Standalone Program.
5190 "OS Kernel Images" are usually images of some Embedded OS which
5191 will take over control completely. Usually these programs
5192 will install their own set of exception handlers, device
5193 drivers, set up the MMU, etc. - this means, that you cannot
5194 expect to re-enter U-Boot except by resetting the CPU.
5195 "RAMDisk Images" are more or less just data blocks, and their
5196 parameters (address, size) are passed to an OS kernel that is
5197 being started.
5198 "Multi-File Images" contain several images, typically an OS
5199 (Linux) kernel image and one or more data images like
5200 RAMDisks. This construct is useful for instance when you want
5201 to boot over the network using BOOTP etc., where the boot
5202 server provides just a single image file, but you want to get
5203 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk6c59edc2004-05-03 20:45:30 +00005205 "Multi-File Images" start with a list of image sizes, each
5206 image size (in bytes) specified by an "uint32_t" in network
5207 byte order. This list is terminated by an "(uint32_t)0".
5208 Immediately after the terminating 0 follow the images, one by
5209 one, all aligned on "uint32_t" boundaries (size rounded up to
5210 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk6c59edc2004-05-03 20:45:30 +00005212 "Firmware Images" are binary images containing firmware (like
5213 U-Boot or FPGA images) which usually will be programmed to
5214 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005215
wdenk6c59edc2004-05-03 20:45:30 +00005216 "Script files" are command sequences that will be executed by
5217 U-Boot's command interpreter; this feature is especially
5218 useful when you configure U-Boot to use a real shell (hush)
5219 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005220
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005221Booting the Linux zImage:
5222-------------------------
5223
5224On some platforms, it's possible to boot Linux zImage. This is done
5225using the "bootz" command. The syntax of "bootz" command is the same
5226as the syntax of "bootm" command.
5227
Tom Rini45f46d12013-05-16 11:40:11 -04005228Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005229kernel with raw initrd images. The syntax is slightly different, the
5230address of the initrd must be augmented by it's size, in the following
5231format: "<initrd addres>:<initrd size>".
5232
stroeseb9c17c52003-04-04 15:53:41 +00005233
wdenk6c59edc2004-05-03 20:45:30 +00005234Standalone HOWTO:
5235=================
stroeseb9c17c52003-04-04 15:53:41 +00005236
wdenk6c59edc2004-05-03 20:45:30 +00005237One of the features of U-Boot is that you can dynamically load and
5238run "standalone" applications, which can use some resources of
5239U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005240
wdenk6c59edc2004-05-03 20:45:30 +00005241Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005242
wdenk6c59edc2004-05-03 20:45:30 +00005243"Hello World" Demo:
5244-------------------
wdenkc6097192002-11-03 00:24:07 +00005245
wdenk6c59edc2004-05-03 20:45:30 +00005246'examples/hello_world.c' contains a small "Hello World" Demo
5247application; it is automatically compiled when you build U-Boot.
5248It's configured to run at address 0x00040004, so you can play with it
5249like that:
wdenkc6097192002-11-03 00:24:07 +00005250
wdenk6c59edc2004-05-03 20:45:30 +00005251 => loads
5252 ## Ready for S-Record download ...
5253 ~>examples/hello_world.srec
5254 1 2 3 4 5 6 7 8 9 10 11 ...
5255 [file transfer complete]
5256 [connected]
5257 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259 => go 40004 Hello World! This is a test.
5260 ## Starting application at 0x00040004 ...
5261 Hello World
5262 argc = 7
5263 argv[0] = "40004"
5264 argv[1] = "Hello"
5265 argv[2] = "World!"
5266 argv[3] = "This"
5267 argv[4] = "is"
5268 argv[5] = "a"
5269 argv[6] = "test."
5270 argv[7] = "<NULL>"
5271 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005272
wdenk6c59edc2004-05-03 20:45:30 +00005273 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005274
wdenk6c59edc2004-05-03 20:45:30 +00005275Another example, which demonstrates how to register a CPM interrupt
5276handler with the U-Boot code, can be found in 'examples/timer.c'.
5277Here, a CPM timer is set up to generate an interrupt every second.
5278The interrupt service routine is trivial, just printing a '.'
5279character, but this is just a demo program. The application can be
5280controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005281
wdenk6c59edc2004-05-03 20:45:30 +00005282 ? - print current values og the CPM Timer registers
5283 b - enable interrupts and start timer
5284 e - stop timer and disable interrupts
5285 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287 => loads
5288 ## Ready for S-Record download ...
5289 ~>examples/timer.srec
5290 1 2 3 4 5 6 7 8 9 10 11 ...
5291 [file transfer complete]
5292 [connected]
5293 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295 => go 40004
5296 ## Starting application at 0x00040004 ...
5297 TIMERS=0xfff00980
5298 Using timer 1
5299 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005300
wdenk6c59edc2004-05-03 20:45:30 +00005301Hit 'b':
5302 [q, b, e, ?] Set interval 1000000 us
5303 Enabling timer
5304Hit '?':
5305 [q, b, e, ?] ........
5306 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5307Hit '?':
5308 [q, b, e, ?] .
5309 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5310Hit '?':
5311 [q, b, e, ?] .
5312 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5313Hit '?':
5314 [q, b, e, ?] .
5315 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5316Hit 'e':
5317 [q, b, e, ?] ...Stopping timer
5318Hit 'q':
5319 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005320
wdenkc6097192002-11-03 00:24:07 +00005321
wdenk6c59edc2004-05-03 20:45:30 +00005322Minicom warning:
5323================
wdenkc6097192002-11-03 00:24:07 +00005324
wdenk6c59edc2004-05-03 20:45:30 +00005325Over time, many people have reported problems when trying to use the
5326"minicom" terminal emulation program for serial download. I (wd)
5327consider minicom to be broken, and recommend not to use it. Under
5328Unix, I recommend to use C-Kermit for general purpose use (and
5329especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005330use "cu" for S-Record download ("loads" command). See
5331http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5332for help with kermit.
5333
wdenkc6097192002-11-03 00:24:07 +00005334
wdenk6c59edc2004-05-03 20:45:30 +00005335Nevertheless, if you absolutely want to use it try adding this
5336configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005337
wdenk6c59edc2004-05-03 20:45:30 +00005338 Name Program Name U/D FullScr IO-Red. Multi
5339 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5340 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005341
wdenk8dba0502003-03-31 16:34:49 +00005342
wdenk6c59edc2004-05-03 20:45:30 +00005343NetBSD Notes:
5344=============
wdenkc6097192002-11-03 00:24:07 +00005345
wdenk6c59edc2004-05-03 20:45:30 +00005346Starting at version 0.9.2, U-Boot supports NetBSD both as host
5347(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349Building requires a cross environment; it is known to work on
5350NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5351need gmake since the Makefiles are not compatible with BSD make).
5352Note that the cross-powerpc package does not install include files;
5353attempting to build U-Boot will fail because <machine/ansi.h> is
5354missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005355
wdenk6c59edc2004-05-03 20:45:30 +00005356 # cd /usr/pkg/cross/powerpc-netbsd/include
5357 # mkdir powerpc
5358 # ln -s powerpc machine
5359 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5360 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005361
wdenk6c59edc2004-05-03 20:45:30 +00005362Native builds *don't* work due to incompatibilities between native
5363and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk6c59edc2004-05-03 20:45:30 +00005365Booting assumes that (the first part of) the image booted is a
5366stage-2 loader which in turn loads and then invokes the kernel
5367proper. Loader sources will eventually appear in the NetBSD source
5368tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005369meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005370
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372Implementation Internals:
5373=========================
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk6c59edc2004-05-03 20:45:30 +00005375The following is not intended to be a complete description of every
5376implementation detail. However, it should help to understand the
5377inner workings of U-Boot and make it easier to port it to custom
5378hardware.
wdenkc6097192002-11-03 00:24:07 +00005379
wdenkc6097192002-11-03 00:24:07 +00005380
wdenk6c59edc2004-05-03 20:45:30 +00005381Initial Stack, Global Data:
5382---------------------------
wdenkc6097192002-11-03 00:24:07 +00005383
wdenk6c59edc2004-05-03 20:45:30 +00005384The implementation of U-Boot is complicated by the fact that U-Boot
5385starts running out of ROM (flash memory), usually without access to
5386system RAM (because the memory controller is not initialized yet).
5387This means that we don't have writable Data or BSS segments, and BSS
5388is not initialized as zero. To be able to get a C environment working
5389at all, we have to allocate at least a minimal stack. Implementation
5390options for this are defined and restricted by the CPU used: Some CPU
5391models provide on-chip memory (like the IMMR area on MPC8xx and
5392MPC826x processors), on others (parts of) the data cache can be
5393locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005394
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005395 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005396 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005397
wdenk6c59edc2004-05-03 20:45:30 +00005398 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5399 From: "Chris Hallinan" <clh@net1plus.com>
5400 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5401 ...
wdenkc6097192002-11-03 00:24:07 +00005402
wdenk6c59edc2004-05-03 20:45:30 +00005403 Correct me if I'm wrong, folks, but the way I understand it
5404 is this: Using DCACHE as initial RAM for Stack, etc, does not
5405 require any physical RAM backing up the cache. The cleverness
5406 is that the cache is being used as a temporary supply of
5407 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005408 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005409 can see how this works by studying the cache architecture and
5410 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk6c59edc2004-05-03 20:45:30 +00005412 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5413 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005414 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005415 option should work for you. Using CS 4 should be fine if your
5416 board designers haven't used it for something that would
5417 cause you grief during the initial boot! It is frequently not
5418 used.
wdenkc6097192002-11-03 00:24:07 +00005419
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005420 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005421 with your processor/board/system design. The default value
5422 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005423 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005424 than your SDRAM module. If you have a 64MB SDRAM module, set
5425 it above 400_0000. Just make sure your board has no resources
5426 that are supposed to respond to that address! That code in
5427 start.S has been around a while and should work as is when
5428 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005429
wdenk6c59edc2004-05-03 20:45:30 +00005430 -Chris Hallinan
5431 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005432
wdenk6c59edc2004-05-03 20:45:30 +00005433It is essential to remember this, since it has some impact on the C
5434code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005435
wdenk6c59edc2004-05-03 20:45:30 +00005436* Initialized global data (data segment) is read-only. Do not attempt
5437 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005438
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005439* Do not use any uninitialized global data (or implicitely initialized
wdenk6c59edc2004-05-03 20:45:30 +00005440 as zero data - BSS segment) at all - this is undefined, initiali-
5441 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005442
wdenk6c59edc2004-05-03 20:45:30 +00005443* Stack space is very limited. Avoid big data buffers or things like
5444 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005445
wdenk6c59edc2004-05-03 20:45:30 +00005446Having only the stack as writable memory limits means we cannot use
5447normal global data to share information beween the code. But it
5448turned out that the implementation of U-Boot can be greatly
5449simplified by making a global data structure (gd_t) available to all
5450functions. We could pass a pointer to this data as argument to _all_
5451functions, but this would bloat the code. Instead we use a feature of
5452the GCC compiler (Global Register Variables) to share the data: we
5453place a pointer (gd) to the global data into a register which we
5454reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005455
wdenk6c59edc2004-05-03 20:45:30 +00005456When choosing a register for such a purpose we are restricted by the
5457relevant (E)ABI specifications for the current architecture, and by
5458GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005459
wdenk6c59edc2004-05-03 20:45:30 +00005460For PowerPC, the following registers have specific use:
5461 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005462 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005463 R3-R4: parameter passing and return values
5464 R5-R10: parameter passing
5465 R13: small data area pointer
5466 R30: GOT pointer
5467 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005468
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005469 (U-Boot also uses R12 as internal GOT pointer. r12
5470 is a volatile register so r12 needs to be reset when
5471 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005472
Wolfgang Denk69c09642008-02-14 22:43:22 +01005473 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005474
wdenk6c59edc2004-05-03 20:45:30 +00005475 Note: on PPC, we could use a static initializer (since the
5476 address of the global data structure is known at compile time),
5477 but it turned out that reserving a register results in somewhat
5478 smaller code - although the code savings are not that big (on
5479 average for all boards 752 bytes for the whole U-Boot image,
5480 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005481
Robin Getz2773d5f2009-08-17 15:23:02 +00005482On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005483 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5484
Robin Getz2773d5f2009-08-17 15:23:02 +00005485 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005486
wdenk6c59edc2004-05-03 20:45:30 +00005487On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005488
wdenk6c59edc2004-05-03 20:45:30 +00005489 R0: function argument word/integer result
5490 R1-R3: function argument word
5491 R9: GOT pointer
5492 R10: stack limit (used only if stack checking if enabled)
5493 R11: argument (frame) pointer
5494 R12: temporary workspace
5495 R13: stack pointer
5496 R14: link register
5497 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005498
wdenk6c59edc2004-05-03 20:45:30 +00005499 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005500
Thomas Chou8fa38582010-05-21 11:08:03 +08005501On Nios II, the ABI is documented here:
5502 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5503
5504 ==> U-Boot will use gp to hold a pointer to the global data
5505
5506 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5507 to access small data sections, so gp is free.
5508
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005509On NDS32, the following registers are used:
5510
5511 R0-R1: argument/return
5512 R2-R5: argument
5513 R15: temporary register for assembler
5514 R16: trampoline register
5515 R28: frame pointer (FP)
5516 R29: global pointer (GP)
5517 R30: link register (LP)
5518 R31: stack pointer (SP)
5519 PC: program counter (PC)
5520
5521 ==> U-Boot will use R10 to hold a pointer to the global data
5522
Wolfgang Denk6405a152006-03-31 18:32:53 +02005523NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5524or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk6c59edc2004-05-03 20:45:30 +00005526Memory Management:
5527------------------
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk6c59edc2004-05-03 20:45:30 +00005529U-Boot runs in system state and uses physical addresses, i.e. the
5530MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005531
wdenk6c59edc2004-05-03 20:45:30 +00005532The available memory is mapped to fixed addresses using the memory
5533controller. In this process, a contiguous block is formed for each
5534memory type (Flash, SDRAM, SRAM), even when it consists of several
5535physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537U-Boot is installed in the first 128 kB of the first Flash bank (on
5538TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5539booting and sizing and initializing DRAM, the code relocates itself
5540to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005541memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005542configuration setting]. Below that, a structure with global Board
5543Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005544
wdenk6c59edc2004-05-03 20:45:30 +00005545Additionally, some exception handler code is copied to the low 8 kB
5546of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005547
wdenk6c59edc2004-05-03 20:45:30 +00005548So a typical memory configuration with 16 MB of DRAM could look like
5549this:
wdenkc6097192002-11-03 00:24:07 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551 0x0000 0000 Exception Vector code
5552 :
5553 0x0000 1FFF
5554 0x0000 2000 Free for Application Use
5555 :
5556 :
wdenkc6097192002-11-03 00:24:07 +00005557
wdenk6c59edc2004-05-03 20:45:30 +00005558 :
5559 :
5560 0x00FB FF20 Monitor Stack (Growing downward)
5561 0x00FB FFAC Board Info Data and permanent copy of global data
5562 0x00FC 0000 Malloc Arena
5563 :
5564 0x00FD FFFF
5565 0x00FE 0000 RAM Copy of Monitor Code
5566 ... eventually: LCD or video framebuffer
5567 ... eventually: pRAM (Protected RAM - unchanged by reset)
5568 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005569
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk6c59edc2004-05-03 20:45:30 +00005571System Initialization:
5572----------------------
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk6c59edc2004-05-03 20:45:30 +00005574In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005575(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk6c59edc2004-05-03 20:45:30 +00005576configuration for CS0# this is a mirror of the onboard Flash memory.
5577To be able to re-map memory U-Boot then jumps to its link address.
5578To be able to implement the initialization code in C, a (small!)
5579initial stack is set up in the internal Dual Ported RAM (in case CPUs
5580which provide such a feature like MPC8xx or MPC8260), or in a locked
5581part of the data cache. After that, U-Boot initializes the CPU core,
5582the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk6c59edc2004-05-03 20:45:30 +00005584Next, all (potentially) available memory banks are mapped using a
5585preliminary mapping. For example, we put them on 512 MB boundaries
5586(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5587on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5588programmed for SDRAM access. Using the temporary configuration, a
5589simple memory test is run that determines the size of the SDRAM
5590banks.
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk6c59edc2004-05-03 20:45:30 +00005592When there is more than one SDRAM bank, and the banks are of
5593different size, the largest is mapped first. For equal size, the first
5594bank (CS2#) is mapped first. The first mapping is always for address
55950x00000000, with any additional banks following immediately to create
5596contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005597
wdenk6c59edc2004-05-03 20:45:30 +00005598Then, the monitor installs itself at the upper end of the SDRAM area
5599and allocates memory for use by malloc() and for the global Board
5600Info data; also, the exception vector code is copied to the low RAM
5601pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005602
wdenk6c59edc2004-05-03 20:45:30 +00005603Only after this relocation will you have a "normal" C environment;
5604until that you are restricted in several ways, mostly because you are
5605running from ROM, and because the code will have to be relocated to a
5606new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005607
wdenkc6097192002-11-03 00:24:07 +00005608
wdenk6c59edc2004-05-03 20:45:30 +00005609U-Boot Porting Guide:
5610----------------------
wdenkc6097192002-11-03 00:24:07 +00005611
wdenk6c59edc2004-05-03 20:45:30 +00005612[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5613list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005614
wdenkc6097192002-11-03 00:24:07 +00005615
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005616int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005617{
5618 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005619
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005620 signal(SIGALRM, no_more_time);
5621 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005622
wdenk6c59edc2004-05-03 20:45:30 +00005623 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005624 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005625 return 0;
5626 }
wdenkc6097192002-11-03 00:24:07 +00005627
wdenk6c59edc2004-05-03 20:45:30 +00005628 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005629
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005630 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005631
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005632 if (clueless)
5633 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005634
wdenk6c59edc2004-05-03 20:45:30 +00005635 while (learning) {
5636 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005637 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5638 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005639 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005640 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005641 }
wdenkc6097192002-11-03 00:24:07 +00005642
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005643 if (available_money > toLocalCurrency ($2500))
5644 Buy a BDI3000;
5645 else
wdenk6c59edc2004-05-03 20:45:30 +00005646 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005647
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005648 if (a similar board exists) { /* hopefully... */
5649 cp -a board/<similar> board/<myboard>
5650 cp include/configs/<similar>.h include/configs/<myboard>.h
5651 } else {
5652 Create your own board support subdirectory;
5653 Create your own board include/configs/<myboard>.h file;
5654 }
5655 Edit new board/<myboard> files
5656 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005657
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005658 while (!accepted) {
5659 while (!running) {
5660 do {
5661 Add / modify source code;
5662 } until (compiles);
5663 Debug;
5664 if (clueless)
5665 email("Hi, I am having problems...");
5666 }
5667 Send patch file to the U-Boot email list;
5668 if (reasonable critiques)
5669 Incorporate improvements from email list code review;
5670 else
5671 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005672 }
wdenkc6097192002-11-03 00:24:07 +00005673
wdenk6c59edc2004-05-03 20:45:30 +00005674 return 0;
5675}
wdenkc6097192002-11-03 00:24:07 +00005676
wdenk6c59edc2004-05-03 20:45:30 +00005677void no_more_time (int sig)
5678{
5679 hire_a_guru();
5680}
wdenkc6097192002-11-03 00:24:07 +00005681
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk6c59edc2004-05-03 20:45:30 +00005683Coding Standards:
5684-----------------
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk6c59edc2004-05-03 20:45:30 +00005686All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005687coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005688"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005689
5690Source files originating from a different project (for example the
5691MTD subsystem) are generally exempt from these guidelines and are not
5692reformated to ease subsequent migration to newer versions of those
5693sources.
wdenkc6097192002-11-03 00:24:07 +00005694
Detlev Zundelaa63d482006-09-01 15:39:02 +02005695Please note that U-Boot is implemented in C (and to some small parts in
5696Assembler); no C++ is used, so please do not use C++ style comments (//)
5697in your code.
wdenkad276f22004-01-04 16:28:35 +00005698
wdenk6c59edc2004-05-03 20:45:30 +00005699Please also stick to the following formatting rules:
5700- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005701- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005702- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005703- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005704- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706Submissions which do not conform to the standards may be returned
5707with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005708
wdenkc6097192002-11-03 00:24:07 +00005709
wdenk6c59edc2004-05-03 20:45:30 +00005710Submitting Patches:
5711-------------------
wdenkc6097192002-11-03 00:24:07 +00005712
wdenk6c59edc2004-05-03 20:45:30 +00005713Since the number of patches for U-Boot is growing, we need to
5714establish some rules. Submissions which do not conform to these rules
5715may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005716
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005717Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005718
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005719Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5720see http://lists.denx.de/mailman/listinfo/u-boot
5721
wdenk6c59edc2004-05-03 20:45:30 +00005722When you send a patch, please include the following information with
5723it:
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725* For bug fixes: a description of the bug and how your patch fixes
5726 this bug. Please try to include a way of demonstrating that the
5727 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk6c59edc2004-05-03 20:45:30 +00005729* For new features: a description of the feature and your
5730 implementation.
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk6c59edc2004-05-03 20:45:30 +00005732* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005733
wdenk6c59edc2004-05-03 20:45:30 +00005734* For major contributions, your entry to the CREDITS file
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk6c59edc2004-05-03 20:45:30 +00005736* When you add support for a new board, don't forget to add this
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005737 board to the MAINTAINERS file, too.
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk6c59edc2004-05-03 20:45:30 +00005739* If your patch adds new configuration options, don't forget to
5740 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005741
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005742* The patch itself. If you are using git (which is *strongly*
5743 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005744 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005745 the U-Boot mailing list, you will avoid most of the common problems
5746 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005747
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005748 If you cannot use git, use "diff -purN OLD NEW". If your version of
5749 diff does not support these options, then get the latest version of
5750 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005751
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005752 The current directory when running this command shall be the parent
5753 directory of the U-Boot source tree (i. e. please make sure that
5754 your patch includes sufficient directory information for the
5755 affected files).
5756
5757 We prefer patches as plain text. MIME attachments are discouraged,
5758 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005759
wdenk6c59edc2004-05-03 20:45:30 +00005760* If one logical set of modifications affects or creates several
5761 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005762
wdenk6c59edc2004-05-03 20:45:30 +00005763* Changesets that contain different, unrelated modifications shall be
5764 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005765
wdenkc6097192002-11-03 00:24:07 +00005766
wdenk6c59edc2004-05-03 20:45:30 +00005767Notes:
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769* Before sending the patch, run the MAKEALL script on your patched
5770 source tree and make sure that no errors or warnings are reported
5771 for any of the boards.
5772
5773* Keep your modifications to the necessary minimum: A patch
5774 containing several unrelated changes or arbitrary reformats will be
5775 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005776
wdenk6c59edc2004-05-03 20:45:30 +00005777* If you modify existing code, make sure that your new code does not
5778 add to the memory footprint of the code ;-) Small is beautiful!
5779 When adding new features, these should compile conditionally only
5780 (using #ifdef), and the resulting code with the new feature
5781 disabled must not need more memory than the old code without your
5782 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005783
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005784* Remember that there is a size limit of 100 kB per message on the
5785 u-boot mailing list. Bigger patches will be moderated. If they are
5786 reasonable and not too big, they will be acknowledged. But patches
5787 bigger than the size limit should be avoided.