blob: 137e8cb949a33ccf25873064a62eed64774bb0be [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-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
wdenke86e5a02004-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 Denk218ca722008-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. Dayadb9d852012-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 Tyser0c325652008-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 Denk218ca722008-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 Ziswiler11ccc332008-07-09 08:17:15 +020082any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010083available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84directory.
85
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010086Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-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 Lilja0d28f342008-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:
126
127 U_BOOT_VERSION u_boot_logo
128 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000129
130
wdenk93f19cc2002-12-17 17:55:09 +0000131Versioning:
132===========
133
Thomas Weber360d8832010-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.
wdenk93f19cc2002-12-17 17:55:09 +0000140
Thomas Weber360d8832010-09-28 08:06:25 +0200141Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000142 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-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
wdenk93f19cc2002-12-17 17:55:09 +0000145
146
wdenkc6097192002-11-03 00:24:07 +0000147Directory Hierarchy:
148====================
149
Peter Tyser8d321b82010-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ßmann6eb09212011-07-18 09:41:08 +0000155 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200156 /imx Files specific to Freescale MC9328 i.MX CPUs
157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-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 Russfea25722011-04-13 19:43:28 +1000172 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-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 Schwierzeck92bbd642011-07-27 13:22:39 +0200188 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800189 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /lib Architecture specific library files
Macpaul Linafc1ce82011-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 Tyser8d321b82010-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 Roesea47a12b2010-04-15 16:07:28 +0200198 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-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 Tyser8d321b82010-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-VILLARD6d0f6bc2008-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 Ziswiler11ccc332008-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
wdenk7f6c2cb2002-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 Phillips26281142007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips26281142007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-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 Ziswiler11ccc332008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
wdenk2535d602003-07-17 23:16:40 +0000324- Board flavour: (if CONFIG_MPC8260ADS is defined)
325 CONFIG_ADSTYPE
326 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-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
wdenk2535d602003-07-17 23:16:40 +0000331
Lei Wencf946c62011-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)
wdenk5da627a2003-10-09 20:09:04 +0000338 Define exactly one of
339 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000340
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200341- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
343 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000344 e.g. if there is no 32KHz
345 reference PIT/RTC clock
wdenk66ca92a2004-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
wdenk66ca92a2004-09-28 17:59:53 +0000349- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200350 CONFIG_SYS_8xx_CPUCLK_MIN
351 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000352 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000353 See doc/README.MPC866
354
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200355 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000356
wdenkba56f622004-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200362 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000363
Heiko Schocher506f3912009-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 Gala66412c62011-02-18 05:40:54 -0600369- 85xx CPU Options:
York Sunffd06e02012-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 Gala66412c62011-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 Gala8f290842011-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 Kushwahaafa6b552012-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 Wood33eee332012-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 Kushwaha74fa22e2013-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 Wood33eee332012-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 Jain765b0bd2013-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 Schwierzeck6cb461b2012-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 Klotzbuecher0b953ff2006-03-24 15:28:02 +0100438- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200439 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200445 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200446
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100447 Defines the Monahans turbo mode to oscillator
448 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200449 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100450 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200451
Daniel Schwierzeck92bbd642011-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 Rieschb67d8812012-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 V5356f542012-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 Warrenc5d47522013-03-04 13:29:40 +0000498 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-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 Warren795659d2013-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
wdenk5da627a2003-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 Denk218ca722008-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
wdenk5da627a2003-10-09 20:09:04 +0000530 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
531
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200532 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-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 Barenfec6d9e2008-06-03 20:34:45 -0400536 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200537
538 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-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 Phillips3bb342f2007-08-10 14:34:14 -0500545 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400546
Marcel Ziswilerb55ae402009-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 Denkf57f70a2005-10-13 01:45:54 +0200551 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600552 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200553
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200554 boards with QUICC Engines require OF_QE to set UCC MAC
555 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500556
Kumar Gala4e253132006-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
wdenk6705d812004-08-02 23:22:59 +0000561
Matthew McClintock02677682006-06-28 10:41:37 -0500562 CONFIG_OF_BOOT_CPU
563
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200564 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500565 param header, the default value is zero if undefined.
566
Heiko Schocher3887c3f2009-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 Grinberg7eb29392011-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 Giger0b2f4ec2008-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 V2c451f72011-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 V93bc2192011-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
wdenk6705d812004-08-02 23:22:59 +0000615- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200616 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000617
618 Define this if you want support for Amba PrimeCell PL010 UARTs.
619
Andreas Engel48d01922008-09-08 14:30:53 +0200620 CONFIG_PL011_SERIAL
wdenk6705d812004-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 Rigby910f1ae2011-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
wdenk6705d812004-08-02 23:22:59 +0000647
wdenkc6097192002-11-03 00:24:07 +0000648- Console Interface:
wdenk43d96162003-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 Denkc53043b2011-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)
wdenkba56f622004-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)
wdenkba56f622004-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-VILLARD6d0f6bc2008-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 Loeliger602ad3b2007-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
wdenka6c7ad22002-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 Ziswiler11ccc332008-07-09 08:17:15 +0200694 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000695 the logo
696
Pali Rohár33a35bb2012-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
wdenk43d96162003-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
wdenkd4ca31c2004-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.
wdenka3ad8e22003-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-VILLARD6d0f6bc2008-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 Schocherc92fac92009-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 Schocher2b3f12c2009-02-10 09:31:47 +0100719 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-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 Russ9558b482011-09-01 00:48:27 +0000724- Pre-Console Buffer:
Wolfgang Denk4cf26092011-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 Denk6feff892011-10-09 21:06:34 +0200732 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200733 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000734
Wolfgang Denk4cf26092011-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 Russ9558b482011-09-01 00:48:27 +0000737
Sonny Rao046a37b2011-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 Hershberger93d72122012-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
wdenk43d96162003-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
wdenk43d96162003-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 Ziswiler11ccc332008-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 Loeliger602ad3b2007-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200812 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000813
814- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500815 Monitor commands can be included or excluded
816 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000817 <config_cmd_all.h> and #undef'ing unwanted
818 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500819 and augmenting with additional #define's
820 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000821
Jon Loeliger602ad3b2007-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 Loeliger602ad3b2007-06-11 19:03:39 -0500825 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-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 Frysinger710b9932010-12-21 14:19:51 -0500833 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-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 Tysera7c93102008-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 Loeliger602ad3b2007-06-11 19:03:39 -0500841 CONFIG_CMD_DTT * Digital Therm and Thermostat
842 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500843 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500844 CONFIG_CMD_EEPROM * EEPROM read/write support
845 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600846 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600847 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500848 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000849 CONFIG_CMD_EXT2 * ext2 command support
850 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500851 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500852 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000853 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-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
Benoît Thébaudeauccca7df2013-04-23 10:17:40 +0000857 CONFIG_CMD_FUSE Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000858 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500859 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000860 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000861 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-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 Kumar8fdf1e02012-12-16 22:32:48 +0000866 CONFIG_CMD_IMLS List all images found in NOR flash
867 CONFIG_CMD_IMLS_NAND List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500868 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500869 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000870 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-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
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500875 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000876 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
877 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500878 CONFIG_CMD_LOADB loadb
879 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400880 CONFIG_CMD_MD5SUM print md5 message digest
881 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000882 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500883 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000884 loop, loopw
885 CONFIG_CMD_MEMTEST mtest
Jon Loeliger602ad3b2007-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 Roese68d7d652009-03-19 13:30:36 +0100889 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500890 CONFIG_CMD_NAND * NAND support
891 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600892 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000893 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500894 CONFIG_CMD_PCI * pciinfo
895 CONFIG_CMD_PCMCIA * PCMCIA support
896 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
897 host
898 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000899 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500900 CONFIG_CMD_REGINFO * Register dump
901 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000902 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500903 CONFIG_CMD_SAVES * save S record dump
904 CONFIG_CMD_SCSI * SCSI Support
905 CONFIG_CMD_SDRAM * print SDRAM configuration information
906 (requires CONFIG_CMD_I2C)
907 CONFIG_CMD_SETGETDCR Support for DCR Register access
908 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700909 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100910 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400911 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800912 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200913 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500914 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000915 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000916 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000917 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
918 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500919 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500920 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000921 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000922
wdenkc6097192002-11-03 00:24:07 +0000923
924 EXAMPLE: If you want all functions except of network
925 support you can write:
926
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500927 #include "config_cmd_all.h"
928 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000929
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400930 Other Commands:
931 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000932
933 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500934 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000935 what you (and your U-Boot users) are doing. Data
936 cache cannot be enabled on systems like the 8xx or
937 8260 (where accesses to the IMMR region must be
938 uncached), and it cannot be disabled on all other
939 systems where we (mis-) use the data cache to hold an
940 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000941
942
943 XXX - this list needs to get updated!
944
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000945- Regular expression support:
946 CONFIG_REGEX
947 If this variable is defined, U-Boot is linked against
948 the SLRE (Super Light Regular Expression) library,
949 which adds regex support to some commands, as for
950 example "env grep" and "setexpr".
951
Simon Glass45ba8072011-10-15 05:48:20 +0000952- Device tree:
953 CONFIG_OF_CONTROL
954 If this variable is defined, U-Boot will use a device tree
955 to configure its devices, instead of relying on statically
956 compiled #defines in the board file. This option is
957 experimental and only available on a few boards. The device
958 tree is available in the global data as gd->fdt_blob.
959
Simon Glass2c0f79e2011-10-24 19:15:31 +0000960 U-Boot needs to get its device tree from somewhere. This can
961 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000962
963 CONFIG_OF_EMBED
964 If this variable is defined, U-Boot will embed a device tree
965 binary in its image. This device tree file should be in the
966 board directory and called <soc>-<board>.dts. The binary file
967 is then picked up in board_init_f() and made available through
968 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000969
Simon Glass2c0f79e2011-10-24 19:15:31 +0000970 CONFIG_OF_SEPARATE
971 If this variable is defined, U-Boot will build a device tree
972 binary. It will be called u-boot.dtb. Architecture-specific
973 code will locate it at run-time. Generally this works by:
974
975 cat u-boot.bin u-boot.dtb >image.bin
976
977 and in fact, U-Boot does this for you, creating a file called
978 u-boot-dtb.bin which is useful in the common case. You can
979 still use the individual files if you need something more
980 exotic.
981
wdenkc6097192002-11-03 00:24:07 +0000982- Watchdog:
983 CONFIG_WATCHDOG
984 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000985 support for the SoC. There must be support in the SoC
986 specific code for a watchdog. For the 8xx and 8260
987 CPUs, the SIU Watchdog feature is enabled in the SYPCR
988 register. When supported for a specific SoC is
989 available, then no further board specific code should
990 be needed to use it.
991
992 CONFIG_HW_WATCHDOG
993 When using a watchdog circuitry external to the used
994 SoC, then define this variable and provide board
995 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000996
stroesec1551ea2003-04-04 15:53:41 +0000997- U-Boot Version:
998 CONFIG_VERSION_VARIABLE
999 If this variable is defined, an environment variable
1000 named "ver" is created by U-Boot showing the U-Boot
1001 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001002 Any change to this variable will be reverted at the
1003 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001004
wdenkc6097192002-11-03 00:24:07 +00001005- Real-Time Clock:
1006
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001007 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001008 has to be selected, too. Define exactly one of the
1009 following options:
1010
1011 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1012 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001013 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001014 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001015 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001016 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001017 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001018 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001019 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001020 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001021 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001022 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1023 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001024
wdenkb37c7e52003-06-30 16:24:52 +00001025 Note that if the RTC uses I2C, then the I2C interface
1026 must also be configured. See I2C Support, below.
1027
Peter Tysere92739d2008-12-17 16:36:21 -06001028- GPIO Support:
1029 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1030 CONFIG_PCA953X_INFO - enable pca953x info command
1031
Chris Packham5dec49c2010-12-19 10:12:13 +00001032 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1033 chip-ngpio pairs that tell the PCA953X driver the number of
1034 pins supported by a particular chip.
1035
Peter Tysere92739d2008-12-17 16:36:21 -06001036 Note that if the GPIO device uses I2C, then the I2C interface
1037 must also be configured. See I2C Support, below.
1038
wdenkc6097192002-11-03 00:24:07 +00001039- Timestamp Support:
1040
wdenk43d96162003-03-06 00:02:04 +00001041 When CONFIG_TIMESTAMP is selected, the timestamp
1042 (date and time) of an image is printed by image
1043 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001044 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001045
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001046- Partition Labels (disklabels) Supported:
1047 Zero or more of the following:
1048 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1049 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1050 Intel architecture, USB sticks, etc.
1051 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1052 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1053 bootloader. Note 2TB partition limit; see
1054 disk/part_efi.c
1055 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001056
Wolfgang Denk218ca722008-03-26 10:40:12 +01001057 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1058 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001059 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001060
1061- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001062 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1063 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001064
wdenk4d13cba2004-03-14 14:09:05 +00001065 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1066 be performed by calling the function
1067 ide_set_reset(int reset)
1068 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001069
1070- ATAPI Support:
1071 CONFIG_ATAPI
1072
1073 Set this to enable ATAPI support.
1074
wdenkc40b2952004-03-13 23:29:43 +00001075- LBA48 Support
1076 CONFIG_LBA48
1077
1078 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001079 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001080 Whithout these , LBA48 support uses 32bit variables and will 'only'
1081 support disks up to 2.1TB.
1082
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001083 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001084 When enabled, makes the IDE subsystem use 64bit sector addresses.
1085 Default is 32bit.
1086
wdenkc6097192002-11-03 00:24:07 +00001087- SCSI Support:
1088 At the moment only there is only support for the
1089 SYM53C8XX SCSI controller; define
1090 CONFIG_SCSI_SYM53C8XX to enable it.
1091
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001092 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1093 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1094 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001095 maximum numbers of LUNs, SCSI ID's and target
1096 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001097 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001098
Stefan Reinauer447c0312012-10-29 05:23:48 +00001099 The environment variable 'scsidevs' is set to the number of
1100 SCSI devices found during the last scan.
1101
wdenkc6097192002-11-03 00:24:07 +00001102- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001103 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001104 Support for Intel 8254x/8257x gigabit chips.
1105
1106 CONFIG_E1000_SPI
1107 Utility code for direct access to the SPI bus on Intel 8257x.
1108 This does not do anything useful unless you set at least one
1109 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1110
1111 CONFIG_E1000_SPI_GENERIC
1112 Allow generic access to the SPI bus on the Intel 8257x, for
1113 example with the "sspi" command.
1114
1115 CONFIG_CMD_E1000
1116 Management command for E1000 devices. When used on devices
1117 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001118
Andre Schwarzac3315c2008-03-06 16:45:44 +01001119 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001120 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001121
wdenkc6097192002-11-03 00:24:07 +00001122 CONFIG_EEPRO100
1123 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001124 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001125 write routine for first time initialisation.
1126
1127 CONFIG_TULIP
1128 Support for Digital 2114x chips.
1129 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1130 modem chip initialisation (KS8761/QS6611).
1131
1132 CONFIG_NATSEMI
1133 Support for National dp83815 chips.
1134
1135 CONFIG_NS8382X
1136 Support for National dp8382[01] gigabit chips.
1137
wdenk45219c42003-05-12 21:50:16 +00001138- NETWORK Support (other):
1139
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001140 CONFIG_DRIVER_AT91EMAC
1141 Support for AT91RM9200 EMAC.
1142
1143 CONFIG_RMII
1144 Define this to use reduced MII inteface
1145
1146 CONFIG_DRIVER_AT91EMAC_QUIET
1147 If this defined, the driver is quiet.
1148 The driver doen't show link status messages.
1149
Rob Herringefdd7312011-12-15 11:15:49 +00001150 CONFIG_CALXEDA_XGMAC
1151 Support for the Calxeda XGMAC device
1152
Ashok3bb46d22012-10-15 06:20:47 +00001153 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001154 Support for SMSC's LAN91C96 chips.
1155
1156 CONFIG_LAN91C96_BASE
1157 Define this to hold the physical address
1158 of the LAN91C96's I/O space
1159
1160 CONFIG_LAN91C96_USE_32_BIT
1161 Define this to enable 32 bit addressing
1162
Ashok3bb46d22012-10-15 06:20:47 +00001163 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001164 Support for SMSC's LAN91C111 chip
1165
1166 CONFIG_SMC91111_BASE
1167 Define this to hold the physical address
1168 of the device (I/O space)
1169
1170 CONFIG_SMC_USE_32_BIT
1171 Define this if data bus is 32 bits
1172
1173 CONFIG_SMC_USE_IOFUNCS
1174 Define this to use i/o functions instead of macros
1175 (some hardware wont work with macros)
1176
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001177 CONFIG_DRIVER_TI_EMAC
1178 Support for davinci emac
1179
1180 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1181 Define this if you have more then 3 PHYs.
1182
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001183 CONFIG_FTGMAC100
1184 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1185
1186 CONFIG_FTGMAC100_EGIGA
1187 Define this to use GE link update with gigabit PHY.
1188 Define this if FTGMAC100 is connected to gigabit PHY.
1189 If your system has 10/100 PHY only, it might not occur
1190 wrong behavior. Because PHY usually return timeout or
1191 useless data when polling gigabit status and gigabit
1192 control registers. This behavior won't affect the
1193 correctnessof 10/100 link speed update.
1194
Mike Rapoportc2fff332009-11-11 10:03:03 +02001195 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001196 Support for SMSC's LAN911x and LAN921x chips
1197
Mike Rapoportc2fff332009-11-11 10:03:03 +02001198 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001199 Define this to hold the physical address
1200 of the device (I/O space)
1201
Mike Rapoportc2fff332009-11-11 10:03:03 +02001202 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001203 Define this if data bus is 32 bits
1204
Mike Rapoportc2fff332009-11-11 10:03:03 +02001205 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001206 Define this if data bus is 16 bits. If your processor
1207 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001208 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001209
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001210 CONFIG_SH_ETHER
1211 Support for Renesas on-chip Ethernet controller
1212
1213 CONFIG_SH_ETHER_USE_PORT
1214 Define the number of ports to be used
1215
1216 CONFIG_SH_ETHER_PHY_ADDR
1217 Define the ETH PHY's address
1218
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001219 CONFIG_SH_ETHER_CACHE_WRITEBACK
1220 If this option is set, the driver enables cache flush.
1221
Vadim Bendebury5e124722011-10-17 08:36:14 +00001222- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001223 CONFIG_TPM
1224 Support TPM devices.
1225
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001226 CONFIG_TPM_TIS_I2C
1227 Support for i2c bus TPM devices. Only one device
1228 per system is supported at this time.
1229
1230 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1231 Define the the i2c bus number for the TPM device
1232
1233 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1234 Define the TPM's address on the i2c bus
1235
1236 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1237 Define the burst count bytes upper limit
1238
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001239 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001240 Support for generic parallel port TPM devices. Only one device
1241 per system is supported at this time.
1242
1243 CONFIG_TPM_TIS_BASE_ADDRESS
1244 Base address where the generic TPM device is mapped
1245 to. Contemporary x86 systems usually map it at
1246 0xfed40000.
1247
wdenkc6097192002-11-03 00:24:07 +00001248- USB Support:
1249 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001250 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001251 CONFIG_USB_UHCI to enable it.
1252 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001253 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001254 storage devices.
1255 Note:
1256 Supported are USB Keyboards and USB Floppy drives
1257 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001258 MPC5200 USB requires additional defines:
1259 CONFIG_USB_CLOCK
1260 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001261 CONFIG_PSC3_USB
1262 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001263 CONFIG_USB_CONFIG
1264 for differential drivers: 0x00001000
1265 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001266 for differential drivers on PSC3: 0x00000100
1267 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001268 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001269 May be defined to allow interrupt polling
1270 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001271
Simon Glass9ab4ce22012-02-27 10:52:47 +00001272 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1273 txfilltuning field in the EHCI controller on reset.
1274
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001275 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1276 interval for usb hub power-on delay.(minimum 100msec)
1277
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001278- USB Device:
1279 Define the below if you wish to use the USB console.
1280 Once firmware is rebuilt from a serial console issue the
1281 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001282 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001283 it has found a new device. The environment variable usbtty
1284 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001285 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001286 Common Device Class Abstract Control Model serial device.
1287 If you select usbtty = gserial you should be able to enumerate
1288 a Linux host by
1289 # modprobe usbserial vendor=0xVendorID product=0xProductID
1290 else if using cdc_acm, simply setting the environment
1291 variable usbtty to be cdc_acm should suffice. The following
1292 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001293
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001294 CONFIG_USB_DEVICE
1295 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001296
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001297 CONFIG_USB_TTY
1298 Define this to have a tty type of device available to
1299 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001300
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301301 CONFIG_USBD_HS
1302 Define this to enable the high speed support for usb
1303 device and usbtty. If this feature is enabled, a routine
1304 int is_usbd_high_speed(void)
1305 also needs to be defined by the driver to dynamically poll
1306 whether the enumeration has succeded at high speed or full
1307 speed.
1308
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001309 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001310 Define this if you want stdin, stdout &/or stderr to
1311 be set to usbtty.
1312
1313 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001314 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001315 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001316 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001317
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001318 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001319 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001320 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001321
Wolfgang Denk386eda02006-06-14 18:14:56 +02001322 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001323 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001324 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001325 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1326 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1327 should pretend to be a Linux device to it's target host.
1328
1329 CONFIG_USBD_MANUFACTURER
1330 Define this string as the name of your company for
1331 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001332
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001333 CONFIG_USBD_PRODUCT_NAME
1334 Define this string as the name of your product
1335 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1336
1337 CONFIG_USBD_VENDORID
1338 Define this as your assigned Vendor ID from the USB
1339 Implementors Forum. This *must* be a genuine Vendor ID
1340 to avoid polluting the USB namespace.
1341 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001342
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001343 CONFIG_USBD_PRODUCTID
1344 Define this as the unique Product ID
1345 for your device
1346 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001347
Igor Grinbergd70a5602011-12-12 12:08:35 +02001348- ULPI Layer Support:
1349 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1350 the generic ULPI layer. The generic layer accesses the ULPI PHY
1351 via the platform viewport, so you need both the genric layer and
1352 the viewport enabled. Currently only Chipidea/ARC based
1353 viewport is supported.
1354 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1355 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001356 If your ULPI phy needs a different reference clock than the
1357 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1358 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001359
1360- MMC Support:
1361 The MMC controller on the Intel PXA is supported. To
1362 enable this define CONFIG_MMC. The MMC can be
1363 accessed from the boot prompt by mapping the device
1364 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001365 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1366 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001367
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001368 CONFIG_SH_MMCIF
1369 Support for Renesas on-chip MMCIF controller
1370
1371 CONFIG_SH_MMCIF_ADDR
1372 Define the base address of MMCIF registers
1373
1374 CONFIG_SH_MMCIF_CLK
1375 Define the clock frequency for MMCIF
1376
Tom Rinib3ba6e92013-03-14 05:32:47 +00001377- USB Device Firmware Update (DFU) class support:
1378 CONFIG_DFU_FUNCTION
1379 This enables the USB portion of the DFU USB class
1380
1381 CONFIG_CMD_DFU
1382 This enables the command "dfu" which is used to have
1383 U-Boot create a DFU class device via USB. This command
1384 requires that the "dfu_alt_info" environment variable be
1385 set and define the alt settings to expose to the host.
1386
1387 CONFIG_DFU_MMC
1388 This enables support for exposing (e)MMC devices via DFU.
1389
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001390 CONFIG_DFU_NAND
1391 This enables support for exposing NAND devices via DFU.
1392
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001393 CONFIG_SYS_DFU_MAX_FILE_SIZE
1394 When updating files rather than the raw storage device,
1395 we use a static buffer to copy the file into and then write
1396 the buffer once we've been given the whole file. Define
1397 this to the maximum filesize (in bytes) for the buffer.
1398 Default is 4 MiB if undefined.
1399
wdenk6705d812004-08-02 23:22:59 +00001400- Journaling Flash filesystem support:
1401 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1402 CONFIG_JFFS2_NAND_DEV
1403 Define these for a default partition on a NAND device
1404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001405 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1406 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001407 Define these for a default partition on a NOR device
1408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001409 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001410 Define this to create an own partition. You have to provide a
1411 function struct part_info* jffs2_part_info(int part_num)
1412
1413 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001414 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001415 to disable the command chpart. This is the default when you
1416 have not defined a custom partition
1417
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001418- FAT(File Allocation Table) filesystem write function support:
1419 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001420
1421 Define this to enable support for saving memory data as a
1422 file in FAT formatted partition.
1423
1424 This will also enable the command "fatwrite" enabling the
1425 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001426
Gabe Black84cd9322012-10-12 14:26:11 +00001427CBFS (Coreboot Filesystem) support
1428 CONFIG_CMD_CBFS
1429
1430 Define this to enable support for reading from a Coreboot
1431 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1432 and cbfsload.
1433
wdenkc6097192002-11-03 00:24:07 +00001434- Keyboard Support:
1435 CONFIG_ISA_KEYBOARD
1436
1437 Define this to enable standard (PC-Style) keyboard
1438 support
1439
1440 CONFIG_I8042_KBD
1441 Standard PC keyboard driver with US (is default) and
1442 GERMAN key layout (switch via environment 'keymap=de') support.
1443 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1444 for cfb_console. Supports cursor blinking.
1445
1446- Video support:
1447 CONFIG_VIDEO
1448
1449 Define this to enable video support (for output to
1450 video).
1451
1452 CONFIG_VIDEO_CT69000
1453
1454 Enable Chips & Technologies 69000 Video chip
1455
1456 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001457 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001458 video output is selected via environment 'videoout'
1459 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1460 assumed.
wdenkc6097192002-11-03 00:24:07 +00001461
wdenkb79a11c2004-03-25 15:14:43 +00001462 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001463 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001464 are possible:
1465 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001466 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001467
1468 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1469 -------------+---------------------------------------------
1470 8 bits | 0x301* 0x303 0x305 0x161 0x307
1471 15 bits | 0x310 0x313 0x316 0x162 0x319
1472 16 bits | 0x311 0x314 0x317 0x163 0x31A
1473 24 bits | 0x312 0x315 0x318 ? 0x31B
1474 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001475 (i.e. setenv videomode 317; saveenv; reset;)
1476
wdenkb79a11c2004-03-25 15:14:43 +00001477 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001478 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001479
1480
stroesec1551ea2003-04-04 15:53:41 +00001481 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001482 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001483 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1484 or CONFIG_VIDEO_SED13806_16BPP
1485
Timur Tabi7d3053f2011-02-15 17:09:19 -06001486 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001487 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001488 SOCs that have a DIU should define this macro to enable DIU
1489 support, and should also define these other macros:
1490
1491 CONFIG_SYS_DIU_ADDR
1492 CONFIG_VIDEO
1493 CONFIG_CMD_BMP
1494 CONFIG_CFB_CONSOLE
1495 CONFIG_VIDEO_SW_CURSOR
1496 CONFIG_VGA_AS_SINGLE_DEVICE
1497 CONFIG_VIDEO_LOGO
1498 CONFIG_VIDEO_BMP_LOGO
1499
Timur Tabiba8e76b2011-04-11 14:18:22 -05001500 The DIU driver will look for the 'video-mode' environment
1501 variable, and if defined, enable the DIU as a console during
1502 boot. See the documentation file README.video for a
1503 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001504
Simon Glass058d59b2012-12-03 13:59:47 +00001505 CONFIG_VIDEO_VGA
1506
1507 Enable the VGA video / BIOS for x86. The alternative if you
1508 are using coreboot is to use the coreboot frame buffer
1509 driver.
1510
1511
wdenk682011f2003-06-03 23:54:09 +00001512- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001513 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001514
wdenk8bde7f72003-06-27 21:31:46 +00001515 Define this to enable a custom keyboard support.
1516 This simply calls drv_keyboard_init() which must be
1517 defined in your board-specific files.
1518 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001519
wdenkc6097192002-11-03 00:24:07 +00001520- LCD Support: CONFIG_LCD
1521
1522 Define this to enable LCD support (for output to LCD
1523 display); also select one of the supported displays
1524 by defining one of these:
1525
Stelian Pop39cf4802008-05-09 21:57:18 +02001526 CONFIG_ATMEL_LCD:
1527
1528 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1529
wdenkfd3103b2003-11-25 16:55:19 +00001530 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001531
wdenkfd3103b2003-11-25 16:55:19 +00001532 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001533
wdenkfd3103b2003-11-25 16:55:19 +00001534 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001535
wdenkfd3103b2003-11-25 16:55:19 +00001536 NEC NL6448BC20-08. 6.5", 640x480.
1537 Active, color, single scan.
1538
1539 CONFIG_NEC_NL6448BC33_54
1540
1541 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001542 Active, color, single scan.
1543
1544 CONFIG_SHARP_16x9
1545
1546 Sharp 320x240. Active, color, single scan.
1547 It isn't 16x9, and I am not sure what it is.
1548
1549 CONFIG_SHARP_LQ64D341
1550
1551 Sharp LQ64D341 display, 640x480.
1552 Active, color, single scan.
1553
1554 CONFIG_HLD1045
1555
1556 HLD1045 display, 640x480.
1557 Active, color, single scan.
1558
1559 CONFIG_OPTREX_BW
1560
1561 Optrex CBL50840-2 NF-FW 99 22 M5
1562 or
1563 Hitachi LMG6912RPFC-00T
1564 or
1565 Hitachi SP14Q002
1566
1567 320x240. Black & white.
1568
1569 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001570 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001571
Simon Glass676d3192012-10-17 13:24:54 +00001572 CONFIG_LCD_ALIGNMENT
1573
1574 Normally the LCD is page-aligned (tyically 4KB). If this is
1575 defined then the LCD will be aligned to this value instead.
1576 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1577 here, since it is cheaper to change data cache settings on
1578 a per-section basis.
1579
Simon Glass0d89efe2012-10-17 13:24:59 +00001580 CONFIG_CONSOLE_SCROLL_LINES
1581
1582 When the console need to be scrolled, this is the number of
1583 lines to scroll by. It defaults to 1. Increasing this makes
1584 the console jump but can help speed up operation when scrolling
1585 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001586
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001587 CONFIG_LCD_BMP_RLE8
1588
1589 Support drawing of RLE8-compressed bitmaps on the LCD.
1590
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001591 CONFIG_I2C_EDID
1592
1593 Enables an 'i2c edid' command which can read EDID
1594 information over I2C from an attached LCD display.
1595
wdenk7152b1d2003-09-05 23:19:14 +00001596- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001597
wdenk8bde7f72003-06-27 21:31:46 +00001598 If this option is set, the environment is checked for
1599 a variable "splashimage". If found, the usual display
1600 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001601 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001602 specified in "splashimage" is loaded instead. The
1603 console is redirected to the "nulldev", too. This
1604 allows for a "silent" boot where a splash screen is
1605 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001606
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001607 CONFIG_SPLASHIMAGE_GUARD
1608
1609 If this option is set, then U-Boot will prevent the environment
1610 variable "splashimage" from being set to a problematic address
1611 (see README.displaying-bmps and README.arm-unaligned-accesses).
1612 This option is useful for targets where, due to alignment
1613 restrictions, an improperly aligned BMP image will cause a data
1614 abort. If you think you will not have problems with unaligned
1615 accesses (for example because your toolchain prevents them)
1616 there is no need to set this option.
1617
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001618 CONFIG_SPLASH_SCREEN_ALIGN
1619
1620 If this option is set the splash image can be freely positioned
1621 on the screen. Environment variable "splashpos" specifies the
1622 position as "x,y". If a positive number is given it is used as
1623 number of pixel from left/top. If a negative number is given it
1624 is used as number of pixel from right/bottom. You can also
1625 specify 'm' for centering the image.
1626
1627 Example:
1628 setenv splashpos m,m
1629 => image at center of screen
1630
1631 setenv splashpos 30,20
1632 => image at x = 30 and y = 20
1633
1634 setenv splashpos -10,m
1635 => vertically centered image
1636 at x = dspWidth - bmpWidth - 9
1637
Nikita Kiryanov581bb412013-01-30 21:39:57 +00001638 CONFIG_SPLASH_SCREEN_PREPARE
1639
1640 If this option is set then the board_splash_screen_prepare()
1641 function, which must be defined in your code, is called as part
1642 of the splash screen display sequence. It gives the board an
1643 opportunity to prepare the splash image data before it is
1644 processed and sent to the frame buffer by U-Boot.
1645
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001646- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1647
1648 If this option is set, additionally to standard BMP
1649 images, gzipped BMP images can be displayed via the
1650 splashscreen support or the bmp command.
1651
Anatolij Gustschind5011762010-03-15 14:50:25 +01001652- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1653
1654 If this option is set, 8-bit RLE compressed BMP images
1655 can be displayed via the splashscreen support or the
1656 bmp command.
1657
Lei Wenf2b96df2012-09-28 04:26:47 +00001658- Do compresssing for memory range:
1659 CONFIG_CMD_ZIP
1660
1661 If this option is set, it would use zlib deflate method
1662 to compress the specified memory at its best effort.
1663
wdenkc29fdfc2003-08-29 20:57:53 +00001664- Compression support:
1665 CONFIG_BZIP2
1666
1667 If this option is set, support for bzip2 compressed
1668 images is included. If not, only uncompressed and gzip
1669 compressed images are supported.
1670
wdenk42d1f032003-10-15 23:53:47 +00001671 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001672 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001673 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001674
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001675 CONFIG_LZMA
1676
1677 If this option is set, support for lzma compressed
1678 images is included.
1679
1680 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1681 requires an amount of dynamic memory that is given by the
1682 formula:
1683
1684 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1685
1686 Where lc and lp stand for, respectively, Literal context bits
1687 and Literal pos bits.
1688
1689 This value is upper-bounded by 14MB in the worst case. Anyway,
1690 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1691 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1692 a very small buffer.
1693
1694 Use the lzmainfo tool to determinate the lc and lp values and
1695 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001696 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001697
wdenk17ea1172004-06-06 21:51:03 +00001698- MII/PHY support:
1699 CONFIG_PHY_ADDR
1700
1701 The address of PHY on MII bus.
1702
1703 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1704
1705 The clock frequency of the MII bus
1706
1707 CONFIG_PHY_GIGE
1708
1709 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001710 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001711
1712 CONFIG_PHY_RESET_DELAY
1713
1714 Some PHY like Intel LXT971A need extra delay after
1715 reset before any MII register access is possible.
1716 For such PHY, set this option to the usec delay
1717 required. (minimum 300usec for LXT971A)
1718
1719 CONFIG_PHY_CMD_DELAY (ppc4xx)
1720
1721 Some PHY like Intel LXT971A need extra delay after
1722 command issued before MII status register can be read
1723
wdenkc6097192002-11-03 00:24:07 +00001724- Ethernet address:
1725 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001726 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001727 CONFIG_ETH2ADDR
1728 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001729 CONFIG_ETH4ADDR
1730 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001731
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001732 Define a default value for Ethernet address to use
1733 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001734 is not determined automatically.
1735
1736- IP address:
1737 CONFIG_IPADDR
1738
1739 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001740 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001741 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001742 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001743
1744- Server IP address:
1745 CONFIG_SERVERIP
1746
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001747 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001748 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001749 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001750
Robin Getz97cfe862009-07-21 12:15:28 -04001751 CONFIG_KEEP_SERVERADDR
1752
1753 Keeps the server's MAC address, in the env 'serveraddr'
1754 for passing to bootargs (like Linux's netconsole option)
1755
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001756- Gateway IP address:
1757 CONFIG_GATEWAYIP
1758
1759 Defines a default value for the IP address of the
1760 default router where packets to other networks are
1761 sent to.
1762 (Environment variable "gatewayip")
1763
1764- Subnet mask:
1765 CONFIG_NETMASK
1766
1767 Defines a default value for the subnet mask (or
1768 routing prefix) which is used to determine if an IP
1769 address belongs to the local subnet or needs to be
1770 forwarded through a router.
1771 (Environment variable "netmask")
1772
David Updegraff53a5c422007-06-11 10:41:07 -05001773- Multicast TFTP Mode:
1774 CONFIG_MCAST_TFTP
1775
1776 Defines whether you want to support multicast TFTP as per
1777 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001778 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001779 driver in use must provide a function: mcast() to join/leave a
1780 multicast group.
1781
wdenkc6097192002-11-03 00:24:07 +00001782- BOOTP Recovery Mode:
1783 CONFIG_BOOTP_RANDOM_DELAY
1784
1785 If you have many targets in a network that try to
1786 boot using BOOTP, you may want to avoid that all
1787 systems send out BOOTP requests at precisely the same
1788 moment (which would happen for instance at recovery
1789 from a power failure, when all systems will try to
1790 boot, thus flooding the BOOTP server. Defining
1791 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1792 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001793 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001794
1795 1st BOOTP request: delay 0 ... 1 sec
1796 2nd BOOTP request: delay 0 ... 2 sec
1797 3rd BOOTP request: delay 0 ... 4 sec
1798 4th and following
1799 BOOTP requests: delay 0 ... 8 sec
1800
stroesefe389a82003-08-28 14:17:32 +00001801- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001802 You can fine tune the DHCP functionality by defining
1803 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001804
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001805 CONFIG_BOOTP_SUBNETMASK
1806 CONFIG_BOOTP_GATEWAY
1807 CONFIG_BOOTP_HOSTNAME
1808 CONFIG_BOOTP_NISDOMAIN
1809 CONFIG_BOOTP_BOOTPATH
1810 CONFIG_BOOTP_BOOTFILESIZE
1811 CONFIG_BOOTP_DNS
1812 CONFIG_BOOTP_DNS2
1813 CONFIG_BOOTP_SEND_HOSTNAME
1814 CONFIG_BOOTP_NTPSERVER
1815 CONFIG_BOOTP_TIMEOFFSET
1816 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001817 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001818
Wilson Callan5d110f02007-07-28 10:56:13 -04001819 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1820 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001821
Joe Hershberger2c00e092012-05-23 07:59:19 +00001822 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1823 after the configured retry count, the call will fail
1824 instead of starting over. This can be used to fail over
1825 to Link-local IP address configuration if the DHCP server
1826 is not available.
1827
stroesefe389a82003-08-28 14:17:32 +00001828 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1829 serverip from a DHCP server, it is possible that more
1830 than one DNS serverip is offered to the client.
1831 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1832 serverip will be stored in the additional environment
1833 variable "dnsip2". The first DNS serverip is always
1834 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001835 is defined.
stroesefe389a82003-08-28 14:17:32 +00001836
1837 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1838 to do a dynamic update of a DNS server. To do this, they
1839 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001840 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001841 of the "hostname" environment variable is passed as
1842 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001843
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001844 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1845
1846 A 32bit value in microseconds for a delay between
1847 receiving a "DHCP Offer" and sending the "DHCP Request".
1848 This fixes a problem with certain DHCP servers that don't
1849 respond 100% of the time to a "DHCP request". E.g. On an
1850 AT91RM9200 processor running at 180MHz, this delay needed
1851 to be *at least* 15,000 usec before a Windows Server 2003
1852 DHCP server would reply 100% of the time. I recommend at
1853 least 50,000 usec to be safe. The alternative is to hope
1854 that one of the retries will be successful but note that
1855 the DHCP timeout and retry process takes a longer than
1856 this delay.
1857
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001858 - Link-local IP address negotiation:
1859 Negotiate with other link-local clients on the local network
1860 for an address that doesn't require explicit configuration.
1861 This is especially useful if a DHCP server cannot be guaranteed
1862 to exist in all environments that the device must operate.
1863
1864 See doc/README.link-local for more information.
1865
wdenka3d991b2004-04-15 21:48:45 +00001866 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001867 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001868
1869 The device id used in CDP trigger frames.
1870
1871 CONFIG_CDP_DEVICE_ID_PREFIX
1872
1873 A two character string which is prefixed to the MAC address
1874 of the device.
1875
1876 CONFIG_CDP_PORT_ID
1877
1878 A printf format string which contains the ascii name of
1879 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001880 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001881
1882 CONFIG_CDP_CAPABILITIES
1883
1884 A 32bit integer which indicates the device capabilities;
1885 0x00000010 for a normal host which does not forwards.
1886
1887 CONFIG_CDP_VERSION
1888
1889 An ascii string containing the version of the software.
1890
1891 CONFIG_CDP_PLATFORM
1892
1893 An ascii string containing the name of the platform.
1894
1895 CONFIG_CDP_TRIGGER
1896
1897 A 32bit integer sent on the trigger.
1898
1899 CONFIG_CDP_POWER_CONSUMPTION
1900
1901 A 16bit integer containing the power consumption of the
1902 device in .1 of milliwatts.
1903
1904 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1905
1906 A byte containing the id of the VLAN.
1907
wdenkc6097192002-11-03 00:24:07 +00001908- Status LED: CONFIG_STATUS_LED
1909
1910 Several configurations allow to display the current
1911 status using a LED. For instance, the LED will blink
1912 fast while running U-Boot code, stop blinking as
1913 soon as a reply to a BOOTP request was received, and
1914 start blinking slow once the Linux kernel is running
1915 (supported by a status LED driver in the Linux
1916 kernel). Defining CONFIG_STATUS_LED enables this
1917 feature in U-Boot.
1918
1919- CAN Support: CONFIG_CAN_DRIVER
1920
1921 Defining CONFIG_CAN_DRIVER enables CAN driver support
1922 on those systems that support this (optional)
1923 feature, like the TQM8xxL modules.
1924
1925- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1926
wdenkb37c7e52003-06-30 16:24:52 +00001927 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001928 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001929 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001930
wdenk945af8d2003-07-16 21:53:01 +00001931 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001932 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001933 CONFIG_COMMANDS) and communicate with i2c based realtime
1934 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001935 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001936
Ben Warrenbb99ad62006-09-07 16:50:54 -04001937 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001938
wdenk945af8d2003-07-16 21:53:01 +00001939 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001940 bit-banging) driver instead of CPM or similar hardware
1941 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001942
wdenk945af8d2003-07-16 21:53:01 +00001943 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001944 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001945
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001946 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001947 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001948 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001949 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001950
Peter Tyser8d321b82010-04-12 22:28:21 -05001951 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001952 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001953 and so its address should therefore be cleared to 0 (See,
1954 eg, MPC823e User's Manual p.16-473). So, set
1955 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001956
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001957 CONFIG_SYS_I2C_INIT_MPC5XXX
1958
1959 When a board is reset during an i2c bus transfer
1960 chips might think that the current transfer is still
1961 in progress. Reset the slave devices by sending start
1962 commands until the slave device responds.
1963
wdenk945af8d2003-07-16 21:53:01 +00001964 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001965
1966 If you use the software i2c interface (CONFIG_SOFT_I2C)
1967 then the following macros need to be defined (examples are
1968 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001969
1970 I2C_INIT
1971
wdenkb37c7e52003-06-30 16:24:52 +00001972 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001973 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001974
wdenkba56f622004-02-06 23:19:44 +00001975 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001976
wdenkc6097192002-11-03 00:24:07 +00001977 I2C_PORT
1978
wdenk43d96162003-03-06 00:02:04 +00001979 (Only for MPC8260 CPU). The I/O port to use (the code
1980 assumes both bits are on the same port). Valid values
1981 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001982
1983 I2C_ACTIVE
1984
1985 The code necessary to make the I2C data line active
1986 (driven). If the data line is open collector, this
1987 define can be null.
1988
wdenkb37c7e52003-06-30 16:24:52 +00001989 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1990
wdenkc6097192002-11-03 00:24:07 +00001991 I2C_TRISTATE
1992
1993 The code necessary to make the I2C data line tri-stated
1994 (inactive). If the data line is open collector, this
1995 define can be null.
1996
wdenkb37c7e52003-06-30 16:24:52 +00001997 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1998
wdenkc6097192002-11-03 00:24:07 +00001999 I2C_READ
2000
York Sun472d5462013-04-01 11:29:11 -07002001 Code that returns true if the I2C data line is high,
2002 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002003
wdenkb37c7e52003-06-30 16:24:52 +00002004 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2005
wdenkc6097192002-11-03 00:24:07 +00002006 I2C_SDA(bit)
2007
York Sun472d5462013-04-01 11:29:11 -07002008 If <bit> is true, sets the I2C data line high. If it
2009 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002010
wdenkb37c7e52003-06-30 16:24:52 +00002011 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002012 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002013 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002014
wdenkc6097192002-11-03 00:24:07 +00002015 I2C_SCL(bit)
2016
York Sun472d5462013-04-01 11:29:11 -07002017 If <bit> is true, sets the I2C clock line high. If it
2018 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002019
wdenkb37c7e52003-06-30 16:24:52 +00002020 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002021 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002022 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002023
wdenkc6097192002-11-03 00:24:07 +00002024 I2C_DELAY
2025
2026 This delay is invoked four times per clock cycle so this
2027 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002028 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002029 like:
2030
wdenkb37c7e52003-06-30 16:24:52 +00002031 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002032
Mike Frysinger793b5722010-07-21 13:38:02 -04002033 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2034
2035 If your arch supports the generic GPIO framework (asm/gpio.h),
2036 then you may alternatively define the two GPIOs that are to be
2037 used as SCL / SDA. Any of the previous I2C_xxx macros will
2038 have GPIO-based defaults assigned to them as appropriate.
2039
2040 You should define these to the GPIO value as given directly to
2041 the generic GPIO functions.
2042
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002043 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002044
wdenk8bde7f72003-06-27 21:31:46 +00002045 When a board is reset during an i2c bus transfer
2046 chips might think that the current transfer is still
2047 in progress. On some boards it is possible to access
2048 the i2c SCLK line directly, either by using the
2049 processor pin as a GPIO or by having a second pin
2050 connected to the bus. If this option is defined a
2051 custom i2c_init_board() routine in boards/xxx/board.c
2052 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002053
Richard Retanubun26a33502010-04-12 15:08:17 -04002054 CONFIG_SYS_I2C_BOARD_LATE_INIT
2055
2056 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2057 defined a custom i2c_board_late_init() routine in
2058 boards/xxx/board.c is run AFTER the operations in i2c_init()
2059 is completed. This callpoint can be used to unreset i2c bus
2060 using CPU i2c controller register accesses for CPUs whose i2c
2061 controller provide such a method. It is called at the end of
2062 i2c_init() to allow i2c_init operations to setup the i2c bus
2063 controller on the CPU (e.g. setting bus speed & slave address).
2064
wdenk17ea1172004-06-06 21:51:03 +00002065 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2066
2067 This option enables configuration of bi_iic_fast[] flags
2068 in u-boot bd_info structure based on u-boot environment
2069 variable "i2cfast". (see also i2cfast)
2070
Ben Warrenbb99ad62006-09-07 16:50:54 -04002071 CONFIG_I2C_MULTI_BUS
2072
2073 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002074 must have a controller. At any point in time, only one bus is
2075 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002076 Note that bus numbering is zero-based.
2077
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002078 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002079
2080 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002081 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002082 is set, specify a list of bus-device pairs. Otherwise, specify
2083 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002084
2085 e.g.
2086 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002087 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002088
2089 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2090
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002091 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002092 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002093
2094 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2095
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002096 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002097
2098 If defined, then this indicates the I2C bus number for DDR SPD.
2099 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002101 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002102
2103 If defined, then this indicates the I2C bus number for the RTC.
2104 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2105
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002106 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002107
2108 If defined, then this indicates the I2C bus number for the DTT.
2109 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2110
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002111 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002112
2113 If defined, specifies the I2C address of the DTT device.
2114 If not defined, then U-Boot uses predefined value for
2115 specified DTT device.
2116
Timur Tabibe5e6182006-11-03 19:15:00 -06002117 CONFIG_FSL_I2C
2118
2119 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01002120 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06002121
Heiko Schocher67b23a32008-10-15 09:39:47 +02002122 CONFIG_I2C_MUX
2123
2124 Define this option if you have I2C devices reached over 1 .. n
2125 I2C Muxes like the pca9544a. This option addes a new I2C
2126 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2127 new I2C Bus to the existing I2C Busses. If you select the
2128 new Bus with "i2c dev", u-bbot sends first the commandos for
2129 the muxes to activate this new "bus".
2130
2131 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2132 feature!
2133
2134 Example:
2135 Adding a new I2C Bus reached over 2 pca9544a muxes
2136 The First mux with address 70 and channel 6
2137 The Second mux with address 71 and channel 4
2138
2139 => i2c bus pca9544a:70:6:pca9544a:71:4
2140
2141 Use the "i2c bus" command without parameter, to get a list
2142 of I2C Busses with muxes:
2143
2144 => i2c bus
2145 Busses reached over muxes:
2146 Bus ID: 2
2147 reached over Mux(es):
2148 pca9544a@70 ch: 4
2149 Bus ID: 3
2150 reached over Mux(es):
2151 pca9544a@70 ch: 6
2152 pca9544a@71 ch: 4
2153 =>
2154
2155 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002156 u-boot first sends the command to the mux@70 to enable
2157 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002158 the channel 4.
2159
2160 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002161 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002162 the 2 muxes.
2163
2164 This option is actually implemented for the bitbanging
2165 algorithm in common/soft_i2c.c and for the Hardware I2C
2166 Bus on the MPC8260. But it should be not so difficult
2167 to add this option to other architectures.
2168
Andrew Dyer2ac69852008-12-29 17:36:01 -06002169 CONFIG_SOFT_I2C_READ_REPEATED_START
2170
2171 defining this will force the i2c_read() function in
2172 the soft_i2c driver to perform an I2C repeated start
2173 between writing the address pointer and reading the
2174 data. If this define is omitted the default behaviour
2175 of doing a stop-start sequence will be used. Most I2C
2176 devices can use either method, but some require one or
2177 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002178
wdenkc6097192002-11-03 00:24:07 +00002179- SPI Support: CONFIG_SPI
2180
2181 Enables SPI driver (so far only tested with
2182 SPI EEPROM, also an instance works with Crystal A/D and
2183 D/As on the SACSng board)
2184
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002185 CONFIG_SH_SPI
2186
2187 Enables the driver for SPI controller on SuperH. Currently
2188 only SH7757 is supported.
2189
wdenkc6097192002-11-03 00:24:07 +00002190 CONFIG_SPI_X
2191
2192 Enables extended (16-bit) SPI EEPROM addressing.
2193 (symmetrical to CONFIG_I2C_X)
2194
2195 CONFIG_SOFT_SPI
2196
wdenk43d96162003-03-06 00:02:04 +00002197 Enables a software (bit-bang) SPI driver rather than
2198 using hardware support. This is a general purpose
2199 driver that only requires three general I/O port pins
2200 (two outputs, one input) to function. If this is
2201 defined, the board configuration must define several
2202 SPI configuration items (port pins to use, etc). For
2203 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002204
Ben Warren04a9e112008-01-16 22:37:35 -05002205 CONFIG_HARD_SPI
2206
2207 Enables a hardware SPI driver for general-purpose reads
2208 and writes. As with CONFIG_SOFT_SPI, the board configuration
2209 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002210 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002211 example, see include/configs/mpc8349emds.h.
2212
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002213 CONFIG_MXC_SPI
2214
2215 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002216 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002217
Matthias Fuchs01335022007-12-27 17:12:34 +01002218- FPGA Support: CONFIG_FPGA
2219
2220 Enables FPGA subsystem.
2221
2222 CONFIG_FPGA_<vendor>
2223
2224 Enables support for specific chip vendors.
2225 (ALTERA, XILINX)
2226
2227 CONFIG_FPGA_<family>
2228
2229 Enables support for FPGA family.
2230 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2231
2232 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002233
wdenk43d96162003-03-06 00:02:04 +00002234 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002235
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002236 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002237
wdenk8bde7f72003-06-27 21:31:46 +00002238 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002239
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002240 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002241
wdenk43d96162003-03-06 00:02:04 +00002242 Enable checks on FPGA configuration interface busy
2243 status by the configuration function. This option
2244 will require a board or device specific function to
2245 be written.
wdenkc6097192002-11-03 00:24:07 +00002246
2247 CONFIG_FPGA_DELAY
2248
2249 If defined, a function that provides delays in the FPGA
2250 configuration driver.
2251
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002252 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002253 Allow Control-C to interrupt FPGA configuration
2254
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002255 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002256
wdenk43d96162003-03-06 00:02:04 +00002257 Check for configuration errors during FPGA bitfile
2258 loading. For example, abort during Virtex II
2259 configuration if the INIT_B line goes low (which
2260 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002262 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002263
wdenk43d96162003-03-06 00:02:04 +00002264 Maximum time to wait for the INIT_B line to deassert
2265 after PROB_B has been deasserted during a Virtex II
2266 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002267 ms.
wdenkc6097192002-11-03 00:24:07 +00002268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002269 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002270
wdenk43d96162003-03-06 00:02:04 +00002271 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002272 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002274 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002275
wdenk43d96162003-03-06 00:02:04 +00002276 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002277 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002278
2279- Configuration Management:
2280 CONFIG_IDENT_STRING
2281
wdenk43d96162003-03-06 00:02:04 +00002282 If defined, this string will be added to the U-Boot
2283 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002284
2285- Vendor Parameter Protection:
2286
wdenk43d96162003-03-06 00:02:04 +00002287 U-Boot considers the values of the environment
2288 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002289 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002290 are set once by the board vendor / manufacturer, and
2291 protects these variables from casual modification by
2292 the user. Once set, these variables are read-only,
2293 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002294 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002295
2296 If CONFIG_ENV_OVERWRITE is #defined in your config
2297 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002298 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002299 these parameters.
2300
2301 Alternatively, if you #define _both_ CONFIG_ETHADDR
2302 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002303 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002304 which can be changed exactly ONCE by the user. [The
2305 serial# is unaffected by this, i. e. it remains
2306 read-only.]
2307
Joe Hershberger25980902012-12-11 22:16:31 -06002308 The same can be accomplished in a more flexible way
2309 for any variable by configuring the type of access
2310 to allow for those variables in the ".flags" variable
2311 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2312
wdenkc6097192002-11-03 00:24:07 +00002313- Protected RAM:
2314 CONFIG_PRAM
2315
2316 Define this variable to enable the reservation of
2317 "protected RAM", i. e. RAM which is not overwritten
2318 by U-Boot. Define CONFIG_PRAM to hold the number of
2319 kB you want to reserve for pRAM. You can overwrite
2320 this default value by defining an environment
2321 variable "pram" to the number of kB you want to
2322 reserve. Note that the board info structure will
2323 still show the full amount of RAM. If pRAM is
2324 reserved, a new environment variable "mem" will
2325 automatically be defined to hold the amount of
2326 remaining RAM in a form that can be passed as boot
2327 argument to Linux, for instance like that:
2328
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002329 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002330 saveenv
2331
2332 This way you can tell Linux not to use this memory,
2333 either, which results in a memory region that will
2334 not be affected by reboots.
2335
2336 *WARNING* If your board configuration uses automatic
2337 detection of the RAM size, you must make sure that
2338 this memory test is non-destructive. So far, the
2339 following board configurations are known to be
2340 "pRAM-clean":
2341
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002342 IVMS8, IVML24, SPD8xx, TQM8xxL,
2343 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002344 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002345
Gabe Black40fef042012-12-02 04:55:18 +00002346- Access to physical memory region (> 4GB)
2347 Some basic support is provided for operations on memory not
2348 normally accessible to U-Boot - e.g. some architectures
2349 support access to more than 4GB of memory on 32-bit
2350 machines using physical address extension or similar.
2351 Define CONFIG_PHYSMEM to access this basic support, which
2352 currently only supports clearing the memory.
2353
wdenkc6097192002-11-03 00:24:07 +00002354- Error Recovery:
2355 CONFIG_PANIC_HANG
2356
2357 Define this variable to stop the system in case of a
2358 fatal error, so that you have to reset it manually.
2359 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002360 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002361 automatically as fast as possible, but it may be
2362 useful during development since you can try to debug
2363 the conditions that lead to the situation.
2364
2365 CONFIG_NET_RETRY_COUNT
2366
wdenk43d96162003-03-06 00:02:04 +00002367 This variable defines the number of retries for
2368 network operations like ARP, RARP, TFTP, or BOOTP
2369 before giving up the operation. If not defined, a
2370 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002371
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002372 CONFIG_ARP_TIMEOUT
2373
2374 Timeout waiting for an ARP reply in milliseconds.
2375
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002376 CONFIG_NFS_TIMEOUT
2377
2378 Timeout in milliseconds used in NFS protocol.
2379 If you encounter "ERROR: Cannot umount" in nfs command,
2380 try longer timeout such as
2381 #define CONFIG_NFS_TIMEOUT 10000UL
2382
wdenkc6097192002-11-03 00:24:07 +00002383- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002384 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002385
2386 Enable auto completion of commands using TAB.
2387
Wolfgang Denka9398e02006-11-27 15:32:42 +01002388 Note that this feature has NOT been implemented yet
2389 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002390
2391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002392 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002393
2394 Define this variable to enable the "hush" shell (from
2395 Busybox) as command line interpreter, thus enabling
2396 powerful command line syntax like
2397 if...then...else...fi conditionals or `&&' and '||'
2398 constructs ("shell scripts").
2399
2400 If undefined, you get the old, much simpler behaviour
2401 with a somewhat smaller memory footprint.
2402
2403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002404 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002405
2406 This defines the secondary prompt string, which is
2407 printed when the command interpreter needs more input
2408 to complete a command. Usually "> ".
2409
2410 Note:
2411
wdenk8bde7f72003-06-27 21:31:46 +00002412 In the current implementation, the local variables
2413 space and global environment variables space are
2414 separated. Local variables are those you define by
2415 simply typing `name=value'. To access a local
2416 variable later on, you have write `$name' or
2417 `${name}'; to execute the contents of a variable
2418 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002419
wdenk43d96162003-03-06 00:02:04 +00002420 Global environment variables are those you use
2421 setenv/printenv to work with. To run a command stored
2422 in such a variable, you need to use the run command,
2423 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002424
2425 To store commands and special characters in a
2426 variable, please use double quotation marks
2427 surrounding the whole text of the variable, instead
2428 of the backslashes before semicolons and special
2429 symbols.
2430
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002431- Commandline Editing and History:
2432 CONFIG_CMDLINE_EDITING
2433
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002434 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002435 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002436
wdenka8c7c702003-12-06 19:49:23 +00002437- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002438 CONFIG_EXTRA_ENV_SETTINGS
2439
wdenk43d96162003-03-06 00:02:04 +00002440 Define this to contain any number of null terminated
2441 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002442 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002443
wdenk43d96162003-03-06 00:02:04 +00002444 For example, place something like this in your
2445 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002446
2447 #define CONFIG_EXTRA_ENV_SETTINGS \
2448 "myvar1=value1\0" \
2449 "myvar2=value2\0"
2450
wdenk43d96162003-03-06 00:02:04 +00002451 Warning: This method is based on knowledge about the
2452 internal format how the environment is stored by the
2453 U-Boot code. This is NOT an official, exported
2454 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002455 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002456 You better know what you are doing here.
2457
wdenk43d96162003-03-06 00:02:04 +00002458 Note: overly (ab)use of the default environment is
2459 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002460 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002461 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002462
Stephen Warren5e724ca2012-05-22 09:21:54 +00002463 CONFIG_ENV_VARS_UBOOT_CONFIG
2464
2465 Define this in order to add variables describing the
2466 U-Boot build configuration to the default environment.
2467 These will be named arch, cpu, board, vendor, and soc.
2468
2469 Enabling this option will cause the following to be defined:
2470
2471 - CONFIG_SYS_ARCH
2472 - CONFIG_SYS_CPU
2473 - CONFIG_SYS_BOARD
2474 - CONFIG_SYS_VENDOR
2475 - CONFIG_SYS_SOC
2476
Tom Rini7e27f892012-10-24 07:28:16 +00002477 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2478
2479 Define this in order to add variables describing certain
2480 run-time determined information about the hardware to the
2481 environment. These will be named board_name, board_rev.
2482
Simon Glass06fd8532012-11-30 13:01:17 +00002483 CONFIG_DELAY_ENVIRONMENT
2484
2485 Normally the environment is loaded when the board is
2486 intialised so that it is available to U-Boot. This inhibits
2487 that so that the environment is not available until
2488 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2489 this is instead controlled by the value of
2490 /config/load-environment.
2491
wdenka8c7c702003-12-06 19:49:23 +00002492- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002493 CONFIG_HAS_DATAFLASH
2494
wdenk8bde7f72003-06-27 21:31:46 +00002495 Defining this option enables DataFlash features and
2496 allows to read/write in Dataflash via the standard
2497 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002498
Eric Nelsonf61ec452012-01-31 10:52:08 -07002499- Serial Flash support
2500 CONFIG_CMD_SF
2501
2502 Defining this option enables SPI flash commands
2503 'sf probe/read/write/erase/update'.
2504
2505 Usage requires an initial 'probe' to define the serial
2506 flash parameters, followed by read/write/erase/update
2507 commands.
2508
2509 The following defaults may be provided by the platform
2510 to handle the common case when only a single serial
2511 flash is present on the system.
2512
2513 CONFIG_SF_DEFAULT_BUS Bus identifier
2514 CONFIG_SF_DEFAULT_CS Chip-select
2515 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2516 CONFIG_SF_DEFAULT_SPEED in Hz
2517
Simon Glass24007272012-10-08 13:16:02 +00002518 CONFIG_CMD_SF_TEST
2519
2520 Define this option to include a destructive SPI flash
2521 test ('sf test').
2522
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302523 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2524
2525 Define this option to use the Bank addr/Extended addr
2526 support on SPI flashes which has size > 16Mbytes.
2527
wdenk3f85ce22004-02-23 16:11:30 +00002528- SystemACE Support:
2529 CONFIG_SYSTEMACE
2530
2531 Adding this option adds support for Xilinx SystemACE
2532 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002533 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002534 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002535
2536 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002537 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002538
2539 When SystemACE support is added, the "ace" device type
2540 becomes available to the fat commands, i.e. fatls.
2541
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002542- TFTP Fixed UDP Port:
2543 CONFIG_TFTP_PORT
2544
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002545 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002546 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002547 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002548 number generator is used.
2549
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002550 Also, the environment variable tftpdstp is used to supply
2551 the TFTP UDP destination port value. If tftpdstp isn't
2552 defined, the normal port 69 is used.
2553
2554 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002555 blindly start the TFTP transfer using the pre-configured
2556 target IP address and UDP port. This has the effect of
2557 "punching through" the (Windows XP) firewall, allowing
2558 the remainder of the TFTP transfer to proceed normally.
2559 A better solution is to properly configure the firewall,
2560 but sometimes that is not allowed.
2561
Simon Glassbf36c5d2012-12-05 14:46:38 +00002562- Hashing support:
2563 CONFIG_CMD_HASH
2564
2565 This enables a generic 'hash' command which can produce
2566 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2567
2568 CONFIG_HASH_VERIFY
2569
2570 Enable the hash verify command (hash -v). This adds to code
2571 size a little.
2572
2573 CONFIG_SHA1 - support SHA1 hashing
2574 CONFIG_SHA256 - support SHA256 hashing
2575
2576 Note: There is also a sha1sum command, which should perhaps
2577 be deprecated in favour of 'hash sha1'.
2578
wdenka8c7c702003-12-06 19:49:23 +00002579- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002580 CONFIG_SHOW_BOOT_PROGRESS
2581
wdenk43d96162003-03-06 00:02:04 +00002582 Defining this option allows to add some board-
2583 specific code (calling a user-provided function
2584 "show_boot_progress(int)") that enables you to show
2585 the system's boot progress on some display (for
2586 example, some LED's) on your board. At the moment,
2587 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002588
Simon Glass3a608ca2012-02-13 13:51:19 +00002589- Detailed boot stage timing
2590 CONFIG_BOOTSTAGE
2591 Define this option to get detailed timing of each stage
2592 of the boot process.
2593
2594 CONFIG_BOOTSTAGE_USER_COUNT
2595 This is the number of available user bootstage records.
2596 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2597 a new ID will be allocated from this stash. If you exceed
2598 the limit, recording will stop.
2599
2600 CONFIG_BOOTSTAGE_REPORT
2601 Define this to print a report before boot, similar to this:
2602
2603 Timer summary in microseconds:
2604 Mark Elapsed Stage
2605 0 0 reset
2606 3,575,678 3,575,678 board_init_f start
2607 3,575,695 17 arch_cpu_init A9
2608 3,575,777 82 arch_cpu_init done
2609 3,659,598 83,821 board_init_r start
2610 3,910,375 250,777 main_loop
2611 29,916,167 26,005,792 bootm_start
2612 30,361,327 445,160 start_kernel
2613
Simon Glass2eba38c2012-09-28 08:56:39 +00002614 CONFIG_CMD_BOOTSTAGE
2615 Add a 'bootstage' command which supports printing a report
2616 and un/stashing of bootstage data.
2617
Simon Glass94fd1312012-09-28 08:56:37 +00002618 CONFIG_BOOTSTAGE_FDT
2619 Stash the bootstage information in the FDT. A root 'bootstage'
2620 node is created with each bootstage id as a child. Each child
2621 has a 'name' property and either 'mark' containing the
2622 mark time in microsecond, or 'accum' containing the
2623 accumulated time for that bootstage id in microseconds.
2624 For example:
2625
2626 bootstage {
2627 154 {
2628 name = "board_init_f";
2629 mark = <3575678>;
2630 };
2631 170 {
2632 name = "lcd";
2633 accum = <33482>;
2634 };
2635 };
2636
2637 Code in the Linux kernel can find this in /proc/devicetree.
2638
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002639Legacy uImage format:
2640
wdenkc6097192002-11-03 00:24:07 +00002641 Arg Where When
2642 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002643 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002644 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002645 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002646 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002647 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002648 4 common/cmd_bootm.c Image data has correct checksum
2649 -4 common/cmd_bootm.c Image is for unsupported architecture
2650 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002651 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002652 6 common/cmd_bootm.c Image Type check OK
2653 -6 common/cmd_bootm.c gunzip uncompression error
2654 -7 common/cmd_bootm.c Unimplemented compression type
2655 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002656 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002657 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002658
2659 9 common/image.c Start initial ramdisk verification
2660 -10 common/image.c Ramdisk header has bad magic number
2661 -11 common/image.c Ramdisk header has bad checksum
2662 10 common/image.c Ramdisk header is OK
2663 -12 common/image.c Ramdisk data has bad checksum
2664 11 common/image.c Ramdisk data has correct checksum
2665 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002666 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002667 13 common/image.c Start multifile image verification
2668 14 common/image.c No initial ramdisk, no multifile, continue.
2669
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002670 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002671
Stefan Roesea47a12b2010-04-15 16:07:28 +02002672 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002673 -31 post/post.c POST test failed, detected by post_output_backlog()
2674 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002675
Heiko Schocher566a4942007-06-22 19:11:54 +02002676 34 common/cmd_doc.c before loading a Image from a DOC device
2677 -35 common/cmd_doc.c Bad usage of "doc" command
2678 35 common/cmd_doc.c correct usage of "doc" command
2679 -36 common/cmd_doc.c No boot device
2680 36 common/cmd_doc.c correct boot device
2681 -37 common/cmd_doc.c Unknown Chip ID on boot device
2682 37 common/cmd_doc.c correct chip ID found, device available
2683 -38 common/cmd_doc.c Read Error on boot device
2684 38 common/cmd_doc.c reading Image header from DOC device OK
2685 -39 common/cmd_doc.c Image header has bad magic number
2686 39 common/cmd_doc.c Image header has correct magic number
2687 -40 common/cmd_doc.c Error reading Image from DOC device
2688 40 common/cmd_doc.c Image header has correct magic number
2689 41 common/cmd_ide.c before loading a Image from a IDE device
2690 -42 common/cmd_ide.c Bad usage of "ide" command
2691 42 common/cmd_ide.c correct usage of "ide" command
2692 -43 common/cmd_ide.c No boot device
2693 43 common/cmd_ide.c boot device found
2694 -44 common/cmd_ide.c Device not available
2695 44 common/cmd_ide.c Device available
2696 -45 common/cmd_ide.c wrong partition selected
2697 45 common/cmd_ide.c partition selected
2698 -46 common/cmd_ide.c Unknown partition table
2699 46 common/cmd_ide.c valid partition table found
2700 -47 common/cmd_ide.c Invalid partition type
2701 47 common/cmd_ide.c correct partition type
2702 -48 common/cmd_ide.c Error reading Image Header on boot device
2703 48 common/cmd_ide.c reading Image Header from IDE device OK
2704 -49 common/cmd_ide.c Image header has bad magic number
2705 49 common/cmd_ide.c Image header has correct magic number
2706 -50 common/cmd_ide.c Image header has bad checksum
2707 50 common/cmd_ide.c Image header has correct checksum
2708 -51 common/cmd_ide.c Error reading Image from IDE device
2709 51 common/cmd_ide.c reading Image from IDE device OK
2710 52 common/cmd_nand.c before loading a Image from a NAND device
2711 -53 common/cmd_nand.c Bad usage of "nand" command
2712 53 common/cmd_nand.c correct usage of "nand" command
2713 -54 common/cmd_nand.c No boot device
2714 54 common/cmd_nand.c boot device found
2715 -55 common/cmd_nand.c Unknown Chip ID on boot device
2716 55 common/cmd_nand.c correct chip ID found, device available
2717 -56 common/cmd_nand.c Error reading Image Header on boot device
2718 56 common/cmd_nand.c reading Image Header from NAND device OK
2719 -57 common/cmd_nand.c Image header has bad magic number
2720 57 common/cmd_nand.c Image header has correct magic number
2721 -58 common/cmd_nand.c Error reading Image from NAND device
2722 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002723
Heiko Schocher566a4942007-06-22 19:11:54 +02002724 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002725
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002726 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002727 -64 net/eth.c no Ethernet found.
2728 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002729
Heiko Schocher566a4942007-06-22 19:11:54 +02002730 -80 common/cmd_net.c usage wrong
2731 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002732 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002733 81 common/cmd_net.c NetLoop() back without error
2734 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2735 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002736 83 common/cmd_net.c running "source" command
2737 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002738 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002739
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002740FIT uImage format:
2741
2742 Arg Where When
2743 100 common/cmd_bootm.c Kernel FIT Image has correct format
2744 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2745 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2746 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2747 102 common/cmd_bootm.c Kernel unit name specified
2748 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002749 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002750 104 common/cmd_bootm.c Got kernel subimage node offset
2751 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2752 105 common/cmd_bootm.c Kernel subimage hash verification OK
2753 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2754 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002755 -106 common/cmd_bootm.c Kernel subimage has wrong type
2756 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002757 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2758 108 common/cmd_bootm.c Got kernel subimage data/size
2759 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2760 -109 common/cmd_bootm.c Can't get kernel subimage type
2761 -110 common/cmd_bootm.c Can't get kernel subimage comp
2762 -111 common/cmd_bootm.c Can't get kernel subimage os
2763 -112 common/cmd_bootm.c Can't get kernel subimage load address
2764 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2765
2766 120 common/image.c Start initial ramdisk verification
2767 -120 common/image.c Ramdisk FIT image has incorrect format
2768 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002769 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002770 -122 common/image.c Can't get configuration for ramdisk subimage
2771 123 common/image.c Ramdisk unit name specified
2772 -124 common/image.c Can't get ramdisk subimage node offset
2773 125 common/image.c Got ramdisk subimage node offset
2774 -125 common/image.c Ramdisk subimage hash verification failed
2775 126 common/image.c Ramdisk subimage hash verification OK
2776 -126 common/image.c Ramdisk subimage for unsupported architecture
2777 127 common/image.c Architecture check OK
2778 -127 common/image.c Can't get ramdisk subimage data/size
2779 128 common/image.c Got ramdisk subimage data/size
2780 129 common/image.c Can't get ramdisk load address
2781 -129 common/image.c Got ramdisk load address
2782
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002783 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002784 131 common/cmd_doc.c FIT image format OK
2785
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002786 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002787 141 common/cmd_ide.c FIT image format OK
2788
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002789 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002790 151 common/cmd_nand.c FIT image format OK
2791
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002792- FIT image support:
2793 CONFIG_FIT
2794 Enable support for the FIT uImage format.
2795
2796 CONFIG_FIT_BEST_MATCH
2797 When no configuration is explicitly selected, default to the
2798 one whose fdt's compatibility field best matches that of
2799 U-Boot itself. A match is considered "best" if it matches the
2800 most specific compatibility entry of U-Boot's fdt's root node.
2801 The order of entries in the configuration's fdt is ignored.
2802
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002803- Standalone program support:
2804 CONFIG_STANDALONE_LOAD_ADDR
2805
Wolfgang Denk6feff892011-10-09 21:06:34 +02002806 This option defines a board specific value for the
2807 address where standalone program gets loaded, thus
2808 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002809 settings.
2810
2811- Frame Buffer Address:
2812 CONFIG_FB_ADDR
2813
2814 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002815 address for frame buffer. This is typically the case
2816 when using a graphics controller has separate video
2817 memory. U-Boot will then place the frame buffer at
2818 the given address instead of dynamically reserving it
2819 in system RAM by calling lcd_setmem(), which grabs
2820 the memory for the frame buffer depending on the
2821 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002822
2823 Please see board_init_f function.
2824
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002825- Automatic software updates via TFTP server
2826 CONFIG_UPDATE_TFTP
2827 CONFIG_UPDATE_TFTP_CNT_MAX
2828 CONFIG_UPDATE_TFTP_MSEC_MAX
2829
2830 These options enable and control the auto-update feature;
2831 for a more detailed description refer to doc/README.update.
2832
2833- MTD Support (mtdparts command, UBI support)
2834 CONFIG_MTD_DEVICE
2835
2836 Adds the MTD device infrastructure from the Linux kernel.
2837 Needed for mtdparts command support.
2838
2839 CONFIG_MTD_PARTITIONS
2840
2841 Adds the MTD partitioning infrastructure from the Linux
2842 kernel. Needed for UBI support.
2843
Joe Hershberger70c219c2013-04-08 10:32:48 +00002844- UBI support
2845 CONFIG_CMD_UBI
2846
2847 Adds commands for interacting with MTD partitions formatted
2848 with the UBI flash translation layer
2849
2850 Requires also defining CONFIG_RBTREE
2851
Joe Hershberger147162d2013-04-08 10:32:49 +00002852 CONFIG_UBI_SILENCE_MSG
2853
2854 Make the verbose messages from UBI stop printing. This leaves
2855 warnings and errors enabled.
2856
Joe Hershberger70c219c2013-04-08 10:32:48 +00002857- UBIFS support
2858 CONFIG_CMD_UBIFS
2859
2860 Adds commands for interacting with UBI volumes formatted as
2861 UBIFS. UBIFS is read-only in u-boot.
2862
2863 Requires UBI support as well as CONFIG_LZO
2864
Joe Hershberger147162d2013-04-08 10:32:49 +00002865 CONFIG_UBIFS_SILENCE_MSG
2866
2867 Make the verbose messages from UBIFS stop printing. This leaves
2868 warnings and errors enabled.
2869
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002870- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002871 CONFIG_SPL
2872 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002873
Tom Rini95579792012-02-14 07:29:40 +00002874 CONFIG_SPL_LDSCRIPT
2875 LDSCRIPT for linking the SPL binary.
2876
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002877 CONFIG_SPL_MAX_FOOTPRINT
2878 Maximum size in memory allocated to the SPL, BSS included.
2879 When defined, the linker checks that the actual memory
2880 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002881 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002882 must not be both defined at the same time.
2883
Tom Rini95579792012-02-14 07:29:40 +00002884 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002885 Maximum size of the SPL image (text, data, rodata, and
2886 linker lists sections), BSS excluded.
2887 When defined, the linker checks that the actual size does
2888 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002889
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002890 CONFIG_SPL_TEXT_BASE
2891 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002892
Scott Wood94a45bb2012-09-20 19:05:12 -05002893 CONFIG_SPL_RELOC_TEXT_BASE
2894 Address to relocate to. If unspecified, this is equal to
2895 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2896
Tom Rini95579792012-02-14 07:29:40 +00002897 CONFIG_SPL_BSS_START_ADDR
2898 Link address for the BSS within the SPL binary.
2899
2900 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002901 Maximum size in memory allocated to the SPL BSS.
2902 When defined, the linker checks that the actual memory used
2903 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002904 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002905 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002906
2907 CONFIG_SPL_STACK
2908 Adress of the start of the stack SPL will use
2909
Scott Wood94a45bb2012-09-20 19:05:12 -05002910 CONFIG_SPL_RELOC_STACK
2911 Adress of the start of the stack SPL will use after
2912 relocation. If unspecified, this is equal to
2913 CONFIG_SPL_STACK.
2914
Tom Rini95579792012-02-14 07:29:40 +00002915 CONFIG_SYS_SPL_MALLOC_START
2916 Starting address of the malloc pool used in SPL.
2917
2918 CONFIG_SYS_SPL_MALLOC_SIZE
2919 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002920
Tom Rini47f7bca2012-08-13 12:03:19 -07002921 CONFIG_SPL_FRAMEWORK
2922 Enable the SPL framework under common/. This framework
2923 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2924 NAND loading of the Linux Kernel.
2925
Tom Rini861a86f2012-08-13 11:37:56 -07002926 CONFIG_SPL_DISPLAY_PRINT
2927 For ARM, enable an optional function to print more information
2928 about the running system.
2929
Scott Wood4b919722012-09-20 16:35:21 -05002930 CONFIG_SPL_INIT_MINIMAL
2931 Arch init code should be built for a very small image
2932
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002933 CONFIG_SPL_LIBCOMMON_SUPPORT
2934 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002935
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002936 CONFIG_SPL_LIBDISK_SUPPORT
2937 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002938
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002939 CONFIG_SPL_I2C_SUPPORT
2940 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002941
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002942 CONFIG_SPL_GPIO_SUPPORT
2943 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002944
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002945 CONFIG_SPL_MMC_SUPPORT
2946 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002947
Tom Rini95579792012-02-14 07:29:40 +00002948 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2949 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2950 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2951 Address, size and partition on the MMC to load U-Boot from
2952 when the MMC is being used in raw mode.
2953
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002954 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2955 Sector to load kernel uImage from when MMC is being
2956 used in raw mode (for Falcon mode)
2957
2958 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2959 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2960 Sector and number of sectors to load kernel argument
2961 parameters from when MMC is being used in raw mode
2962 (for falcon mode)
2963
Tom Rini95579792012-02-14 07:29:40 +00002964 CONFIG_SPL_FAT_SUPPORT
2965 Support for fs/fat/libfat.o in SPL binary
2966
2967 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2968 Filename to read to load U-Boot when reading from FAT
2969
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002970 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
2971 Filename to read to load kernel uImage when reading
2972 from FAT (for Falcon mode)
2973
2974 CONFIG_SPL_FAT_LOAD_ARGS_NAME
2975 Filename to read to load kernel argument parameters
2976 when reading from FAT (for Falcon mode)
2977
Scott Wood06f60ae2012-12-06 13:33:17 +00002978 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2979 Set this for NAND SPL on PPC mpc83xx targets, so that
2980 start.S waits for the rest of the SPL to load before
2981 continuing (the hardware starts execution after just
2982 loading the first page rather than the full 4K).
2983
Scott Wood6f2f01b2012-09-20 19:09:07 -05002984 CONFIG_SPL_NAND_BASE
2985 Include nand_base.c in the SPL. Requires
2986 CONFIG_SPL_NAND_DRIVERS.
2987
2988 CONFIG_SPL_NAND_DRIVERS
2989 SPL uses normal NAND drivers, not minimal drivers.
2990
2991 CONFIG_SPL_NAND_ECC
2992 Include standard software ECC in the SPL
2993
Tom Rini95579792012-02-14 07:29:40 +00002994 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002995 Support for NAND boot using simple NAND drivers that
2996 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002997
2998 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2999 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3000 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3001 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3002 CONFIG_SYS_NAND_ECCBYTES
3003 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003004 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003005
3006 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003007 Location in NAND to read U-Boot from
3008
3009 CONFIG_SYS_NAND_U_BOOT_DST
3010 Location in memory to load U-Boot to
3011
3012 CONFIG_SYS_NAND_U_BOOT_SIZE
3013 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003014
3015 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003016 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003017
3018 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3019 Define this if you need to first read the OOB and then the
3020 data. This is used for example on davinci plattforms.
3021
3022 CONFIG_SPL_OMAP3_ID_NAND
3023 Support for an OMAP3-specific set of functions to return the
3024 ID and MFR of the first attached NAND chip, if present.
3025
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003026 CONFIG_SPL_SERIAL_SUPPORT
3027 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003028
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003029 CONFIG_SPL_SPI_FLASH_SUPPORT
3030 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003031
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003032 CONFIG_SPL_SPI_SUPPORT
3033 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003034
Pavel Machekc57b9532012-08-30 22:42:11 +02003035 CONFIG_SPL_RAM_DEVICE
3036 Support for running image already present in ram, in SPL binary
3037
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003038 CONFIG_SPL_LIBGENERIC_SUPPORT
3039 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003040
Ying Zhangba1bee42013-05-20 14:07:25 +08003041 CONFIG_SPL_ENV_SUPPORT
3042 Support for the environment operating in SPL binary
3043
3044 CONFIG_SPL_NET_SUPPORT
3045 Support for the net/libnet.o in SPL binary.
3046 It conflicts with SPL env from storage medium specified by
3047 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3048
Scott Wood74752ba2012-12-06 13:33:16 +00003049 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003050 Image offset to which the SPL should be padded before appending
3051 the SPL payload. By default, this is defined as
3052 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3053 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3054 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003055
Scott Woodca2fca22012-09-21 16:27:32 -05003056 CONFIG_SPL_TARGET
3057 Final target image containing SPL and payload. Some SPLs
3058 use an arch-specific makefile fragment instead, for
3059 example if more than one image needs to be produced.
3060
Simon Glass87ebee32013-05-08 08:05:59 +00003061 CONFIG_FIT_SPL_PRINT
3062 Printing information about a FIT image adds quite a bit of
3063 code to SPL. So this is normally disabled in SPL. Use this
3064 option to re-enable it. This will affect the output of the
3065 bootm command when booting a FIT image.
3066
wdenkc6097192002-11-03 00:24:07 +00003067Modem Support:
3068--------------
3069
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003070[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003071
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003072- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003073 CONFIG_MODEM_SUPPORT
3074
3075- RTS/CTS Flow control enable:
3076 CONFIG_HWFLOW
3077
3078- Modem debug support:
3079 CONFIG_MODEM_SUPPORT_DEBUG
3080
wdenk43d96162003-03-06 00:02:04 +00003081 Enables debugging stuff (char screen[1024], dbg())
3082 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003083
wdenka8c7c702003-12-06 19:49:23 +00003084- Interrupt support (PPC):
3085
wdenkd4ca31c2004-01-02 14:00:00 +00003086 There are common interrupt_init() and timer_interrupt()
3087 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003088 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003089 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003090 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003091 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003092 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003093 specific handling. If board has watchdog / status_led
3094 / other_activity_monitor it works automatically from
3095 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003096
wdenkc6097192002-11-03 00:24:07 +00003097- General:
3098
wdenk43d96162003-03-06 00:02:04 +00003099 In the target system modem support is enabled when a
3100 specific key (key combination) is pressed during
3101 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003102 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003103 board_init(). Currently key_pressed() is a dummy
3104 function, returning 1 and thus enabling modem
3105 initialization.
wdenkc6097192002-11-03 00:24:07 +00003106
wdenk43d96162003-03-06 00:02:04 +00003107 If there are no modem init strings in the
3108 environment, U-Boot proceed to autoboot; the
3109 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003110 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003111
3112 See also: doc/README.Modem
3113
Helmut Raiger9660e442011-10-20 04:19:47 +00003114Board initialization settings:
3115------------------------------
3116
3117During Initialization u-boot calls a number of board specific functions
3118to allow the preparation of board specific prerequisites, e.g. pin setup
3119before drivers are initialized. To enable these callbacks the
3120following configuration macros have to be defined. Currently this is
3121architecture specific, so please check arch/your_architecture/lib/board.c
3122typically in board_init_f() and board_init_r().
3123
3124- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3125- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3126- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3127- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003128
wdenkc6097192002-11-03 00:24:07 +00003129Configuration Settings:
3130-----------------------
3131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003132- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003133 undefine this when you're short of memory.
3134
Peter Tyser2fb26042009-01-27 18:03:12 -06003135- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3136 width of the commands listed in the 'help' command output.
3137
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003138- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003139 prompt for user input.
3140
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003141- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003142
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003143- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003144
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003145- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003146
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003147- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003148 the application (usually a Linux kernel) when it is
3149 booted
3150
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003151- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003152 List of legal baudrate settings for this board.
3153
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003154- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003155 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003156
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003157- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003158 If the board specific function
3159 extern int overwrite_console (void);
3160 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003161 serial port, else the settings in the environment are used.
3162
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003163- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003164 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003165
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003166- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003167 Enable overwrite of previous console environment settings.
3168
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003169- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003170 Begin and End addresses of the area used by the
3171 simple memory test.
3172
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003173- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003174 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003175
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003176- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003177 Scratch address used by the alternate memory test
3178 You only need to set this if address zero isn't writeable
3179
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003180- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3181 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003182 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003183 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003184 fixing up gd->ram_size the Linux kernel should gets passed
3185 the now "corrected" memory size and won't touch it either.
3186 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003187 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003188 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003189 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003190
3191 This option can be used as a workaround for the 440EPx/GRx
3192 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3193 be touched.
3194
3195 WARNING: Please make sure that this value is a multiple of
3196 the Linux page size (normally 4k). If this is not the case,
3197 then the end address of the Linux memory will be located at a
3198 non page size aligned address and this could cause major
3199 problems.
3200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003201- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003202 Enable temporary baudrate change while serial download
3203
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003204- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003205 Physical start address of SDRAM. _Must_ be 0 here.
3206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003207- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003208 Physical start address of Motherboard I/O (if using a
3209 Cogent motherboard)
3210
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003211- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003212 Physical start address of Flash memory.
3213
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003214- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003215 Physical start address of boot monitor code (set by
3216 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003217 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003218 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003219
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003220- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003221 Size of memory reserved for monitor code, used to
3222 determine _at_compile_time_ (!) if the environment is
3223 embedded within the U-Boot image, or in a separate
3224 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003225
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003226- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003227 Size of DRAM reserved for malloc() use.
3228
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003229- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003230 Normally compressed uImages are limited to an
3231 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003232 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003233 to adjust this setting to your needs.
3234
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003235- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003236 Maximum size of memory mapped by the startup code of
3237 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003238 the Linux kernel (bd_info, boot arguments, FDT blob if
3239 used) must be put below this limit, unless "bootm_low"
3240 enviroment variable is defined and non-zero. In such case
3241 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003242 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003243 variable "bootm_mapsize" will override the value of
3244 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3245 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003246
John Rigbyfca43cc2010-10-13 13:57:35 -06003247- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3248 Enable initrd_high functionality. If defined then the
3249 initrd_high feature is enabled and the bootm ramdisk subcommand
3250 is enabled.
3251
3252- CONFIG_SYS_BOOT_GET_CMDLINE:
3253 Enables allocating and saving kernel cmdline in space between
3254 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3255
3256- CONFIG_SYS_BOOT_GET_KBD:
3257 Enables allocating and saving a kernel copy of the bd_info in
3258 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003260- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003261 Max number of Flash memory banks
3262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003263- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003264 Max number of sectors on a Flash chip
3265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003266- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003267 Timeout for Flash erase operations (in ms)
3268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003269- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003270 Timeout for Flash write operations (in ms)
3271
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003272- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003273 Timeout for Flash set sector lock bit operation (in ms)
3274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003275- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003276 Timeout for Flash clear lock bits operation (in ms)
3277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003278- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003279 If defined, hardware flash sectors protection is used
3280 instead of U-Boot software protection.
3281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003282- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003283
3284 Enable TFTP transfers directly to flash memory;
3285 without this option such a download has to be
3286 performed in two steps: (1) download to RAM, and (2)
3287 copy from RAM to flash.
3288
3289 The two-step approach is usually more reliable, since
3290 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003291 the flash, but in some situations (when system RAM is
3292 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003293 downloaded image) this option may be very useful.
3294
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003295- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003296 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003297 common flash structure for storing flash geometry.
3298
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003299- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003300 This option also enables the building of the cfi_flash driver
3301 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003302
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003303- CONFIG_FLASH_CFI_MTD
3304 This option enables the building of the cfi_mtd driver
3305 in the drivers directory. The driver exports CFI flash
3306 to the MTD layer.
3307
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003308- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003309 Use buffered writes to flash.
3310
3311- CONFIG_FLASH_SPANSION_S29WS_N
3312 s29ws-n MirrorBit flash has non-standard addresses for buffered
3313 write commands.
3314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003315- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003316 If this option is defined, the common CFI flash doesn't
3317 print it's warning upon not recognized FLASH banks. This
3318 is useful, if some of the configured banks are only
3319 optionally available.
3320
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003321- CONFIG_FLASH_SHOW_PROGRESS
3322 If defined (must be an integer), print out countdown
3323 digits and dots. Recommended value: 45 (9..1) for 80
3324 column displays, 15 (3..1) for 40 column displays.
3325
Stefan Roese352ef3f2013-04-04 15:53:14 +02003326- CONFIG_FLASH_VERIFY
3327 If defined, the content of the flash (destination) is compared
3328 against the source after the write operation. An error message
3329 will be printed when the contents are not identical.
3330 Please note that this option is useless in nearly all cases,
3331 since such flash programming errors usually are detected earlier
3332 while unprotecting/erasing/programming. Please only enable
3333 this option if you really know what you are doing.
3334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003335- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003336 Defines the number of Ethernet receive buffers. On some
3337 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003338 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3339 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003340 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003341 Defaults to 4 if not defined.
3342
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003343- CONFIG_ENV_MAX_ENTRIES
3344
Wolfgang Denk071bc922010-10-27 22:48:30 +02003345 Maximum number of entries in the hash table that is used
3346 internally to store the environment settings. The default
3347 setting is supposed to be generous and should work in most
3348 cases. This setting can be used to tune behaviour; see
3349 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003350
Joe Hershberger25980902012-12-11 22:16:31 -06003351- CONFIG_ENV_FLAGS_LIST_DEFAULT
3352- CONFIG_ENV_FLAGS_LIST_STATIC
3353 Enable validation of the values given to enviroment variables when
3354 calling env set. Variables can be restricted to only decimal,
3355 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3356 the variables can also be restricted to IP address or MAC address.
3357
3358 The format of the list is:
3359 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003360 access_atribute = [a|r|o|c]
3361 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003362 entry = variable_name[:attributes]
3363 list = entry[,list]
3364
3365 The type attributes are:
3366 s - String (default)
3367 d - Decimal
3368 x - Hexadecimal
3369 b - Boolean ([1yYtT|0nNfF])
3370 i - IP address
3371 m - MAC address
3372
Joe Hershberger267541f2012-12-11 22:16:34 -06003373 The access attributes are:
3374 a - Any (default)
3375 r - Read-only
3376 o - Write-once
3377 c - Change-default
3378
Joe Hershberger25980902012-12-11 22:16:31 -06003379 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3380 Define this to a list (string) to define the ".flags"
3381 envirnoment variable in the default or embedded environment.
3382
3383 - CONFIG_ENV_FLAGS_LIST_STATIC
3384 Define this to a list (string) to define validation that
3385 should be done if an entry is not found in the ".flags"
3386 environment variable. To override a setting in the static
3387 list, simply add an entry for the same variable name to the
3388 ".flags" variable.
3389
Joe Hershberger267541f2012-12-11 22:16:34 -06003390- CONFIG_ENV_ACCESS_IGNORE_FORCE
3391 If defined, don't allow the -f switch to env set override variable
3392 access flags.
3393
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003394- CONFIG_SYS_GENERIC_BOARD
3395 This selects the architecture-generic board system instead of the
3396 architecture-specific board files. It is intended to move boards
3397 to this new framework over time. Defining this will disable the
3398 arch/foo/lib/board.c file and use common/board_f.c and
3399 common/board_r.c instead. To use this option your architecture
3400 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3401 its config.mk file). If you find problems enabling this option on
3402 your board please report the problem and send patches!
3403
Simon Glass632efa72013-03-11 07:06:48 +00003404- CONFIG_SYS_SYM_OFFSETS
3405 This is set by architectures that use offsets for link symbols
3406 instead of absolute values. So bss_start is obtained using an
3407 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3408 directly. You should not need to touch this setting.
3409
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003410- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3411 This is set by OMAP boards for the max time that reset should
3412 be asserted. See doc/README.omap-reset-time for details on how
3413 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003414
wdenkc6097192002-11-03 00:24:07 +00003415The following definitions that deal with the placement and management
3416of environment data (variable area); in general, we support the
3417following configurations:
3418
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003419- CONFIG_BUILD_ENVCRC:
3420
3421 Builds up envcrc with the target environment so that external utils
3422 may easily extract it and embed it in final U-Boot images.
3423
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003424- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003425
3426 Define this if the environment is in flash memory.
3427
3428 a) The environment occupies one whole flash sector, which is
3429 "embedded" in the text segment with the U-Boot code. This
3430 happens usually with "bottom boot sector" or "top boot
3431 sector" type flash chips, which have several smaller
3432 sectors at the start or the end. For instance, such a
3433 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3434 such a case you would place the environment in one of the
3435 4 kB sectors - with U-Boot code before and after it. With
3436 "top boot sector" type flash chips, you would put the
3437 environment in one of the last sectors, leaving a gap
3438 between U-Boot and the environment.
3439
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003440 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003441
3442 Offset of environment data (variable area) to the
3443 beginning of flash memory; for instance, with bottom boot
3444 type flash chips the second sector can be used: the offset
3445 for this sector is given here.
3446
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003447 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003448
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003449 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003450
3451 This is just another way to specify the start address of
3452 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003453 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003454
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003455 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003456
3457 Size of the sector containing the environment.
3458
3459
3460 b) Sometimes flash chips have few, equal sized, BIG sectors.
3461 In such a case you don't want to spend a whole sector for
3462 the environment.
3463
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003464 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003465
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003466 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003467 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003468 of this flash sector for the environment. This saves
3469 memory for the RAM copy of the environment.
3470
3471 It may also save flash memory if you decide to use this
3472 when your environment is "embedded" within U-Boot code,
3473 since then the remainder of the flash sector could be used
3474 for U-Boot code. It should be pointed out that this is
3475 STRONGLY DISCOURAGED from a robustness point of view:
3476 updating the environment in flash makes it always
3477 necessary to erase the WHOLE sector. If something goes
3478 wrong before the contents has been restored from a copy in
3479 RAM, your target system will be dead.
3480
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003481 - CONFIG_ENV_ADDR_REDUND
3482 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003483
wdenk43d96162003-03-06 00:02:04 +00003484 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003485 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003486 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003487 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003488
3489BE CAREFUL! Any changes to the flash layout, and some changes to the
3490source code will make it necessary to adapt <board>/u-boot.lds*
3491accordingly!
3492
3493
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003494- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003495
3496 Define this if you have some non-volatile memory device
3497 (NVRAM, battery buffered SRAM) which you want to use for the
3498 environment.
3499
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003500 - CONFIG_ENV_ADDR:
3501 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003502
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003503 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003504 want to use for environment. It is assumed that this memory
3505 can just be read and written to, without any special
3506 provision.
3507
3508BE CAREFUL! The first access to the environment happens quite early
3509in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003510console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003511U-Boot will hang.
3512
3513Please note that even with NVRAM we still use a copy of the
3514environment in RAM: we could work on NVRAM directly, but we want to
3515keep settings there always unmodified except somebody uses "saveenv"
3516to save the current settings.
3517
3518
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003519- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003520
3521 Use this if you have an EEPROM or similar serial access
3522 device and a driver for it.
3523
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003524 - CONFIG_ENV_OFFSET:
3525 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003526
3527 These two #defines specify the offset and size of the
3528 environment area within the total memory of your EEPROM.
3529
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003530 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003531 If defined, specified the chip address of the EEPROM device.
3532 The default address is zero.
3533
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003534 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003535 If defined, the number of bits used to address bytes in a
3536 single page in the EEPROM device. A 64 byte page, for example
3537 would require six bits.
3538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003539 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003540 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003541 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003543 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003544 The length in bytes of the EEPROM memory array address. Note
3545 that this is NOT the chip address length!
3546
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003547 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003548 EEPROM chips that implement "address overflow" are ones
3549 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3550 address and the extra bits end up in the "chip address" bit
3551 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3552 byte chips.
3553
3554 Note that we consider the length of the address field to
3555 still be one byte because the extra address bits are hidden
3556 in the chip address.
3557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003558 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003559 The size in bytes of the EEPROM device.
3560
Heiko Schocher548738b2010-01-07 08:55:40 +01003561 - CONFIG_ENV_EEPROM_IS_ON_I2C
3562 define this, if you have I2C and SPI activated, and your
3563 EEPROM, which holds the environment, is on the I2C bus.
3564
3565 - CONFIG_I2C_ENV_EEPROM_BUS
3566 if you have an Environment on an EEPROM reached over
3567 I2C muxes, you can define here, how to reach this
3568 EEPROM. For example:
3569
Wolfgang Denka9046b92010-06-13 17:48:15 +02003570 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003571
3572 EEPROM which holds the environment, is reached over
3573 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003574
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003575- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003576
wdenkd4ca31c2004-01-02 14:00:00 +00003577 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003578 want to use for the environment.
3579
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003580 - CONFIG_ENV_OFFSET:
3581 - CONFIG_ENV_ADDR:
3582 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003583
3584 These three #defines specify the offset and size of the
3585 environment area within the total memory of your DataFlash placed
3586 at the specified address.
3587
Liu Gang0a85a9e2012-03-08 00:33:20 +00003588- CONFIG_ENV_IS_IN_REMOTE:
3589
3590 Define this if you have a remote memory space which you
3591 want to use for the local device's environment.
3592
3593 - CONFIG_ENV_ADDR:
3594 - CONFIG_ENV_SIZE:
3595
3596 These two #defines specify the address and size of the
3597 environment area within the remote memory space. The
3598 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003599 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003600
3601BE CAREFUL! For some special cases, the local device can not use
3602"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003603environment stored in a remote NOR flash by SRIO or PCIE link,
3604but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003605
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003606- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003607
3608 Define this if you have a NAND device which you want to use
3609 for the environment.
3610
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003611 - CONFIG_ENV_OFFSET:
3612 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003613
3614 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003615 area within the first NAND device. CONFIG_ENV_OFFSET must be
3616 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003617
Scott Woodfdd813d2010-09-17 14:38:37 -05003618 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003619
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003620 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003621 size used to hold a redundant copy of the environment data, so
3622 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003623 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003624 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003625
Scott Woodfdd813d2010-09-17 14:38:37 -05003626 - CONFIG_ENV_RANGE (optional):
3627
3628 Specifies the length of the region in which the environment
3629 can be written. This should be a multiple of the NAND device's
3630 block size. Specifying a range with more erase blocks than
3631 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3632 the range to be avoided.
3633
3634 - CONFIG_ENV_OFFSET_OOB (optional):
3635
3636 Enables support for dynamically retrieving the offset of the
3637 environment from block zero's out-of-band data. The
3638 "nand env.oob" command can be used to record this offset.
3639 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3640 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003641
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003642- CONFIG_NAND_ENV_DST
3643
3644 Defines address in RAM to which the nand_spl code should copy the
3645 environment. If redundant environment is used, it will be copied to
3646 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3647
Joe Hershberger2b744332013-04-08 10:32:51 +00003648- CONFIG_ENV_IS_IN_UBI:
3649
3650 Define this if you have an UBI volume that you want to use for the
3651 environment. This has the benefit of wear-leveling the environment
3652 accesses, which is important on NAND.
3653
3654 - CONFIG_ENV_UBI_PART:
3655
3656 Define this to a string that is the mtd partition containing the UBI.
3657
3658 - CONFIG_ENV_UBI_VOLUME:
3659
3660 Define this to the name of the volume that you want to store the
3661 environment in.
3662
Joe Hershberger785881f2013-04-08 10:32:52 +00003663 - CONFIG_ENV_UBI_VOLUME_REDUND:
3664
3665 Define this to the name of another volume to store a second copy of
3666 the environment in. This will enable redundant environments in UBI.
3667 It is assumed that both volumes are in the same MTD partition.
3668
Joe Hershberger2b744332013-04-08 10:32:51 +00003669 - CONFIG_UBI_SILENCE_MSG
3670 - CONFIG_UBIFS_SILENCE_MSG
3671
3672 You will probably want to define these to avoid a really noisy system
3673 when storing the env in UBI.
3674
Stephen Warren06e4ae52013-06-11 15:14:00 -06003675- CONFIG_ENV_IS_IN_MMC:
3676
3677 Define this if you have an MMC device which you want to use for the
3678 environment.
3679
3680 - CONFIG_SYS_MMC_ENV_DEV:
3681
3682 Specifies which MMC device the environment is stored in.
3683
3684 - CONFIG_SYS_MMC_ENV_PART (optional):
3685
3686 Specifies which MMC partition the environment is stored in. If not
3687 set, defaults to partition 0, the user area. Common values might be
3688 1 (first MMC boot partition), 2 (second MMC boot partition).
3689
3690 - CONFIG_ENV_OFFSET:
3691 - CONFIG_ENV_SIZE:
3692
3693 These two #defines specify the offset and size of the environment
3694 area within the specified MMC device.
3695
Stephen Warren5c088ee2013-06-11 15:14:02 -06003696 If offset is positive (the usual case), it is treated as relative to
3697 the start of the MMC partition. If offset is negative, it is treated
3698 as relative to the end of the MMC partition. This can be useful if
3699 your board may be fitted with different MMC devices, which have
3700 different sizes for the MMC partitions, and you always want the
3701 environment placed at the very end of the partition, to leave the
3702 maximum possible space before it, to store other data.
3703
Stephen Warren06e4ae52013-06-11 15:14:00 -06003704 These two values are in units of bytes, but must be aligned to an
3705 MMC sector boundary.
3706
3707 - CONFIG_ENV_OFFSET_REDUND (optional):
3708
3709 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3710 hold a redundant copy of the environment data. This provides a
3711 valid backup copy in case the other copy is corrupted, e.g. due
3712 to a power failure during a "saveenv" operation.
3713
Stephen Warren5c088ee2013-06-11 15:14:02 -06003714 This value may also be positive or negative; this is handled in the
3715 same way as CONFIG_ENV_OFFSET.
3716
Stephen Warren06e4ae52013-06-11 15:14:00 -06003717 This value is also in units of bytes, but must also be aligned to
3718 an MMC sector boundary.
3719
3720 - CONFIG_ENV_SIZE_REDUND (optional):
3721
3722 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3723 set. If this value is set, it must be set to the same value as
3724 CONFIG_ENV_SIZE.
3725
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003726- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003727
3728 Defines offset to the initial SPI buffer area in DPRAM. The
3729 area is used at an early stage (ROM part) if the environment
3730 is configured to reside in the SPI EEPROM: We need a 520 byte
3731 scratch DPRAM area. It is used between the two initialization
3732 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3733 to be a good choice since it makes it far enough from the
3734 start of the data area as well as from the stack pointer.
3735
Bruce Adlere881cb52007-11-02 13:15:42 -07003736Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003737has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003738created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003739until then to read environment variables.
3740
wdenk85ec0bc2003-03-31 16:34:49 +00003741The environment is protected by a CRC32 checksum. Before the monitor
3742is relocated into RAM, as a result of a bad CRC you will be working
3743with the compiled-in default environment - *silently*!!! [This is
3744necessary, because the first environment variable we need is the
3745"baudrate" setting for the console - if we have a bad CRC, we don't
3746have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003747
3748Note: once the monitor has been relocated, then it will complain if
3749the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003750use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003752- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003753 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003754
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003755 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003756 also needs to be defined.
3757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003758- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003759 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003760
Ron Madridf5675aa2009-02-18 14:30:44 -08003761- CONFIG_NS16550_MIN_FUNCTIONS:
3762 Define this if you desire to only have use of the NS16550_init
3763 and NS16550_putc functions for the serial driver located at
3764 drivers/serial/ns16550.c. This option is useful for saving
3765 space for already greatly restricted images, including but not
3766 limited to NAND_SPL configurations.
3767
Simon Glassb2b92f52012-11-30 13:01:18 +00003768- CONFIG_DISPLAY_BOARDINFO
3769 Display information about the board that U-Boot is running on
3770 when U-Boot starts up. The board function checkboard() is called
3771 to do this.
3772
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003773- CONFIG_DISPLAY_BOARDINFO_LATE
3774 Similar to the previous option, but display this information
3775 later, once stdio is running and output goes to the LCD, if
3776 present.
3777
wdenkc6097192002-11-03 00:24:07 +00003778Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003779---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003781- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003782 Cache Line Size of the CPU.
3783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003784- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003785 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003786
wdenk42d1f032003-10-15 23:53:47 +00003787 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3788 and RPXsuper) to be able to adjust the position of
3789 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003790
Timur Tabie46fedf2011-08-04 18:03:41 -05003791- CONFIG_SYS_CCSRBAR_DEFAULT:
3792 Default (power-on reset) physical address of CCSR on Freescale
3793 PowerPC SOCs.
3794
3795- CONFIG_SYS_CCSRBAR:
3796 Virtual address of CCSR. On a 32-bit build, this is typically
3797 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3798
3799 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3800 for cross-platform code that uses that macro instead.
3801
3802- CONFIG_SYS_CCSRBAR_PHYS:
3803 Physical address of CCSR. CCSR can be relocated to a new
3804 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003805 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003806 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3807 is typically relocated on 36-bit builds. It is recommended
3808 that this macro be defined via the _HIGH and _LOW macros:
3809
3810 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3811 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3812
3813- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003814 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3815 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003816 used in assembly code, so it must not contain typecasts or
3817 integer size suffixes (e.g. "ULL").
3818
3819- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3820 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3821 used in assembly code, so it must not contain typecasts or
3822 integer size suffixes (e.g. "ULL").
3823
3824- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3825 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3826 forced to a value that ensures that CCSR is not relocated.
3827
wdenk7f6c2cb2002-11-10 22:06:23 +00003828- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003829 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003830
3831 the default drive number (default value 0)
3832
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003833 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003834
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003835 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003836 (default value 1)
3837
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003838 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003839
wdenk43d96162003-03-06 00:02:04 +00003840 defines the offset of register from address. It
3841 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003842 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003844 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3845 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003846 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003847
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003848 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003849 fdc_hw_init() is called at the beginning of the FDC
3850 setup. fdc_hw_init() must be provided by the board
3851 source code. It is used to make hardware dependant
3852 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003853
Macpaul Lin0abddf82011-04-11 20:45:32 +00003854- CONFIG_IDE_AHB:
3855 Most IDE controllers were designed to be connected with PCI
3856 interface. Only few of them were designed for AHB interface.
3857 When software is doing ATA command and data transfer to
3858 IDE devices through IDE-AHB controller, some additional
3859 registers accessing to these kind of IDE-AHB controller
3860 is requierd.
3861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003862- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003863 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003864 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003865
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003866- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003867
wdenk7152b1d2003-09-05 23:19:14 +00003868 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003869 initial data and stack; please note that this must be
3870 writable memory that is working WITHOUT special
3871 initialization, i. e. you CANNOT use normal RAM which
3872 will become available only after programming the
3873 memory controller and running certain initialization
3874 sequences.
3875
3876 U-Boot uses the following memory types:
3877 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3878 - MPC824X: data cache
3879 - PPC4xx: data cache
3880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003881- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003882
3883 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003884 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3885 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003886 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003887 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003888 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3889 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3890 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003891
3892 Note:
3893 On the MPC824X (or other systems that use the data
3894 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003895 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003896 point to an otherwise UNUSED address space between
3897 the top of RAM and the start of the PCI space.
3898
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003899- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003900
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003901- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003903- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003904
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003905- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003906
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003907- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003909- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003910
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003911- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003912 SDRAM timing
3913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003914- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003915 periodic timer for refresh
3916
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003917- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003918
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003919- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3920 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3921 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3922 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003923 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3924
3925- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003926 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3927 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003928 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3929
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003930- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3931 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003932 Machine Mode Register and Memory Periodic Timer
3933 Prescaler definitions (SDRAM timing)
3934
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003935- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003936 enable I2C microcode relocation patch (MPC8xx);
3937 define relocation offset in DPRAM [DSP2]
3938
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003939- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003940 enable SMC microcode relocation patch (MPC8xx);
3941 define relocation offset in DPRAM [SMC1]
3942
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003943- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003944 enable SPI microcode relocation patch (MPC8xx);
3945 define relocation offset in DPRAM [SCC4]
3946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003947- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003948 Use OSCM clock mode on MBX8xx board. Be careful,
3949 wrong setting might damage your board. Read
3950 doc/README.MBX before setting this variable!
3951
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003952- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003953 Offset of the bootmode word in DPRAM used by post
3954 (Power On Self Tests). This definition overrides
3955 #define'd default value in commproc.h resp.
3956 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003957
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003958- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3959 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3960 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3961 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3962 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3963 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3964 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3965 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003966 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003967
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003968- CONFIG_PCI_DISABLE_PCIE:
3969 Disable PCI-Express on systems where it is supported but not
3970 required.
3971
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003972- CONFIG_PCI_ENUM_ONLY
3973 Only scan through and get the devices on the busses.
3974 Don't do any setup work, presumably because someone or
3975 something has already done it, and we don't need to do it
3976 a second time. Useful for platforms that are pre-booted
3977 by coreboot or similar.
3978
Gabor Juhos842033e2013-05-30 07:06:12 +00003979- CONFIG_PCI_INDIRECT_BRIDGE:
3980 Enable support for indirect PCI bridges.
3981
Kumar Galaa09b9b62010-12-30 12:09:53 -06003982- CONFIG_SYS_SRIO:
3983 Chip has SRIO or not
3984
3985- CONFIG_SRIO1:
3986 Board has SRIO 1 port available
3987
3988- CONFIG_SRIO2:
3989 Board has SRIO 2 port available
3990
Liu Gangc8b28152013-05-07 16:30:46 +08003991- CONFIG_SRIO_PCIE_BOOT_MASTER
3992 Board can support master function for Boot from SRIO and PCIE
3993
Kumar Galaa09b9b62010-12-30 12:09:53 -06003994- CONFIG_SYS_SRIOn_MEM_VIRT:
3995 Virtual Address of SRIO port 'n' memory region
3996
3997- CONFIG_SYS_SRIOn_MEM_PHYS:
3998 Physical Address of SRIO port 'n' memory region
3999
4000- CONFIG_SYS_SRIOn_MEM_SIZE:
4001 Size of SRIO port 'n' memory region
4002
Fabio Estevam66bd1842013-04-11 09:35:34 +00004003- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4004 Defined to tell the NAND controller that the NAND chip is using
4005 a 16 bit bus.
4006 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004007 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004008 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004009 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004010
4011- CONFIG_SYS_NDFC_EBC0_CFG
4012 Sets the EBC0_CFG register for the NDFC. If not defined
4013 a default value will be used.
4014
Ben Warrenbb99ad62006-09-07 16:50:54 -04004015- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004016 Get DDR timing information from an I2C EEPROM. Common
4017 with pluggable memory modules such as SODIMMs
4018
Ben Warrenbb99ad62006-09-07 16:50:54 -04004019 SPD_EEPROM_ADDRESS
4020 I2C address of the SPD EEPROM
4021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004022- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004023 If SPD EEPROM is on an I2C bus other than the first
4024 one, specify here. Note that the value must resolve
4025 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004026
York Sun1b3e3c42011-06-07 09:42:16 +08004027- CONFIG_SYS_DDR_RAW_TIMING
4028 Get DDR timing information from other than SPD. Common with
4029 soldered DDR chips onboard without SPD. DDR raw timing
4030 parameters are extracted from datasheet and hard-coded into
4031 header files or board specific files.
4032
York Sun6f5e1dc2011-09-16 13:21:35 -07004033- CONFIG_FSL_DDR_INTERACTIVE
4034 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4035
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004036- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004037 Only for 83xx systems. If specified, then DDR should
4038 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004039
wdenkc26e4542004-04-18 10:13:26 +00004040- CONFIG_ETHER_ON_FEC[12]
4041 Define to enable FEC[12] on a 8xx series processor.
4042
4043- CONFIG_FEC[12]_PHY
4044 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004045 to the given FEC; i. e.
4046 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004047 means that the PHY with address 4 is connected to FEC1
4048
4049 When set to -1, means to probe for first available.
4050
4051- CONFIG_FEC[12]_PHY_NORXERR
4052 The PHY does not have a RXERR line (RMII only).
4053 (so program the FEC to ignore it).
4054
4055- CONFIG_RMII
4056 Enable RMII mode for all FECs.
4057 Note that this is a global option, we can't
4058 have one FEC in standard MII mode and another in RMII mode.
4059
wdenk5cf91d62004-04-23 20:32:05 +00004060- CONFIG_CRC32_VERIFY
4061 Add a verify option to the crc32 command.
4062 The syntax is:
4063
4064 => crc32 -v <address> <count> <crc32>
4065
4066 Where address/count indicate a memory area
4067 and crc32 is the correct crc32 which the
4068 area should have.
4069
wdenk56523f12004-07-11 17:40:54 +00004070- CONFIG_LOOPW
4071 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004072 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004073
stroese7b466642004-12-16 18:46:55 +00004074- CONFIG_MX_CYCLIC
4075 Add the "mdc" and "mwc" memory commands. These are cyclic
4076 "md/mw" commands.
4077 Examples:
4078
wdenkefe2a4d2004-12-16 21:44:03 +00004079 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004080 This command will print 4 bytes (10,11,12,13) each 500 ms.
4081
wdenkefe2a4d2004-12-16 21:44:03 +00004082 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004083 This command will write 12345678 to address 100 all 10 ms.
4084
wdenkefe2a4d2004-12-16 21:44:03 +00004085 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004086 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004087
wdenk8aa1a2d2005-04-04 12:44:11 +00004088- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004089 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004090 low level initializations (like setting up the memory
4091 controller) are omitted and/or U-Boot does not
4092 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004093
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004094 Normally this variable MUST NOT be defined. The only
4095 exception is when U-Boot is loaded (to RAM) by some
4096 other boot loader or by a debugger which performs
4097 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004098
Aneesh V401bb302011-07-13 05:11:07 +00004099- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004100 Modifies the behaviour of start.S when compiling a loader
4101 that is executed before the actual U-Boot. E.g. when
4102 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004103
Ying Zhang5df572f2013-05-20 14:07:23 +08004104- CONFIG_SYS_MPC85XX_NO_RESETVEC
4105 Only for 85xx systems. If this variable is specified, the section
4106 .resetvec is not kept and the section .bootpg is placed in the
4107 previous 4k of the .text section.
4108
Simon Glass4213fc22013-02-24 17:33:14 +00004109- CONFIG_ARCH_MAP_SYSMEM
4110 Generally U-Boot (and in particular the md command) uses
4111 effective address. It is therefore not necessary to regard
4112 U-Boot address as virtual addresses that need to be translated
4113 to physical addresses. However, sandbox requires this, since
4114 it maintains its own little RAM buffer which contains all
4115 addressable memory. This option causes some memory accesses
4116 to be mapped through map_sysmem() / unmap_sysmem().
4117
Matthias Weisserd8834a12011-03-10 21:36:32 +00004118- CONFIG_USE_ARCH_MEMCPY
4119 CONFIG_USE_ARCH_MEMSET
4120 If these options are used a optimized version of memcpy/memset will
4121 be used if available. These functions may be faster under some
4122 conditions but may increase the binary size.
4123
Simon Glass588a13f2013-02-14 04:18:54 +00004124- CONFIG_X86_RESET_VECTOR
4125 If defined, the x86 reset vector code is included. This is not
4126 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004127
Mark Jacksonfc337052013-03-04 01:27:20 +00004128- CONFIG_SYS_MPUCLK
4129 Defines the MPU clock speed (in MHz).
4130
4131 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004132
Timur Tabif2717b42011-11-22 09:21:25 -06004133Freescale QE/FMAN Firmware Support:
4134-----------------------------------
4135
4136The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4137loading of "firmware", which is encoded in the QE firmware binary format.
4138This firmware often needs to be loaded during U-Boot booting, so macros
4139are used to identify the storage device (NOR flash, SPI, etc) and the address
4140within that device.
4141
4142- CONFIG_SYS_QE_FMAN_FW_ADDR
4143 The address in the storage device where the firmware is located. The
4144 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4145 is also specified.
4146
4147- CONFIG_SYS_QE_FMAN_FW_LENGTH
4148 The maximum possible size of the firmware. The firmware binary format
4149 has a field that specifies the actual size of the firmware, but it
4150 might not be possible to read any part of the firmware unless some
4151 local storage is allocated to hold the entire firmware first.
4152
4153- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4154 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4155 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4156 virtual address in NOR flash.
4157
4158- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4159 Specifies that QE/FMAN firmware is located in NAND flash.
4160 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4161
4162- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4163 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4164 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4165
4166- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4167 Specifies that QE/FMAN firmware is located on the primary SPI
4168 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4169
Liu Gang292dc6c2012-03-08 00:33:18 +00004170- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4171 Specifies that QE/FMAN firmware is located in the remote (master)
4172 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004173 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4174 window->master inbound window->master LAW->the ucode address in
4175 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004176
wdenkc6097192002-11-03 00:24:07 +00004177Building the Software:
4178======================
4179
Wolfgang Denk218ca722008-03-26 10:40:12 +01004180Building U-Boot has been tested in several native build environments
4181and in many different cross environments. Of course we cannot support
4182all possibly existing versions of cross development tools in all
4183(potentially obsolete) versions. In case of tool chain problems we
4184recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4185which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004186
Wolfgang Denk218ca722008-03-26 10:40:12 +01004187If you are not using a native environment, it is assumed that you
4188have GNU cross compiling tools available in your path. In this case,
4189you must set the environment variable CROSS_COMPILE in your shell.
4190Note that no changes to the Makefile or any other source files are
4191necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004192
Wolfgang Denk218ca722008-03-26 10:40:12 +01004193 $ CROSS_COMPILE=ppc_4xx-
4194 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004195
Peter Tyser2f8d3962009-03-13 18:54:51 -05004196Note: If you wish to generate Windows versions of the utilities in
4197 the tools directory you can use the MinGW toolchain
4198 (http://www.mingw.org). Set your HOST tools to the MinGW
4199 toolchain and execute 'make tools'. For example:
4200
4201 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4202
4203 Binaries such as tools/mkimage.exe will be created which can
4204 be executed on computers running Windows.
4205
Wolfgang Denk218ca722008-03-26 10:40:12 +01004206U-Boot is intended to be simple to build. After installing the
4207sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004208is done by typing:
4209
4210 make NAME_config
4211
Wolfgang Denk218ca722008-03-26 10:40:12 +01004212where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004213rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004214
wdenk2729af92004-05-03 20:45:30 +00004215Note: for some board special configuration names may exist; check if
4216 additional information is available from the board vendor; for
4217 instance, the TQM823L systems are available without (standard)
4218 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004219 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004220
wdenk2729af92004-05-03 20:45:30 +00004221 make TQM823L_config
4222 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004223
wdenk2729af92004-05-03 20:45:30 +00004224 make TQM823L_LCD_config
4225 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004226
wdenk2729af92004-05-03 20:45:30 +00004227 etc.
wdenkc6097192002-11-03 00:24:07 +00004228
wdenkc6097192002-11-03 00:24:07 +00004229
wdenk2729af92004-05-03 20:45:30 +00004230Finally, type "make all", and you should get some working U-Boot
4231images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004232
wdenk2729af92004-05-03 20:45:30 +00004233- "u-boot.bin" is a raw binary image
4234- "u-boot" is an image in ELF binary format
4235- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004236
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004237By default the build is performed locally and the objects are saved
4238in the source directory. One of the two methods can be used to change
4239this behavior and build U-Boot to some external directory:
4240
42411. Add O= to the make command line invocations:
4242
4243 make O=/tmp/build distclean
4244 make O=/tmp/build NAME_config
4245 make O=/tmp/build all
4246
42472. Set environment variable BUILD_DIR to point to the desired location:
4248
4249 export BUILD_DIR=/tmp/build
4250 make distclean
4251 make NAME_config
4252 make all
4253
4254Note that the command line "O=" setting overrides the BUILD_DIR environment
4255variable.
4256
wdenkc6097192002-11-03 00:24:07 +00004257
wdenk2729af92004-05-03 20:45:30 +00004258Please be aware that the Makefiles assume you are using GNU make, so
4259for instance on NetBSD you might need to use "gmake" instead of
4260native "make".
wdenkc6097192002-11-03 00:24:07 +00004261
wdenkc6097192002-11-03 00:24:07 +00004262
wdenk2729af92004-05-03 20:45:30 +00004263If the system board that you have is not listed, then you will need
4264to port U-Boot to your hardware platform. To do this, follow these
4265steps:
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk2729af92004-05-03 20:45:30 +000042671. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004268 "boards.cfg" file, using the existing entries as examples.
4269 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000042702. Create a new directory to hold your board specific code. Add any
4271 files you need. In your board directory, you will need at least
4272 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
42733. Create a new configuration file "include/configs/<board>.h" for
4274 your board
42753. If you're porting U-Boot to a new CPU, then also create a new
4276 directory to hold your CPU specific code. Add any files you need.
42774. Run "make <board>_config" with your new name.
42785. Type "make", and you should get a working "u-boot.srec" file
4279 to be installed on your target system.
42806. Debug and solve any problems that might arise.
4281 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004282
wdenkc6097192002-11-03 00:24:07 +00004283
wdenk2729af92004-05-03 20:45:30 +00004284Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4285==============================================================
wdenkc6097192002-11-03 00:24:07 +00004286
Wolfgang Denk218ca722008-03-26 10:40:12 +01004287If you have modified U-Boot sources (for instance added a new board
4288or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004289provide feedback to the other developers. The feedback normally takes
4290the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004291official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004292
Wolfgang Denk218ca722008-03-26 10:40:12 +01004293But before you submit such a patch, please verify that your modifi-
4294cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004295the supported boards compile WITHOUT ANY compiler warnings. To do so,
4296just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004297for ALL supported system. Be warned, this will take a while. You can
4298select which (cross) compiler to use by passing a `CROSS_COMPILE'
4299environment variable to the script, i. e. to use the ELDK cross tools
4300you can type
wdenkc6097192002-11-03 00:24:07 +00004301
wdenk2729af92004-05-03 20:45:30 +00004302 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk2729af92004-05-03 20:45:30 +00004304or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004305
wdenk2729af92004-05-03 20:45:30 +00004306 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004307
Wolfgang Denk218ca722008-03-26 10:40:12 +01004308When using the MAKEALL script, the default behaviour is to build
4309U-Boot in the source directory. This location can be changed by
4310setting the BUILD_DIR environment variable. Also, for each target
4311built, the MAKEALL script saves two log files (<target>.ERR and
4312<target>.MAKEALL) in the <source dir>/LOG directory. This default
4313location can be changed by setting the MAKEALL_LOGDIR environment
4314variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004315
4316 export BUILD_DIR=/tmp/build
4317 export MAKEALL_LOGDIR=/tmp/log
4318 CROSS_COMPILE=ppc_8xx- MAKEALL
4319
Wolfgang Denk218ca722008-03-26 10:40:12 +01004320With the above settings build objects are saved in the /tmp/build,
4321log files are saved in the /tmp/log and the source tree remains clean
4322during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004323
4324
wdenk2729af92004-05-03 20:45:30 +00004325See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004326
wdenkc6097192002-11-03 00:24:07 +00004327
wdenk2729af92004-05-03 20:45:30 +00004328Monitor Commands - Overview:
4329============================
wdenkc6097192002-11-03 00:24:07 +00004330
wdenk2729af92004-05-03 20:45:30 +00004331go - start application at address 'addr'
4332run - run commands in an environment variable
4333bootm - boot application image from memory
4334bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004335bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004336tftpboot- boot image via network using TFTP protocol
4337 and env variables "ipaddr" and "serverip"
4338 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004339tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004340rarpboot- boot image via network using RARP/TFTP protocol
4341diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4342loads - load S-Record file over serial line
4343loadb - load binary file over serial line (kermit mode)
4344md - memory display
4345mm - memory modify (auto-incrementing)
4346nm - memory modify (constant address)
4347mw - memory write (fill)
4348cp - memory copy
4349cmp - memory compare
4350crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004351i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004352sspi - SPI utility commands
4353base - print or set address offset
4354printenv- print environment variables
4355setenv - set environment variables
4356saveenv - save environment variables to persistent storage
4357protect - enable or disable FLASH write protection
4358erase - erase FLASH memory
4359flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004360nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004361bdinfo - print Board Info structure
4362iminfo - print header information for application image
4363coninfo - print console devices and informations
4364ide - IDE sub-system
4365loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004366loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004367mtest - simple RAM test
4368icache - enable or disable instruction cache
4369dcache - enable or disable data cache
4370reset - Perform RESET of the CPU
4371echo - echo args to console
4372version - print monitor version
4373help - print online help
4374? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004375
wdenkc6097192002-11-03 00:24:07 +00004376
wdenk2729af92004-05-03 20:45:30 +00004377Monitor Commands - Detailed Description:
4378========================================
wdenkc6097192002-11-03 00:24:07 +00004379
wdenk2729af92004-05-03 20:45:30 +00004380TODO.
wdenkc6097192002-11-03 00:24:07 +00004381
wdenk2729af92004-05-03 20:45:30 +00004382For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004383
4384
wdenk2729af92004-05-03 20:45:30 +00004385Environment Variables:
4386======================
wdenkc6097192002-11-03 00:24:07 +00004387
wdenk2729af92004-05-03 20:45:30 +00004388U-Boot supports user configuration using Environment Variables which
4389can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004390
wdenk2729af92004-05-03 20:45:30 +00004391Environment Variables are set using "setenv", printed using
4392"printenv", and saved to Flash using "saveenv". Using "setenv"
4393without a value can be used to delete a variable from the
4394environment. As long as you don't save the environment you are
4395working with an in-memory copy. In case the Flash area containing the
4396environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004397
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004398Some configuration options can be set using Environment Variables.
4399
4400List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004401
wdenk2729af92004-05-03 20:45:30 +00004402 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004403
wdenk2729af92004-05-03 20:45:30 +00004404 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004407
wdenk2729af92004-05-03 20:45:30 +00004408 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004409
wdenk2729af92004-05-03 20:45:30 +00004410 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004411
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004412 bootm_low - Memory range available for image processing in the bootm
4413 command can be restricted. This variable is given as
4414 a hexadecimal number and defines lowest address allowed
4415 for use by the bootm command. See also "bootm_size"
4416 environment variable. Address defined by "bootm_low" is
4417 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004418 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4419 bootm_mapsize.
4420
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004421 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004422 This variable is given as a hexadecimal number and it
4423 defines the size of the memory region starting at base
4424 address bootm_low that is accessible by the Linux kernel
4425 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4426 as the default value if it is defined, and bootm_size is
4427 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004428
4429 bootm_size - Memory range available for image processing in the bootm
4430 command can be restricted. This variable is given as
4431 a hexadecimal number and defines the size of the region
4432 allowed for use by the bootm command. See also "bootm_low"
4433 environment variable.
4434
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004435 updatefile - Location of the software update file on a TFTP server, used
4436 by the automatic software update feature. Please refer to
4437 documentation in doc/README.update for more details.
4438
wdenk2729af92004-05-03 20:45:30 +00004439 autoload - if set to "no" (any string beginning with 'n'),
4440 "bootp" will just load perform a lookup of the
4441 configuration from the BOOTP server, but not try to
4442 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004443
wdenk2729af92004-05-03 20:45:30 +00004444 autostart - if set to "yes", an image loaded using the "bootp",
4445 "rarpboot", "tftpboot" or "diskboot" commands will
4446 be automatically started (by internally calling
4447 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004448
wdenk2729af92004-05-03 20:45:30 +00004449 If set to "no", a standalone image passed to the
4450 "bootm" command will be copied to the load address
4451 (and eventually uncompressed), but NOT be started.
4452 This can be used to load and uncompress arbitrary
4453 data.
wdenkc6097192002-11-03 00:24:07 +00004454
David A. Longa28afca2011-07-09 16:40:19 -04004455 fdt_high - if set this restricts the maximum address that the
4456 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004457 For example, if you have a system with 1 GB memory
4458 at physical address 0x10000000, while Linux kernel
4459 only recognizes the first 704 MB as low memory, you
4460 may need to set fdt_high as 0x3C000000 to have the
4461 device tree blob be copied to the maximum address
4462 of the 704 MB low memory, so that Linux kernel can
4463 access it during the boot procedure.
4464
David A. Longa28afca2011-07-09 16:40:19 -04004465 If this is set to the special value 0xFFFFFFFF then
4466 the fdt will not be copied at all on boot. For this
4467 to work it must reside in writable memory, have
4468 sufficient padding on the end of it for u-boot to
4469 add the information it needs into it, and the memory
4470 must be accessible by the kernel.
4471
Simon Glasseea63e02011-10-24 19:15:34 +00004472 fdtcontroladdr- if set this is the address of the control flattened
4473 device tree used by U-Boot when CONFIG_OF_CONTROL is
4474 defined.
4475
wdenk17ea1172004-06-06 21:51:03 +00004476 i2cfast - (PPC405GP|PPC405EP only)
4477 if set to 'y' configures Linux I2C driver for fast
4478 mode (400kHZ). This environment variable is used in
4479 initialization code. So, for changes to be effective
4480 it must be saved and board must be reset.
4481
wdenk2729af92004-05-03 20:45:30 +00004482 initrd_high - restrict positioning of initrd images:
4483 If this variable is not set, initrd images will be
4484 copied to the highest possible address in RAM; this
4485 is usually what you want since it allows for
4486 maximum initrd size. If for some reason you want to
4487 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004488 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004489 variable to a value of "no" or "off" or "0".
4490 Alternatively, you can set it to a maximum upper
4491 address to use (U-Boot will still check that it
4492 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004493
wdenk2729af92004-05-03 20:45:30 +00004494 For instance, when you have a system with 16 MB
4495 RAM, and want to reserve 4 MB from use by Linux,
4496 you can do this by adding "mem=12M" to the value of
4497 the "bootargs" variable. However, now you must make
4498 sure that the initrd image is placed in the first
4499 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004500
wdenk2729af92004-05-03 20:45:30 +00004501 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004502
wdenk2729af92004-05-03 20:45:30 +00004503 If you set initrd_high to 0xFFFFFFFF, this is an
4504 indication to U-Boot that all addresses are legal
4505 for the Linux kernel, including addresses in flash
4506 memory. In this case U-Boot will NOT COPY the
4507 ramdisk at all. This may be useful to reduce the
4508 boot time on your system, but requires that this
4509 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004510
wdenk2729af92004-05-03 20:45:30 +00004511 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004512
wdenk2729af92004-05-03 20:45:30 +00004513 loadaddr - Default load address for commands like "bootp",
4514 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk2729af92004-05-03 20:45:30 +00004516 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004517
wdenk2729af92004-05-03 20:45:30 +00004518 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004519
wdenk2729af92004-05-03 20:45:30 +00004520 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004521
wdenk2729af92004-05-03 20:45:30 +00004522 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004523
wdenk2729af92004-05-03 20:45:30 +00004524 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004525
Mike Frysingere2a53452011-10-02 10:01:27 +00004526 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004527
Mike Frysingere2a53452011-10-02 10:01:27 +00004528 ethact - controls which interface is currently active.
4529 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004530
Heiko Schocher48690d82010-07-20 17:45:02 +02004531 => setenv ethact FEC
4532 => ping 192.168.0.1 # traffic sent on FEC
4533 => setenv ethact SCC
4534 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004535
Matthias Fuchse1692572008-01-17 07:45:05 +01004536 ethrotate - When set to "no" U-Boot does not go through all
4537 available network interfaces.
4538 It just stays at the currently selected interface.
4539
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004540 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004541 either succeed or fail without retrying.
4542 When set to "once" the network operation will
4543 fail when all the available network interfaces
4544 are tried once without success.
4545 Useful on scripts which control the retry operation
4546 themselves.
wdenkc6097192002-11-03 00:24:07 +00004547
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004548 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004549
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004550 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004551 UDP source port.
4552
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004553 tftpdstport - If this is set, the value is used for TFTP's UDP
4554 destination port instead of the Well Know Port 69.
4555
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004556 tftpblocksize - Block size to use for TFTP transfers; if not set,
4557 we use the TFTP server's default block size
4558
4559 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4560 seconds, minimum value is 1000 = 1 second). Defines
4561 when a packet is considered to be lost so it has to
4562 be retransmitted. The default is 5000 = 5 seconds.
4563 Lowering this value may make downloads succeed
4564 faster in networks with high packet loss rates or
4565 with unreliable TFTP servers.
4566
4567 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004568 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004569 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004570
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004571The following image location variables contain the location of images
4572used in booting. The "Image" column gives the role of the image and is
4573not an environment variable name. The other columns are environment
4574variable names. "File Name" gives the name of the file on a TFTP
4575server, "RAM Address" gives the location in RAM the image will be
4576loaded to, and "Flash Location" gives the image's address in NOR
4577flash or offset in NAND flash.
4578
4579*Note* - these variables don't have to be defined for all boards, some
4580boards currenlty use other variables for these purposes, and some
4581boards use these variables for other purposes.
4582
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004583Image File Name RAM Address Flash Location
4584----- --------- ----------- --------------
4585u-boot u-boot u-boot_addr_r u-boot_addr
4586Linux kernel bootfile kernel_addr_r kernel_addr
4587device tree blob fdtfile fdt_addr_r fdt_addr
4588ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004589
wdenk2729af92004-05-03 20:45:30 +00004590The following environment variables may be used and automatically
4591updated by the network boot commands ("bootp" and "rarpboot"),
4592depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004593
wdenk2729af92004-05-03 20:45:30 +00004594 bootfile - see above
4595 dnsip - IP address of your Domain Name Server
4596 dnsip2 - IP address of your secondary Domain Name Server
4597 gatewayip - IP address of the Gateway (Router) to use
4598 hostname - Target hostname
4599 ipaddr - see above
4600 netmask - Subnet Mask
4601 rootpath - Pathname of the root filesystem on the NFS server
4602 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004603
wdenka3d991b2004-04-15 21:48:45 +00004604
wdenk2729af92004-05-03 20:45:30 +00004605There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004606
wdenk2729af92004-05-03 20:45:30 +00004607 serial# - contains hardware identification information such
4608 as type string and/or serial number
4609 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk2729af92004-05-03 20:45:30 +00004611These variables can be set only once (usually during manufacturing of
4612the board). U-Boot refuses to delete or overwrite these variables
4613once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004614
4615
wdenk2729af92004-05-03 20:45:30 +00004616Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004617
wdenk2729af92004-05-03 20:45:30 +00004618 ver - Contains the U-Boot version string as printed
4619 with the "version" command. This variable is
4620 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004621
wdenkc6097192002-11-03 00:24:07 +00004622
wdenk2729af92004-05-03 20:45:30 +00004623Please note that changes to some configuration parameters may take
4624only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004625
stroesec1551ea2003-04-04 15:53:41 +00004626
Joe Hershberger170ab112012-12-11 22:16:24 -06004627Callback functions for environment variables:
4628---------------------------------------------
4629
4630For some environment variables, the behavior of u-boot needs to change
4631when their values are changed. This functionailty allows functions to
4632be associated with arbitrary variables. On creation, overwrite, or
4633deletion, the callback will provide the opportunity for some side
4634effect to happen or for the change to be rejected.
4635
4636The callbacks are named and associated with a function using the
4637U_BOOT_ENV_CALLBACK macro in your board or driver code.
4638
4639These callbacks are associated with variables in one of two ways. The
4640static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4641in the board configuration to a string that defines a list of
4642associations. The list must be in the following format:
4643
4644 entry = variable_name[:callback_name]
4645 list = entry[,list]
4646
4647If the callback name is not specified, then the callback is deleted.
4648Spaces are also allowed anywhere in the list.
4649
4650Callbacks can also be associated by defining the ".callbacks" variable
4651with the same list format above. Any association in ".callbacks" will
4652override any association in the static list. You can define
4653CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4654".callbacks" envirnoment variable in the default or embedded environment.
4655
4656
wdenk2729af92004-05-03 20:45:30 +00004657Command Line Parsing:
4658=====================
stroesec1551ea2003-04-04 15:53:41 +00004659
wdenk2729af92004-05-03 20:45:30 +00004660There are two different command line parsers available with U-Boot:
4661the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004662
wdenk2729af92004-05-03 20:45:30 +00004663Old, simple command line parser:
4664--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004665
wdenk2729af92004-05-03 20:45:30 +00004666- supports environment variables (through setenv / saveenv commands)
4667- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004668- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004669- special characters ('$', ';') can be escaped by prefixing with '\',
4670 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004671 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004672- You can also escape text by enclosing in single apostrophes, for example:
4673 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004674
wdenk2729af92004-05-03 20:45:30 +00004675Hush shell:
4676-----------
wdenkf07771c2003-05-28 08:06:31 +00004677
wdenk2729af92004-05-03 20:45:30 +00004678- similar to Bourne shell, with control structures like
4679 if...then...else...fi, for...do...done; while...do...done,
4680 until...do...done, ...
4681- supports environment ("global") variables (through setenv / saveenv
4682 commands) and local shell variables (through standard shell syntax
4683 "name=value"); only environment variables can be used with "run"
4684 command
wdenkf07771c2003-05-28 08:06:31 +00004685
wdenk2729af92004-05-03 20:45:30 +00004686General rules:
4687--------------
wdenkf07771c2003-05-28 08:06:31 +00004688
wdenk2729af92004-05-03 20:45:30 +00004689(1) If a command line (or an environment variable executed by a "run"
4690 command) contains several commands separated by semicolon, and
4691 one of these commands fails, then the remaining commands will be
4692 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004693
wdenk2729af92004-05-03 20:45:30 +00004694(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004695 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004696 command will cause "run" to terminate, i. e. the remaining
4697 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004698
wdenk2729af92004-05-03 20:45:30 +00004699Note for Redundant Ethernet Interfaces:
4700=======================================
wdenkf07771c2003-05-28 08:06:31 +00004701
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004702Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004703such configurations and is capable of automatic selection of a
4704"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004705
wdenk2729af92004-05-03 20:45:30 +00004706Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4707MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4708"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004709
wdenk2729af92004-05-03 20:45:30 +00004710If the network interface stores some valid MAC address (for instance
4711in SROM), this is used as default address if there is NO correspon-
4712ding setting in the environment; if the corresponding environment
4713variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004714
wdenk2729af92004-05-03 20:45:30 +00004715o If the SROM has a valid MAC address, and there is no address in the
4716 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk2729af92004-05-03 20:45:30 +00004718o If there is no valid address in the SROM, and a definition in the
4719 environment exists, then the value from the environment variable is
4720 used.
wdenkc6097192002-11-03 00:24:07 +00004721
wdenk2729af92004-05-03 20:45:30 +00004722o If both the SROM and the environment contain a MAC address, and
4723 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004724
wdenk2729af92004-05-03 20:45:30 +00004725o If both the SROM and the environment contain a MAC address, and the
4726 addresses differ, the value from the environment is used and a
4727 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004728
wdenk2729af92004-05-03 20:45:30 +00004729o If neither SROM nor the environment contain a MAC address, an error
4730 is raised.
wdenkc6097192002-11-03 00:24:07 +00004731
Ben Warrenecee9322010-04-26 11:11:46 -07004732If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004733will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004734may be skipped by setting the appropriate 'ethmacskip' environment variable.
4735The naming convention is as follows:
4736"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004737
wdenk2729af92004-05-03 20:45:30 +00004738Image Formats:
4739==============
wdenkc6097192002-11-03 00:24:07 +00004740
Marian Balakowicz3310c542008-03-12 12:13:13 +01004741U-Boot is capable of booting (and performing other auxiliary operations on)
4742images in two formats:
4743
4744New uImage format (FIT)
4745-----------------------
4746
4747Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4748to Flattened Device Tree). It allows the use of images with multiple
4749components (several kernels, ramdisks, etc.), with contents protected by
4750SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4751
4752
4753Old uImage format
4754-----------------
4755
4756Old image format is based on binary files which can be basically anything,
4757preceded by a special header; see the definitions in include/image.h for
4758details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk2729af92004-05-03 20:45:30 +00004760* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4761 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004762 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4763 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4764 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004765* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004766 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4767 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004768* Compression Type (uncompressed, gzip, bzip2)
4769* Load Address
4770* Entry Point
4771* Image Name
4772* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004773
wdenk2729af92004-05-03 20:45:30 +00004774The header is marked by a special Magic Number, and both the header
4775and the data portions of the image are secured against corruption by
4776CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004777
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk2729af92004-05-03 20:45:30 +00004779Linux Support:
4780==============
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk2729af92004-05-03 20:45:30 +00004782Although U-Boot should support any OS or standalone application
4783easily, the main focus has always been on Linux during the design of
4784U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004785
wdenk2729af92004-05-03 20:45:30 +00004786U-Boot includes many features that so far have been part of some
4787special "boot loader" code within the Linux kernel. Also, any
4788"initrd" images to be used are no longer part of one big Linux image;
4789instead, kernel and "initrd" are separate images. This implementation
4790serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004791
wdenk2729af92004-05-03 20:45:30 +00004792- the same features can be used for other OS or standalone
4793 applications (for instance: using compressed images to reduce the
4794 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004795
wdenk2729af92004-05-03 20:45:30 +00004796- it becomes much easier to port new Linux kernel versions because
4797 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004798
wdenk2729af92004-05-03 20:45:30 +00004799- the same Linux kernel image can now be used with different "initrd"
4800 images; of course this also means that different kernel images can
4801 be run with the same "initrd". This makes testing easier (you don't
4802 have to build a new "zImage.initrd" Linux image when you just
4803 change a file in your "initrd"). Also, a field-upgrade of the
4804 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004805
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk2729af92004-05-03 20:45:30 +00004807Linux HOWTO:
4808============
wdenkc6097192002-11-03 00:24:07 +00004809
wdenk2729af92004-05-03 20:45:30 +00004810Porting Linux to U-Boot based systems:
4811---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004812
wdenk2729af92004-05-03 20:45:30 +00004813U-Boot cannot save you from doing all the necessary modifications to
4814configure the Linux device drivers for use with your target hardware
4815(no, we don't intend to provide a full virtual machine interface to
4816Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004817
Stefan Roesea47a12b2010-04-15 16:07:28 +02004818But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk2729af92004-05-03 20:45:30 +00004820Just make sure your machine specific header file (for instance
4821include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004822Information structure as we define in include/asm-<arch>/u-boot.h,
4823and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004824as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004825
wdenkc6097192002-11-03 00:24:07 +00004826
wdenk2729af92004-05-03 20:45:30 +00004827Configuring the Linux kernel:
4828-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk2729af92004-05-03 20:45:30 +00004830No specific requirements for U-Boot. Make sure you have some root
4831device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004832
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk2729af92004-05-03 20:45:30 +00004834Building a Linux Image:
4835-----------------------
wdenkc6097192002-11-03 00:24:07 +00004836
wdenk2729af92004-05-03 20:45:30 +00004837With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4838not used. If you use recent kernel source, a new build target
4839"uImage" will exist which automatically builds an image usable by
4840U-Boot. Most older kernels also have support for a "pImage" target,
4841which was introduced for our predecessor project PPCBoot and uses a
4842100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk2729af92004-05-03 20:45:30 +00004844Example:
wdenkc6097192002-11-03 00:24:07 +00004845
wdenk2729af92004-05-03 20:45:30 +00004846 make TQM850L_config
4847 make oldconfig
4848 make dep
4849 make uImage
wdenkc6097192002-11-03 00:24:07 +00004850
wdenk2729af92004-05-03 20:45:30 +00004851The "uImage" build target uses a special tool (in 'tools/mkimage') to
4852encapsulate a compressed Linux kernel image with header information,
4853CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk2729af92004-05-03 20:45:30 +00004855* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk2729af92004-05-03 20:45:30 +00004857* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004858
wdenk2729af92004-05-03 20:45:30 +00004859 ${CROSS_COMPILE}-objcopy -O binary \
4860 -R .note -R .comment \
4861 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004862
wdenk2729af92004-05-03 20:45:30 +00004863* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004864
wdenk2729af92004-05-03 20:45:30 +00004865 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004866
wdenk2729af92004-05-03 20:45:30 +00004867* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004868
wdenk2729af92004-05-03 20:45:30 +00004869 mkimage -A ppc -O linux -T kernel -C gzip \
4870 -a 0 -e 0 -n "Linux Kernel Image" \
4871 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004872
wdenk24ee89b2002-11-03 17:56:27 +00004873
wdenk2729af92004-05-03 20:45:30 +00004874The "mkimage" tool can also be used to create ramdisk images for use
4875with U-Boot, either separated from the Linux kernel image, or
4876combined into one file. "mkimage" encapsulates the images with a 64
4877byte header containing information about target architecture,
4878operating system, image type, compression method, entry points, time
4879stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004880
wdenk2729af92004-05-03 20:45:30 +00004881"mkimage" can be called in two ways: to verify existing images and
4882print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004883
wdenk2729af92004-05-03 20:45:30 +00004884In the first form (with "-l" option) mkimage lists the information
4885contained in the header of an existing U-Boot image; this includes
4886checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004887
wdenk2729af92004-05-03 20:45:30 +00004888 tools/mkimage -l image
4889 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004890
wdenk2729af92004-05-03 20:45:30 +00004891The second form (with "-d" option) is used to build a U-Boot image
4892from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004893
wdenk2729af92004-05-03 20:45:30 +00004894 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4895 -n name -d data_file image
4896 -A ==> set architecture to 'arch'
4897 -O ==> set operating system to 'os'
4898 -T ==> set image type to 'type'
4899 -C ==> set compression type 'comp'
4900 -a ==> set load address to 'addr' (hex)
4901 -e ==> set entry point to 'ep' (hex)
4902 -n ==> set image name to 'name'
4903 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004904
wdenk69459792004-05-29 16:53:29 +00004905Right now, all Linux kernels for PowerPC systems use the same load
4906address (0x00000000), but the entry point address depends on the
4907kernel version:
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk2729af92004-05-03 20:45:30 +00004909- 2.2.x kernels have the entry point at 0x0000000C,
4910- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004911
wdenk2729af92004-05-03 20:45:30 +00004912So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004913
wdenk2729af92004-05-03 20:45:30 +00004914 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4915 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004916 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004917 > examples/uImage.TQM850L
4918 Image Name: 2.4.4 kernel for TQM850L
4919 Created: Wed Jul 19 02:34:59 2000
4920 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4921 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4922 Load Address: 0x00000000
4923 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004924
wdenk2729af92004-05-03 20:45:30 +00004925To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk2729af92004-05-03 20:45:30 +00004927 -> tools/mkimage -l examples/uImage.TQM850L
4928 Image Name: 2.4.4 kernel for TQM850L
4929 Created: Wed Jul 19 02:34:59 2000
4930 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4931 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4932 Load Address: 0x00000000
4933 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004934
wdenk2729af92004-05-03 20:45:30 +00004935NOTE: for embedded systems where boot time is critical you can trade
4936speed for memory and install an UNCOMPRESSED image instead: this
4937needs more space in Flash, but boots much faster since it does not
4938need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004939
Stefan Roesea47a12b2010-04-15 16:07:28 +02004940 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004941 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4942 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004943 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004944 > examples/uImage.TQM850L-uncompressed
4945 Image Name: 2.4.4 kernel for TQM850L
4946 Created: Wed Jul 19 02:34:59 2000
4947 Image Type: PowerPC Linux Kernel Image (uncompressed)
4948 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4949 Load Address: 0x00000000
4950 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004951
wdenkc6097192002-11-03 00:24:07 +00004952
wdenk2729af92004-05-03 20:45:30 +00004953Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4954when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004955
wdenk2729af92004-05-03 20:45:30 +00004956 -> tools/mkimage -n 'Simple Ramdisk Image' \
4957 > -A ppc -O linux -T ramdisk -C gzip \
4958 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4959 Image Name: Simple Ramdisk Image
4960 Created: Wed Jan 12 14:01:50 2000
4961 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4962 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4963 Load Address: 0x00000000
4964 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004965
wdenkdb01a2e2004-04-15 23:14:49 +00004966
wdenk2729af92004-05-03 20:45:30 +00004967Installing a Linux Image:
4968-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004969
wdenk2729af92004-05-03 20:45:30 +00004970To downloading a U-Boot image over the serial (console) interface,
4971you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004972
wdenk2729af92004-05-03 20:45:30 +00004973 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004974
wdenk2729af92004-05-03 20:45:30 +00004975The 'objcopy' does not understand the information in the U-Boot
4976image header, so the resulting S-Record file will be relative to
4977address 0x00000000. To load it to a given address, you need to
4978specify the target address as 'offset' parameter with the 'loads'
4979command.
wdenkc6097192002-11-03 00:24:07 +00004980
wdenk2729af92004-05-03 20:45:30 +00004981Example: install the image to address 0x40100000 (which on the
4982TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004983
wdenk2729af92004-05-03 20:45:30 +00004984 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004985
wdenk2729af92004-05-03 20:45:30 +00004986 .......... done
4987 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004988
wdenk2729af92004-05-03 20:45:30 +00004989 => loads 40100000
4990 ## Ready for S-Record download ...
4991 ~>examples/image.srec
4992 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4993 ...
4994 15989 15990 15991 15992
4995 [file transfer complete]
4996 [connected]
4997 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004998
4999
wdenk2729af92004-05-03 20:45:30 +00005000You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005001this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005002corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk2729af92004-05-03 20:45:30 +00005004 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005005
wdenk2729af92004-05-03 20:45:30 +00005006 ## Checking Image at 40100000 ...
5007 Image Name: 2.2.13 for initrd on TQM850L
5008 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5009 Data Size: 335725 Bytes = 327 kB = 0 MB
5010 Load Address: 00000000
5011 Entry Point: 0000000c
5012 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005013
5014
wdenk2729af92004-05-03 20:45:30 +00005015Boot Linux:
5016-----------
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk2729af92004-05-03 20:45:30 +00005018The "bootm" command is used to boot an application that is stored in
5019memory (RAM or Flash). In case of a Linux kernel image, the contents
5020of the "bootargs" environment variable is passed to the kernel as
5021parameters. You can check and modify this variable using the
5022"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005023
5024
wdenk2729af92004-05-03 20:45:30 +00005025 => printenv bootargs
5026 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk2729af92004-05-03 20:45:30 +00005028 => 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 +00005029
wdenk2729af92004-05-03 20:45:30 +00005030 => printenv bootargs
5031 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 +00005032
wdenk2729af92004-05-03 20:45:30 +00005033 => bootm 40020000
5034 ## Booting Linux kernel at 40020000 ...
5035 Image Name: 2.2.13 for NFS on TQM850L
5036 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5037 Data Size: 381681 Bytes = 372 kB = 0 MB
5038 Load Address: 00000000
5039 Entry Point: 0000000c
5040 Verifying Checksum ... OK
5041 Uncompressing Kernel Image ... OK
5042 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
5043 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5044 time_init: decrementer frequency = 187500000/60
5045 Calibrating delay loop... 49.77 BogoMIPS
5046 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5047 ...
wdenkc6097192002-11-03 00:24:07 +00005048
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005049If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005050the memory addresses of both the kernel and the initrd image (PPBCOOT
5051format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005052
wdenk2729af92004-05-03 20:45:30 +00005053 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005054
wdenk2729af92004-05-03 20:45:30 +00005055 ## Checking Image at 40100000 ...
5056 Image Name: 2.2.13 for initrd on TQM850L
5057 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5058 Data Size: 335725 Bytes = 327 kB = 0 MB
5059 Load Address: 00000000
5060 Entry Point: 0000000c
5061 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005062
wdenk2729af92004-05-03 20:45:30 +00005063 ## Checking Image at 40200000 ...
5064 Image Name: Simple Ramdisk Image
5065 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5066 Data Size: 566530 Bytes = 553 kB = 0 MB
5067 Load Address: 00000000
5068 Entry Point: 00000000
5069 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005070
wdenk2729af92004-05-03 20:45:30 +00005071 => bootm 40100000 40200000
5072 ## Booting Linux kernel at 40100000 ...
5073 Image Name: 2.2.13 for initrd on TQM850L
5074 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5075 Data Size: 335725 Bytes = 327 kB = 0 MB
5076 Load Address: 00000000
5077 Entry Point: 0000000c
5078 Verifying Checksum ... OK
5079 Uncompressing Kernel Image ... OK
5080 ## Loading RAMDisk Image at 40200000 ...
5081 Image Name: Simple Ramdisk Image
5082 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5083 Data Size: 566530 Bytes = 553 kB = 0 MB
5084 Load Address: 00000000
5085 Entry Point: 00000000
5086 Verifying Checksum ... OK
5087 Loading Ramdisk ... OK
5088 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
5089 Boot arguments: root=/dev/ram
5090 time_init: decrementer frequency = 187500000/60
5091 Calibrating delay loop... 49.77 BogoMIPS
5092 ...
5093 RAMDISK: Compressed image found at block 0
5094 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005095
wdenk2729af92004-05-03 20:45:30 +00005096 bash#
wdenkc6097192002-11-03 00:24:07 +00005097
Matthew McClintock02677682006-06-28 10:41:37 -05005098Boot Linux and pass a flat device tree:
5099-----------
5100
5101First, U-Boot must be compiled with the appropriate defines. See the section
5102titled "Linux Kernel Interface" above for a more in depth explanation. The
5103following is an example of how to start a kernel and pass an updated
5104flat device tree:
5105
5106=> print oftaddr
5107oftaddr=0x300000
5108=> print oft
5109oft=oftrees/mpc8540ads.dtb
5110=> tftp $oftaddr $oft
5111Speed: 1000, full duplex
5112Using TSEC0 device
5113TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5114Filename 'oftrees/mpc8540ads.dtb'.
5115Load address: 0x300000
5116Loading: #
5117done
5118Bytes transferred = 4106 (100a hex)
5119=> tftp $loadaddr $bootfile
5120Speed: 1000, full duplex
5121Using TSEC0 device
5122TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5123Filename 'uImage'.
5124Load address: 0x200000
5125Loading:############
5126done
5127Bytes transferred = 1029407 (fb51f hex)
5128=> print loadaddr
5129loadaddr=200000
5130=> print oftaddr
5131oftaddr=0x300000
5132=> bootm $loadaddr - $oftaddr
5133## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005134 Image Name: Linux-2.6.17-dirty
5135 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5136 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005137 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005138 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005139 Verifying Checksum ... OK
5140 Uncompressing Kernel Image ... OK
5141Booting using flat device tree at 0x300000
5142Using MPC85xx ADS machine description
5143Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5144[snip]
5145
5146
wdenk2729af92004-05-03 20:45:30 +00005147More About U-Boot Image Types:
5148------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005149
wdenk2729af92004-05-03 20:45:30 +00005150U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005151
wdenk2729af92004-05-03 20:45:30 +00005152 "Standalone Programs" are directly runnable in the environment
5153 provided by U-Boot; it is expected that (if they behave
5154 well) you can continue to work in U-Boot after return from
5155 the Standalone Program.
5156 "OS Kernel Images" are usually images of some Embedded OS which
5157 will take over control completely. Usually these programs
5158 will install their own set of exception handlers, device
5159 drivers, set up the MMU, etc. - this means, that you cannot
5160 expect to re-enter U-Boot except by resetting the CPU.
5161 "RAMDisk Images" are more or less just data blocks, and their
5162 parameters (address, size) are passed to an OS kernel that is
5163 being started.
5164 "Multi-File Images" contain several images, typically an OS
5165 (Linux) kernel image and one or more data images like
5166 RAMDisks. This construct is useful for instance when you want
5167 to boot over the network using BOOTP etc., where the boot
5168 server provides just a single image file, but you want to get
5169 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005170
wdenk2729af92004-05-03 20:45:30 +00005171 "Multi-File Images" start with a list of image sizes, each
5172 image size (in bytes) specified by an "uint32_t" in network
5173 byte order. This list is terminated by an "(uint32_t)0".
5174 Immediately after the terminating 0 follow the images, one by
5175 one, all aligned on "uint32_t" boundaries (size rounded up to
5176 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005177
wdenk2729af92004-05-03 20:45:30 +00005178 "Firmware Images" are binary images containing firmware (like
5179 U-Boot or FPGA images) which usually will be programmed to
5180 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005181
wdenk2729af92004-05-03 20:45:30 +00005182 "Script files" are command sequences that will be executed by
5183 U-Boot's command interpreter; this feature is especially
5184 useful when you configure U-Boot to use a real shell (hush)
5185 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005186
Marek Vasut44f074c2012-03-14 21:52:45 +00005187Booting the Linux zImage:
5188-------------------------
5189
5190On some platforms, it's possible to boot Linux zImage. This is done
5191using the "bootz" command. The syntax of "bootz" command is the same
5192as the syntax of "bootm" command.
5193
Tom Rini8ac28562013-05-16 11:40:11 -04005194Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005195kernel with raw initrd images. The syntax is slightly different, the
5196address of the initrd must be augmented by it's size, in the following
5197format: "<initrd addres>:<initrd size>".
5198
wdenkc6097192002-11-03 00:24:07 +00005199
wdenk2729af92004-05-03 20:45:30 +00005200Standalone HOWTO:
5201=================
wdenkc6097192002-11-03 00:24:07 +00005202
wdenk2729af92004-05-03 20:45:30 +00005203One of the features of U-Boot is that you can dynamically load and
5204run "standalone" applications, which can use some resources of
5205U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005206
wdenk2729af92004-05-03 20:45:30 +00005207Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005208
wdenk2729af92004-05-03 20:45:30 +00005209"Hello World" Demo:
5210-------------------
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk2729af92004-05-03 20:45:30 +00005212'examples/hello_world.c' contains a small "Hello World" Demo
5213application; it is automatically compiled when you build U-Boot.
5214It's configured to run at address 0x00040004, so you can play with it
5215like that:
wdenkc6097192002-11-03 00:24:07 +00005216
wdenk2729af92004-05-03 20:45:30 +00005217 => loads
5218 ## Ready for S-Record download ...
5219 ~>examples/hello_world.srec
5220 1 2 3 4 5 6 7 8 9 10 11 ...
5221 [file transfer complete]
5222 [connected]
5223 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005224
wdenk2729af92004-05-03 20:45:30 +00005225 => go 40004 Hello World! This is a test.
5226 ## Starting application at 0x00040004 ...
5227 Hello World
5228 argc = 7
5229 argv[0] = "40004"
5230 argv[1] = "Hello"
5231 argv[2] = "World!"
5232 argv[3] = "This"
5233 argv[4] = "is"
5234 argv[5] = "a"
5235 argv[6] = "test."
5236 argv[7] = "<NULL>"
5237 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005238
wdenk2729af92004-05-03 20:45:30 +00005239 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk2729af92004-05-03 20:45:30 +00005241Another example, which demonstrates how to register a CPM interrupt
5242handler with the U-Boot code, can be found in 'examples/timer.c'.
5243Here, a CPM timer is set up to generate an interrupt every second.
5244The interrupt service routine is trivial, just printing a '.'
5245character, but this is just a demo program. The application can be
5246controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005247
wdenk2729af92004-05-03 20:45:30 +00005248 ? - print current values og the CPM Timer registers
5249 b - enable interrupts and start timer
5250 e - stop timer and disable interrupts
5251 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005252
wdenk2729af92004-05-03 20:45:30 +00005253 => loads
5254 ## Ready for S-Record download ...
5255 ~>examples/timer.srec
5256 1 2 3 4 5 6 7 8 9 10 11 ...
5257 [file transfer complete]
5258 [connected]
5259 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk2729af92004-05-03 20:45:30 +00005261 => go 40004
5262 ## Starting application at 0x00040004 ...
5263 TIMERS=0xfff00980
5264 Using timer 1
5265 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005266
wdenk2729af92004-05-03 20:45:30 +00005267Hit 'b':
5268 [q, b, e, ?] Set interval 1000000 us
5269 Enabling timer
5270Hit '?':
5271 [q, b, e, ?] ........
5272 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5273Hit '?':
5274 [q, b, e, ?] .
5275 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5276Hit '?':
5277 [q, b, e, ?] .
5278 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5279Hit '?':
5280 [q, b, e, ?] .
5281 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5282Hit 'e':
5283 [q, b, e, ?] ...Stopping timer
5284Hit 'q':
5285 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005286
5287
wdenk2729af92004-05-03 20:45:30 +00005288Minicom warning:
5289================
wdenk85ec0bc2003-03-31 16:34:49 +00005290
wdenk2729af92004-05-03 20:45:30 +00005291Over time, many people have reported problems when trying to use the
5292"minicom" terminal emulation program for serial download. I (wd)
5293consider minicom to be broken, and recommend not to use it. Under
5294Unix, I recommend to use C-Kermit for general purpose use (and
5295especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005296use "cu" for S-Record download ("loads" command). See
5297http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5298for help with kermit.
5299
wdenk85ec0bc2003-03-31 16:34:49 +00005300
wdenk2729af92004-05-03 20:45:30 +00005301Nevertheless, if you absolutely want to use it try adding this
5302configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005303
wdenk2729af92004-05-03 20:45:30 +00005304 Name Program Name U/D FullScr IO-Red. Multi
5305 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5306 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005307
5308
wdenk2729af92004-05-03 20:45:30 +00005309NetBSD Notes:
5310=============
wdenkc6097192002-11-03 00:24:07 +00005311
wdenk2729af92004-05-03 20:45:30 +00005312Starting at version 0.9.2, U-Boot supports NetBSD both as host
5313(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk2729af92004-05-03 20:45:30 +00005315Building requires a cross environment; it is known to work on
5316NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5317need gmake since the Makefiles are not compatible with BSD make).
5318Note that the cross-powerpc package does not install include files;
5319attempting to build U-Boot will fail because <machine/ansi.h> is
5320missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005321
wdenk2729af92004-05-03 20:45:30 +00005322 # cd /usr/pkg/cross/powerpc-netbsd/include
5323 # mkdir powerpc
5324 # ln -s powerpc machine
5325 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5326 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk2729af92004-05-03 20:45:30 +00005328Native builds *don't* work due to incompatibilities between native
5329and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk2729af92004-05-03 20:45:30 +00005331Booting assumes that (the first part of) the image booted is a
5332stage-2 loader which in turn loads and then invokes the kernel
5333proper. Loader sources will eventually appear in the NetBSD source
5334tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005335meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005336
5337
wdenk2729af92004-05-03 20:45:30 +00005338Implementation Internals:
5339=========================
wdenkc6097192002-11-03 00:24:07 +00005340
wdenk2729af92004-05-03 20:45:30 +00005341The following is not intended to be a complete description of every
5342implementation detail. However, it should help to understand the
5343inner workings of U-Boot and make it easier to port it to custom
5344hardware.
wdenkc6097192002-11-03 00:24:07 +00005345
5346
wdenk2729af92004-05-03 20:45:30 +00005347Initial Stack, Global Data:
5348---------------------------
wdenkc6097192002-11-03 00:24:07 +00005349
wdenk2729af92004-05-03 20:45:30 +00005350The implementation of U-Boot is complicated by the fact that U-Boot
5351starts running out of ROM (flash memory), usually without access to
5352system RAM (because the memory controller is not initialized yet).
5353This means that we don't have writable Data or BSS segments, and BSS
5354is not initialized as zero. To be able to get a C environment working
5355at all, we have to allocate at least a minimal stack. Implementation
5356options for this are defined and restricted by the CPU used: Some CPU
5357models provide on-chip memory (like the IMMR area on MPC8xx and
5358MPC826x processors), on others (parts of) the data cache can be
5359locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005360
Wolfgang Denk218ca722008-03-26 10:40:12 +01005361 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005362 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005363
wdenk2729af92004-05-03 20:45:30 +00005364 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5365 From: "Chris Hallinan" <clh@net1plus.com>
5366 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5367 ...
wdenk43d96162003-03-06 00:02:04 +00005368
wdenk2729af92004-05-03 20:45:30 +00005369 Correct me if I'm wrong, folks, but the way I understand it
5370 is this: Using DCACHE as initial RAM for Stack, etc, does not
5371 require any physical RAM backing up the cache. The cleverness
5372 is that the cache is being used as a temporary supply of
5373 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005374 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005375 can see how this works by studying the cache architecture and
5376 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005377
wdenk2729af92004-05-03 20:45:30 +00005378 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5379 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005380 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005381 option should work for you. Using CS 4 should be fine if your
5382 board designers haven't used it for something that would
5383 cause you grief during the initial boot! It is frequently not
5384 used.
wdenk43d96162003-03-06 00:02:04 +00005385
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005386 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005387 with your processor/board/system design. The default value
5388 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005389 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005390 than your SDRAM module. If you have a 64MB SDRAM module, set
5391 it above 400_0000. Just make sure your board has no resources
5392 that are supposed to respond to that address! That code in
5393 start.S has been around a while and should work as is when
5394 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005395
wdenk2729af92004-05-03 20:45:30 +00005396 -Chris Hallinan
5397 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005398
wdenk2729af92004-05-03 20:45:30 +00005399It is essential to remember this, since it has some impact on the C
5400code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005401
wdenk2729af92004-05-03 20:45:30 +00005402* Initialized global data (data segment) is read-only. Do not attempt
5403 to write it.
wdenkc6097192002-11-03 00:24:07 +00005404
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005405* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005406 as zero data - BSS segment) at all - this is undefined, initiali-
5407 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk2729af92004-05-03 20:45:30 +00005409* Stack space is very limited. Avoid big data buffers or things like
5410 that.
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk2729af92004-05-03 20:45:30 +00005412Having only the stack as writable memory limits means we cannot use
5413normal global data to share information beween the code. But it
5414turned out that the implementation of U-Boot can be greatly
5415simplified by making a global data structure (gd_t) available to all
5416functions. We could pass a pointer to this data as argument to _all_
5417functions, but this would bloat the code. Instead we use a feature of
5418the GCC compiler (Global Register Variables) to share the data: we
5419place a pointer (gd) to the global data into a register which we
5420reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005421
wdenk2729af92004-05-03 20:45:30 +00005422When choosing a register for such a purpose we are restricted by the
5423relevant (E)ABI specifications for the current architecture, and by
5424GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005425
wdenk2729af92004-05-03 20:45:30 +00005426For PowerPC, the following registers have specific use:
5427 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005428 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005429 R3-R4: parameter passing and return values
5430 R5-R10: parameter passing
5431 R13: small data area pointer
5432 R30: GOT pointer
5433 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005434
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005435 (U-Boot also uses R12 as internal GOT pointer. r12
5436 is a volatile register so r12 needs to be reset when
5437 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005438
Wolfgang Denke7670f62008-02-14 22:43:22 +01005439 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005440
wdenk2729af92004-05-03 20:45:30 +00005441 Note: on PPC, we could use a static initializer (since the
5442 address of the global data structure is known at compile time),
5443 but it turned out that reserving a register results in somewhat
5444 smaller code - although the code savings are not that big (on
5445 average for all boards 752 bytes for the whole U-Boot image,
5446 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005447
Robin Getzc4db3352009-08-17 15:23:02 +00005448On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005449 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5450
Robin Getzc4db3352009-08-17 15:23:02 +00005451 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005452
wdenk2729af92004-05-03 20:45:30 +00005453On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005454
wdenk2729af92004-05-03 20:45:30 +00005455 R0: function argument word/integer result
5456 R1-R3: function argument word
5457 R9: GOT pointer
5458 R10: stack limit (used only if stack checking if enabled)
5459 R11: argument (frame) pointer
5460 R12: temporary workspace
5461 R13: stack pointer
5462 R14: link register
5463 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk2729af92004-05-03 20:45:30 +00005465 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005466
Thomas Chou0df01fd2010-05-21 11:08:03 +08005467On Nios II, the ABI is documented here:
5468 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5469
5470 ==> U-Boot will use gp to hold a pointer to the global data
5471
5472 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5473 to access small data sections, so gp is free.
5474
Macpaul Linafc1ce82011-10-19 20:41:11 +00005475On NDS32, the following registers are used:
5476
5477 R0-R1: argument/return
5478 R2-R5: argument
5479 R15: temporary register for assembler
5480 R16: trampoline register
5481 R28: frame pointer (FP)
5482 R29: global pointer (GP)
5483 R30: link register (LP)
5484 R31: stack pointer (SP)
5485 PC: program counter (PC)
5486
5487 ==> U-Boot will use R10 to hold a pointer to the global data
5488
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005489NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5490or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005491
wdenk2729af92004-05-03 20:45:30 +00005492Memory Management:
5493------------------
wdenkc6097192002-11-03 00:24:07 +00005494
wdenk2729af92004-05-03 20:45:30 +00005495U-Boot runs in system state and uses physical addresses, i.e. the
5496MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005497
wdenk2729af92004-05-03 20:45:30 +00005498The available memory is mapped to fixed addresses using the memory
5499controller. In this process, a contiguous block is formed for each
5500memory type (Flash, SDRAM, SRAM), even when it consists of several
5501physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005502
wdenk2729af92004-05-03 20:45:30 +00005503U-Boot is installed in the first 128 kB of the first Flash bank (on
5504TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5505booting and sizing and initializing DRAM, the code relocates itself
5506to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005507memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005508configuration setting]. Below that, a structure with global Board
5509Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk2729af92004-05-03 20:45:30 +00005511Additionally, some exception handler code is copied to the low 8 kB
5512of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005513
wdenk2729af92004-05-03 20:45:30 +00005514So a typical memory configuration with 16 MB of DRAM could look like
5515this:
wdenkc6097192002-11-03 00:24:07 +00005516
wdenk2729af92004-05-03 20:45:30 +00005517 0x0000 0000 Exception Vector code
5518 :
5519 0x0000 1FFF
5520 0x0000 2000 Free for Application Use
5521 :
5522 :
wdenkc6097192002-11-03 00:24:07 +00005523
wdenk2729af92004-05-03 20:45:30 +00005524 :
5525 :
5526 0x00FB FF20 Monitor Stack (Growing downward)
5527 0x00FB FFAC Board Info Data and permanent copy of global data
5528 0x00FC 0000 Malloc Arena
5529 :
5530 0x00FD FFFF
5531 0x00FE 0000 RAM Copy of Monitor Code
5532 ... eventually: LCD or video framebuffer
5533 ... eventually: pRAM (Protected RAM - unchanged by reset)
5534 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005535
5536
wdenk2729af92004-05-03 20:45:30 +00005537System Initialization:
5538----------------------
wdenkc6097192002-11-03 00:24:07 +00005539
wdenk2729af92004-05-03 20:45:30 +00005540In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005541(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005542configuration for CS0# this is a mirror of the onboard Flash memory.
5543To be able to re-map memory U-Boot then jumps to its link address.
5544To be able to implement the initialization code in C, a (small!)
5545initial stack is set up in the internal Dual Ported RAM (in case CPUs
5546which provide such a feature like MPC8xx or MPC8260), or in a locked
5547part of the data cache. After that, U-Boot initializes the CPU core,
5548the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005549
wdenk2729af92004-05-03 20:45:30 +00005550Next, all (potentially) available memory banks are mapped using a
5551preliminary mapping. For example, we put them on 512 MB boundaries
5552(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5553on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5554programmed for SDRAM access. Using the temporary configuration, a
5555simple memory test is run that determines the size of the SDRAM
5556banks.
wdenkc6097192002-11-03 00:24:07 +00005557
wdenk2729af92004-05-03 20:45:30 +00005558When there is more than one SDRAM bank, and the banks are of
5559different size, the largest is mapped first. For equal size, the first
5560bank (CS2#) is mapped first. The first mapping is always for address
55610x00000000, with any additional banks following immediately to create
5562contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005563
wdenk2729af92004-05-03 20:45:30 +00005564Then, the monitor installs itself at the upper end of the SDRAM area
5565and allocates memory for use by malloc() and for the global Board
5566Info data; also, the exception vector code is copied to the low RAM
5567pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005568
wdenk2729af92004-05-03 20:45:30 +00005569Only after this relocation will you have a "normal" C environment;
5570until that you are restricted in several ways, mostly because you are
5571running from ROM, and because the code will have to be relocated to a
5572new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005573
5574
wdenk2729af92004-05-03 20:45:30 +00005575U-Boot Porting Guide:
5576----------------------
wdenkc6097192002-11-03 00:24:07 +00005577
wdenk2729af92004-05-03 20:45:30 +00005578[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5579list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005580
5581
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005582int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005583{
5584 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005585
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005586 signal(SIGALRM, no_more_time);
5587 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk2729af92004-05-03 20:45:30 +00005589 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005590 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005591 return 0;
5592 }
5593
wdenk2729af92004-05-03 20:45:30 +00005594 Download latest U-Boot source;
5595
Wolfgang Denk06682362008-12-30 22:56:11 +01005596 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005597
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005598 if (clueless)
5599 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk2729af92004-05-03 20:45:30 +00005601 while (learning) {
5602 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005603 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5604 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005605 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005606 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005607 }
wdenkc6097192002-11-03 00:24:07 +00005608
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005609 if (available_money > toLocalCurrency ($2500))
5610 Buy a BDI3000;
5611 else
wdenk2729af92004-05-03 20:45:30 +00005612 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005613
5614 if (a similar board exists) { /* hopefully... */
5615 cp -a board/<similar> board/<myboard>
5616 cp include/configs/<similar>.h include/configs/<myboard>.h
5617 } else {
5618 Create your own board support subdirectory;
5619 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005620 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005621 Edit new board/<myboard> files
5622 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005623
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005624 while (!accepted) {
5625 while (!running) {
5626 do {
5627 Add / modify source code;
5628 } until (compiles);
5629 Debug;
5630 if (clueless)
5631 email("Hi, I am having problems...");
5632 }
5633 Send patch file to the U-Boot email list;
5634 if (reasonable critiques)
5635 Incorporate improvements from email list code review;
5636 else
5637 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005638 }
wdenkc6097192002-11-03 00:24:07 +00005639
wdenk2729af92004-05-03 20:45:30 +00005640 return 0;
5641}
5642
5643void no_more_time (int sig)
5644{
5645 hire_a_guru();
5646}
wdenkc6097192002-11-03 00:24:07 +00005647
5648
wdenk2729af92004-05-03 20:45:30 +00005649Coding Standards:
5650-----------------
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005653coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005654"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005655
Detlev Zundel2c051652006-09-01 15:39:02 +02005656Source files originating from a different project (for example the
5657MTD subsystem) are generally exempt from these guidelines and are not
5658reformated to ease subsequent migration to newer versions of those
5659sources.
5660
5661Please note that U-Boot is implemented in C (and to some small parts in
5662Assembler); no C++ is used, so please do not use C++ style comments (//)
5663in your code.
wdenk2729af92004-05-03 20:45:30 +00005664
5665Please also stick to the following formatting rules:
5666- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005667- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005668- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005669- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005670- do not add trailing empty lines to source files
5671
5672Submissions which do not conform to the standards may be returned
5673with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005674
5675
wdenk2729af92004-05-03 20:45:30 +00005676Submitting Patches:
5677-------------------
wdenkc6097192002-11-03 00:24:07 +00005678
wdenk2729af92004-05-03 20:45:30 +00005679Since the number of patches for U-Boot is growing, we need to
5680establish some rules. Submissions which do not conform to these rules
5681may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005682
Magnus Lilja0d28f342008-08-06 19:32:33 +02005683Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005684
Wolfgang Denk06682362008-12-30 22:56:11 +01005685Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5686see http://lists.denx.de/mailman/listinfo/u-boot
5687
wdenk2729af92004-05-03 20:45:30 +00005688When you send a patch, please include the following information with
5689it:
wdenkc6097192002-11-03 00:24:07 +00005690
wdenk2729af92004-05-03 20:45:30 +00005691* For bug fixes: a description of the bug and how your patch fixes
5692 this bug. Please try to include a way of demonstrating that the
5693 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk2729af92004-05-03 20:45:30 +00005695* For new features: a description of the feature and your
5696 implementation.
wdenkc6097192002-11-03 00:24:07 +00005697
wdenk2729af92004-05-03 20:45:30 +00005698* A CHANGELOG entry as plaintext (separate from the patch)
5699
5700* For major contributions, your entry to the CREDITS file
5701
5702* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005703 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005704
5705* If your patch adds new configuration options, don't forget to
5706 document these in the README file.
5707
Wolfgang Denk218ca722008-03-26 10:40:12 +01005708* The patch itself. If you are using git (which is *strongly*
5709 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005710 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005711 the U-Boot mailing list, you will avoid most of the common problems
5712 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005713
Wolfgang Denk218ca722008-03-26 10:40:12 +01005714 If you cannot use git, use "diff -purN OLD NEW". If your version of
5715 diff does not support these options, then get the latest version of
5716 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005717
Wolfgang Denk218ca722008-03-26 10:40:12 +01005718 The current directory when running this command shall be the parent
5719 directory of the U-Boot source tree (i. e. please make sure that
5720 your patch includes sufficient directory information for the
5721 affected files).
5722
5723 We prefer patches as plain text. MIME attachments are discouraged,
5724 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005725
5726* If one logical set of modifications affects or creates several
5727 files, all these changes shall be submitted in a SINGLE patch file.
5728
5729* Changesets that contain different, unrelated modifications shall be
5730 submitted as SEPARATE patches, one patch per changeset.
5731
5732
5733Notes:
5734
5735* Before sending the patch, run the MAKEALL script on your patched
5736 source tree and make sure that no errors or warnings are reported
5737 for any of the boards.
5738
5739* Keep your modifications to the necessary minimum: A patch
5740 containing several unrelated changes or arbitrary reformats will be
5741 returned with a request to re-formatting / split it.
5742
5743* If you modify existing code, make sure that your new code does not
5744 add to the memory footprint of the code ;-) Small is beautiful!
5745 When adding new features, these should compile conditionally only
5746 (using #ifdef), and the resulting code with the new feature
5747 disabled must not need more memory than the old code without your
5748 modification.
wdenk90dc6702005-05-03 14:12:25 +00005749
Wolfgang Denk06682362008-12-30 22:56:11 +01005750* Remember that there is a size limit of 100 kB per message on the
5751 u-boot mailing list. Bigger patches will be moderated. If they are
5752 reasonable and not too big, they will be acknowledged. But patches
5753 bigger than the size limit should be avoided.