blob: 6db33c46d19a4550873607af3d02eba1d55839e4 [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
416 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418 This is the value to write into CCSR offset 0x18600
419 according to the A004510 workaround.
420
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000421- Generic CPU options:
422 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
423
424 Defines the endianess of the CPU. Implementation of those
425 values is arch specific.
426
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100427- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200428 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100429
430 Defines the Monahans run mode to oscillator
431 ratio. Valid values are 8, 16, 24, 31. The core
432 frequency is this value multiplied by 13 MHz.
433
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200434 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200435
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100436 Defines the Monahans turbo mode to oscillator
437 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200438 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100439 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200440
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200441- MIPS CPU options:
442 CONFIG_SYS_INIT_SP_OFFSET
443
444 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
445 pointer. This is needed for the temporary stack before
446 relocation.
447
448 CONFIG_SYS_MIPS_CACHE_MODE
449
450 Cache operation mode for the MIPS CPU.
451 See also arch/mips/include/asm/mipsregs.h.
452 Possible values are:
453 CONF_CM_CACHABLE_NO_WA
454 CONF_CM_CACHABLE_WA
455 CONF_CM_UNCACHED
456 CONF_CM_CACHABLE_NONCOHERENT
457 CONF_CM_CACHABLE_CE
458 CONF_CM_CACHABLE_COW
459 CONF_CM_CACHABLE_CUW
460 CONF_CM_CACHABLE_ACCELERATED
461
462 CONFIG_SYS_XWAY_EBU_BOOTCFG
463
464 Special option for Lantiq XWAY SoCs for booting from NOR flash.
465 See also arch/mips/cpu/mips32/start.S.
466
467 CONFIG_XWAY_SWAP_BYTES
468
469 Enable compilation of tools/xway-swap-bytes needed for Lantiq
470 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
471 be swapped if a flash programmer is used.
472
Christian Rieschb67d8812012-02-02 00:44:39 +0000473- ARM options:
474 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
475
476 Select high exception vectors of the ARM core, e.g., do not
477 clear the V bit of the c1 register of CP15.
478
Aneesh V5356f542012-03-08 07:20:19 +0000479 CONFIG_SYS_THUMB_BUILD
480
481 Use this flag to build U-Boot using the Thumb instruction
482 set for ARM architectures. Thumb instruction set provides
483 better code density. For ARM architectures that support
484 Thumb2 this flag will result in Thumb2 code generated by
485 GCC.
486
Stephen Warrenc5d47522013-03-04 13:29:40 +0000487 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000488 CONFIG_ARM_ERRATA_742230
489 CONFIG_ARM_ERRATA_743622
490 CONFIG_ARM_ERRATA_751472
491
492 If set, the workarounds for these ARM errata are applied early
493 during U-Boot startup. Note that these options force the
494 workarounds to be applied; no CPU-type/version detection
495 exists, unlike the similar options in the Linux kernel. Do not
496 set these options unless they apply!
497
Stephen Warren795659d2013-03-27 17:06:41 +0000498- CPU timer options:
499 CONFIG_SYS_HZ
500
501 The frequency of the timer returned by get_timer().
502 get_timer() must operate in milliseconds and this CONFIG
503 option must be set to 1000.
504
wdenk5da627a2003-10-09 20:09:04 +0000505- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000506 CONFIG_CLOCKS_IN_MHZ
507
508 U-Boot stores all clock information in Hz
509 internally. For binary compatibility with older Linux
510 kernels (which expect the clocks passed in the
511 bd_info data to be in MHz) the environment variable
512 "clocks_in_mhz" can be defined so that U-Boot
513 converts clock data to MHZ before passing it to the
514 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000515 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100516 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000517 default environment.
518
wdenk5da627a2003-10-09 20:09:04 +0000519 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
520
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200521 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000522 expect it to be in bytes, others in MB.
523 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
524
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400525 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200526
527 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400528 passed using flattened device trees (based on open firmware
529 concepts).
530
531 CONFIG_OF_LIBFDT
532 * New libfdt-based support
533 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500534 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400535
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200536 OF_CPU - The proper name of the cpus node (only required for
537 MPC512X and MPC5xxx based boards).
538 OF_SOC - The proper name of the soc node (only required for
539 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200540 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600541 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200542
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200543 boards with QUICC Engines require OF_QE to set UCC MAC
544 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500545
Kumar Gala4e253132006-01-11 13:54:17 -0600546 CONFIG_OF_BOARD_SETUP
547
548 Board code has addition modification that it wants to make
549 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000550
Matthew McClintock02677682006-06-28 10:41:37 -0500551 CONFIG_OF_BOOT_CPU
552
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200553 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500554 param header, the default value is zero if undefined.
555
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200556 CONFIG_OF_IDE_FIXUP
557
558 U-Boot can detect if an IDE device is present or not.
559 If not, and this new config option is activated, U-Boot
560 removes the ATA node from the DTS before booting Linux,
561 so the Linux IDE driver does not probe the device and
562 crash. This is needed for buggy hardware (uc101) where
563 no pull down resistor is connected to the signal IDE5V_DD7.
564
Igor Grinberg7eb29392011-07-14 05:45:07 +0000565 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
566
567 This setting is mandatory for all boards that have only one
568 machine type and must be used to specify the machine type
569 number as it appears in the ARM machine registry
570 (see http://www.arm.linux.org.uk/developer/machines/).
571 Only boards that have multiple machine types supported
572 in a single configuration file and the machine type is
573 runtime discoverable, do not have to use this setting.
574
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100575- vxWorks boot parameters:
576
577 bootvx constructs a valid bootline using the following
578 environments variables: bootfile, ipaddr, serverip, hostname.
579 It loads the vxWorks image pointed bootfile.
580
581 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
582 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
583 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
584 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
585
586 CONFIG_SYS_VXWORKS_ADD_PARAMS
587
588 Add it at the end of the bootline. E.g "u=username pw=secret"
589
590 Note: If a "bootargs" environment is defined, it will overwride
591 the defaults discussed just above.
592
Aneesh V2c451f72011-06-16 23:30:47 +0000593- Cache Configuration:
594 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
595 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
596 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
597
Aneesh V93bc2192011-06-16 23:30:51 +0000598- Cache Configuration for ARM:
599 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
600 controller
601 CONFIG_SYS_PL310_BASE - Physical base address of PL310
602 controller register space
603
wdenk6705d812004-08-02 23:22:59 +0000604- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200605 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000606
607 Define this if you want support for Amba PrimeCell PL010 UARTs.
608
Andreas Engel48d01922008-09-08 14:30:53 +0200609 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000610
611 Define this if you want support for Amba PrimeCell PL011 UARTs.
612
613 CONFIG_PL011_CLOCK
614
615 If you have Amba PrimeCell PL011 UARTs, set this variable to
616 the clock speed of the UARTs.
617
618 CONFIG_PL01x_PORTS
619
620 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
621 define this to a list of base addresses for each (supported)
622 port. See e.g. include/configs/versatile.h
623
John Rigby910f1ae2011-04-19 10:42:39 +0000624 CONFIG_PL011_SERIAL_RLCR
625
626 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
627 have separate receive and transmit line control registers. Set
628 this variable to initialize the extra register.
629
630 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
631
632 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
633 boot loader that has already initialized the UART. Define this
634 variable to flush the UART at init time.
635
wdenk6705d812004-08-02 23:22:59 +0000636
wdenkc6097192002-11-03 00:24:07 +0000637- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000638 Depending on board, define exactly one serial port
639 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
640 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
641 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000642
643 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
644 port routines must be defined elsewhere
645 (i.e. serial_init(), serial_getc(), ...)
646
647 CONFIG_CFB_CONSOLE
648 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000649 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000650 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
651 (default big endian)
652 VIDEO_HW_RECTFILL graphic chip supports
653 rectangle fill
654 (cf. smiLynxEM)
655 VIDEO_HW_BITBLT graphic chip supports
656 bit-blit (cf. smiLynxEM)
657 VIDEO_VISIBLE_COLS visible pixel columns
658 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000659 VIDEO_VISIBLE_ROWS visible pixel rows
660 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000661 VIDEO_DATA_FORMAT graphic data format
662 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000663 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000664 VIDEO_KBD_INIT_FCT keyboard int fct
665 (i.e. i8042_kbd_init())
666 VIDEO_TSTC_FCT test char fct
667 (i.e. i8042_tstc)
668 VIDEO_GETC_FCT get char fct
669 (i.e. i8042_getc)
670 CONFIG_CONSOLE_CURSOR cursor drawing on/off
671 (requires blink timer
672 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200673 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000674 CONFIG_CONSOLE_TIME display time/date info in
675 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500676 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000677 CONFIG_VIDEO_LOGO display Linux logo in
678 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000679 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
680 linux_logo.h for logo.
681 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000682 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200683 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000684 the logo
685
Pali Rohár33a35bb2012-10-19 13:30:09 +0000686 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
687 a limited number of ANSI escape sequences (cursor control,
688 erase functions and limited graphics rendition control).
689
wdenk43d96162003-03-06 00:02:04 +0000690 When CONFIG_CFB_CONSOLE is defined, video console is
691 default i/o. Serial console can be forced with
692 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000693
wdenkd4ca31c2004-01-02 14:00:00 +0000694 When CONFIG_SILENT_CONSOLE is defined, all console
695 messages (by U-Boot and Linux!) can be silenced with
696 the "silent" environment variable. See
697 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000698
wdenkc6097192002-11-03 00:24:07 +0000699- Console Baudrate:
700 CONFIG_BAUDRATE - in bps
701 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200702 CONFIG_SYS_BAUDRATE_TABLE, see below.
703 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000704
Heiko Schocherc92fac92009-01-30 12:55:38 +0100705- Console Rx buffer length
706 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
707 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100708 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100709 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
710 must be defined, to setup the maximum idle timeout for
711 the SMC.
712
Graeme Russ9558b482011-09-01 00:48:27 +0000713- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200714 Prior to the console being initialised (i.e. serial UART
715 initialised etc) all console output is silently discarded.
716 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
717 buffer any console messages prior to the console being
718 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
719 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
720 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200721 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200722 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000723
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200724 'Sane' compilers will generate smaller code if
725 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000726
Sonny Rao046a37b2011-11-02 09:52:08 +0000727- Safe printf() functions
728 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
729 the printf() functions. These are defined in
730 include/vsprintf.h and include snprintf(), vsnprintf() and
731 so on. Code size increase is approximately 300-500 bytes.
732 If this option is not given then these functions will
733 silently discard their buffer size argument - this means
734 you are not getting any overflow checking in this case.
735
wdenkc6097192002-11-03 00:24:07 +0000736- Boot Delay: CONFIG_BOOTDELAY - in seconds
737 Delay before automatically booting the default image;
738 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000739 set to -2 to autoboot with no delay and not check for abort
740 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000741
742 See doc/README.autoboot for these options that
743 work with CONFIG_BOOTDELAY. None are required.
744 CONFIG_BOOT_RETRY_TIME
745 CONFIG_BOOT_RETRY_MIN
746 CONFIG_AUTOBOOT_KEYED
747 CONFIG_AUTOBOOT_PROMPT
748 CONFIG_AUTOBOOT_DELAY_STR
749 CONFIG_AUTOBOOT_STOP_STR
750 CONFIG_AUTOBOOT_DELAY_STR2
751 CONFIG_AUTOBOOT_STOP_STR2
752 CONFIG_ZERO_BOOTDELAY_CHECK
753 CONFIG_RESET_TO_RETRY
754
755- Autoboot Command:
756 CONFIG_BOOTCOMMAND
757 Only needed when CONFIG_BOOTDELAY is enabled;
758 define a command string that is automatically executed
759 when no character is read on the console interface
760 within "Boot Delay" after reset.
761
762 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000763 This can be used to pass arguments to the bootm
764 command. The value of CONFIG_BOOTARGS goes into the
765 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000766
767 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000768 The value of these goes into the environment as
769 "ramboot" and "nfsboot" respectively, and can be used
770 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200771 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000772
773- Pre-Boot Commands:
774 CONFIG_PREBOOT
775
776 When this option is #defined, the existence of the
777 environment variable "preboot" will be checked
778 immediately before starting the CONFIG_BOOTDELAY
779 countdown and/or running the auto-boot command resp.
780 entering interactive mode.
781
782 This feature is especially useful when "preboot" is
783 automatically generated or modified. For an example
784 see the LWMON board specific code: here "preboot" is
785 modified when the user holds down a certain
786 combination of keys on the (special) keyboard when
787 booting the systems
788
789- Serial Download Echo Mode:
790 CONFIG_LOADS_ECHO
791 If defined to 1, all characters received during a
792 serial download (using the "loads" command) are
793 echoed back. This might be needed by some terminal
794 emulations (like "cu"), but may as well just take
795 time on others. This setting #define's the initial
796 value of the "loads_echo" environment variable.
797
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500798- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000799 CONFIG_KGDB_BAUDRATE
800 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200801 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000802
803- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500804 Monitor commands can be included or excluded
805 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000806 <config_cmd_all.h> and #undef'ing unwanted
807 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500808 and augmenting with additional #define's
809 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000810
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500811 The default command configuration includes all commands
812 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000813
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500814 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500815 CONFIG_CMD_BDI bdinfo
816 CONFIG_CMD_BEDBUG * Include BedBug Debugger
817 CONFIG_CMD_BMP * BMP support
818 CONFIG_CMD_BSP * Board specific commands
819 CONFIG_CMD_BOOTD bootd
820 CONFIG_CMD_CACHE * icache, dcache
821 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500822 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500823 CONFIG_CMD_DATE * support for RTC, date/time...
824 CONFIG_CMD_DHCP * DHCP support
825 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600826 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
827 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
828 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
829 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500830 CONFIG_CMD_DTT * Digital Therm and Thermostat
831 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500832 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500833 CONFIG_CMD_EEPROM * EEPROM read/write support
834 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600835 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600836 CONFIG_CMD_ENV_FLAGS * display details about env flags
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500837 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000838 CONFIG_CMD_EXT2 * ext2 command support
839 CONFIG_CMD_EXT4 * ext4 command support
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500840 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500841 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000842 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500843 CONFIG_CMD_FDOS * Dos diskette Support
844 CONFIG_CMD_FLASH flinfo, erase, protect
845 CONFIG_CMD_FPGA FPGA device initialization support
Benoît Thébaudeauccca7df2013-04-23 10:17:40 +0000846 CONFIG_CMD_FUSE Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000847 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500848 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000849 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000850 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500851 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
852 CONFIG_CMD_I2C * I2C serial bus support
853 CONFIG_CMD_IDE * IDE harddisk support
854 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +0000855 CONFIG_CMD_IMLS List all images found in NOR flash
856 CONFIG_CMD_IMLS_NAND List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500857 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500858 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000859 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500860 CONFIG_CMD_IRQ * irqinfo
861 CONFIG_CMD_ITEST Integer/string test of 2 values
862 CONFIG_CMD_JFFS2 * JFFS2 Support
863 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500864 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000865 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
866 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500867 CONFIG_CMD_LOADB loadb
868 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400869 CONFIG_CMD_MD5SUM print md5 message digest
870 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +0000871 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500872 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +0000873 loop, loopw
874 CONFIG_CMD_MEMTEST mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500875 CONFIG_CMD_MISC Misc functions like sleep etc
876 CONFIG_CMD_MMC * MMC memory mapped support
877 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100878 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500879 CONFIG_CMD_NAND * NAND support
880 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600881 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000882 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500883 CONFIG_CMD_PCI * pciinfo
884 CONFIG_CMD_PCMCIA * PCMCIA support
885 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
886 host
887 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +0000888 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500889 CONFIG_CMD_REGINFO * Register dump
890 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +0000891 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500892 CONFIG_CMD_SAVES * save S record dump
893 CONFIG_CMD_SCSI * SCSI Support
894 CONFIG_CMD_SDRAM * print SDRAM configuration information
895 (requires CONFIG_CMD_I2C)
896 CONFIG_CMD_SETGETDCR Support for DCR Register access
897 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700898 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100899 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400900 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +0800901 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200902 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500903 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000904 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000905 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000906 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
907 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500908 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500909 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000910 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000911
wdenkc6097192002-11-03 00:24:07 +0000912
913 EXAMPLE: If you want all functions except of network
914 support you can write:
915
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500916 #include "config_cmd_all.h"
917 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000918
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400919 Other Commands:
920 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000921
922 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500923 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000924 what you (and your U-Boot users) are doing. Data
925 cache cannot be enabled on systems like the 8xx or
926 8260 (where accesses to the IMMR region must be
927 uncached), and it cannot be disabled on all other
928 systems where we (mis-) use the data cache to hold an
929 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000930
931
932 XXX - this list needs to get updated!
933
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000934- Regular expression support:
935 CONFIG_REGEX
936 If this variable is defined, U-Boot is linked against
937 the SLRE (Super Light Regular Expression) library,
938 which adds regex support to some commands, as for
939 example "env grep" and "setexpr".
940
Simon Glass45ba8072011-10-15 05:48:20 +0000941- Device tree:
942 CONFIG_OF_CONTROL
943 If this variable is defined, U-Boot will use a device tree
944 to configure its devices, instead of relying on statically
945 compiled #defines in the board file. This option is
946 experimental and only available on a few boards. The device
947 tree is available in the global data as gd->fdt_blob.
948
Simon Glass2c0f79e2011-10-24 19:15:31 +0000949 U-Boot needs to get its device tree from somewhere. This can
950 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000951
952 CONFIG_OF_EMBED
953 If this variable is defined, U-Boot will embed a device tree
954 binary in its image. This device tree file should be in the
955 board directory and called <soc>-<board>.dts. The binary file
956 is then picked up in board_init_f() and made available through
957 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000958
Simon Glass2c0f79e2011-10-24 19:15:31 +0000959 CONFIG_OF_SEPARATE
960 If this variable is defined, U-Boot will build a device tree
961 binary. It will be called u-boot.dtb. Architecture-specific
962 code will locate it at run-time. Generally this works by:
963
964 cat u-boot.bin u-boot.dtb >image.bin
965
966 and in fact, U-Boot does this for you, creating a file called
967 u-boot-dtb.bin which is useful in the common case. You can
968 still use the individual files if you need something more
969 exotic.
970
wdenkc6097192002-11-03 00:24:07 +0000971- Watchdog:
972 CONFIG_WATCHDOG
973 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000974 support for the SoC. There must be support in the SoC
975 specific code for a watchdog. For the 8xx and 8260
976 CPUs, the SIU Watchdog feature is enabled in the SYPCR
977 register. When supported for a specific SoC is
978 available, then no further board specific code should
979 be needed to use it.
980
981 CONFIG_HW_WATCHDOG
982 When using a watchdog circuitry external to the used
983 SoC, then define this variable and provide board
984 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000985
stroesec1551ea2003-04-04 15:53:41 +0000986- U-Boot Version:
987 CONFIG_VERSION_VARIABLE
988 If this variable is defined, an environment variable
989 named "ver" is created by U-Boot showing the U-Boot
990 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200991 Any change to this variable will be reverted at the
992 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000993
wdenkc6097192002-11-03 00:24:07 +0000994- Real-Time Clock:
995
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500996 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000997 has to be selected, too. Define exactly one of the
998 following options:
999
1000 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1001 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001002 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001003 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001004 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001005 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001006 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +00001007 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001008 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001009 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001010 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001011 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1012 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001013
wdenkb37c7e52003-06-30 16:24:52 +00001014 Note that if the RTC uses I2C, then the I2C interface
1015 must also be configured. See I2C Support, below.
1016
Peter Tysere92739d2008-12-17 16:36:21 -06001017- GPIO Support:
1018 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
1019 CONFIG_PCA953X_INFO - enable pca953x info command
1020
Chris Packham5dec49c2010-12-19 10:12:13 +00001021 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1022 chip-ngpio pairs that tell the PCA953X driver the number of
1023 pins supported by a particular chip.
1024
Peter Tysere92739d2008-12-17 16:36:21 -06001025 Note that if the GPIO device uses I2C, then the I2C interface
1026 must also be configured. See I2C Support, below.
1027
wdenkc6097192002-11-03 00:24:07 +00001028- Timestamp Support:
1029
wdenk43d96162003-03-06 00:02:04 +00001030 When CONFIG_TIMESTAMP is selected, the timestamp
1031 (date and time) of an image is printed by image
1032 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001033 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001034
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001035- Partition Labels (disklabels) Supported:
1036 Zero or more of the following:
1037 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1038 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1039 Intel architecture, USB sticks, etc.
1040 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1041 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1042 bootloader. Note 2TB partition limit; see
1043 disk/part_efi.c
1044 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001045
Wolfgang Denk218ca722008-03-26 10:40:12 +01001046 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1047 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001048 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001049
1050- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001051 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1052 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001053
wdenk4d13cba2004-03-14 14:09:05 +00001054 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1055 be performed by calling the function
1056 ide_set_reset(int reset)
1057 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001058
1059- ATAPI Support:
1060 CONFIG_ATAPI
1061
1062 Set this to enable ATAPI support.
1063
wdenkc40b2952004-03-13 23:29:43 +00001064- LBA48 Support
1065 CONFIG_LBA48
1066
1067 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001068 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001069 Whithout these , LBA48 support uses 32bit variables and will 'only'
1070 support disks up to 2.1TB.
1071
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001072 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001073 When enabled, makes the IDE subsystem use 64bit sector addresses.
1074 Default is 32bit.
1075
wdenkc6097192002-11-03 00:24:07 +00001076- SCSI Support:
1077 At the moment only there is only support for the
1078 SYM53C8XX SCSI controller; define
1079 CONFIG_SCSI_SYM53C8XX to enable it.
1080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001081 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1082 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1083 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001084 maximum numbers of LUNs, SCSI ID's and target
1085 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001086 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001087
Stefan Reinauer447c0312012-10-29 05:23:48 +00001088 The environment variable 'scsidevs' is set to the number of
1089 SCSI devices found during the last scan.
1090
wdenkc6097192002-11-03 00:24:07 +00001091- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001092 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001093 Support for Intel 8254x/8257x gigabit chips.
1094
1095 CONFIG_E1000_SPI
1096 Utility code for direct access to the SPI bus on Intel 8257x.
1097 This does not do anything useful unless you set at least one
1098 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1099
1100 CONFIG_E1000_SPI_GENERIC
1101 Allow generic access to the SPI bus on the Intel 8257x, for
1102 example with the "sspi" command.
1103
1104 CONFIG_CMD_E1000
1105 Management command for E1000 devices. When used on devices
1106 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001107
Andre Schwarzac3315c2008-03-06 16:45:44 +01001108 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001109 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001110
wdenkc6097192002-11-03 00:24:07 +00001111 CONFIG_EEPRO100
1112 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001113 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001114 write routine for first time initialisation.
1115
1116 CONFIG_TULIP
1117 Support for Digital 2114x chips.
1118 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1119 modem chip initialisation (KS8761/QS6611).
1120
1121 CONFIG_NATSEMI
1122 Support for National dp83815 chips.
1123
1124 CONFIG_NS8382X
1125 Support for National dp8382[01] gigabit chips.
1126
wdenk45219c42003-05-12 21:50:16 +00001127- NETWORK Support (other):
1128
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001129 CONFIG_DRIVER_AT91EMAC
1130 Support for AT91RM9200 EMAC.
1131
1132 CONFIG_RMII
1133 Define this to use reduced MII inteface
1134
1135 CONFIG_DRIVER_AT91EMAC_QUIET
1136 If this defined, the driver is quiet.
1137 The driver doen't show link status messages.
1138
Rob Herringefdd7312011-12-15 11:15:49 +00001139 CONFIG_CALXEDA_XGMAC
1140 Support for the Calxeda XGMAC device
1141
Ashok3bb46d22012-10-15 06:20:47 +00001142 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001143 Support for SMSC's LAN91C96 chips.
1144
1145 CONFIG_LAN91C96_BASE
1146 Define this to hold the physical address
1147 of the LAN91C96's I/O space
1148
1149 CONFIG_LAN91C96_USE_32_BIT
1150 Define this to enable 32 bit addressing
1151
Ashok3bb46d22012-10-15 06:20:47 +00001152 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001153 Support for SMSC's LAN91C111 chip
1154
1155 CONFIG_SMC91111_BASE
1156 Define this to hold the physical address
1157 of the device (I/O space)
1158
1159 CONFIG_SMC_USE_32_BIT
1160 Define this if data bus is 32 bits
1161
1162 CONFIG_SMC_USE_IOFUNCS
1163 Define this to use i/o functions instead of macros
1164 (some hardware wont work with macros)
1165
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001166 CONFIG_DRIVER_TI_EMAC
1167 Support for davinci emac
1168
1169 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1170 Define this if you have more then 3 PHYs.
1171
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001172 CONFIG_FTGMAC100
1173 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1174
1175 CONFIG_FTGMAC100_EGIGA
1176 Define this to use GE link update with gigabit PHY.
1177 Define this if FTGMAC100 is connected to gigabit PHY.
1178 If your system has 10/100 PHY only, it might not occur
1179 wrong behavior. Because PHY usually return timeout or
1180 useless data when polling gigabit status and gigabit
1181 control registers. This behavior won't affect the
1182 correctnessof 10/100 link speed update.
1183
Mike Rapoportc2fff332009-11-11 10:03:03 +02001184 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001185 Support for SMSC's LAN911x and LAN921x chips
1186
Mike Rapoportc2fff332009-11-11 10:03:03 +02001187 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001188 Define this to hold the physical address
1189 of the device (I/O space)
1190
Mike Rapoportc2fff332009-11-11 10:03:03 +02001191 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001192 Define this if data bus is 32 bits
1193
Mike Rapoportc2fff332009-11-11 10:03:03 +02001194 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001195 Define this if data bus is 16 bits. If your processor
1196 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001197 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001198
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001199 CONFIG_SH_ETHER
1200 Support for Renesas on-chip Ethernet controller
1201
1202 CONFIG_SH_ETHER_USE_PORT
1203 Define the number of ports to be used
1204
1205 CONFIG_SH_ETHER_PHY_ADDR
1206 Define the ETH PHY's address
1207
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001208 CONFIG_SH_ETHER_CACHE_WRITEBACK
1209 If this option is set, the driver enables cache flush.
1210
Vadim Bendebury5e124722011-10-17 08:36:14 +00001211- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001212 CONFIG_TPM
1213 Support TPM devices.
1214
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001215 CONFIG_TPM_TIS_I2C
1216 Support for i2c bus TPM devices. Only one device
1217 per system is supported at this time.
1218
1219 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1220 Define the the i2c bus number for the TPM device
1221
1222 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1223 Define the TPM's address on the i2c bus
1224
1225 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1226 Define the burst count bytes upper limit
1227
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001228 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001229 Support for generic parallel port TPM devices. Only one device
1230 per system is supported at this time.
1231
1232 CONFIG_TPM_TIS_BASE_ADDRESS
1233 Base address where the generic TPM device is mapped
1234 to. Contemporary x86 systems usually map it at
1235 0xfed40000.
1236
wdenkc6097192002-11-03 00:24:07 +00001237- USB Support:
1238 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001239 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001240 CONFIG_USB_UHCI to enable it.
1241 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001242 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001243 storage devices.
1244 Note:
1245 Supported are USB Keyboards and USB Floppy drives
1246 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001247 MPC5200 USB requires additional defines:
1248 CONFIG_USB_CLOCK
1249 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001250 CONFIG_PSC3_USB
1251 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001252 CONFIG_USB_CONFIG
1253 for differential drivers: 0x00001000
1254 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001255 for differential drivers on PSC3: 0x00000100
1256 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001257 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001258 May be defined to allow interrupt polling
1259 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001260
Simon Glass9ab4ce22012-02-27 10:52:47 +00001261 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1262 txfilltuning field in the EHCI controller on reset.
1263
Kuo-Jung Suaa155052013-05-15 15:29:22 +08001264 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1265 interval for usb hub power-on delay.(minimum 100msec)
1266
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001267- USB Device:
1268 Define the below if you wish to use the USB console.
1269 Once firmware is rebuilt from a serial console issue the
1270 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001271 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001272 it has found a new device. The environment variable usbtty
1273 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001274 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001275 Common Device Class Abstract Control Model serial device.
1276 If you select usbtty = gserial you should be able to enumerate
1277 a Linux host by
1278 # modprobe usbserial vendor=0xVendorID product=0xProductID
1279 else if using cdc_acm, simply setting the environment
1280 variable usbtty to be cdc_acm should suffice. The following
1281 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001282
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001283 CONFIG_USB_DEVICE
1284 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001285
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001286 CONFIG_USB_TTY
1287 Define this to have a tty type of device available to
1288 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001289
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301290 CONFIG_USBD_HS
1291 Define this to enable the high speed support for usb
1292 device and usbtty. If this feature is enabled, a routine
1293 int is_usbd_high_speed(void)
1294 also needs to be defined by the driver to dynamically poll
1295 whether the enumeration has succeded at high speed or full
1296 speed.
1297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001298 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001299 Define this if you want stdin, stdout &/or stderr to
1300 be set to usbtty.
1301
1302 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001303 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001304 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001305 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001307 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001308 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001309 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001310
Wolfgang Denk386eda02006-06-14 18:14:56 +02001311 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001312 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001313 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001314 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1315 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1316 should pretend to be a Linux device to it's target host.
1317
1318 CONFIG_USBD_MANUFACTURER
1319 Define this string as the name of your company for
1320 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001321
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001322 CONFIG_USBD_PRODUCT_NAME
1323 Define this string as the name of your product
1324 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1325
1326 CONFIG_USBD_VENDORID
1327 Define this as your assigned Vendor ID from the USB
1328 Implementors Forum. This *must* be a genuine Vendor ID
1329 to avoid polluting the USB namespace.
1330 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001331
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001332 CONFIG_USBD_PRODUCTID
1333 Define this as the unique Product ID
1334 for your device
1335 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001336
Igor Grinbergd70a5602011-12-12 12:08:35 +02001337- ULPI Layer Support:
1338 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1339 the generic ULPI layer. The generic layer accesses the ULPI PHY
1340 via the platform viewport, so you need both the genric layer and
1341 the viewport enabled. Currently only Chipidea/ARC based
1342 viewport is supported.
1343 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1344 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001345 If your ULPI phy needs a different reference clock than the
1346 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1347 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001348
1349- MMC Support:
1350 The MMC controller on the Intel PXA is supported. To
1351 enable this define CONFIG_MMC. The MMC can be
1352 accessed from the boot prompt by mapping the device
1353 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001354 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1355 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001356
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001357 CONFIG_SH_MMCIF
1358 Support for Renesas on-chip MMCIF controller
1359
1360 CONFIG_SH_MMCIF_ADDR
1361 Define the base address of MMCIF registers
1362
1363 CONFIG_SH_MMCIF_CLK
1364 Define the clock frequency for MMCIF
1365
Tom Rinib3ba6e92013-03-14 05:32:47 +00001366- USB Device Firmware Update (DFU) class support:
1367 CONFIG_DFU_FUNCTION
1368 This enables the USB portion of the DFU USB class
1369
1370 CONFIG_CMD_DFU
1371 This enables the command "dfu" which is used to have
1372 U-Boot create a DFU class device via USB. This command
1373 requires that the "dfu_alt_info" environment variable be
1374 set and define the alt settings to expose to the host.
1375
1376 CONFIG_DFU_MMC
1377 This enables support for exposing (e)MMC devices via DFU.
1378
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001379 CONFIG_DFU_NAND
1380 This enables support for exposing NAND devices via DFU.
1381
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001382 CONFIG_SYS_DFU_MAX_FILE_SIZE
1383 When updating files rather than the raw storage device,
1384 we use a static buffer to copy the file into and then write
1385 the buffer once we've been given the whole file. Define
1386 this to the maximum filesize (in bytes) for the buffer.
1387 Default is 4 MiB if undefined.
1388
wdenk6705d812004-08-02 23:22:59 +00001389- Journaling Flash filesystem support:
1390 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1391 CONFIG_JFFS2_NAND_DEV
1392 Define these for a default partition on a NAND device
1393
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001394 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1395 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001396 Define these for a default partition on a NOR device
1397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001398 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001399 Define this to create an own partition. You have to provide a
1400 function struct part_info* jffs2_part_info(int part_num)
1401
1402 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001403 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001404 to disable the command chpart. This is the default when you
1405 have not defined a custom partition
1406
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001407- FAT(File Allocation Table) filesystem write function support:
1408 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001409
1410 Define this to enable support for saving memory data as a
1411 file in FAT formatted partition.
1412
1413 This will also enable the command "fatwrite" enabling the
1414 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001415
Gabe Black84cd9322012-10-12 14:26:11 +00001416CBFS (Coreboot Filesystem) support
1417 CONFIG_CMD_CBFS
1418
1419 Define this to enable support for reading from a Coreboot
1420 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1421 and cbfsload.
1422
wdenkc6097192002-11-03 00:24:07 +00001423- Keyboard Support:
1424 CONFIG_ISA_KEYBOARD
1425
1426 Define this to enable standard (PC-Style) keyboard
1427 support
1428
1429 CONFIG_I8042_KBD
1430 Standard PC keyboard driver with US (is default) and
1431 GERMAN key layout (switch via environment 'keymap=de') support.
1432 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1433 for cfb_console. Supports cursor blinking.
1434
1435- Video support:
1436 CONFIG_VIDEO
1437
1438 Define this to enable video support (for output to
1439 video).
1440
1441 CONFIG_VIDEO_CT69000
1442
1443 Enable Chips & Technologies 69000 Video chip
1444
1445 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001446 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001447 video output is selected via environment 'videoout'
1448 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1449 assumed.
wdenkc6097192002-11-03 00:24:07 +00001450
wdenkb79a11c2004-03-25 15:14:43 +00001451 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001452 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001453 are possible:
1454 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001455 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001456
1457 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1458 -------------+---------------------------------------------
1459 8 bits | 0x301* 0x303 0x305 0x161 0x307
1460 15 bits | 0x310 0x313 0x316 0x162 0x319
1461 16 bits | 0x311 0x314 0x317 0x163 0x31A
1462 24 bits | 0x312 0x315 0x318 ? 0x31B
1463 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001464 (i.e. setenv videomode 317; saveenv; reset;)
1465
wdenkb79a11c2004-03-25 15:14:43 +00001466 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001467 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001468
1469
stroesec1551ea2003-04-04 15:53:41 +00001470 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001471 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001472 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1473 or CONFIG_VIDEO_SED13806_16BPP
1474
Timur Tabi7d3053f2011-02-15 17:09:19 -06001475 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001476 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001477 SOCs that have a DIU should define this macro to enable DIU
1478 support, and should also define these other macros:
1479
1480 CONFIG_SYS_DIU_ADDR
1481 CONFIG_VIDEO
1482 CONFIG_CMD_BMP
1483 CONFIG_CFB_CONSOLE
1484 CONFIG_VIDEO_SW_CURSOR
1485 CONFIG_VGA_AS_SINGLE_DEVICE
1486 CONFIG_VIDEO_LOGO
1487 CONFIG_VIDEO_BMP_LOGO
1488
Timur Tabiba8e76b2011-04-11 14:18:22 -05001489 The DIU driver will look for the 'video-mode' environment
1490 variable, and if defined, enable the DIU as a console during
1491 boot. See the documentation file README.video for a
1492 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001493
Simon Glass058d59b2012-12-03 13:59:47 +00001494 CONFIG_VIDEO_VGA
1495
1496 Enable the VGA video / BIOS for x86. The alternative if you
1497 are using coreboot is to use the coreboot frame buffer
1498 driver.
1499
1500
wdenk682011f2003-06-03 23:54:09 +00001501- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001502 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001503
wdenk8bde7f72003-06-27 21:31:46 +00001504 Define this to enable a custom keyboard support.
1505 This simply calls drv_keyboard_init() which must be
1506 defined in your board-specific files.
1507 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001508
wdenkc6097192002-11-03 00:24:07 +00001509- LCD Support: CONFIG_LCD
1510
1511 Define this to enable LCD support (for output to LCD
1512 display); also select one of the supported displays
1513 by defining one of these:
1514
Stelian Pop39cf4802008-05-09 21:57:18 +02001515 CONFIG_ATMEL_LCD:
1516
1517 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1518
wdenkfd3103b2003-11-25 16:55:19 +00001519 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001520
wdenkfd3103b2003-11-25 16:55:19 +00001521 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001522
wdenkfd3103b2003-11-25 16:55:19 +00001523 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001524
wdenkfd3103b2003-11-25 16:55:19 +00001525 NEC NL6448BC20-08. 6.5", 640x480.
1526 Active, color, single scan.
1527
1528 CONFIG_NEC_NL6448BC33_54
1529
1530 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001531 Active, color, single scan.
1532
1533 CONFIG_SHARP_16x9
1534
1535 Sharp 320x240. Active, color, single scan.
1536 It isn't 16x9, and I am not sure what it is.
1537
1538 CONFIG_SHARP_LQ64D341
1539
1540 Sharp LQ64D341 display, 640x480.
1541 Active, color, single scan.
1542
1543 CONFIG_HLD1045
1544
1545 HLD1045 display, 640x480.
1546 Active, color, single scan.
1547
1548 CONFIG_OPTREX_BW
1549
1550 Optrex CBL50840-2 NF-FW 99 22 M5
1551 or
1552 Hitachi LMG6912RPFC-00T
1553 or
1554 Hitachi SP14Q002
1555
1556 320x240. Black & white.
1557
1558 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001559 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001560
Simon Glass676d3192012-10-17 13:24:54 +00001561 CONFIG_LCD_ALIGNMENT
1562
1563 Normally the LCD is page-aligned (tyically 4KB). If this is
1564 defined then the LCD will be aligned to this value instead.
1565 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1566 here, since it is cheaper to change data cache settings on
1567 a per-section basis.
1568
Simon Glass0d89efe2012-10-17 13:24:59 +00001569 CONFIG_CONSOLE_SCROLL_LINES
1570
1571 When the console need to be scrolled, this is the number of
1572 lines to scroll by. It defaults to 1. Increasing this makes
1573 the console jump but can help speed up operation when scrolling
1574 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001575
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001576 CONFIG_LCD_BMP_RLE8
1577
1578 Support drawing of RLE8-compressed bitmaps on the LCD.
1579
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001580 CONFIG_I2C_EDID
1581
1582 Enables an 'i2c edid' command which can read EDID
1583 information over I2C from an attached LCD display.
1584
wdenk7152b1d2003-09-05 23:19:14 +00001585- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001586
wdenk8bde7f72003-06-27 21:31:46 +00001587 If this option is set, the environment is checked for
1588 a variable "splashimage". If found, the usual display
1589 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001590 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001591 specified in "splashimage" is loaded instead. The
1592 console is redirected to the "nulldev", too. This
1593 allows for a "silent" boot where a splash screen is
1594 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001595
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001596 CONFIG_SPLASHIMAGE_GUARD
1597
1598 If this option is set, then U-Boot will prevent the environment
1599 variable "splashimage" from being set to a problematic address
1600 (see README.displaying-bmps and README.arm-unaligned-accesses).
1601 This option is useful for targets where, due to alignment
1602 restrictions, an improperly aligned BMP image will cause a data
1603 abort. If you think you will not have problems with unaligned
1604 accesses (for example because your toolchain prevents them)
1605 there is no need to set this option.
1606
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001607 CONFIG_SPLASH_SCREEN_ALIGN
1608
1609 If this option is set the splash image can be freely positioned
1610 on the screen. Environment variable "splashpos" specifies the
1611 position as "x,y". If a positive number is given it is used as
1612 number of pixel from left/top. If a negative number is given it
1613 is used as number of pixel from right/bottom. You can also
1614 specify 'm' for centering the image.
1615
1616 Example:
1617 setenv splashpos m,m
1618 => image at center of screen
1619
1620 setenv splashpos 30,20
1621 => image at x = 30 and y = 20
1622
1623 setenv splashpos -10,m
1624 => vertically centered image
1625 at x = dspWidth - bmpWidth - 9
1626
Nikita Kiryanov581bb412013-01-30 21:39:57 +00001627 CONFIG_SPLASH_SCREEN_PREPARE
1628
1629 If this option is set then the board_splash_screen_prepare()
1630 function, which must be defined in your code, is called as part
1631 of the splash screen display sequence. It gives the board an
1632 opportunity to prepare the splash image data before it is
1633 processed and sent to the frame buffer by U-Boot.
1634
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001635- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1636
1637 If this option is set, additionally to standard BMP
1638 images, gzipped BMP images can be displayed via the
1639 splashscreen support or the bmp command.
1640
Anatolij Gustschind5011762010-03-15 14:50:25 +01001641- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1642
1643 If this option is set, 8-bit RLE compressed BMP images
1644 can be displayed via the splashscreen support or the
1645 bmp command.
1646
Lei Wenf2b96df2012-09-28 04:26:47 +00001647- Do compresssing for memory range:
1648 CONFIG_CMD_ZIP
1649
1650 If this option is set, it would use zlib deflate method
1651 to compress the specified memory at its best effort.
1652
wdenkc29fdfc2003-08-29 20:57:53 +00001653- Compression support:
1654 CONFIG_BZIP2
1655
1656 If this option is set, support for bzip2 compressed
1657 images is included. If not, only uncompressed and gzip
1658 compressed images are supported.
1659
wdenk42d1f032003-10-15 23:53:47 +00001660 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001661 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001662 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001663
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001664 CONFIG_LZMA
1665
1666 If this option is set, support for lzma compressed
1667 images is included.
1668
1669 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1670 requires an amount of dynamic memory that is given by the
1671 formula:
1672
1673 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1674
1675 Where lc and lp stand for, respectively, Literal context bits
1676 and Literal pos bits.
1677
1678 This value is upper-bounded by 14MB in the worst case. Anyway,
1679 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1680 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1681 a very small buffer.
1682
1683 Use the lzmainfo tool to determinate the lc and lp values and
1684 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001685 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001686
wdenk17ea1172004-06-06 21:51:03 +00001687- MII/PHY support:
1688 CONFIG_PHY_ADDR
1689
1690 The address of PHY on MII bus.
1691
1692 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1693
1694 The clock frequency of the MII bus
1695
1696 CONFIG_PHY_GIGE
1697
1698 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001699 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001700
1701 CONFIG_PHY_RESET_DELAY
1702
1703 Some PHY like Intel LXT971A need extra delay after
1704 reset before any MII register access is possible.
1705 For such PHY, set this option to the usec delay
1706 required. (minimum 300usec for LXT971A)
1707
1708 CONFIG_PHY_CMD_DELAY (ppc4xx)
1709
1710 Some PHY like Intel LXT971A need extra delay after
1711 command issued before MII status register can be read
1712
wdenkc6097192002-11-03 00:24:07 +00001713- Ethernet address:
1714 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001715 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001716 CONFIG_ETH2ADDR
1717 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001718 CONFIG_ETH4ADDR
1719 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001720
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001721 Define a default value for Ethernet address to use
1722 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001723 is not determined automatically.
1724
1725- IP address:
1726 CONFIG_IPADDR
1727
1728 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001729 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001730 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001731 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001732
1733- Server IP address:
1734 CONFIG_SERVERIP
1735
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001736 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001737 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001738 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001739
Robin Getz97cfe862009-07-21 12:15:28 -04001740 CONFIG_KEEP_SERVERADDR
1741
1742 Keeps the server's MAC address, in the env 'serveraddr'
1743 for passing to bootargs (like Linux's netconsole option)
1744
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001745- Gateway IP address:
1746 CONFIG_GATEWAYIP
1747
1748 Defines a default value for the IP address of the
1749 default router where packets to other networks are
1750 sent to.
1751 (Environment variable "gatewayip")
1752
1753- Subnet mask:
1754 CONFIG_NETMASK
1755
1756 Defines a default value for the subnet mask (or
1757 routing prefix) which is used to determine if an IP
1758 address belongs to the local subnet or needs to be
1759 forwarded through a router.
1760 (Environment variable "netmask")
1761
David Updegraff53a5c422007-06-11 10:41:07 -05001762- Multicast TFTP Mode:
1763 CONFIG_MCAST_TFTP
1764
1765 Defines whether you want to support multicast TFTP as per
1766 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001767 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001768 driver in use must provide a function: mcast() to join/leave a
1769 multicast group.
1770
wdenkc6097192002-11-03 00:24:07 +00001771- BOOTP Recovery Mode:
1772 CONFIG_BOOTP_RANDOM_DELAY
1773
1774 If you have many targets in a network that try to
1775 boot using BOOTP, you may want to avoid that all
1776 systems send out BOOTP requests at precisely the same
1777 moment (which would happen for instance at recovery
1778 from a power failure, when all systems will try to
1779 boot, thus flooding the BOOTP server. Defining
1780 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1781 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001782 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001783
1784 1st BOOTP request: delay 0 ... 1 sec
1785 2nd BOOTP request: delay 0 ... 2 sec
1786 3rd BOOTP request: delay 0 ... 4 sec
1787 4th and following
1788 BOOTP requests: delay 0 ... 8 sec
1789
stroesefe389a82003-08-28 14:17:32 +00001790- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001791 You can fine tune the DHCP functionality by defining
1792 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001793
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001794 CONFIG_BOOTP_SUBNETMASK
1795 CONFIG_BOOTP_GATEWAY
1796 CONFIG_BOOTP_HOSTNAME
1797 CONFIG_BOOTP_NISDOMAIN
1798 CONFIG_BOOTP_BOOTPATH
1799 CONFIG_BOOTP_BOOTFILESIZE
1800 CONFIG_BOOTP_DNS
1801 CONFIG_BOOTP_DNS2
1802 CONFIG_BOOTP_SEND_HOSTNAME
1803 CONFIG_BOOTP_NTPSERVER
1804 CONFIG_BOOTP_TIMEOFFSET
1805 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001806 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001807
Wilson Callan5d110f02007-07-28 10:56:13 -04001808 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1809 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001810
Joe Hershberger2c00e092012-05-23 07:59:19 +00001811 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1812 after the configured retry count, the call will fail
1813 instead of starting over. This can be used to fail over
1814 to Link-local IP address configuration if the DHCP server
1815 is not available.
1816
stroesefe389a82003-08-28 14:17:32 +00001817 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1818 serverip from a DHCP server, it is possible that more
1819 than one DNS serverip is offered to the client.
1820 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1821 serverip will be stored in the additional environment
1822 variable "dnsip2". The first DNS serverip is always
1823 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001824 is defined.
stroesefe389a82003-08-28 14:17:32 +00001825
1826 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1827 to do a dynamic update of a DNS server. To do this, they
1828 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001829 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001830 of the "hostname" environment variable is passed as
1831 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001832
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001833 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1834
1835 A 32bit value in microseconds for a delay between
1836 receiving a "DHCP Offer" and sending the "DHCP Request".
1837 This fixes a problem with certain DHCP servers that don't
1838 respond 100% of the time to a "DHCP request". E.g. On an
1839 AT91RM9200 processor running at 180MHz, this delay needed
1840 to be *at least* 15,000 usec before a Windows Server 2003
1841 DHCP server would reply 100% of the time. I recommend at
1842 least 50,000 usec to be safe. The alternative is to hope
1843 that one of the retries will be successful but note that
1844 the DHCP timeout and retry process takes a longer than
1845 this delay.
1846
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001847 - Link-local IP address negotiation:
1848 Negotiate with other link-local clients on the local network
1849 for an address that doesn't require explicit configuration.
1850 This is especially useful if a DHCP server cannot be guaranteed
1851 to exist in all environments that the device must operate.
1852
1853 See doc/README.link-local for more information.
1854
wdenka3d991b2004-04-15 21:48:45 +00001855 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001856 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001857
1858 The device id used in CDP trigger frames.
1859
1860 CONFIG_CDP_DEVICE_ID_PREFIX
1861
1862 A two character string which is prefixed to the MAC address
1863 of the device.
1864
1865 CONFIG_CDP_PORT_ID
1866
1867 A printf format string which contains the ascii name of
1868 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001869 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001870
1871 CONFIG_CDP_CAPABILITIES
1872
1873 A 32bit integer which indicates the device capabilities;
1874 0x00000010 for a normal host which does not forwards.
1875
1876 CONFIG_CDP_VERSION
1877
1878 An ascii string containing the version of the software.
1879
1880 CONFIG_CDP_PLATFORM
1881
1882 An ascii string containing the name of the platform.
1883
1884 CONFIG_CDP_TRIGGER
1885
1886 A 32bit integer sent on the trigger.
1887
1888 CONFIG_CDP_POWER_CONSUMPTION
1889
1890 A 16bit integer containing the power consumption of the
1891 device in .1 of milliwatts.
1892
1893 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1894
1895 A byte containing the id of the VLAN.
1896
wdenkc6097192002-11-03 00:24:07 +00001897- Status LED: CONFIG_STATUS_LED
1898
1899 Several configurations allow to display the current
1900 status using a LED. For instance, the LED will blink
1901 fast while running U-Boot code, stop blinking as
1902 soon as a reply to a BOOTP request was received, and
1903 start blinking slow once the Linux kernel is running
1904 (supported by a status LED driver in the Linux
1905 kernel). Defining CONFIG_STATUS_LED enables this
1906 feature in U-Boot.
1907
1908- CAN Support: CONFIG_CAN_DRIVER
1909
1910 Defining CONFIG_CAN_DRIVER enables CAN driver support
1911 on those systems that support this (optional)
1912 feature, like the TQM8xxL modules.
1913
1914- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1915
wdenkb37c7e52003-06-30 16:24:52 +00001916 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001917 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001918 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001919
wdenk945af8d2003-07-16 21:53:01 +00001920 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001921 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001922 CONFIG_COMMANDS) and communicate with i2c based realtime
1923 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001924 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001925
Ben Warrenbb99ad62006-09-07 16:50:54 -04001926 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001927
wdenk945af8d2003-07-16 21:53:01 +00001928 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001929 bit-banging) driver instead of CPM or similar hardware
1930 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001931
wdenk945af8d2003-07-16 21:53:01 +00001932 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001933 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001934
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001935 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001936 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001937 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001938 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001939
Peter Tyser8d321b82010-04-12 22:28:21 -05001940 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001941 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001942 and so its address should therefore be cleared to 0 (See,
1943 eg, MPC823e User's Manual p.16-473). So, set
1944 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001945
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001946 CONFIG_SYS_I2C_INIT_MPC5XXX
1947
1948 When a board is reset during an i2c bus transfer
1949 chips might think that the current transfer is still
1950 in progress. Reset the slave devices by sending start
1951 commands until the slave device responds.
1952
wdenk945af8d2003-07-16 21:53:01 +00001953 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001954
1955 If you use the software i2c interface (CONFIG_SOFT_I2C)
1956 then the following macros need to be defined (examples are
1957 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001958
1959 I2C_INIT
1960
wdenkb37c7e52003-06-30 16:24:52 +00001961 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001962 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001963
wdenkba56f622004-02-06 23:19:44 +00001964 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001965
wdenkc6097192002-11-03 00:24:07 +00001966 I2C_PORT
1967
wdenk43d96162003-03-06 00:02:04 +00001968 (Only for MPC8260 CPU). The I/O port to use (the code
1969 assumes both bits are on the same port). Valid values
1970 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001971
1972 I2C_ACTIVE
1973
1974 The code necessary to make the I2C data line active
1975 (driven). If the data line is open collector, this
1976 define can be null.
1977
wdenkb37c7e52003-06-30 16:24:52 +00001978 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1979
wdenkc6097192002-11-03 00:24:07 +00001980 I2C_TRISTATE
1981
1982 The code necessary to make the I2C data line tri-stated
1983 (inactive). If the data line is open collector, this
1984 define can be null.
1985
wdenkb37c7e52003-06-30 16:24:52 +00001986 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1987
wdenkc6097192002-11-03 00:24:07 +00001988 I2C_READ
1989
York Sun472d5462013-04-01 11:29:11 -07001990 Code that returns true if the I2C data line is high,
1991 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001992
wdenkb37c7e52003-06-30 16:24:52 +00001993 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1994
wdenkc6097192002-11-03 00:24:07 +00001995 I2C_SDA(bit)
1996
York Sun472d5462013-04-01 11:29:11 -07001997 If <bit> is true, sets the I2C data line high. If it
1998 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001999
wdenkb37c7e52003-06-30 16:24:52 +00002000 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002001 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002002 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002003
wdenkc6097192002-11-03 00:24:07 +00002004 I2C_SCL(bit)
2005
York Sun472d5462013-04-01 11:29:11 -07002006 If <bit> is true, sets the I2C clock line high. If it
2007 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002008
wdenkb37c7e52003-06-30 16:24:52 +00002009 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002010 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002011 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002012
wdenkc6097192002-11-03 00:24:07 +00002013 I2C_DELAY
2014
2015 This delay is invoked four times per clock cycle so this
2016 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002017 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002018 like:
2019
wdenkb37c7e52003-06-30 16:24:52 +00002020 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002021
Mike Frysinger793b5722010-07-21 13:38:02 -04002022 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2023
2024 If your arch supports the generic GPIO framework (asm/gpio.h),
2025 then you may alternatively define the two GPIOs that are to be
2026 used as SCL / SDA. Any of the previous I2C_xxx macros will
2027 have GPIO-based defaults assigned to them as appropriate.
2028
2029 You should define these to the GPIO value as given directly to
2030 the generic GPIO functions.
2031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002032 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002033
wdenk8bde7f72003-06-27 21:31:46 +00002034 When a board is reset during an i2c bus transfer
2035 chips might think that the current transfer is still
2036 in progress. On some boards it is possible to access
2037 the i2c SCLK line directly, either by using the
2038 processor pin as a GPIO or by having a second pin
2039 connected to the bus. If this option is defined a
2040 custom i2c_init_board() routine in boards/xxx/board.c
2041 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002042
Richard Retanubun26a33502010-04-12 15:08:17 -04002043 CONFIG_SYS_I2C_BOARD_LATE_INIT
2044
2045 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2046 defined a custom i2c_board_late_init() routine in
2047 boards/xxx/board.c is run AFTER the operations in i2c_init()
2048 is completed. This callpoint can be used to unreset i2c bus
2049 using CPU i2c controller register accesses for CPUs whose i2c
2050 controller provide such a method. It is called at the end of
2051 i2c_init() to allow i2c_init operations to setup the i2c bus
2052 controller on the CPU (e.g. setting bus speed & slave address).
2053
wdenk17ea1172004-06-06 21:51:03 +00002054 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2055
2056 This option enables configuration of bi_iic_fast[] flags
2057 in u-boot bd_info structure based on u-boot environment
2058 variable "i2cfast". (see also i2cfast)
2059
Ben Warrenbb99ad62006-09-07 16:50:54 -04002060 CONFIG_I2C_MULTI_BUS
2061
2062 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002063 must have a controller. At any point in time, only one bus is
2064 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002065 Note that bus numbering is zero-based.
2066
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002067 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002068
2069 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002070 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002071 is set, specify a list of bus-device pairs. Otherwise, specify
2072 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002073
2074 e.g.
2075 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002076 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002077
2078 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2079
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002080 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002081 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002082
2083 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2084
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002085 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002086
2087 If defined, then this indicates the I2C bus number for DDR SPD.
2088 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2089
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002090 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002091
2092 If defined, then this indicates the I2C bus number for the RTC.
2093 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2094
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002095 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002096
2097 If defined, then this indicates the I2C bus number for the DTT.
2098 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2099
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002100 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002101
2102 If defined, specifies the I2C address of the DTT device.
2103 If not defined, then U-Boot uses predefined value for
2104 specified DTT device.
2105
Timur Tabibe5e6182006-11-03 19:15:00 -06002106 CONFIG_FSL_I2C
2107
2108 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01002109 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06002110
Heiko Schocher67b23a32008-10-15 09:39:47 +02002111 CONFIG_I2C_MUX
2112
2113 Define this option if you have I2C devices reached over 1 .. n
2114 I2C Muxes like the pca9544a. This option addes a new I2C
2115 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
2116 new I2C Bus to the existing I2C Busses. If you select the
2117 new Bus with "i2c dev", u-bbot sends first the commandos for
2118 the muxes to activate this new "bus".
2119
2120 CONFIG_I2C_MULTI_BUS must be also defined, to use this
2121 feature!
2122
2123 Example:
2124 Adding a new I2C Bus reached over 2 pca9544a muxes
2125 The First mux with address 70 and channel 6
2126 The Second mux with address 71 and channel 4
2127
2128 => i2c bus pca9544a:70:6:pca9544a:71:4
2129
2130 Use the "i2c bus" command without parameter, to get a list
2131 of I2C Busses with muxes:
2132
2133 => i2c bus
2134 Busses reached over muxes:
2135 Bus ID: 2
2136 reached over Mux(es):
2137 pca9544a@70 ch: 4
2138 Bus ID: 3
2139 reached over Mux(es):
2140 pca9544a@70 ch: 6
2141 pca9544a@71 ch: 4
2142 =>
2143
2144 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00002145 u-boot first sends the command to the mux@70 to enable
2146 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02002147 the channel 4.
2148
2149 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002150 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002151 the 2 muxes.
2152
2153 This option is actually implemented for the bitbanging
2154 algorithm in common/soft_i2c.c and for the Hardware I2C
2155 Bus on the MPC8260. But it should be not so difficult
2156 to add this option to other architectures.
2157
Andrew Dyer2ac69852008-12-29 17:36:01 -06002158 CONFIG_SOFT_I2C_READ_REPEATED_START
2159
2160 defining this will force the i2c_read() function in
2161 the soft_i2c driver to perform an I2C repeated start
2162 between writing the address pointer and reading the
2163 data. If this define is omitted the default behaviour
2164 of doing a stop-start sequence will be used. Most I2C
2165 devices can use either method, but some require one or
2166 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002167
wdenkc6097192002-11-03 00:24:07 +00002168- SPI Support: CONFIG_SPI
2169
2170 Enables SPI driver (so far only tested with
2171 SPI EEPROM, also an instance works with Crystal A/D and
2172 D/As on the SACSng board)
2173
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002174 CONFIG_SH_SPI
2175
2176 Enables the driver for SPI controller on SuperH. Currently
2177 only SH7757 is supported.
2178
wdenkc6097192002-11-03 00:24:07 +00002179 CONFIG_SPI_X
2180
2181 Enables extended (16-bit) SPI EEPROM addressing.
2182 (symmetrical to CONFIG_I2C_X)
2183
2184 CONFIG_SOFT_SPI
2185
wdenk43d96162003-03-06 00:02:04 +00002186 Enables a software (bit-bang) SPI driver rather than
2187 using hardware support. This is a general purpose
2188 driver that only requires three general I/O port pins
2189 (two outputs, one input) to function. If this is
2190 defined, the board configuration must define several
2191 SPI configuration items (port pins to use, etc). For
2192 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002193
Ben Warren04a9e112008-01-16 22:37:35 -05002194 CONFIG_HARD_SPI
2195
2196 Enables a hardware SPI driver for general-purpose reads
2197 and writes. As with CONFIG_SOFT_SPI, the board configuration
2198 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002199 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002200 example, see include/configs/mpc8349emds.h.
2201
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002202 CONFIG_MXC_SPI
2203
2204 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002205 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002206
Matthias Fuchs01335022007-12-27 17:12:34 +01002207- FPGA Support: CONFIG_FPGA
2208
2209 Enables FPGA subsystem.
2210
2211 CONFIG_FPGA_<vendor>
2212
2213 Enables support for specific chip vendors.
2214 (ALTERA, XILINX)
2215
2216 CONFIG_FPGA_<family>
2217
2218 Enables support for FPGA family.
2219 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2220
2221 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002222
wdenk43d96162003-03-06 00:02:04 +00002223 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002224
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002225 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002226
wdenk8bde7f72003-06-27 21:31:46 +00002227 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002228
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002229 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002230
wdenk43d96162003-03-06 00:02:04 +00002231 Enable checks on FPGA configuration interface busy
2232 status by the configuration function. This option
2233 will require a board or device specific function to
2234 be written.
wdenkc6097192002-11-03 00:24:07 +00002235
2236 CONFIG_FPGA_DELAY
2237
2238 If defined, a function that provides delays in the FPGA
2239 configuration driver.
2240
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002241 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002242 Allow Control-C to interrupt FPGA configuration
2243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002244 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002245
wdenk43d96162003-03-06 00:02:04 +00002246 Check for configuration errors during FPGA bitfile
2247 loading. For example, abort during Virtex II
2248 configuration if the INIT_B line goes low (which
2249 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002250
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002251 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002252
wdenk43d96162003-03-06 00:02:04 +00002253 Maximum time to wait for the INIT_B line to deassert
2254 after PROB_B has been deasserted during a Virtex II
2255 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002256 ms.
wdenkc6097192002-11-03 00:24:07 +00002257
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002258 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002259
wdenk43d96162003-03-06 00:02:04 +00002260 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002261 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002263 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002264
wdenk43d96162003-03-06 00:02:04 +00002265 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002266 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002267
2268- Configuration Management:
2269 CONFIG_IDENT_STRING
2270
wdenk43d96162003-03-06 00:02:04 +00002271 If defined, this string will be added to the U-Boot
2272 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002273
2274- Vendor Parameter Protection:
2275
wdenk43d96162003-03-06 00:02:04 +00002276 U-Boot considers the values of the environment
2277 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002278 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002279 are set once by the board vendor / manufacturer, and
2280 protects these variables from casual modification by
2281 the user. Once set, these variables are read-only,
2282 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002283 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002284
2285 If CONFIG_ENV_OVERWRITE is #defined in your config
2286 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002287 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002288 these parameters.
2289
2290 Alternatively, if you #define _both_ CONFIG_ETHADDR
2291 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002292 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002293 which can be changed exactly ONCE by the user. [The
2294 serial# is unaffected by this, i. e. it remains
2295 read-only.]
2296
Joe Hershberger25980902012-12-11 22:16:31 -06002297 The same can be accomplished in a more flexible way
2298 for any variable by configuring the type of access
2299 to allow for those variables in the ".flags" variable
2300 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2301
wdenkc6097192002-11-03 00:24:07 +00002302- Protected RAM:
2303 CONFIG_PRAM
2304
2305 Define this variable to enable the reservation of
2306 "protected RAM", i. e. RAM which is not overwritten
2307 by U-Boot. Define CONFIG_PRAM to hold the number of
2308 kB you want to reserve for pRAM. You can overwrite
2309 this default value by defining an environment
2310 variable "pram" to the number of kB you want to
2311 reserve. Note that the board info structure will
2312 still show the full amount of RAM. If pRAM is
2313 reserved, a new environment variable "mem" will
2314 automatically be defined to hold the amount of
2315 remaining RAM in a form that can be passed as boot
2316 argument to Linux, for instance like that:
2317
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002318 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002319 saveenv
2320
2321 This way you can tell Linux not to use this memory,
2322 either, which results in a memory region that will
2323 not be affected by reboots.
2324
2325 *WARNING* If your board configuration uses automatic
2326 detection of the RAM size, you must make sure that
2327 this memory test is non-destructive. So far, the
2328 following board configurations are known to be
2329 "pRAM-clean":
2330
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002331 IVMS8, IVML24, SPD8xx, TQM8xxL,
2332 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002333 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002334
Gabe Black40fef042012-12-02 04:55:18 +00002335- Access to physical memory region (> 4GB)
2336 Some basic support is provided for operations on memory not
2337 normally accessible to U-Boot - e.g. some architectures
2338 support access to more than 4GB of memory on 32-bit
2339 machines using physical address extension or similar.
2340 Define CONFIG_PHYSMEM to access this basic support, which
2341 currently only supports clearing the memory.
2342
wdenkc6097192002-11-03 00:24:07 +00002343- Error Recovery:
2344 CONFIG_PANIC_HANG
2345
2346 Define this variable to stop the system in case of a
2347 fatal error, so that you have to reset it manually.
2348 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002349 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002350 automatically as fast as possible, but it may be
2351 useful during development since you can try to debug
2352 the conditions that lead to the situation.
2353
2354 CONFIG_NET_RETRY_COUNT
2355
wdenk43d96162003-03-06 00:02:04 +00002356 This variable defines the number of retries for
2357 network operations like ARP, RARP, TFTP, or BOOTP
2358 before giving up the operation. If not defined, a
2359 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002360
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002361 CONFIG_ARP_TIMEOUT
2362
2363 Timeout waiting for an ARP reply in milliseconds.
2364
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002365 CONFIG_NFS_TIMEOUT
2366
2367 Timeout in milliseconds used in NFS protocol.
2368 If you encounter "ERROR: Cannot umount" in nfs command,
2369 try longer timeout such as
2370 #define CONFIG_NFS_TIMEOUT 10000UL
2371
wdenkc6097192002-11-03 00:24:07 +00002372- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002373 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002374
2375 Enable auto completion of commands using TAB.
2376
Wolfgang Denka9398e02006-11-27 15:32:42 +01002377 Note that this feature has NOT been implemented yet
2378 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002379
2380
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002381 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002382
2383 Define this variable to enable the "hush" shell (from
2384 Busybox) as command line interpreter, thus enabling
2385 powerful command line syntax like
2386 if...then...else...fi conditionals or `&&' and '||'
2387 constructs ("shell scripts").
2388
2389 If undefined, you get the old, much simpler behaviour
2390 with a somewhat smaller memory footprint.
2391
2392
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002393 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002394
2395 This defines the secondary prompt string, which is
2396 printed when the command interpreter needs more input
2397 to complete a command. Usually "> ".
2398
2399 Note:
2400
wdenk8bde7f72003-06-27 21:31:46 +00002401 In the current implementation, the local variables
2402 space and global environment variables space are
2403 separated. Local variables are those you define by
2404 simply typing `name=value'. To access a local
2405 variable later on, you have write `$name' or
2406 `${name}'; to execute the contents of a variable
2407 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002408
wdenk43d96162003-03-06 00:02:04 +00002409 Global environment variables are those you use
2410 setenv/printenv to work with. To run a command stored
2411 in such a variable, you need to use the run command,
2412 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002413
2414 To store commands and special characters in a
2415 variable, please use double quotation marks
2416 surrounding the whole text of the variable, instead
2417 of the backslashes before semicolons and special
2418 symbols.
2419
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002420- Commandline Editing and History:
2421 CONFIG_CMDLINE_EDITING
2422
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002423 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002424 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002425
wdenka8c7c702003-12-06 19:49:23 +00002426- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002427 CONFIG_EXTRA_ENV_SETTINGS
2428
wdenk43d96162003-03-06 00:02:04 +00002429 Define this to contain any number of null terminated
2430 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002431 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002432
wdenk43d96162003-03-06 00:02:04 +00002433 For example, place something like this in your
2434 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002435
2436 #define CONFIG_EXTRA_ENV_SETTINGS \
2437 "myvar1=value1\0" \
2438 "myvar2=value2\0"
2439
wdenk43d96162003-03-06 00:02:04 +00002440 Warning: This method is based on knowledge about the
2441 internal format how the environment is stored by the
2442 U-Boot code. This is NOT an official, exported
2443 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002444 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002445 You better know what you are doing here.
2446
wdenk43d96162003-03-06 00:02:04 +00002447 Note: overly (ab)use of the default environment is
2448 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002449 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002450 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002451
Stephen Warren5e724ca2012-05-22 09:21:54 +00002452 CONFIG_ENV_VARS_UBOOT_CONFIG
2453
2454 Define this in order to add variables describing the
2455 U-Boot build configuration to the default environment.
2456 These will be named arch, cpu, board, vendor, and soc.
2457
2458 Enabling this option will cause the following to be defined:
2459
2460 - CONFIG_SYS_ARCH
2461 - CONFIG_SYS_CPU
2462 - CONFIG_SYS_BOARD
2463 - CONFIG_SYS_VENDOR
2464 - CONFIG_SYS_SOC
2465
Tom Rini7e27f892012-10-24 07:28:16 +00002466 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2467
2468 Define this in order to add variables describing certain
2469 run-time determined information about the hardware to the
2470 environment. These will be named board_name, board_rev.
2471
Simon Glass06fd8532012-11-30 13:01:17 +00002472 CONFIG_DELAY_ENVIRONMENT
2473
2474 Normally the environment is loaded when the board is
2475 intialised so that it is available to U-Boot. This inhibits
2476 that so that the environment is not available until
2477 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2478 this is instead controlled by the value of
2479 /config/load-environment.
2480
wdenka8c7c702003-12-06 19:49:23 +00002481- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002482 CONFIG_HAS_DATAFLASH
2483
wdenk8bde7f72003-06-27 21:31:46 +00002484 Defining this option enables DataFlash features and
2485 allows to read/write in Dataflash via the standard
2486 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002487
Eric Nelsonf61ec452012-01-31 10:52:08 -07002488- Serial Flash support
2489 CONFIG_CMD_SF
2490
2491 Defining this option enables SPI flash commands
2492 'sf probe/read/write/erase/update'.
2493
2494 Usage requires an initial 'probe' to define the serial
2495 flash parameters, followed by read/write/erase/update
2496 commands.
2497
2498 The following defaults may be provided by the platform
2499 to handle the common case when only a single serial
2500 flash is present on the system.
2501
2502 CONFIG_SF_DEFAULT_BUS Bus identifier
2503 CONFIG_SF_DEFAULT_CS Chip-select
2504 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2505 CONFIG_SF_DEFAULT_SPEED in Hz
2506
Simon Glass24007272012-10-08 13:16:02 +00002507 CONFIG_CMD_SF_TEST
2508
2509 Define this option to include a destructive SPI flash
2510 test ('sf test').
2511
Jagannadha Sutradharudu Teki1dcd6d02013-06-19 15:33:58 +05302512 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg
2513
2514 Define this option to use the Bank addr/Extended addr
2515 support on SPI flashes which has size > 16Mbytes.
2516
wdenk3f85ce22004-02-23 16:11:30 +00002517- SystemACE Support:
2518 CONFIG_SYSTEMACE
2519
2520 Adding this option adds support for Xilinx SystemACE
2521 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002522 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002523 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002524
2525 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002526 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002527
2528 When SystemACE support is added, the "ace" device type
2529 becomes available to the fat commands, i.e. fatls.
2530
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002531- TFTP Fixed UDP Port:
2532 CONFIG_TFTP_PORT
2533
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002534 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002535 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002536 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002537 number generator is used.
2538
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002539 Also, the environment variable tftpdstp is used to supply
2540 the TFTP UDP destination port value. If tftpdstp isn't
2541 defined, the normal port 69 is used.
2542
2543 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002544 blindly start the TFTP transfer using the pre-configured
2545 target IP address and UDP port. This has the effect of
2546 "punching through" the (Windows XP) firewall, allowing
2547 the remainder of the TFTP transfer to proceed normally.
2548 A better solution is to properly configure the firewall,
2549 but sometimes that is not allowed.
2550
Simon Glassbf36c5d2012-12-05 14:46:38 +00002551- Hashing support:
2552 CONFIG_CMD_HASH
2553
2554 This enables a generic 'hash' command which can produce
2555 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2556
2557 CONFIG_HASH_VERIFY
2558
2559 Enable the hash verify command (hash -v). This adds to code
2560 size a little.
2561
2562 CONFIG_SHA1 - support SHA1 hashing
2563 CONFIG_SHA256 - support SHA256 hashing
2564
2565 Note: There is also a sha1sum command, which should perhaps
2566 be deprecated in favour of 'hash sha1'.
2567
wdenka8c7c702003-12-06 19:49:23 +00002568- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002569 CONFIG_SHOW_BOOT_PROGRESS
2570
wdenk43d96162003-03-06 00:02:04 +00002571 Defining this option allows to add some board-
2572 specific code (calling a user-provided function
2573 "show_boot_progress(int)") that enables you to show
2574 the system's boot progress on some display (for
2575 example, some LED's) on your board. At the moment,
2576 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002577
Simon Glass3a608ca2012-02-13 13:51:19 +00002578- Detailed boot stage timing
2579 CONFIG_BOOTSTAGE
2580 Define this option to get detailed timing of each stage
2581 of the boot process.
2582
2583 CONFIG_BOOTSTAGE_USER_COUNT
2584 This is the number of available user bootstage records.
2585 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2586 a new ID will be allocated from this stash. If you exceed
2587 the limit, recording will stop.
2588
2589 CONFIG_BOOTSTAGE_REPORT
2590 Define this to print a report before boot, similar to this:
2591
2592 Timer summary in microseconds:
2593 Mark Elapsed Stage
2594 0 0 reset
2595 3,575,678 3,575,678 board_init_f start
2596 3,575,695 17 arch_cpu_init A9
2597 3,575,777 82 arch_cpu_init done
2598 3,659,598 83,821 board_init_r start
2599 3,910,375 250,777 main_loop
2600 29,916,167 26,005,792 bootm_start
2601 30,361,327 445,160 start_kernel
2602
Simon Glass2eba38c2012-09-28 08:56:39 +00002603 CONFIG_CMD_BOOTSTAGE
2604 Add a 'bootstage' command which supports printing a report
2605 and un/stashing of bootstage data.
2606
Simon Glass94fd1312012-09-28 08:56:37 +00002607 CONFIG_BOOTSTAGE_FDT
2608 Stash the bootstage information in the FDT. A root 'bootstage'
2609 node is created with each bootstage id as a child. Each child
2610 has a 'name' property and either 'mark' containing the
2611 mark time in microsecond, or 'accum' containing the
2612 accumulated time for that bootstage id in microseconds.
2613 For example:
2614
2615 bootstage {
2616 154 {
2617 name = "board_init_f";
2618 mark = <3575678>;
2619 };
2620 170 {
2621 name = "lcd";
2622 accum = <33482>;
2623 };
2624 };
2625
2626 Code in the Linux kernel can find this in /proc/devicetree.
2627
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002628Legacy uImage format:
2629
wdenkc6097192002-11-03 00:24:07 +00002630 Arg Where When
2631 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002632 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002633 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002634 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002635 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002636 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002637 4 common/cmd_bootm.c Image data has correct checksum
2638 -4 common/cmd_bootm.c Image is for unsupported architecture
2639 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002640 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002641 6 common/cmd_bootm.c Image Type check OK
2642 -6 common/cmd_bootm.c gunzip uncompression error
2643 -7 common/cmd_bootm.c Unimplemented compression type
2644 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002645 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002646 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002647
2648 9 common/image.c Start initial ramdisk verification
2649 -10 common/image.c Ramdisk header has bad magic number
2650 -11 common/image.c Ramdisk header has bad checksum
2651 10 common/image.c Ramdisk header is OK
2652 -12 common/image.c Ramdisk data has bad checksum
2653 11 common/image.c Ramdisk data has correct checksum
2654 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002655 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002656 13 common/image.c Start multifile image verification
2657 14 common/image.c No initial ramdisk, no multifile, continue.
2658
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002659 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002660
Stefan Roesea47a12b2010-04-15 16:07:28 +02002661 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002662 -31 post/post.c POST test failed, detected by post_output_backlog()
2663 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002664
Heiko Schocher566a4942007-06-22 19:11:54 +02002665 34 common/cmd_doc.c before loading a Image from a DOC device
2666 -35 common/cmd_doc.c Bad usage of "doc" command
2667 35 common/cmd_doc.c correct usage of "doc" command
2668 -36 common/cmd_doc.c No boot device
2669 36 common/cmd_doc.c correct boot device
2670 -37 common/cmd_doc.c Unknown Chip ID on boot device
2671 37 common/cmd_doc.c correct chip ID found, device available
2672 -38 common/cmd_doc.c Read Error on boot device
2673 38 common/cmd_doc.c reading Image header from DOC device OK
2674 -39 common/cmd_doc.c Image header has bad magic number
2675 39 common/cmd_doc.c Image header has correct magic number
2676 -40 common/cmd_doc.c Error reading Image from DOC device
2677 40 common/cmd_doc.c Image header has correct magic number
2678 41 common/cmd_ide.c before loading a Image from a IDE device
2679 -42 common/cmd_ide.c Bad usage of "ide" command
2680 42 common/cmd_ide.c correct usage of "ide" command
2681 -43 common/cmd_ide.c No boot device
2682 43 common/cmd_ide.c boot device found
2683 -44 common/cmd_ide.c Device not available
2684 44 common/cmd_ide.c Device available
2685 -45 common/cmd_ide.c wrong partition selected
2686 45 common/cmd_ide.c partition selected
2687 -46 common/cmd_ide.c Unknown partition table
2688 46 common/cmd_ide.c valid partition table found
2689 -47 common/cmd_ide.c Invalid partition type
2690 47 common/cmd_ide.c correct partition type
2691 -48 common/cmd_ide.c Error reading Image Header on boot device
2692 48 common/cmd_ide.c reading Image Header from IDE device OK
2693 -49 common/cmd_ide.c Image header has bad magic number
2694 49 common/cmd_ide.c Image header has correct magic number
2695 -50 common/cmd_ide.c Image header has bad checksum
2696 50 common/cmd_ide.c Image header has correct checksum
2697 -51 common/cmd_ide.c Error reading Image from IDE device
2698 51 common/cmd_ide.c reading Image from IDE device OK
2699 52 common/cmd_nand.c before loading a Image from a NAND device
2700 -53 common/cmd_nand.c Bad usage of "nand" command
2701 53 common/cmd_nand.c correct usage of "nand" command
2702 -54 common/cmd_nand.c No boot device
2703 54 common/cmd_nand.c boot device found
2704 -55 common/cmd_nand.c Unknown Chip ID on boot device
2705 55 common/cmd_nand.c correct chip ID found, device available
2706 -56 common/cmd_nand.c Error reading Image Header on boot device
2707 56 common/cmd_nand.c reading Image Header from NAND device OK
2708 -57 common/cmd_nand.c Image header has bad magic number
2709 57 common/cmd_nand.c Image header has correct magic number
2710 -58 common/cmd_nand.c Error reading Image from NAND device
2711 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002712
Heiko Schocher566a4942007-06-22 19:11:54 +02002713 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002714
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002715 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002716 -64 net/eth.c no Ethernet found.
2717 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002718
Heiko Schocher566a4942007-06-22 19:11:54 +02002719 -80 common/cmd_net.c usage wrong
2720 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002721 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002722 81 common/cmd_net.c NetLoop() back without error
2723 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2724 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002725 83 common/cmd_net.c running "source" command
2726 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002727 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002728
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002729FIT uImage format:
2730
2731 Arg Where When
2732 100 common/cmd_bootm.c Kernel FIT Image has correct format
2733 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2734 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2735 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2736 102 common/cmd_bootm.c Kernel unit name specified
2737 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002738 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002739 104 common/cmd_bootm.c Got kernel subimage node offset
2740 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2741 105 common/cmd_bootm.c Kernel subimage hash verification OK
2742 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2743 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002744 -106 common/cmd_bootm.c Kernel subimage has wrong type
2745 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002746 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2747 108 common/cmd_bootm.c Got kernel subimage data/size
2748 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2749 -109 common/cmd_bootm.c Can't get kernel subimage type
2750 -110 common/cmd_bootm.c Can't get kernel subimage comp
2751 -111 common/cmd_bootm.c Can't get kernel subimage os
2752 -112 common/cmd_bootm.c Can't get kernel subimage load address
2753 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2754
2755 120 common/image.c Start initial ramdisk verification
2756 -120 common/image.c Ramdisk FIT image has incorrect format
2757 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002758 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002759 -122 common/image.c Can't get configuration for ramdisk subimage
2760 123 common/image.c Ramdisk unit name specified
2761 -124 common/image.c Can't get ramdisk subimage node offset
2762 125 common/image.c Got ramdisk subimage node offset
2763 -125 common/image.c Ramdisk subimage hash verification failed
2764 126 common/image.c Ramdisk subimage hash verification OK
2765 -126 common/image.c Ramdisk subimage for unsupported architecture
2766 127 common/image.c Architecture check OK
2767 -127 common/image.c Can't get ramdisk subimage data/size
2768 128 common/image.c Got ramdisk subimage data/size
2769 129 common/image.c Can't get ramdisk load address
2770 -129 common/image.c Got ramdisk load address
2771
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002772 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002773 131 common/cmd_doc.c FIT image format OK
2774
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002775 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002776 141 common/cmd_ide.c FIT image format OK
2777
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002778 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002779 151 common/cmd_nand.c FIT image format OK
2780
Gabe Blackd95f6ec2012-10-25 16:31:10 +00002781- FIT image support:
2782 CONFIG_FIT
2783 Enable support for the FIT uImage format.
2784
2785 CONFIG_FIT_BEST_MATCH
2786 When no configuration is explicitly selected, default to the
2787 one whose fdt's compatibility field best matches that of
2788 U-Boot itself. A match is considered "best" if it matches the
2789 most specific compatibility entry of U-Boot's fdt's root node.
2790 The order of entries in the configuration's fdt is ignored.
2791
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002792- Standalone program support:
2793 CONFIG_STANDALONE_LOAD_ADDR
2794
Wolfgang Denk6feff892011-10-09 21:06:34 +02002795 This option defines a board specific value for the
2796 address where standalone program gets loaded, thus
2797 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002798 settings.
2799
2800- Frame Buffer Address:
2801 CONFIG_FB_ADDR
2802
2803 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002804 address for frame buffer. This is typically the case
2805 when using a graphics controller has separate video
2806 memory. U-Boot will then place the frame buffer at
2807 the given address instead of dynamically reserving it
2808 in system RAM by calling lcd_setmem(), which grabs
2809 the memory for the frame buffer depending on the
2810 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002811
2812 Please see board_init_f function.
2813
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002814- Automatic software updates via TFTP server
2815 CONFIG_UPDATE_TFTP
2816 CONFIG_UPDATE_TFTP_CNT_MAX
2817 CONFIG_UPDATE_TFTP_MSEC_MAX
2818
2819 These options enable and control the auto-update feature;
2820 for a more detailed description refer to doc/README.update.
2821
2822- MTD Support (mtdparts command, UBI support)
2823 CONFIG_MTD_DEVICE
2824
2825 Adds the MTD device infrastructure from the Linux kernel.
2826 Needed for mtdparts command support.
2827
2828 CONFIG_MTD_PARTITIONS
2829
2830 Adds the MTD partitioning infrastructure from the Linux
2831 kernel. Needed for UBI support.
2832
Joe Hershberger70c219c2013-04-08 10:32:48 +00002833- UBI support
2834 CONFIG_CMD_UBI
2835
2836 Adds commands for interacting with MTD partitions formatted
2837 with the UBI flash translation layer
2838
2839 Requires also defining CONFIG_RBTREE
2840
Joe Hershberger147162d2013-04-08 10:32:49 +00002841 CONFIG_UBI_SILENCE_MSG
2842
2843 Make the verbose messages from UBI stop printing. This leaves
2844 warnings and errors enabled.
2845
Joe Hershberger70c219c2013-04-08 10:32:48 +00002846- UBIFS support
2847 CONFIG_CMD_UBIFS
2848
2849 Adds commands for interacting with UBI volumes formatted as
2850 UBIFS. UBIFS is read-only in u-boot.
2851
2852 Requires UBI support as well as CONFIG_LZO
2853
Joe Hershberger147162d2013-04-08 10:32:49 +00002854 CONFIG_UBIFS_SILENCE_MSG
2855
2856 Make the verbose messages from UBIFS stop printing. This leaves
2857 warnings and errors enabled.
2858
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002859- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002860 CONFIG_SPL
2861 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002862
Tom Rini95579792012-02-14 07:29:40 +00002863 CONFIG_SPL_LDSCRIPT
2864 LDSCRIPT for linking the SPL binary.
2865
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002866 CONFIG_SPL_MAX_FOOTPRINT
2867 Maximum size in memory allocated to the SPL, BSS included.
2868 When defined, the linker checks that the actual memory
2869 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002870 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002871 must not be both defined at the same time.
2872
Tom Rini95579792012-02-14 07:29:40 +00002873 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002874 Maximum size of the SPL image (text, data, rodata, and
2875 linker lists sections), BSS excluded.
2876 When defined, the linker checks that the actual size does
2877 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00002878
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002879 CONFIG_SPL_TEXT_BASE
2880 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002881
Scott Wood94a45bb2012-09-20 19:05:12 -05002882 CONFIG_SPL_RELOC_TEXT_BASE
2883 Address to relocate to. If unspecified, this is equal to
2884 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
2885
Tom Rini95579792012-02-14 07:29:40 +00002886 CONFIG_SPL_BSS_START_ADDR
2887 Link address for the BSS within the SPL binary.
2888
2889 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002890 Maximum size in memory allocated to the SPL BSS.
2891 When defined, the linker checks that the actual memory used
2892 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00002893 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00002894 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00002895
2896 CONFIG_SPL_STACK
2897 Adress of the start of the stack SPL will use
2898
Scott Wood94a45bb2012-09-20 19:05:12 -05002899 CONFIG_SPL_RELOC_STACK
2900 Adress of the start of the stack SPL will use after
2901 relocation. If unspecified, this is equal to
2902 CONFIG_SPL_STACK.
2903
Tom Rini95579792012-02-14 07:29:40 +00002904 CONFIG_SYS_SPL_MALLOC_START
2905 Starting address of the malloc pool used in SPL.
2906
2907 CONFIG_SYS_SPL_MALLOC_SIZE
2908 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002909
Tom Rini47f7bca2012-08-13 12:03:19 -07002910 CONFIG_SPL_FRAMEWORK
2911 Enable the SPL framework under common/. This framework
2912 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2913 NAND loading of the Linux Kernel.
2914
Tom Rini861a86f2012-08-13 11:37:56 -07002915 CONFIG_SPL_DISPLAY_PRINT
2916 For ARM, enable an optional function to print more information
2917 about the running system.
2918
Scott Wood4b919722012-09-20 16:35:21 -05002919 CONFIG_SPL_INIT_MINIMAL
2920 Arch init code should be built for a very small image
2921
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002922 CONFIG_SPL_LIBCOMMON_SUPPORT
2923 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002924
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002925 CONFIG_SPL_LIBDISK_SUPPORT
2926 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002927
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002928 CONFIG_SPL_I2C_SUPPORT
2929 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002930
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002931 CONFIG_SPL_GPIO_SUPPORT
2932 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002933
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002934 CONFIG_SPL_MMC_SUPPORT
2935 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002936
Tom Rini95579792012-02-14 07:29:40 +00002937 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2938 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2939 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2940 Address, size and partition on the MMC to load U-Boot from
2941 when the MMC is being used in raw mode.
2942
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00002943 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
2944 Sector to load kernel uImage from when MMC is being
2945 used in raw mode (for Falcon mode)
2946
2947 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
2948 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
2949 Sector and number of sectors to load kernel argument
2950 parameters from when MMC is being used in raw mode
2951 (for falcon mode)
2952
Tom Rini95579792012-02-14 07:29:40 +00002953 CONFIG_SPL_FAT_SUPPORT
2954 Support for fs/fat/libfat.o in SPL binary
2955
2956 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2957 Filename to read to load U-Boot when reading from FAT
2958
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00002959 CONFIG_SPL_FAT_LOAD_KERNEL_NAME
2960 Filename to read to load kernel uImage when reading
2961 from FAT (for Falcon mode)
2962
2963 CONFIG_SPL_FAT_LOAD_ARGS_NAME
2964 Filename to read to load kernel argument parameters
2965 when reading from FAT (for Falcon mode)
2966
Scott Wood06f60ae2012-12-06 13:33:17 +00002967 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
2968 Set this for NAND SPL on PPC mpc83xx targets, so that
2969 start.S waits for the rest of the SPL to load before
2970 continuing (the hardware starts execution after just
2971 loading the first page rather than the full 4K).
2972
Scott Wood6f2f01b2012-09-20 19:09:07 -05002973 CONFIG_SPL_NAND_BASE
2974 Include nand_base.c in the SPL. Requires
2975 CONFIG_SPL_NAND_DRIVERS.
2976
2977 CONFIG_SPL_NAND_DRIVERS
2978 SPL uses normal NAND drivers, not minimal drivers.
2979
2980 CONFIG_SPL_NAND_ECC
2981 Include standard software ECC in the SPL
2982
Tom Rini95579792012-02-14 07:29:40 +00002983 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05002984 Support for NAND boot using simple NAND drivers that
2985 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00002986
2987 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2988 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2989 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2990 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2991 CONFIG_SYS_NAND_ECCBYTES
2992 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05002993 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00002994
2995 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05002996 Location in NAND to read U-Boot from
2997
2998 CONFIG_SYS_NAND_U_BOOT_DST
2999 Location in memory to load U-Boot to
3000
3001 CONFIG_SYS_NAND_U_BOOT_SIZE
3002 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003003
3004 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003005 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003006
3007 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3008 Define this if you need to first read the OOB and then the
3009 data. This is used for example on davinci plattforms.
3010
3011 CONFIG_SPL_OMAP3_ID_NAND
3012 Support for an OMAP3-specific set of functions to return the
3013 ID and MFR of the first attached NAND chip, if present.
3014
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003015 CONFIG_SPL_SERIAL_SUPPORT
3016 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003017
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003018 CONFIG_SPL_SPI_FLASH_SUPPORT
3019 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003020
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003021 CONFIG_SPL_SPI_SUPPORT
3022 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003023
Pavel Machekc57b9532012-08-30 22:42:11 +02003024 CONFIG_SPL_RAM_DEVICE
3025 Support for running image already present in ram, in SPL binary
3026
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003027 CONFIG_SPL_LIBGENERIC_SUPPORT
3028 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003029
Scott Wood74752ba2012-12-06 13:33:16 +00003030 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003031 Image offset to which the SPL should be padded before appending
3032 the SPL payload. By default, this is defined as
3033 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3034 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3035 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003036
Scott Woodca2fca22012-09-21 16:27:32 -05003037 CONFIG_SPL_TARGET
3038 Final target image containing SPL and payload. Some SPLs
3039 use an arch-specific makefile fragment instead, for
3040 example if more than one image needs to be produced.
3041
Simon Glass87ebee32013-05-08 08:05:59 +00003042 CONFIG_FIT_SPL_PRINT
3043 Printing information about a FIT image adds quite a bit of
3044 code to SPL. So this is normally disabled in SPL. Use this
3045 option to re-enable it. This will affect the output of the
3046 bootm command when booting a FIT image.
3047
wdenkc6097192002-11-03 00:24:07 +00003048Modem Support:
3049--------------
3050
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003051[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003052
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003053- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003054 CONFIG_MODEM_SUPPORT
3055
3056- RTS/CTS Flow control enable:
3057 CONFIG_HWFLOW
3058
3059- Modem debug support:
3060 CONFIG_MODEM_SUPPORT_DEBUG
3061
wdenk43d96162003-03-06 00:02:04 +00003062 Enables debugging stuff (char screen[1024], dbg())
3063 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003064
wdenka8c7c702003-12-06 19:49:23 +00003065- Interrupt support (PPC):
3066
wdenkd4ca31c2004-01-02 14:00:00 +00003067 There are common interrupt_init() and timer_interrupt()
3068 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003069 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003070 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003071 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003072 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003073 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003074 specific handling. If board has watchdog / status_led
3075 / other_activity_monitor it works automatically from
3076 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003077
wdenkc6097192002-11-03 00:24:07 +00003078- General:
3079
wdenk43d96162003-03-06 00:02:04 +00003080 In the target system modem support is enabled when a
3081 specific key (key combination) is pressed during
3082 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003083 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003084 board_init(). Currently key_pressed() is a dummy
3085 function, returning 1 and thus enabling modem
3086 initialization.
wdenkc6097192002-11-03 00:24:07 +00003087
wdenk43d96162003-03-06 00:02:04 +00003088 If there are no modem init strings in the
3089 environment, U-Boot proceed to autoboot; the
3090 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003091 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003092
3093 See also: doc/README.Modem
3094
Helmut Raiger9660e442011-10-20 04:19:47 +00003095Board initialization settings:
3096------------------------------
3097
3098During Initialization u-boot calls a number of board specific functions
3099to allow the preparation of board specific prerequisites, e.g. pin setup
3100before drivers are initialized. To enable these callbacks the
3101following configuration macros have to be defined. Currently this is
3102architecture specific, so please check arch/your_architecture/lib/board.c
3103typically in board_init_f() and board_init_r().
3104
3105- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3106- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3107- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3108- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003109
wdenkc6097192002-11-03 00:24:07 +00003110Configuration Settings:
3111-----------------------
3112
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003113- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003114 undefine this when you're short of memory.
3115
Peter Tyser2fb26042009-01-27 18:03:12 -06003116- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3117 width of the commands listed in the 'help' command output.
3118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003120 prompt for user input.
3121
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003122- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003124- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003125
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003126- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003127
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003128- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003129 the application (usually a Linux kernel) when it is
3130 booted
3131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003132- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003133 List of legal baudrate settings for this board.
3134
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003135- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003136 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003137
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003138- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003139 If the board specific function
3140 extern int overwrite_console (void);
3141 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003142 serial port, else the settings in the environment are used.
3143
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003144- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003145 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003146
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003147- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003148 Enable overwrite of previous console environment settings.
3149
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003150- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003151 Begin and End addresses of the area used by the
3152 simple memory test.
3153
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003154- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003155 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003156
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003157- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003158 Scratch address used by the alternate memory test
3159 You only need to set this if address zero isn't writeable
3160
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003161- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
3162 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003163 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003164 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003165 fixing up gd->ram_size the Linux kernel should gets passed
3166 the now "corrected" memory size and won't touch it either.
3167 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003168 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003169 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003170 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003171
3172 This option can be used as a workaround for the 440EPx/GRx
3173 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3174 be touched.
3175
3176 WARNING: Please make sure that this value is a multiple of
3177 the Linux page size (normally 4k). If this is not the case,
3178 then the end address of the Linux memory will be located at a
3179 non page size aligned address and this could cause major
3180 problems.
3181
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003182- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003183 Enable temporary baudrate change while serial download
3184
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003185- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003186 Physical start address of SDRAM. _Must_ be 0 here.
3187
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003188- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003189 Physical start address of Motherboard I/O (if using a
3190 Cogent motherboard)
3191
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003192- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003193 Physical start address of Flash memory.
3194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003195- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003196 Physical start address of boot monitor code (set by
3197 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003198 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003199 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003201- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003202 Size of memory reserved for monitor code, used to
3203 determine _at_compile_time_ (!) if the environment is
3204 embedded within the U-Boot image, or in a separate
3205 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003206
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003207- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003208 Size of DRAM reserved for malloc() use.
3209
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003210- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003211 Normally compressed uImages are limited to an
3212 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003213 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003214 to adjust this setting to your needs.
3215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003216- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003217 Maximum size of memory mapped by the startup code of
3218 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003219 the Linux kernel (bd_info, boot arguments, FDT blob if
3220 used) must be put below this limit, unless "bootm_low"
3221 enviroment variable is defined and non-zero. In such case
3222 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003223 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003224 variable "bootm_mapsize" will override the value of
3225 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3226 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003227
John Rigbyfca43cc2010-10-13 13:57:35 -06003228- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3229 Enable initrd_high functionality. If defined then the
3230 initrd_high feature is enabled and the bootm ramdisk subcommand
3231 is enabled.
3232
3233- CONFIG_SYS_BOOT_GET_CMDLINE:
3234 Enables allocating and saving kernel cmdline in space between
3235 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3236
3237- CONFIG_SYS_BOOT_GET_KBD:
3238 Enables allocating and saving a kernel copy of the bd_info in
3239 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3240
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003241- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003242 Max number of Flash memory banks
3243
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003244- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003245 Max number of sectors on a Flash chip
3246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003247- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003248 Timeout for Flash erase operations (in ms)
3249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003250- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003251 Timeout for Flash write operations (in ms)
3252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003253- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003254 Timeout for Flash set sector lock bit operation (in ms)
3255
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003256- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003257 Timeout for Flash clear lock bits operation (in ms)
3258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003259- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003260 If defined, hardware flash sectors protection is used
3261 instead of U-Boot software protection.
3262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003263- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003264
3265 Enable TFTP transfers directly to flash memory;
3266 without this option such a download has to be
3267 performed in two steps: (1) download to RAM, and (2)
3268 copy from RAM to flash.
3269
3270 The two-step approach is usually more reliable, since
3271 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003272 the flash, but in some situations (when system RAM is
3273 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003274 downloaded image) this option may be very useful.
3275
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003276- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003277 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003278 common flash structure for storing flash geometry.
3279
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003280- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003281 This option also enables the building of the cfi_flash driver
3282 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003283
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003284- CONFIG_FLASH_CFI_MTD
3285 This option enables the building of the cfi_mtd driver
3286 in the drivers directory. The driver exports CFI flash
3287 to the MTD layer.
3288
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003289- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003290 Use buffered writes to flash.
3291
3292- CONFIG_FLASH_SPANSION_S29WS_N
3293 s29ws-n MirrorBit flash has non-standard addresses for buffered
3294 write commands.
3295
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003296- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003297 If this option is defined, the common CFI flash doesn't
3298 print it's warning upon not recognized FLASH banks. This
3299 is useful, if some of the configured banks are only
3300 optionally available.
3301
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003302- CONFIG_FLASH_SHOW_PROGRESS
3303 If defined (must be an integer), print out countdown
3304 digits and dots. Recommended value: 45 (9..1) for 80
3305 column displays, 15 (3..1) for 40 column displays.
3306
Stefan Roese352ef3f2013-04-04 15:53:14 +02003307- CONFIG_FLASH_VERIFY
3308 If defined, the content of the flash (destination) is compared
3309 against the source after the write operation. An error message
3310 will be printed when the contents are not identical.
3311 Please note that this option is useless in nearly all cases,
3312 since such flash programming errors usually are detected earlier
3313 while unprotecting/erasing/programming. Please only enable
3314 this option if you really know what you are doing.
3315
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003316- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003317 Defines the number of Ethernet receive buffers. On some
3318 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003319 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3320 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003321 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003322 Defaults to 4 if not defined.
3323
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003324- CONFIG_ENV_MAX_ENTRIES
3325
Wolfgang Denk071bc922010-10-27 22:48:30 +02003326 Maximum number of entries in the hash table that is used
3327 internally to store the environment settings. The default
3328 setting is supposed to be generous and should work in most
3329 cases. This setting can be used to tune behaviour; see
3330 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003331
Joe Hershberger25980902012-12-11 22:16:31 -06003332- CONFIG_ENV_FLAGS_LIST_DEFAULT
3333- CONFIG_ENV_FLAGS_LIST_STATIC
3334 Enable validation of the values given to enviroment variables when
3335 calling env set. Variables can be restricted to only decimal,
3336 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3337 the variables can also be restricted to IP address or MAC address.
3338
3339 The format of the list is:
3340 type_attribute = [s|d|x|b|i|m]
Joe Hershberger267541f2012-12-11 22:16:34 -06003341 access_atribute = [a|r|o|c]
3342 attributes = type_attribute[access_atribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003343 entry = variable_name[:attributes]
3344 list = entry[,list]
3345
3346 The type attributes are:
3347 s - String (default)
3348 d - Decimal
3349 x - Hexadecimal
3350 b - Boolean ([1yYtT|0nNfF])
3351 i - IP address
3352 m - MAC address
3353
Joe Hershberger267541f2012-12-11 22:16:34 -06003354 The access attributes are:
3355 a - Any (default)
3356 r - Read-only
3357 o - Write-once
3358 c - Change-default
3359
Joe Hershberger25980902012-12-11 22:16:31 -06003360 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3361 Define this to a list (string) to define the ".flags"
3362 envirnoment variable in the default or embedded environment.
3363
3364 - CONFIG_ENV_FLAGS_LIST_STATIC
3365 Define this to a list (string) to define validation that
3366 should be done if an entry is not found in the ".flags"
3367 environment variable. To override a setting in the static
3368 list, simply add an entry for the same variable name to the
3369 ".flags" variable.
3370
Joe Hershberger267541f2012-12-11 22:16:34 -06003371- CONFIG_ENV_ACCESS_IGNORE_FORCE
3372 If defined, don't allow the -f switch to env set override variable
3373 access flags.
3374
Simon Glass5c1a7ea2013-03-08 13:45:27 +00003375- CONFIG_SYS_GENERIC_BOARD
3376 This selects the architecture-generic board system instead of the
3377 architecture-specific board files. It is intended to move boards
3378 to this new framework over time. Defining this will disable the
3379 arch/foo/lib/board.c file and use common/board_f.c and
3380 common/board_r.c instead. To use this option your architecture
3381 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
3382 its config.mk file). If you find problems enabling this option on
3383 your board please report the problem and send patches!
3384
Simon Glass632efa72013-03-11 07:06:48 +00003385- CONFIG_SYS_SYM_OFFSETS
3386 This is set by architectures that use offsets for link symbols
3387 instead of absolute values. So bss_start is obtained using an
3388 offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3389 directly. You should not need to touch this setting.
3390
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00003391- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3392 This is set by OMAP boards for the max time that reset should
3393 be asserted. See doc/README.omap-reset-time for details on how
3394 the value can be calulated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00003395
wdenkc6097192002-11-03 00:24:07 +00003396The following definitions that deal with the placement and management
3397of environment data (variable area); in general, we support the
3398following configurations:
3399
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003400- CONFIG_BUILD_ENVCRC:
3401
3402 Builds up envcrc with the target environment so that external utils
3403 may easily extract it and embed it in final U-Boot images.
3404
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003405- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003406
3407 Define this if the environment is in flash memory.
3408
3409 a) The environment occupies one whole flash sector, which is
3410 "embedded" in the text segment with the U-Boot code. This
3411 happens usually with "bottom boot sector" or "top boot
3412 sector" type flash chips, which have several smaller
3413 sectors at the start or the end. For instance, such a
3414 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3415 such a case you would place the environment in one of the
3416 4 kB sectors - with U-Boot code before and after it. With
3417 "top boot sector" type flash chips, you would put the
3418 environment in one of the last sectors, leaving a gap
3419 between U-Boot and the environment.
3420
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003421 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003422
3423 Offset of environment data (variable area) to the
3424 beginning of flash memory; for instance, with bottom boot
3425 type flash chips the second sector can be used: the offset
3426 for this sector is given here.
3427
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003428 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003429
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003430 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003431
3432 This is just another way to specify the start address of
3433 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003434 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003435
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003436 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003437
3438 Size of the sector containing the environment.
3439
3440
3441 b) Sometimes flash chips have few, equal sized, BIG sectors.
3442 In such a case you don't want to spend a whole sector for
3443 the environment.
3444
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003445 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003446
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003447 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003448 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003449 of this flash sector for the environment. This saves
3450 memory for the RAM copy of the environment.
3451
3452 It may also save flash memory if you decide to use this
3453 when your environment is "embedded" within U-Boot code,
3454 since then the remainder of the flash sector could be used
3455 for U-Boot code. It should be pointed out that this is
3456 STRONGLY DISCOURAGED from a robustness point of view:
3457 updating the environment in flash makes it always
3458 necessary to erase the WHOLE sector. If something goes
3459 wrong before the contents has been restored from a copy in
3460 RAM, your target system will be dead.
3461
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003462 - CONFIG_ENV_ADDR_REDUND
3463 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003464
wdenk43d96162003-03-06 00:02:04 +00003465 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003466 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003467 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003468 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003469
3470BE CAREFUL! Any changes to the flash layout, and some changes to the
3471source code will make it necessary to adapt <board>/u-boot.lds*
3472accordingly!
3473
3474
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003475- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003476
3477 Define this if you have some non-volatile memory device
3478 (NVRAM, battery buffered SRAM) which you want to use for the
3479 environment.
3480
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003481 - CONFIG_ENV_ADDR:
3482 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003483
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003484 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003485 want to use for environment. It is assumed that this memory
3486 can just be read and written to, without any special
3487 provision.
3488
3489BE CAREFUL! The first access to the environment happens quite early
3490in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003491console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003492U-Boot will hang.
3493
3494Please note that even with NVRAM we still use a copy of the
3495environment in RAM: we could work on NVRAM directly, but we want to
3496keep settings there always unmodified except somebody uses "saveenv"
3497to save the current settings.
3498
3499
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003500- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003501
3502 Use this if you have an EEPROM or similar serial access
3503 device and a driver for it.
3504
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003505 - CONFIG_ENV_OFFSET:
3506 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003507
3508 These two #defines specify the offset and size of the
3509 environment area within the total memory of your EEPROM.
3510
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003511 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003512 If defined, specified the chip address of the EEPROM device.
3513 The default address is zero.
3514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003515 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003516 If defined, the number of bits used to address bytes in a
3517 single page in the EEPROM device. A 64 byte page, for example
3518 would require six bits.
3519
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003520 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003521 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003522 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003524 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003525 The length in bytes of the EEPROM memory array address. Note
3526 that this is NOT the chip address length!
3527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003528 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003529 EEPROM chips that implement "address overflow" are ones
3530 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3531 address and the extra bits end up in the "chip address" bit
3532 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3533 byte chips.
3534
3535 Note that we consider the length of the address field to
3536 still be one byte because the extra address bits are hidden
3537 in the chip address.
3538
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003539 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003540 The size in bytes of the EEPROM device.
3541
Heiko Schocher548738b2010-01-07 08:55:40 +01003542 - CONFIG_ENV_EEPROM_IS_ON_I2C
3543 define this, if you have I2C and SPI activated, and your
3544 EEPROM, which holds the environment, is on the I2C bus.
3545
3546 - CONFIG_I2C_ENV_EEPROM_BUS
3547 if you have an Environment on an EEPROM reached over
3548 I2C muxes, you can define here, how to reach this
3549 EEPROM. For example:
3550
Wolfgang Denka9046b92010-06-13 17:48:15 +02003551 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003552
3553 EEPROM which holds the environment, is reached over
3554 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003555
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003556- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003557
wdenkd4ca31c2004-01-02 14:00:00 +00003558 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003559 want to use for the environment.
3560
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003561 - CONFIG_ENV_OFFSET:
3562 - CONFIG_ENV_ADDR:
3563 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003564
3565 These three #defines specify the offset and size of the
3566 environment area within the total memory of your DataFlash placed
3567 at the specified address.
3568
Liu Gang0a85a9e2012-03-08 00:33:20 +00003569- CONFIG_ENV_IS_IN_REMOTE:
3570
3571 Define this if you have a remote memory space which you
3572 want to use for the local device's environment.
3573
3574 - CONFIG_ENV_ADDR:
3575 - CONFIG_ENV_SIZE:
3576
3577 These two #defines specify the address and size of the
3578 environment area within the remote memory space. The
3579 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003580 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003581
3582BE CAREFUL! For some special cases, the local device can not use
3583"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003584environment stored in a remote NOR flash by SRIO or PCIE link,
3585but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003586
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003587- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003588
3589 Define this if you have a NAND device which you want to use
3590 for the environment.
3591
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003592 - CONFIG_ENV_OFFSET:
3593 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003594
3595 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003596 area within the first NAND device. CONFIG_ENV_OFFSET must be
3597 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003598
Scott Woodfdd813d2010-09-17 14:38:37 -05003599 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003600
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003601 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003602 size used to hold a redundant copy of the environment data, so
3603 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003604 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003605 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003606
Scott Woodfdd813d2010-09-17 14:38:37 -05003607 - CONFIG_ENV_RANGE (optional):
3608
3609 Specifies the length of the region in which the environment
3610 can be written. This should be a multiple of the NAND device's
3611 block size. Specifying a range with more erase blocks than
3612 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3613 the range to be avoided.
3614
3615 - CONFIG_ENV_OFFSET_OOB (optional):
3616
3617 Enables support for dynamically retrieving the offset of the
3618 environment from block zero's out-of-band data. The
3619 "nand env.oob" command can be used to record this offset.
3620 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3621 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003622
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003623- CONFIG_NAND_ENV_DST
3624
3625 Defines address in RAM to which the nand_spl code should copy the
3626 environment. If redundant environment is used, it will be copied to
3627 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3628
Joe Hershberger2b744332013-04-08 10:32:51 +00003629- CONFIG_ENV_IS_IN_UBI:
3630
3631 Define this if you have an UBI volume that you want to use for the
3632 environment. This has the benefit of wear-leveling the environment
3633 accesses, which is important on NAND.
3634
3635 - CONFIG_ENV_UBI_PART:
3636
3637 Define this to a string that is the mtd partition containing the UBI.
3638
3639 - CONFIG_ENV_UBI_VOLUME:
3640
3641 Define this to the name of the volume that you want to store the
3642 environment in.
3643
Joe Hershberger785881f2013-04-08 10:32:52 +00003644 - CONFIG_ENV_UBI_VOLUME_REDUND:
3645
3646 Define this to the name of another volume to store a second copy of
3647 the environment in. This will enable redundant environments in UBI.
3648 It is assumed that both volumes are in the same MTD partition.
3649
Joe Hershberger2b744332013-04-08 10:32:51 +00003650 - CONFIG_UBI_SILENCE_MSG
3651 - CONFIG_UBIFS_SILENCE_MSG
3652
3653 You will probably want to define these to avoid a really noisy system
3654 when storing the env in UBI.
3655
Stephen Warren06e4ae52013-06-11 15:14:00 -06003656- CONFIG_ENV_IS_IN_MMC:
3657
3658 Define this if you have an MMC device which you want to use for the
3659 environment.
3660
3661 - CONFIG_SYS_MMC_ENV_DEV:
3662
3663 Specifies which MMC device the environment is stored in.
3664
3665 - CONFIG_SYS_MMC_ENV_PART (optional):
3666
3667 Specifies which MMC partition the environment is stored in. If not
3668 set, defaults to partition 0, the user area. Common values might be
3669 1 (first MMC boot partition), 2 (second MMC boot partition).
3670
3671 - CONFIG_ENV_OFFSET:
3672 - CONFIG_ENV_SIZE:
3673
3674 These two #defines specify the offset and size of the environment
3675 area within the specified MMC device.
3676
Stephen Warren5c088ee2013-06-11 15:14:02 -06003677 If offset is positive (the usual case), it is treated as relative to
3678 the start of the MMC partition. If offset is negative, it is treated
3679 as relative to the end of the MMC partition. This can be useful if
3680 your board may be fitted with different MMC devices, which have
3681 different sizes for the MMC partitions, and you always want the
3682 environment placed at the very end of the partition, to leave the
3683 maximum possible space before it, to store other data.
3684
Stephen Warren06e4ae52013-06-11 15:14:00 -06003685 These two values are in units of bytes, but must be aligned to an
3686 MMC sector boundary.
3687
3688 - CONFIG_ENV_OFFSET_REDUND (optional):
3689
3690 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3691 hold a redundant copy of the environment data. This provides a
3692 valid backup copy in case the other copy is corrupted, e.g. due
3693 to a power failure during a "saveenv" operation.
3694
Stephen Warren5c088ee2013-06-11 15:14:02 -06003695 This value may also be positive or negative; this is handled in the
3696 same way as CONFIG_ENV_OFFSET.
3697
Stephen Warren06e4ae52013-06-11 15:14:00 -06003698 This value is also in units of bytes, but must also be aligned to
3699 an MMC sector boundary.
3700
3701 - CONFIG_ENV_SIZE_REDUND (optional):
3702
3703 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3704 set. If this value is set, it must be set to the same value as
3705 CONFIG_ENV_SIZE.
3706
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003707- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003708
3709 Defines offset to the initial SPI buffer area in DPRAM. The
3710 area is used at an early stage (ROM part) if the environment
3711 is configured to reside in the SPI EEPROM: We need a 520 byte
3712 scratch DPRAM area. It is used between the two initialization
3713 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3714 to be a good choice since it makes it far enough from the
3715 start of the data area as well as from the stack pointer.
3716
Bruce Adlere881cb52007-11-02 13:15:42 -07003717Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003718has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003719created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003720until then to read environment variables.
3721
wdenk85ec0bc2003-03-31 16:34:49 +00003722The environment is protected by a CRC32 checksum. Before the monitor
3723is relocated into RAM, as a result of a bad CRC you will be working
3724with the compiled-in default environment - *silently*!!! [This is
3725necessary, because the first environment variable we need is the
3726"baudrate" setting for the console - if we have a bad CRC, we don't
3727have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003728
3729Note: once the monitor has been relocated, then it will complain if
3730the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003731use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003733- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003734 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003735
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003736 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003737 also needs to be defined.
3738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003739- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003740 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003741
Ron Madridf5675aa2009-02-18 14:30:44 -08003742- CONFIG_NS16550_MIN_FUNCTIONS:
3743 Define this if you desire to only have use of the NS16550_init
3744 and NS16550_putc functions for the serial driver located at
3745 drivers/serial/ns16550.c. This option is useful for saving
3746 space for already greatly restricted images, including but not
3747 limited to NAND_SPL configurations.
3748
Simon Glassb2b92f52012-11-30 13:01:18 +00003749- CONFIG_DISPLAY_BOARDINFO
3750 Display information about the board that U-Boot is running on
3751 when U-Boot starts up. The board function checkboard() is called
3752 to do this.
3753
Simon Glasse2e3e2b2012-11-30 13:01:19 +00003754- CONFIG_DISPLAY_BOARDINFO_LATE
3755 Similar to the previous option, but display this information
3756 later, once stdio is running and output goes to the LCD, if
3757 present.
3758
wdenkc6097192002-11-03 00:24:07 +00003759Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003760---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003761
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003762- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003763 Cache Line Size of the CPU.
3764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003765- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003766 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003767
wdenk42d1f032003-10-15 23:53:47 +00003768 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3769 and RPXsuper) to be able to adjust the position of
3770 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003771
Timur Tabie46fedf2011-08-04 18:03:41 -05003772- CONFIG_SYS_CCSRBAR_DEFAULT:
3773 Default (power-on reset) physical address of CCSR on Freescale
3774 PowerPC SOCs.
3775
3776- CONFIG_SYS_CCSRBAR:
3777 Virtual address of CCSR. On a 32-bit build, this is typically
3778 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3779
3780 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3781 for cross-platform code that uses that macro instead.
3782
3783- CONFIG_SYS_CCSRBAR_PHYS:
3784 Physical address of CCSR. CCSR can be relocated to a new
3785 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003786 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003787 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3788 is typically relocated on 36-bit builds. It is recommended
3789 that this macro be defined via the _HIGH and _LOW macros:
3790
3791 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3792 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3793
3794- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003795 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3796 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003797 used in assembly code, so it must not contain typecasts or
3798 integer size suffixes (e.g. "ULL").
3799
3800- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3801 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3802 used in assembly code, so it must not contain typecasts or
3803 integer size suffixes (e.g. "ULL").
3804
3805- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3806 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3807 forced to a value that ensures that CCSR is not relocated.
3808
wdenk7f6c2cb2002-11-10 22:06:23 +00003809- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003810 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003811
3812 the default drive number (default value 0)
3813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003814 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003815
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003816 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003817 (default value 1)
3818
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003819 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003820
wdenk43d96162003-03-06 00:02:04 +00003821 defines the offset of register from address. It
3822 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003823 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003825 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3826 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003827 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003828
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003829 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003830 fdc_hw_init() is called at the beginning of the FDC
3831 setup. fdc_hw_init() must be provided by the board
3832 source code. It is used to make hardware dependant
3833 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003834
Macpaul Lin0abddf82011-04-11 20:45:32 +00003835- CONFIG_IDE_AHB:
3836 Most IDE controllers were designed to be connected with PCI
3837 interface. Only few of them were designed for AHB interface.
3838 When software is doing ATA command and data transfer to
3839 IDE devices through IDE-AHB controller, some additional
3840 registers accessing to these kind of IDE-AHB controller
3841 is requierd.
3842
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003843- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003844 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003845 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003846
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003847- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk7152b1d2003-09-05 23:19:14 +00003849 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003850 initial data and stack; please note that this must be
3851 writable memory that is working WITHOUT special
3852 initialization, i. e. you CANNOT use normal RAM which
3853 will become available only after programming the
3854 memory controller and running certain initialization
3855 sequences.
3856
3857 U-Boot uses the following memory types:
3858 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3859 - MPC824X: data cache
3860 - PPC4xx: data cache
3861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003862- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003863
3864 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003865 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3866 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003867 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003868 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003869 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3870 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3871 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003872
3873 Note:
3874 On the MPC824X (or other systems that use the data
3875 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003876 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003877 point to an otherwise UNUSED address space between
3878 the top of RAM and the start of the PCI space.
3879
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003880- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003881
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003882- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003883
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003884- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003885
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003886- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003887
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003888- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003889
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003890- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003891
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003892- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003893 SDRAM timing
3894
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003895- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003896 periodic timer for refresh
3897
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003898- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003900- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3901 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3902 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3903 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003904 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3905
3906- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003907 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3908 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003909 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3910
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003911- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3912 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003913 Machine Mode Register and Memory Periodic Timer
3914 Prescaler definitions (SDRAM timing)
3915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003916- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003917 enable I2C microcode relocation patch (MPC8xx);
3918 define relocation offset in DPRAM [DSP2]
3919
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003920- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003921 enable SMC microcode relocation patch (MPC8xx);
3922 define relocation offset in DPRAM [SMC1]
3923
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003924- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003925 enable SPI microcode relocation patch (MPC8xx);
3926 define relocation offset in DPRAM [SCC4]
3927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003928- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003929 Use OSCM clock mode on MBX8xx board. Be careful,
3930 wrong setting might damage your board. Read
3931 doc/README.MBX before setting this variable!
3932
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003933- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003934 Offset of the bootmode word in DPRAM used by post
3935 (Power On Self Tests). This definition overrides
3936 #define'd default value in commproc.h resp.
3937 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003938
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003939- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3940 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3941 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3942 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3943 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3944 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3945 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3946 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003947 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003948
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003949- CONFIG_PCI_DISABLE_PCIE:
3950 Disable PCI-Express on systems where it is supported but not
3951 required.
3952
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003953- CONFIG_PCI_ENUM_ONLY
3954 Only scan through and get the devices on the busses.
3955 Don't do any setup work, presumably because someone or
3956 something has already done it, and we don't need to do it
3957 a second time. Useful for platforms that are pre-booted
3958 by coreboot or similar.
3959
Gabor Juhos842033e2013-05-30 07:06:12 +00003960- CONFIG_PCI_INDIRECT_BRIDGE:
3961 Enable support for indirect PCI bridges.
3962
Kumar Galaa09b9b62010-12-30 12:09:53 -06003963- CONFIG_SYS_SRIO:
3964 Chip has SRIO or not
3965
3966- CONFIG_SRIO1:
3967 Board has SRIO 1 port available
3968
3969- CONFIG_SRIO2:
3970 Board has SRIO 2 port available
3971
3972- CONFIG_SYS_SRIOn_MEM_VIRT:
3973 Virtual Address of SRIO port 'n' memory region
3974
3975- CONFIG_SYS_SRIOn_MEM_PHYS:
3976 Physical Address of SRIO port 'n' memory region
3977
3978- CONFIG_SYS_SRIOn_MEM_SIZE:
3979 Size of SRIO port 'n' memory region
3980
Fabio Estevam66bd1842013-04-11 09:35:34 +00003981- CONFIG_SYS_NAND_BUSWIDTH_16BIT
3982 Defined to tell the NAND controller that the NAND chip is using
3983 a 16 bit bus.
3984 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00003985 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00003986 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00003987 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04003988
3989- CONFIG_SYS_NDFC_EBC0_CFG
3990 Sets the EBC0_CFG register for the NDFC. If not defined
3991 a default value will be used.
3992
Ben Warrenbb99ad62006-09-07 16:50:54 -04003993- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003994 Get DDR timing information from an I2C EEPROM. Common
3995 with pluggable memory modules such as SODIMMs
3996
Ben Warrenbb99ad62006-09-07 16:50:54 -04003997 SPD_EEPROM_ADDRESS
3998 I2C address of the SPD EEPROM
3999
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004000- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004001 If SPD EEPROM is on an I2C bus other than the first
4002 one, specify here. Note that the value must resolve
4003 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004004
York Sun1b3e3c42011-06-07 09:42:16 +08004005- CONFIG_SYS_DDR_RAW_TIMING
4006 Get DDR timing information from other than SPD. Common with
4007 soldered DDR chips onboard without SPD. DDR raw timing
4008 parameters are extracted from datasheet and hard-coded into
4009 header files or board specific files.
4010
York Sun6f5e1dc2011-09-16 13:21:35 -07004011- CONFIG_FSL_DDR_INTERACTIVE
4012 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4013
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004014- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004015 Only for 83xx systems. If specified, then DDR should
4016 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004017
wdenkc26e4542004-04-18 10:13:26 +00004018- CONFIG_ETHER_ON_FEC[12]
4019 Define to enable FEC[12] on a 8xx series processor.
4020
4021- CONFIG_FEC[12]_PHY
4022 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004023 to the given FEC; i. e.
4024 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004025 means that the PHY with address 4 is connected to FEC1
4026
4027 When set to -1, means to probe for first available.
4028
4029- CONFIG_FEC[12]_PHY_NORXERR
4030 The PHY does not have a RXERR line (RMII only).
4031 (so program the FEC to ignore it).
4032
4033- CONFIG_RMII
4034 Enable RMII mode for all FECs.
4035 Note that this is a global option, we can't
4036 have one FEC in standard MII mode and another in RMII mode.
4037
wdenk5cf91d62004-04-23 20:32:05 +00004038- CONFIG_CRC32_VERIFY
4039 Add a verify option to the crc32 command.
4040 The syntax is:
4041
4042 => crc32 -v <address> <count> <crc32>
4043
4044 Where address/count indicate a memory area
4045 and crc32 is the correct crc32 which the
4046 area should have.
4047
wdenk56523f12004-07-11 17:40:54 +00004048- CONFIG_LOOPW
4049 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004050 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004051
stroese7b466642004-12-16 18:46:55 +00004052- CONFIG_MX_CYCLIC
4053 Add the "mdc" and "mwc" memory commands. These are cyclic
4054 "md/mw" commands.
4055 Examples:
4056
wdenkefe2a4d2004-12-16 21:44:03 +00004057 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004058 This command will print 4 bytes (10,11,12,13) each 500 ms.
4059
wdenkefe2a4d2004-12-16 21:44:03 +00004060 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004061 This command will write 12345678 to address 100 all 10 ms.
4062
wdenkefe2a4d2004-12-16 21:44:03 +00004063 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004064 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004065
wdenk8aa1a2d2005-04-04 12:44:11 +00004066- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004067 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004068 low level initializations (like setting up the memory
4069 controller) are omitted and/or U-Boot does not
4070 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004071
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004072 Normally this variable MUST NOT be defined. The only
4073 exception is when U-Boot is loaded (to RAM) by some
4074 other boot loader or by a debugger which performs
4075 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004076
Aneesh V401bb302011-07-13 05:11:07 +00004077- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004078 Modifies the behaviour of start.S when compiling a loader
4079 that is executed before the actual U-Boot. E.g. when
4080 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004081
Simon Glass4213fc22013-02-24 17:33:14 +00004082- CONFIG_ARCH_MAP_SYSMEM
4083 Generally U-Boot (and in particular the md command) uses
4084 effective address. It is therefore not necessary to regard
4085 U-Boot address as virtual addresses that need to be translated
4086 to physical addresses. However, sandbox requires this, since
4087 it maintains its own little RAM buffer which contains all
4088 addressable memory. This option causes some memory accesses
4089 to be mapped through map_sysmem() / unmap_sysmem().
4090
Matthias Weisserd8834a12011-03-10 21:36:32 +00004091- CONFIG_USE_ARCH_MEMCPY
4092 CONFIG_USE_ARCH_MEMSET
4093 If these options are used a optimized version of memcpy/memset will
4094 be used if available. These functions may be faster under some
4095 conditions but may increase the binary size.
4096
Simon Glass588a13f2013-02-14 04:18:54 +00004097- CONFIG_X86_RESET_VECTOR
4098 If defined, the x86 reset vector code is included. This is not
4099 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004100
Mark Jacksonfc337052013-03-04 01:27:20 +00004101- CONFIG_SYS_MPUCLK
4102 Defines the MPU clock speed (in MHz).
4103
4104 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004105
Timur Tabif2717b42011-11-22 09:21:25 -06004106Freescale QE/FMAN Firmware Support:
4107-----------------------------------
4108
4109The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4110loading of "firmware", which is encoded in the QE firmware binary format.
4111This firmware often needs to be loaded during U-Boot booting, so macros
4112are used to identify the storage device (NOR flash, SPI, etc) and the address
4113within that device.
4114
4115- CONFIG_SYS_QE_FMAN_FW_ADDR
4116 The address in the storage device where the firmware is located. The
4117 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4118 is also specified.
4119
4120- CONFIG_SYS_QE_FMAN_FW_LENGTH
4121 The maximum possible size of the firmware. The firmware binary format
4122 has a field that specifies the actual size of the firmware, but it
4123 might not be possible to read any part of the firmware unless some
4124 local storage is allocated to hold the entire firmware first.
4125
4126- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4127 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4128 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4129 virtual address in NOR flash.
4130
4131- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4132 Specifies that QE/FMAN firmware is located in NAND flash.
4133 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4134
4135- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4136 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4137 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4138
4139- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4140 Specifies that QE/FMAN firmware is located on the primary SPI
4141 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4142
Liu Gang292dc6c2012-03-08 00:33:18 +00004143- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4144 Specifies that QE/FMAN firmware is located in the remote (master)
4145 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004146 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4147 window->master inbound window->master LAW->the ucode address in
4148 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004149
wdenkc6097192002-11-03 00:24:07 +00004150Building the Software:
4151======================
4152
Wolfgang Denk218ca722008-03-26 10:40:12 +01004153Building U-Boot has been tested in several native build environments
4154and in many different cross environments. Of course we cannot support
4155all possibly existing versions of cross development tools in all
4156(potentially obsolete) versions. In case of tool chain problems we
4157recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4158which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004159
Wolfgang Denk218ca722008-03-26 10:40:12 +01004160If you are not using a native environment, it is assumed that you
4161have GNU cross compiling tools available in your path. In this case,
4162you must set the environment variable CROSS_COMPILE in your shell.
4163Note that no changes to the Makefile or any other source files are
4164necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004165
Wolfgang Denk218ca722008-03-26 10:40:12 +01004166 $ CROSS_COMPILE=ppc_4xx-
4167 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004168
Peter Tyser2f8d3962009-03-13 18:54:51 -05004169Note: If you wish to generate Windows versions of the utilities in
4170 the tools directory you can use the MinGW toolchain
4171 (http://www.mingw.org). Set your HOST tools to the MinGW
4172 toolchain and execute 'make tools'. For example:
4173
4174 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4175
4176 Binaries such as tools/mkimage.exe will be created which can
4177 be executed on computers running Windows.
4178
Wolfgang Denk218ca722008-03-26 10:40:12 +01004179U-Boot is intended to be simple to build. After installing the
4180sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004181is done by typing:
4182
4183 make NAME_config
4184
Wolfgang Denk218ca722008-03-26 10:40:12 +01004185where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00004186rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00004187
wdenk2729af92004-05-03 20:45:30 +00004188Note: for some board special configuration names may exist; check if
4189 additional information is available from the board vendor; for
4190 instance, the TQM823L systems are available without (standard)
4191 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004192 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004193
wdenk2729af92004-05-03 20:45:30 +00004194 make TQM823L_config
4195 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197 make TQM823L_LCD_config
4198 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004199
wdenk2729af92004-05-03 20:45:30 +00004200 etc.
wdenkc6097192002-11-03 00:24:07 +00004201
wdenkc6097192002-11-03 00:24:07 +00004202
wdenk2729af92004-05-03 20:45:30 +00004203Finally, type "make all", and you should get some working U-Boot
4204images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk2729af92004-05-03 20:45:30 +00004206- "u-boot.bin" is a raw binary image
4207- "u-boot" is an image in ELF binary format
4208- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004209
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004210By default the build is performed locally and the objects are saved
4211in the source directory. One of the two methods can be used to change
4212this behavior and build U-Boot to some external directory:
4213
42141. Add O= to the make command line invocations:
4215
4216 make O=/tmp/build distclean
4217 make O=/tmp/build NAME_config
4218 make O=/tmp/build all
4219
42202. Set environment variable BUILD_DIR to point to the desired location:
4221
4222 export BUILD_DIR=/tmp/build
4223 make distclean
4224 make NAME_config
4225 make all
4226
4227Note that the command line "O=" setting overrides the BUILD_DIR environment
4228variable.
4229
wdenkc6097192002-11-03 00:24:07 +00004230
wdenk2729af92004-05-03 20:45:30 +00004231Please be aware that the Makefiles assume you are using GNU make, so
4232for instance on NetBSD you might need to use "gmake" instead of
4233native "make".
wdenkc6097192002-11-03 00:24:07 +00004234
wdenkc6097192002-11-03 00:24:07 +00004235
wdenk2729af92004-05-03 20:45:30 +00004236If the system board that you have is not listed, then you will need
4237to port U-Boot to your hardware platform. To do this, follow these
4238steps:
wdenkc6097192002-11-03 00:24:07 +00004239
wdenk2729af92004-05-03 20:45:30 +000042401. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00004241 "boards.cfg" file, using the existing entries as examples.
4242 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000042432. Create a new directory to hold your board specific code. Add any
4244 files you need. In your board directory, you will need at least
4245 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
42463. Create a new configuration file "include/configs/<board>.h" for
4247 your board
42483. If you're porting U-Boot to a new CPU, then also create a new
4249 directory to hold your CPU specific code. Add any files you need.
42504. Run "make <board>_config" with your new name.
42515. Type "make", and you should get a working "u-boot.srec" file
4252 to be installed on your target system.
42536. Debug and solve any problems that might arise.
4254 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004255
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk2729af92004-05-03 20:45:30 +00004257Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4258==============================================================
wdenkc6097192002-11-03 00:24:07 +00004259
Wolfgang Denk218ca722008-03-26 10:40:12 +01004260If you have modified U-Boot sources (for instance added a new board
4261or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00004262provide feedback to the other developers. The feedback normally takes
4263the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01004264official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004265
Wolfgang Denk218ca722008-03-26 10:40:12 +01004266But before you submit such a patch, please verify that your modifi-
4267cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00004268the supported boards compile WITHOUT ANY compiler warnings. To do so,
4269just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01004270for ALL supported system. Be warned, this will take a while. You can
4271select which (cross) compiler to use by passing a `CROSS_COMPILE'
4272environment variable to the script, i. e. to use the ELDK cross tools
4273you can type
wdenkc6097192002-11-03 00:24:07 +00004274
wdenk2729af92004-05-03 20:45:30 +00004275 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00004280
Wolfgang Denk218ca722008-03-26 10:40:12 +01004281When using the MAKEALL script, the default behaviour is to build
4282U-Boot in the source directory. This location can be changed by
4283setting the BUILD_DIR environment variable. Also, for each target
4284built, the MAKEALL script saves two log files (<target>.ERR and
4285<target>.MAKEALL) in the <source dir>/LOG directory. This default
4286location can be changed by setting the MAKEALL_LOGDIR environment
4287variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004288
4289 export BUILD_DIR=/tmp/build
4290 export MAKEALL_LOGDIR=/tmp/log
4291 CROSS_COMPILE=ppc_8xx- MAKEALL
4292
Wolfgang Denk218ca722008-03-26 10:40:12 +01004293With the above settings build objects are saved in the /tmp/build,
4294log files are saved in the /tmp/log and the source tree remains clean
4295during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02004296
4297
wdenk2729af92004-05-03 20:45:30 +00004298See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004299
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk2729af92004-05-03 20:45:30 +00004301Monitor Commands - Overview:
4302============================
wdenkc6097192002-11-03 00:24:07 +00004303
wdenk2729af92004-05-03 20:45:30 +00004304go - start application at address 'addr'
4305run - run commands in an environment variable
4306bootm - boot application image from memory
4307bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00004308bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00004309tftpboot- boot image via network using TFTP protocol
4310 and env variables "ipaddr" and "serverip"
4311 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00004312tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00004313rarpboot- boot image via network using RARP/TFTP protocol
4314diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4315loads - load S-Record file over serial line
4316loadb - load binary file over serial line (kermit mode)
4317md - memory display
4318mm - memory modify (auto-incrementing)
4319nm - memory modify (constant address)
4320mw - memory write (fill)
4321cp - memory copy
4322cmp - memory compare
4323crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05004324i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00004325sspi - SPI utility commands
4326base - print or set address offset
4327printenv- print environment variables
4328setenv - set environment variables
4329saveenv - save environment variables to persistent storage
4330protect - enable or disable FLASH write protection
4331erase - erase FLASH memory
4332flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00004333nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00004334bdinfo - print Board Info structure
4335iminfo - print header information for application image
4336coninfo - print console devices and informations
4337ide - IDE sub-system
4338loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00004339loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00004340mtest - simple RAM test
4341icache - enable or disable instruction cache
4342dcache - enable or disable data cache
4343reset - Perform RESET of the CPU
4344echo - echo args to console
4345version - print monitor version
4346help - print online help
4347? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004348
wdenkc6097192002-11-03 00:24:07 +00004349
wdenk2729af92004-05-03 20:45:30 +00004350Monitor Commands - Detailed Description:
4351========================================
wdenkc6097192002-11-03 00:24:07 +00004352
wdenk2729af92004-05-03 20:45:30 +00004353TODO.
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk2729af92004-05-03 20:45:30 +00004355For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004356
4357
wdenk2729af92004-05-03 20:45:30 +00004358Environment Variables:
4359======================
wdenkc6097192002-11-03 00:24:07 +00004360
wdenk2729af92004-05-03 20:45:30 +00004361U-Boot supports user configuration using Environment Variables which
4362can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004363
wdenk2729af92004-05-03 20:45:30 +00004364Environment Variables are set using "setenv", printed using
4365"printenv", and saved to Flash using "saveenv". Using "setenv"
4366without a value can be used to delete a variable from the
4367environment. As long as you don't save the environment you are
4368working with an in-memory copy. In case the Flash area containing the
4369environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004370
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004371Some configuration options can be set using Environment Variables.
4372
4373List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004374
wdenk2729af92004-05-03 20:45:30 +00004375 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004376
wdenk2729af92004-05-03 20:45:30 +00004377 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004378
wdenk2729af92004-05-03 20:45:30 +00004379 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004380
wdenk2729af92004-05-03 20:45:30 +00004381 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk2729af92004-05-03 20:45:30 +00004383 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004384
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004385 bootm_low - Memory range available for image processing in the bootm
4386 command can be restricted. This variable is given as
4387 a hexadecimal number and defines lowest address allowed
4388 for use by the bootm command. See also "bootm_size"
4389 environment variable. Address defined by "bootm_low" is
4390 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00004391 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4392 bootm_mapsize.
4393
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004394 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00004395 This variable is given as a hexadecimal number and it
4396 defines the size of the memory region starting at base
4397 address bootm_low that is accessible by the Linux kernel
4398 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4399 as the default value if it is defined, and bootm_size is
4400 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02004401
4402 bootm_size - Memory range available for image processing in the bootm
4403 command can be restricted. This variable is given as
4404 a hexadecimal number and defines the size of the region
4405 allowed for use by the bootm command. See also "bootm_low"
4406 environment variable.
4407
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02004408 updatefile - Location of the software update file on a TFTP server, used
4409 by the automatic software update feature. Please refer to
4410 documentation in doc/README.update for more details.
4411
wdenk2729af92004-05-03 20:45:30 +00004412 autoload - if set to "no" (any string beginning with 'n'),
4413 "bootp" will just load perform a lookup of the
4414 configuration from the BOOTP server, but not try to
4415 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004416
wdenk2729af92004-05-03 20:45:30 +00004417 autostart - if set to "yes", an image loaded using the "bootp",
4418 "rarpboot", "tftpboot" or "diskboot" commands will
4419 be automatically started (by internally calling
4420 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004421
wdenk2729af92004-05-03 20:45:30 +00004422 If set to "no", a standalone image passed to the
4423 "bootm" command will be copied to the load address
4424 (and eventually uncompressed), but NOT be started.
4425 This can be used to load and uncompress arbitrary
4426 data.
wdenkc6097192002-11-03 00:24:07 +00004427
David A. Longa28afca2011-07-09 16:40:19 -04004428 fdt_high - if set this restricts the maximum address that the
4429 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00004430 For example, if you have a system with 1 GB memory
4431 at physical address 0x10000000, while Linux kernel
4432 only recognizes the first 704 MB as low memory, you
4433 may need to set fdt_high as 0x3C000000 to have the
4434 device tree blob be copied to the maximum address
4435 of the 704 MB low memory, so that Linux kernel can
4436 access it during the boot procedure.
4437
David A. Longa28afca2011-07-09 16:40:19 -04004438 If this is set to the special value 0xFFFFFFFF then
4439 the fdt will not be copied at all on boot. For this
4440 to work it must reside in writable memory, have
4441 sufficient padding on the end of it for u-boot to
4442 add the information it needs into it, and the memory
4443 must be accessible by the kernel.
4444
Simon Glasseea63e02011-10-24 19:15:34 +00004445 fdtcontroladdr- if set this is the address of the control flattened
4446 device tree used by U-Boot when CONFIG_OF_CONTROL is
4447 defined.
4448
wdenk17ea1172004-06-06 21:51:03 +00004449 i2cfast - (PPC405GP|PPC405EP only)
4450 if set to 'y' configures Linux I2C driver for fast
4451 mode (400kHZ). This environment variable is used in
4452 initialization code. So, for changes to be effective
4453 it must be saved and board must be reset.
4454
wdenk2729af92004-05-03 20:45:30 +00004455 initrd_high - restrict positioning of initrd images:
4456 If this variable is not set, initrd images will be
4457 copied to the highest possible address in RAM; this
4458 is usually what you want since it allows for
4459 maximum initrd size. If for some reason you want to
4460 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004461 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00004462 variable to a value of "no" or "off" or "0".
4463 Alternatively, you can set it to a maximum upper
4464 address to use (U-Boot will still check that it
4465 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004466
wdenk2729af92004-05-03 20:45:30 +00004467 For instance, when you have a system with 16 MB
4468 RAM, and want to reserve 4 MB from use by Linux,
4469 you can do this by adding "mem=12M" to the value of
4470 the "bootargs" variable. However, now you must make
4471 sure that the initrd image is placed in the first
4472 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004473
wdenk2729af92004-05-03 20:45:30 +00004474 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004475
wdenk2729af92004-05-03 20:45:30 +00004476 If you set initrd_high to 0xFFFFFFFF, this is an
4477 indication to U-Boot that all addresses are legal
4478 for the Linux kernel, including addresses in flash
4479 memory. In this case U-Boot will NOT COPY the
4480 ramdisk at all. This may be useful to reduce the
4481 boot time on your system, but requires that this
4482 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00004483
wdenk2729af92004-05-03 20:45:30 +00004484 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004485
wdenk2729af92004-05-03 20:45:30 +00004486 loadaddr - Default load address for commands like "bootp",
4487 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004488
wdenk2729af92004-05-03 20:45:30 +00004489 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk2729af92004-05-03 20:45:30 +00004491 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00004492
wdenk2729af92004-05-03 20:45:30 +00004493 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004494
wdenk2729af92004-05-03 20:45:30 +00004495 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004496
wdenk2729af92004-05-03 20:45:30 +00004497 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004498
Mike Frysingere2a53452011-10-02 10:01:27 +00004499 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004500
Mike Frysingere2a53452011-10-02 10:01:27 +00004501 ethact - controls which interface is currently active.
4502 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004503
Heiko Schocher48690d82010-07-20 17:45:02 +02004504 => setenv ethact FEC
4505 => ping 192.168.0.1 # traffic sent on FEC
4506 => setenv ethact SCC
4507 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004508
Matthias Fuchse1692572008-01-17 07:45:05 +01004509 ethrotate - When set to "no" U-Boot does not go through all
4510 available network interfaces.
4511 It just stays at the currently selected interface.
4512
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004513 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004514 either succeed or fail without retrying.
4515 When set to "once" the network operation will
4516 fail when all the available network interfaces
4517 are tried once without success.
4518 Useful on scripts which control the retry operation
4519 themselves.
wdenkc6097192002-11-03 00:24:07 +00004520
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004521 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004522
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004523 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004524 UDP source port.
4525
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004526 tftpdstport - If this is set, the value is used for TFTP's UDP
4527 destination port instead of the Well Know Port 69.
4528
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004529 tftpblocksize - Block size to use for TFTP transfers; if not set,
4530 we use the TFTP server's default block size
4531
4532 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4533 seconds, minimum value is 1000 = 1 second). Defines
4534 when a packet is considered to be lost so it has to
4535 be retransmitted. The default is 5000 = 5 seconds.
4536 Lowering this value may make downloads succeed
4537 faster in networks with high packet loss rates or
4538 with unreliable TFTP servers.
4539
4540 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004541 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004542 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004543
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004544The following image location variables contain the location of images
4545used in booting. The "Image" column gives the role of the image and is
4546not an environment variable name. The other columns are environment
4547variable names. "File Name" gives the name of the file on a TFTP
4548server, "RAM Address" gives the location in RAM the image will be
4549loaded to, and "Flash Location" gives the image's address in NOR
4550flash or offset in NAND flash.
4551
4552*Note* - these variables don't have to be defined for all boards, some
4553boards currenlty use other variables for these purposes, and some
4554boards use these variables for other purposes.
4555
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004556Image File Name RAM Address Flash Location
4557----- --------- ----------- --------------
4558u-boot u-boot u-boot_addr_r u-boot_addr
4559Linux kernel bootfile kernel_addr_r kernel_addr
4560device tree blob fdtfile fdt_addr_r fdt_addr
4561ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004562
wdenk2729af92004-05-03 20:45:30 +00004563The following environment variables may be used and automatically
4564updated by the network boot commands ("bootp" and "rarpboot"),
4565depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004566
wdenk2729af92004-05-03 20:45:30 +00004567 bootfile - see above
4568 dnsip - IP address of your Domain Name Server
4569 dnsip2 - IP address of your secondary Domain Name Server
4570 gatewayip - IP address of the Gateway (Router) to use
4571 hostname - Target hostname
4572 ipaddr - see above
4573 netmask - Subnet Mask
4574 rootpath - Pathname of the root filesystem on the NFS server
4575 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004576
wdenka3d991b2004-04-15 21:48:45 +00004577
wdenk2729af92004-05-03 20:45:30 +00004578There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004579
wdenk2729af92004-05-03 20:45:30 +00004580 serial# - contains hardware identification information such
4581 as type string and/or serial number
4582 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004583
wdenk2729af92004-05-03 20:45:30 +00004584These variables can be set only once (usually during manufacturing of
4585the board). U-Boot refuses to delete or overwrite these variables
4586once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004587
4588
wdenk2729af92004-05-03 20:45:30 +00004589Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004590
wdenk2729af92004-05-03 20:45:30 +00004591 ver - Contains the U-Boot version string as printed
4592 with the "version" command. This variable is
4593 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004594
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk2729af92004-05-03 20:45:30 +00004596Please note that changes to some configuration parameters may take
4597only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004598
stroesec1551ea2003-04-04 15:53:41 +00004599
Joe Hershberger170ab112012-12-11 22:16:24 -06004600Callback functions for environment variables:
4601---------------------------------------------
4602
4603For some environment variables, the behavior of u-boot needs to change
4604when their values are changed. This functionailty allows functions to
4605be associated with arbitrary variables. On creation, overwrite, or
4606deletion, the callback will provide the opportunity for some side
4607effect to happen or for the change to be rejected.
4608
4609The callbacks are named and associated with a function using the
4610U_BOOT_ENV_CALLBACK macro in your board or driver code.
4611
4612These callbacks are associated with variables in one of two ways. The
4613static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4614in the board configuration to a string that defines a list of
4615associations. The list must be in the following format:
4616
4617 entry = variable_name[:callback_name]
4618 list = entry[,list]
4619
4620If the callback name is not specified, then the callback is deleted.
4621Spaces are also allowed anywhere in the list.
4622
4623Callbacks can also be associated by defining the ".callbacks" variable
4624with the same list format above. Any association in ".callbacks" will
4625override any association in the static list. You can define
4626CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4627".callbacks" envirnoment variable in the default or embedded environment.
4628
4629
wdenk2729af92004-05-03 20:45:30 +00004630Command Line Parsing:
4631=====================
stroesec1551ea2003-04-04 15:53:41 +00004632
wdenk2729af92004-05-03 20:45:30 +00004633There are two different command line parsers available with U-Boot:
4634the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004635
wdenk2729af92004-05-03 20:45:30 +00004636Old, simple command line parser:
4637--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004638
wdenk2729af92004-05-03 20:45:30 +00004639- supports environment variables (through setenv / saveenv commands)
4640- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004641- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004642- special characters ('$', ';') can be escaped by prefixing with '\',
4643 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004644 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004645- You can also escape text by enclosing in single apostrophes, for example:
4646 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004647
wdenk2729af92004-05-03 20:45:30 +00004648Hush shell:
4649-----------
wdenkf07771c2003-05-28 08:06:31 +00004650
wdenk2729af92004-05-03 20:45:30 +00004651- similar to Bourne shell, with control structures like
4652 if...then...else...fi, for...do...done; while...do...done,
4653 until...do...done, ...
4654- supports environment ("global") variables (through setenv / saveenv
4655 commands) and local shell variables (through standard shell syntax
4656 "name=value"); only environment variables can be used with "run"
4657 command
wdenkf07771c2003-05-28 08:06:31 +00004658
wdenk2729af92004-05-03 20:45:30 +00004659General rules:
4660--------------
wdenkf07771c2003-05-28 08:06:31 +00004661
wdenk2729af92004-05-03 20:45:30 +00004662(1) If a command line (or an environment variable executed by a "run"
4663 command) contains several commands separated by semicolon, and
4664 one of these commands fails, then the remaining commands will be
4665 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004666
wdenk2729af92004-05-03 20:45:30 +00004667(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004668 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004669 command will cause "run" to terminate, i. e. the remaining
4670 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004671
wdenk2729af92004-05-03 20:45:30 +00004672Note for Redundant Ethernet Interfaces:
4673=======================================
wdenkf07771c2003-05-28 08:06:31 +00004674
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004675Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004676such configurations and is capable of automatic selection of a
4677"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004678
wdenk2729af92004-05-03 20:45:30 +00004679Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4680MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4681"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004682
wdenk2729af92004-05-03 20:45:30 +00004683If the network interface stores some valid MAC address (for instance
4684in SROM), this is used as default address if there is NO correspon-
4685ding setting in the environment; if the corresponding environment
4686variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004687
wdenk2729af92004-05-03 20:45:30 +00004688o If the SROM has a valid MAC address, and there is no address in the
4689 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004690
wdenk2729af92004-05-03 20:45:30 +00004691o If there is no valid address in the SROM, and a definition in the
4692 environment exists, then the value from the environment variable is
4693 used.
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk2729af92004-05-03 20:45:30 +00004695o If both the SROM and the environment contain a MAC address, and
4696 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk2729af92004-05-03 20:45:30 +00004698o If both the SROM and the environment contain a MAC address, and the
4699 addresses differ, the value from the environment is used and a
4700 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk2729af92004-05-03 20:45:30 +00004702o If neither SROM nor the environment contain a MAC address, an error
4703 is raised.
wdenkc6097192002-11-03 00:24:07 +00004704
Ben Warrenecee9322010-04-26 11:11:46 -07004705If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004706will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004707may be skipped by setting the appropriate 'ethmacskip' environment variable.
4708The naming convention is as follows:
4709"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004710
wdenk2729af92004-05-03 20:45:30 +00004711Image Formats:
4712==============
wdenkc6097192002-11-03 00:24:07 +00004713
Marian Balakowicz3310c542008-03-12 12:13:13 +01004714U-Boot is capable of booting (and performing other auxiliary operations on)
4715images in two formats:
4716
4717New uImage format (FIT)
4718-----------------------
4719
4720Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4721to Flattened Device Tree). It allows the use of images with multiple
4722components (several kernels, ramdisks, etc.), with contents protected by
4723SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4724
4725
4726Old uImage format
4727-----------------
4728
4729Old image format is based on binary files which can be basically anything,
4730preceded by a special header; see the definitions in include/image.h for
4731details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004732
wdenk2729af92004-05-03 20:45:30 +00004733* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4734 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004735 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4736 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4737 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004738* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004739 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4740 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004741* Compression Type (uncompressed, gzip, bzip2)
4742* Load Address
4743* Entry Point
4744* Image Name
4745* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk2729af92004-05-03 20:45:30 +00004747The header is marked by a special Magic Number, and both the header
4748and the data portions of the image are secured against corruption by
4749CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004750
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk2729af92004-05-03 20:45:30 +00004752Linux Support:
4753==============
wdenkc6097192002-11-03 00:24:07 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755Although U-Boot should support any OS or standalone application
4756easily, the main focus has always been on Linux during the design of
4757U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004758
wdenk2729af92004-05-03 20:45:30 +00004759U-Boot includes many features that so far have been part of some
4760special "boot loader" code within the Linux kernel. Also, any
4761"initrd" images to be used are no longer part of one big Linux image;
4762instead, kernel and "initrd" are separate images. This implementation
4763serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004764
wdenk2729af92004-05-03 20:45:30 +00004765- the same features can be used for other OS or standalone
4766 applications (for instance: using compressed images to reduce the
4767 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk2729af92004-05-03 20:45:30 +00004769- it becomes much easier to port new Linux kernel versions because
4770 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk2729af92004-05-03 20:45:30 +00004772- the same Linux kernel image can now be used with different "initrd"
4773 images; of course this also means that different kernel images can
4774 be run with the same "initrd". This makes testing easier (you don't
4775 have to build a new "zImage.initrd" Linux image when you just
4776 change a file in your "initrd"). Also, a field-upgrade of the
4777 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004778
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk2729af92004-05-03 20:45:30 +00004780Linux HOWTO:
4781============
wdenkc6097192002-11-03 00:24:07 +00004782
wdenk2729af92004-05-03 20:45:30 +00004783Porting Linux to U-Boot based systems:
4784---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004785
wdenk2729af92004-05-03 20:45:30 +00004786U-Boot cannot save you from doing all the necessary modifications to
4787configure the Linux device drivers for use with your target hardware
4788(no, we don't intend to provide a full virtual machine interface to
4789Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004790
Stefan Roesea47a12b2010-04-15 16:07:28 +02004791But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk2729af92004-05-03 20:45:30 +00004793Just make sure your machine specific header file (for instance
4794include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004795Information structure as we define in include/asm-<arch>/u-boot.h,
4796and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004797as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004798
wdenkc6097192002-11-03 00:24:07 +00004799
wdenk2729af92004-05-03 20:45:30 +00004800Configuring the Linux kernel:
4801-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004802
wdenk2729af92004-05-03 20:45:30 +00004803No specific requirements for U-Boot. Make sure you have some root
4804device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004805
wdenkc6097192002-11-03 00:24:07 +00004806
wdenk2729af92004-05-03 20:45:30 +00004807Building a Linux Image:
4808-----------------------
wdenkc6097192002-11-03 00:24:07 +00004809
wdenk2729af92004-05-03 20:45:30 +00004810With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4811not used. If you use recent kernel source, a new build target
4812"uImage" will exist which automatically builds an image usable by
4813U-Boot. Most older kernels also have support for a "pImage" target,
4814which was introduced for our predecessor project PPCBoot and uses a
4815100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004816
wdenk2729af92004-05-03 20:45:30 +00004817Example:
wdenkc6097192002-11-03 00:24:07 +00004818
wdenk2729af92004-05-03 20:45:30 +00004819 make TQM850L_config
4820 make oldconfig
4821 make dep
4822 make uImage
wdenkc6097192002-11-03 00:24:07 +00004823
wdenk2729af92004-05-03 20:45:30 +00004824The "uImage" build target uses a special tool (in 'tools/mkimage') to
4825encapsulate a compressed Linux kernel image with header information,
4826CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk2729af92004-05-03 20:45:30 +00004828* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk2729af92004-05-03 20:45:30 +00004830* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004831
wdenk2729af92004-05-03 20:45:30 +00004832 ${CROSS_COMPILE}-objcopy -O binary \
4833 -R .note -R .comment \
4834 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004835
wdenk2729af92004-05-03 20:45:30 +00004836* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004837
wdenk2729af92004-05-03 20:45:30 +00004838 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004839
wdenk2729af92004-05-03 20:45:30 +00004840* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004841
wdenk2729af92004-05-03 20:45:30 +00004842 mkimage -A ppc -O linux -T kernel -C gzip \
4843 -a 0 -e 0 -n "Linux Kernel Image" \
4844 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004845
wdenk24ee89b2002-11-03 17:56:27 +00004846
wdenk2729af92004-05-03 20:45:30 +00004847The "mkimage" tool can also be used to create ramdisk images for use
4848with U-Boot, either separated from the Linux kernel image, or
4849combined into one file. "mkimage" encapsulates the images with a 64
4850byte header containing information about target architecture,
4851operating system, image type, compression method, entry points, time
4852stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004853
wdenk2729af92004-05-03 20:45:30 +00004854"mkimage" can be called in two ways: to verify existing images and
4855print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004856
wdenk2729af92004-05-03 20:45:30 +00004857In the first form (with "-l" option) mkimage lists the information
4858contained in the header of an existing U-Boot image; this includes
4859checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004860
wdenk2729af92004-05-03 20:45:30 +00004861 tools/mkimage -l image
4862 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004863
wdenk2729af92004-05-03 20:45:30 +00004864The second form (with "-d" option) is used to build a U-Boot image
4865from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004866
wdenk2729af92004-05-03 20:45:30 +00004867 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4868 -n name -d data_file image
4869 -A ==> set architecture to 'arch'
4870 -O ==> set operating system to 'os'
4871 -T ==> set image type to 'type'
4872 -C ==> set compression type 'comp'
4873 -a ==> set load address to 'addr' (hex)
4874 -e ==> set entry point to 'ep' (hex)
4875 -n ==> set image name to 'name'
4876 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004877
wdenk69459792004-05-29 16:53:29 +00004878Right now, all Linux kernels for PowerPC systems use the same load
4879address (0x00000000), but the entry point address depends on the
4880kernel version:
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk2729af92004-05-03 20:45:30 +00004882- 2.2.x kernels have the entry point at 0x0000000C,
4883- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004884
wdenk2729af92004-05-03 20:45:30 +00004885So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk2729af92004-05-03 20:45:30 +00004887 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4888 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004889 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004890 > examples/uImage.TQM850L
4891 Image Name: 2.4.4 kernel for TQM850L
4892 Created: Wed Jul 19 02:34:59 2000
4893 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4894 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4895 Load Address: 0x00000000
4896 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004897
wdenk2729af92004-05-03 20:45:30 +00004898To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004899
wdenk2729af92004-05-03 20:45:30 +00004900 -> tools/mkimage -l examples/uImage.TQM850L
4901 Image Name: 2.4.4 kernel for TQM850L
4902 Created: Wed Jul 19 02:34:59 2000
4903 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4904 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4905 Load Address: 0x00000000
4906 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004907
wdenk2729af92004-05-03 20:45:30 +00004908NOTE: for embedded systems where boot time is critical you can trade
4909speed for memory and install an UNCOMPRESSED image instead: this
4910needs more space in Flash, but boots much faster since it does not
4911need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004912
Stefan Roesea47a12b2010-04-15 16:07:28 +02004913 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004914 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4915 > -A ppc -O linux -T kernel -C none -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 \
wdenk2729af92004-05-03 20:45:30 +00004917 > examples/uImage.TQM850L-uncompressed
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 (uncompressed)
4921 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4922 Load Address: 0x00000000
4923 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004924
wdenkc6097192002-11-03 00:24:07 +00004925
wdenk2729af92004-05-03 20:45:30 +00004926Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4927when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004928
wdenk2729af92004-05-03 20:45:30 +00004929 -> tools/mkimage -n 'Simple Ramdisk Image' \
4930 > -A ppc -O linux -T ramdisk -C gzip \
4931 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4932 Image Name: Simple Ramdisk Image
4933 Created: Wed Jan 12 14:01:50 2000
4934 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4935 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4936 Load Address: 0x00000000
4937 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004938
wdenkdb01a2e2004-04-15 23:14:49 +00004939
wdenk2729af92004-05-03 20:45:30 +00004940Installing a Linux Image:
4941-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004942
wdenk2729af92004-05-03 20:45:30 +00004943To downloading a U-Boot image over the serial (console) interface,
4944you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004945
wdenk2729af92004-05-03 20:45:30 +00004946 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004947
wdenk2729af92004-05-03 20:45:30 +00004948The 'objcopy' does not understand the information in the U-Boot
4949image header, so the resulting S-Record file will be relative to
4950address 0x00000000. To load it to a given address, you need to
4951specify the target address as 'offset' parameter with the 'loads'
4952command.
wdenkc6097192002-11-03 00:24:07 +00004953
wdenk2729af92004-05-03 20:45:30 +00004954Example: install the image to address 0x40100000 (which on the
4955TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004956
wdenk2729af92004-05-03 20:45:30 +00004957 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004958
wdenk2729af92004-05-03 20:45:30 +00004959 .......... done
4960 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004961
wdenk2729af92004-05-03 20:45:30 +00004962 => loads 40100000
4963 ## Ready for S-Record download ...
4964 ~>examples/image.srec
4965 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4966 ...
4967 15989 15990 15991 15992
4968 [file transfer complete]
4969 [connected]
4970 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004971
4972
wdenk2729af92004-05-03 20:45:30 +00004973You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004974this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004975corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004976
wdenk2729af92004-05-03 20:45:30 +00004977 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004978
wdenk2729af92004-05-03 20:45:30 +00004979 ## Checking Image at 40100000 ...
4980 Image Name: 2.2.13 for initrd on TQM850L
4981 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4982 Data Size: 335725 Bytes = 327 kB = 0 MB
4983 Load Address: 00000000
4984 Entry Point: 0000000c
4985 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004986
4987
wdenk2729af92004-05-03 20:45:30 +00004988Boot Linux:
4989-----------
wdenkc6097192002-11-03 00:24:07 +00004990
wdenk2729af92004-05-03 20:45:30 +00004991The "bootm" command is used to boot an application that is stored in
4992memory (RAM or Flash). In case of a Linux kernel image, the contents
4993of the "bootargs" environment variable is passed to the kernel as
4994parameters. You can check and modify this variable using the
4995"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004996
4997
wdenk2729af92004-05-03 20:45:30 +00004998 => printenv bootargs
4999 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk2729af92004-05-03 20:45:30 +00005001 => 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 +00005002
wdenk2729af92004-05-03 20:45:30 +00005003 => printenv bootargs
5004 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 +00005005
wdenk2729af92004-05-03 20:45:30 +00005006 => bootm 40020000
5007 ## Booting Linux kernel at 40020000 ...
5008 Image Name: 2.2.13 for NFS on TQM850L
5009 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5010 Data Size: 381681 Bytes = 372 kB = 0 MB
5011 Load Address: 00000000
5012 Entry Point: 0000000c
5013 Verifying Checksum ... OK
5014 Uncompressing Kernel Image ... OK
5015 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
5016 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5017 time_init: decrementer frequency = 187500000/60
5018 Calibrating delay loop... 49.77 BogoMIPS
5019 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5020 ...
wdenkc6097192002-11-03 00:24:07 +00005021
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005022If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005023the memory addresses of both the kernel and the initrd image (PPBCOOT
5024format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk2729af92004-05-03 20:45:30 +00005026 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk2729af92004-05-03 20:45:30 +00005028 ## Checking Image at 40100000 ...
5029 Image Name: 2.2.13 for initrd on TQM850L
5030 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5031 Data Size: 335725 Bytes = 327 kB = 0 MB
5032 Load Address: 00000000
5033 Entry Point: 0000000c
5034 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005035
wdenk2729af92004-05-03 20:45:30 +00005036 ## Checking Image at 40200000 ...
5037 Image Name: Simple Ramdisk Image
5038 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5039 Data Size: 566530 Bytes = 553 kB = 0 MB
5040 Load Address: 00000000
5041 Entry Point: 00000000
5042 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005043
wdenk2729af92004-05-03 20:45:30 +00005044 => bootm 40100000 40200000
5045 ## Booting Linux kernel at 40100000 ...
5046 Image Name: 2.2.13 for initrd on TQM850L
5047 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5048 Data Size: 335725 Bytes = 327 kB = 0 MB
5049 Load Address: 00000000
5050 Entry Point: 0000000c
5051 Verifying Checksum ... OK
5052 Uncompressing Kernel Image ... OK
5053 ## Loading RAMDisk Image at 40200000 ...
5054 Image Name: Simple Ramdisk Image
5055 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5056 Data Size: 566530 Bytes = 553 kB = 0 MB
5057 Load Address: 00000000
5058 Entry Point: 00000000
5059 Verifying Checksum ... OK
5060 Loading Ramdisk ... OK
5061 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
5062 Boot arguments: root=/dev/ram
5063 time_init: decrementer frequency = 187500000/60
5064 Calibrating delay loop... 49.77 BogoMIPS
5065 ...
5066 RAMDISK: Compressed image found at block 0
5067 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk2729af92004-05-03 20:45:30 +00005069 bash#
wdenkc6097192002-11-03 00:24:07 +00005070
Matthew McClintock02677682006-06-28 10:41:37 -05005071Boot Linux and pass a flat device tree:
5072-----------
5073
5074First, U-Boot must be compiled with the appropriate defines. See the section
5075titled "Linux Kernel Interface" above for a more in depth explanation. The
5076following is an example of how to start a kernel and pass an updated
5077flat device tree:
5078
5079=> print oftaddr
5080oftaddr=0x300000
5081=> print oft
5082oft=oftrees/mpc8540ads.dtb
5083=> tftp $oftaddr $oft
5084Speed: 1000, full duplex
5085Using TSEC0 device
5086TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5087Filename 'oftrees/mpc8540ads.dtb'.
5088Load address: 0x300000
5089Loading: #
5090done
5091Bytes transferred = 4106 (100a hex)
5092=> tftp $loadaddr $bootfile
5093Speed: 1000, full duplex
5094Using TSEC0 device
5095TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5096Filename 'uImage'.
5097Load address: 0x200000
5098Loading:############
5099done
5100Bytes transferred = 1029407 (fb51f hex)
5101=> print loadaddr
5102loadaddr=200000
5103=> print oftaddr
5104oftaddr=0x300000
5105=> bootm $loadaddr - $oftaddr
5106## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005107 Image Name: Linux-2.6.17-dirty
5108 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5109 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005110 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005111 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005112 Verifying Checksum ... OK
5113 Uncompressing Kernel Image ... OK
5114Booting using flat device tree at 0x300000
5115Using MPC85xx ADS machine description
5116Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5117[snip]
5118
5119
wdenk2729af92004-05-03 20:45:30 +00005120More About U-Boot Image Types:
5121------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005122
wdenk2729af92004-05-03 20:45:30 +00005123U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005124
wdenk2729af92004-05-03 20:45:30 +00005125 "Standalone Programs" are directly runnable in the environment
5126 provided by U-Boot; it is expected that (if they behave
5127 well) you can continue to work in U-Boot after return from
5128 the Standalone Program.
5129 "OS Kernel Images" are usually images of some Embedded OS which
5130 will take over control completely. Usually these programs
5131 will install their own set of exception handlers, device
5132 drivers, set up the MMU, etc. - this means, that you cannot
5133 expect to re-enter U-Boot except by resetting the CPU.
5134 "RAMDisk Images" are more or less just data blocks, and their
5135 parameters (address, size) are passed to an OS kernel that is
5136 being started.
5137 "Multi-File Images" contain several images, typically an OS
5138 (Linux) kernel image and one or more data images like
5139 RAMDisks. This construct is useful for instance when you want
5140 to boot over the network using BOOTP etc., where the boot
5141 server provides just a single image file, but you want to get
5142 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005143
wdenk2729af92004-05-03 20:45:30 +00005144 "Multi-File Images" start with a list of image sizes, each
5145 image size (in bytes) specified by an "uint32_t" in network
5146 byte order. This list is terminated by an "(uint32_t)0".
5147 Immediately after the terminating 0 follow the images, one by
5148 one, all aligned on "uint32_t" boundaries (size rounded up to
5149 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00005150
wdenk2729af92004-05-03 20:45:30 +00005151 "Firmware Images" are binary images containing firmware (like
5152 U-Boot or FPGA images) which usually will be programmed to
5153 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00005154
wdenk2729af92004-05-03 20:45:30 +00005155 "Script files" are command sequences that will be executed by
5156 U-Boot's command interpreter; this feature is especially
5157 useful when you configure U-Boot to use a real shell (hush)
5158 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00005159
Marek Vasut44f074c2012-03-14 21:52:45 +00005160Booting the Linux zImage:
5161-------------------------
5162
5163On some platforms, it's possible to boot Linux zImage. This is done
5164using the "bootz" command. The syntax of "bootz" command is the same
5165as the syntax of "bootm" command.
5166
Tom Rini8ac28562013-05-16 11:40:11 -04005167Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00005168kernel with raw initrd images. The syntax is slightly different, the
5169address of the initrd must be augmented by it's size, in the following
5170format: "<initrd addres>:<initrd size>".
5171
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk2729af92004-05-03 20:45:30 +00005173Standalone HOWTO:
5174=================
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk2729af92004-05-03 20:45:30 +00005176One of the features of U-Boot is that you can dynamically load and
5177run "standalone" applications, which can use some resources of
5178U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00005179
wdenk2729af92004-05-03 20:45:30 +00005180Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk2729af92004-05-03 20:45:30 +00005182"Hello World" Demo:
5183-------------------
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk2729af92004-05-03 20:45:30 +00005185'examples/hello_world.c' contains a small "Hello World" Demo
5186application; it is automatically compiled when you build U-Boot.
5187It's configured to run at address 0x00040004, so you can play with it
5188like that:
wdenkc6097192002-11-03 00:24:07 +00005189
wdenk2729af92004-05-03 20:45:30 +00005190 => loads
5191 ## Ready for S-Record download ...
5192 ~>examples/hello_world.srec
5193 1 2 3 4 5 6 7 8 9 10 11 ...
5194 [file transfer complete]
5195 [connected]
5196 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk2729af92004-05-03 20:45:30 +00005198 => go 40004 Hello World! This is a test.
5199 ## Starting application at 0x00040004 ...
5200 Hello World
5201 argc = 7
5202 argv[0] = "40004"
5203 argv[1] = "Hello"
5204 argv[2] = "World!"
5205 argv[3] = "This"
5206 argv[4] = "is"
5207 argv[5] = "a"
5208 argv[6] = "test."
5209 argv[7] = "<NULL>"
5210 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk2729af92004-05-03 20:45:30 +00005212 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005213
wdenk2729af92004-05-03 20:45:30 +00005214Another example, which demonstrates how to register a CPM interrupt
5215handler with the U-Boot code, can be found in 'examples/timer.c'.
5216Here, a CPM timer is set up to generate an interrupt every second.
5217The interrupt service routine is trivial, just printing a '.'
5218character, but this is just a demo program. The application can be
5219controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk2729af92004-05-03 20:45:30 +00005221 ? - print current values og the CPM Timer registers
5222 b - enable interrupts and start timer
5223 e - stop timer and disable interrupts
5224 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk2729af92004-05-03 20:45:30 +00005226 => loads
5227 ## Ready for S-Record download ...
5228 ~>examples/timer.srec
5229 1 2 3 4 5 6 7 8 9 10 11 ...
5230 [file transfer complete]
5231 [connected]
5232 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005233
wdenk2729af92004-05-03 20:45:30 +00005234 => go 40004
5235 ## Starting application at 0x00040004 ...
5236 TIMERS=0xfff00980
5237 Using timer 1
5238 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005239
wdenk2729af92004-05-03 20:45:30 +00005240Hit 'b':
5241 [q, b, e, ?] Set interval 1000000 us
5242 Enabling timer
5243Hit '?':
5244 [q, b, e, ?] ........
5245 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5246Hit '?':
5247 [q, b, e, ?] .
5248 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5249Hit '?':
5250 [q, b, e, ?] .
5251 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5252Hit '?':
5253 [q, b, e, ?] .
5254 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5255Hit 'e':
5256 [q, b, e, ?] ...Stopping timer
5257Hit 'q':
5258 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005259
5260
wdenk2729af92004-05-03 20:45:30 +00005261Minicom warning:
5262================
wdenk85ec0bc2003-03-31 16:34:49 +00005263
wdenk2729af92004-05-03 20:45:30 +00005264Over time, many people have reported problems when trying to use the
5265"minicom" terminal emulation program for serial download. I (wd)
5266consider minicom to be broken, and recommend not to use it. Under
5267Unix, I recommend to use C-Kermit for general purpose use (and
5268especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00005269use "cu" for S-Record download ("loads" command). See
5270http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5271for help with kermit.
5272
wdenk85ec0bc2003-03-31 16:34:49 +00005273
wdenk2729af92004-05-03 20:45:30 +00005274Nevertheless, if you absolutely want to use it try adding this
5275configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00005276
wdenk2729af92004-05-03 20:45:30 +00005277 Name Program Name U/D FullScr IO-Red. Multi
5278 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5279 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00005280
5281
wdenk2729af92004-05-03 20:45:30 +00005282NetBSD Notes:
5283=============
wdenkc6097192002-11-03 00:24:07 +00005284
wdenk2729af92004-05-03 20:45:30 +00005285Starting at version 0.9.2, U-Boot supports NetBSD both as host
5286(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00005287
wdenk2729af92004-05-03 20:45:30 +00005288Building requires a cross environment; it is known to work on
5289NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5290need gmake since the Makefiles are not compatible with BSD make).
5291Note that the cross-powerpc package does not install include files;
5292attempting to build U-Boot will fail because <machine/ansi.h> is
5293missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk2729af92004-05-03 20:45:30 +00005295 # cd /usr/pkg/cross/powerpc-netbsd/include
5296 # mkdir powerpc
5297 # ln -s powerpc machine
5298 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5299 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00005300
wdenk2729af92004-05-03 20:45:30 +00005301Native builds *don't* work due to incompatibilities between native
5302and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005303
wdenk2729af92004-05-03 20:45:30 +00005304Booting assumes that (the first part of) the image booted is a
5305stage-2 loader which in turn loads and then invokes the kernel
5306proper. Loader sources will eventually appear in the NetBSD source
5307tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00005308meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005309
5310
wdenk2729af92004-05-03 20:45:30 +00005311Implementation Internals:
5312=========================
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk2729af92004-05-03 20:45:30 +00005314The following is not intended to be a complete description of every
5315implementation detail. However, it should help to understand the
5316inner workings of U-Boot and make it easier to port it to custom
5317hardware.
wdenkc6097192002-11-03 00:24:07 +00005318
5319
wdenk2729af92004-05-03 20:45:30 +00005320Initial Stack, Global Data:
5321---------------------------
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk2729af92004-05-03 20:45:30 +00005323The implementation of U-Boot is complicated by the fact that U-Boot
5324starts running out of ROM (flash memory), usually without access to
5325system RAM (because the memory controller is not initialized yet).
5326This means that we don't have writable Data or BSS segments, and BSS
5327is not initialized as zero. To be able to get a C environment working
5328at all, we have to allocate at least a minimal stack. Implementation
5329options for this are defined and restricted by the CPU used: Some CPU
5330models provide on-chip memory (like the IMMR area on MPC8xx and
5331MPC826x processors), on others (parts of) the data cache can be
5332locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005333
Wolfgang Denk218ca722008-03-26 10:40:12 +01005334 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01005335 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00005336
wdenk2729af92004-05-03 20:45:30 +00005337 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5338 From: "Chris Hallinan" <clh@net1plus.com>
5339 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5340 ...
wdenk43d96162003-03-06 00:02:04 +00005341
wdenk2729af92004-05-03 20:45:30 +00005342 Correct me if I'm wrong, folks, but the way I understand it
5343 is this: Using DCACHE as initial RAM for Stack, etc, does not
5344 require any physical RAM backing up the cache. The cleverness
5345 is that the cache is being used as a temporary supply of
5346 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005347 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00005348 can see how this works by studying the cache architecture and
5349 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00005350
wdenk2729af92004-05-03 20:45:30 +00005351 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5352 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005353 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00005354 option should work for you. Using CS 4 should be fine if your
5355 board designers haven't used it for something that would
5356 cause you grief during the initial boot! It is frequently not
5357 used.
wdenk43d96162003-03-06 00:02:04 +00005358
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005359 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00005360 with your processor/board/system design. The default value
5361 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02005362 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00005363 than your SDRAM module. If you have a 64MB SDRAM module, set
5364 it above 400_0000. Just make sure your board has no resources
5365 that are supposed to respond to that address! That code in
5366 start.S has been around a while and should work as is when
5367 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00005368
wdenk2729af92004-05-03 20:45:30 +00005369 -Chris Hallinan
5370 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00005371
wdenk2729af92004-05-03 20:45:30 +00005372It is essential to remember this, since it has some impact on the C
5373code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk2729af92004-05-03 20:45:30 +00005375* Initialized global data (data segment) is read-only. Do not attempt
5376 to write it.
wdenkc6097192002-11-03 00:24:07 +00005377
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005378* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00005379 as zero data - BSS segment) at all - this is undefined, initiali-
5380 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00005381
wdenk2729af92004-05-03 20:45:30 +00005382* Stack space is very limited. Avoid big data buffers or things like
5383 that.
wdenkc6097192002-11-03 00:24:07 +00005384
wdenk2729af92004-05-03 20:45:30 +00005385Having only the stack as writable memory limits means we cannot use
5386normal global data to share information beween the code. But it
5387turned out that the implementation of U-Boot can be greatly
5388simplified by making a global data structure (gd_t) available to all
5389functions. We could pass a pointer to this data as argument to _all_
5390functions, but this would bloat the code. Instead we use a feature of
5391the GCC compiler (Global Register Variables) to share the data: we
5392place a pointer (gd) to the global data into a register which we
5393reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005394
wdenk2729af92004-05-03 20:45:30 +00005395When choosing a register for such a purpose we are restricted by the
5396relevant (E)ABI specifications for the current architecture, and by
5397GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005398
wdenk2729af92004-05-03 20:45:30 +00005399For PowerPC, the following registers have specific use:
5400 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01005401 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00005402 R3-R4: parameter passing and return values
5403 R5-R10: parameter passing
5404 R13: small data area pointer
5405 R30: GOT pointer
5406 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005407
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01005408 (U-Boot also uses R12 as internal GOT pointer. r12
5409 is a volatile register so r12 needs to be reset when
5410 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005411
Wolfgang Denke7670f62008-02-14 22:43:22 +01005412 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005413
wdenk2729af92004-05-03 20:45:30 +00005414 Note: on PPC, we could use a static initializer (since the
5415 address of the global data structure is known at compile time),
5416 but it turned out that reserving a register results in somewhat
5417 smaller code - although the code savings are not that big (on
5418 average for all boards 752 bytes for the whole U-Boot image,
5419 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005420
Robin Getzc4db3352009-08-17 15:23:02 +00005421On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005422 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5423
Robin Getzc4db3352009-08-17 15:23:02 +00005424 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05005425
wdenk2729af92004-05-03 20:45:30 +00005426On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005427
wdenk2729af92004-05-03 20:45:30 +00005428 R0: function argument word/integer result
5429 R1-R3: function argument word
5430 R9: GOT pointer
5431 R10: stack limit (used only if stack checking if enabled)
5432 R11: argument (frame) pointer
5433 R12: temporary workspace
5434 R13: stack pointer
5435 R14: link register
5436 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005437
wdenk2729af92004-05-03 20:45:30 +00005438 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005439
Thomas Chou0df01fd2010-05-21 11:08:03 +08005440On Nios II, the ABI is documented here:
5441 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5442
5443 ==> U-Boot will use gp to hold a pointer to the global data
5444
5445 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5446 to access small data sections, so gp is free.
5447
Macpaul Linafc1ce82011-10-19 20:41:11 +00005448On NDS32, the following registers are used:
5449
5450 R0-R1: argument/return
5451 R2-R5: argument
5452 R15: temporary register for assembler
5453 R16: trampoline register
5454 R28: frame pointer (FP)
5455 R29: global pointer (GP)
5456 R30: link register (LP)
5457 R31: stack pointer (SP)
5458 PC: program counter (PC)
5459
5460 ==> U-Boot will use R10 to hold a pointer to the global data
5461
Wolfgang Denkd87080b2006-03-31 18:32:53 +02005462NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5463or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk2729af92004-05-03 20:45:30 +00005465Memory Management:
5466------------------
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk2729af92004-05-03 20:45:30 +00005468U-Boot runs in system state and uses physical addresses, i.e. the
5469MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005470
wdenk2729af92004-05-03 20:45:30 +00005471The available memory is mapped to fixed addresses using the memory
5472controller. In this process, a contiguous block is formed for each
5473memory type (Flash, SDRAM, SRAM), even when it consists of several
5474physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005475
wdenk2729af92004-05-03 20:45:30 +00005476U-Boot is installed in the first 128 kB of the first Flash bank (on
5477TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5478booting and sizing and initializing DRAM, the code relocates itself
5479to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005480memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00005481configuration setting]. Below that, a structure with global Board
5482Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005483
wdenk2729af92004-05-03 20:45:30 +00005484Additionally, some exception handler code is copied to the low 8 kB
5485of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005486
wdenk2729af92004-05-03 20:45:30 +00005487So a typical memory configuration with 16 MB of DRAM could look like
5488this:
wdenkc6097192002-11-03 00:24:07 +00005489
wdenk2729af92004-05-03 20:45:30 +00005490 0x0000 0000 Exception Vector code
5491 :
5492 0x0000 1FFF
5493 0x0000 2000 Free for Application Use
5494 :
5495 :
wdenkc6097192002-11-03 00:24:07 +00005496
wdenk2729af92004-05-03 20:45:30 +00005497 :
5498 :
5499 0x00FB FF20 Monitor Stack (Growing downward)
5500 0x00FB FFAC Board Info Data and permanent copy of global data
5501 0x00FC 0000 Malloc Arena
5502 :
5503 0x00FD FFFF
5504 0x00FE 0000 RAM Copy of Monitor Code
5505 ... eventually: LCD or video framebuffer
5506 ... eventually: pRAM (Protected RAM - unchanged by reset)
5507 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005508
5509
wdenk2729af92004-05-03 20:45:30 +00005510System Initialization:
5511----------------------
wdenkc6097192002-11-03 00:24:07 +00005512
wdenk2729af92004-05-03 20:45:30 +00005513In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005514(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00005515configuration for CS0# this is a mirror of the onboard Flash memory.
5516To be able to re-map memory U-Boot then jumps to its link address.
5517To be able to implement the initialization code in C, a (small!)
5518initial stack is set up in the internal Dual Ported RAM (in case CPUs
5519which provide such a feature like MPC8xx or MPC8260), or in a locked
5520part of the data cache. After that, U-Boot initializes the CPU core,
5521the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk2729af92004-05-03 20:45:30 +00005523Next, all (potentially) available memory banks are mapped using a
5524preliminary mapping. For example, we put them on 512 MB boundaries
5525(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5526on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5527programmed for SDRAM access. Using the temporary configuration, a
5528simple memory test is run that determines the size of the SDRAM
5529banks.
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk2729af92004-05-03 20:45:30 +00005531When there is more than one SDRAM bank, and the banks are of
5532different size, the largest is mapped first. For equal size, the first
5533bank (CS2#) is mapped first. The first mapping is always for address
55340x00000000, with any additional banks following immediately to create
5535contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk2729af92004-05-03 20:45:30 +00005537Then, the monitor installs itself at the upper end of the SDRAM area
5538and allocates memory for use by malloc() and for the global Board
5539Info data; also, the exception vector code is copied to the low RAM
5540pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005541
wdenk2729af92004-05-03 20:45:30 +00005542Only after this relocation will you have a "normal" C environment;
5543until that you are restricted in several ways, mostly because you are
5544running from ROM, and because the code will have to be relocated to a
5545new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005546
5547
wdenk2729af92004-05-03 20:45:30 +00005548U-Boot Porting Guide:
5549----------------------
wdenkc6097192002-11-03 00:24:07 +00005550
wdenk2729af92004-05-03 20:45:30 +00005551[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5552list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005553
5554
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005555int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005556{
5557 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005558
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005559 signal(SIGALRM, no_more_time);
5560 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk2729af92004-05-03 20:45:30 +00005562 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005563 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005564 return 0;
5565 }
5566
wdenk2729af92004-05-03 20:45:30 +00005567 Download latest U-Boot source;
5568
Wolfgang Denk06682362008-12-30 22:56:11 +01005569 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005570
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005571 if (clueless)
5572 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk2729af92004-05-03 20:45:30 +00005574 while (learning) {
5575 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005576 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5577 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005578 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005579 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005580 }
wdenkc6097192002-11-03 00:24:07 +00005581
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005582 if (available_money > toLocalCurrency ($2500))
5583 Buy a BDI3000;
5584 else
wdenk2729af92004-05-03 20:45:30 +00005585 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005586
5587 if (a similar board exists) { /* hopefully... */
5588 cp -a board/<similar> board/<myboard>
5589 cp include/configs/<similar>.h include/configs/<myboard>.h
5590 } else {
5591 Create your own board support subdirectory;
5592 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005593 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005594 Edit new board/<myboard> files
5595 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005596
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005597 while (!accepted) {
5598 while (!running) {
5599 do {
5600 Add / modify source code;
5601 } until (compiles);
5602 Debug;
5603 if (clueless)
5604 email("Hi, I am having problems...");
5605 }
5606 Send patch file to the U-Boot email list;
5607 if (reasonable critiques)
5608 Incorporate improvements from email list code review;
5609 else
5610 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005611 }
wdenkc6097192002-11-03 00:24:07 +00005612
wdenk2729af92004-05-03 20:45:30 +00005613 return 0;
5614}
5615
5616void no_more_time (int sig)
5617{
5618 hire_a_guru();
5619}
wdenkc6097192002-11-03 00:24:07 +00005620
5621
wdenk2729af92004-05-03 20:45:30 +00005622Coding Standards:
5623-----------------
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk2729af92004-05-03 20:45:30 +00005625All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005626coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005627"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005628
Detlev Zundel2c051652006-09-01 15:39:02 +02005629Source files originating from a different project (for example the
5630MTD subsystem) are generally exempt from these guidelines and are not
5631reformated to ease subsequent migration to newer versions of those
5632sources.
5633
5634Please note that U-Boot is implemented in C (and to some small parts in
5635Assembler); no C++ is used, so please do not use C++ style comments (//)
5636in your code.
wdenk2729af92004-05-03 20:45:30 +00005637
5638Please also stick to the following formatting rules:
5639- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005640- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005641- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005642- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005643- do not add trailing empty lines to source files
5644
5645Submissions which do not conform to the standards may be returned
5646with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005647
5648
wdenk2729af92004-05-03 20:45:30 +00005649Submitting Patches:
5650-------------------
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652Since the number of patches for U-Boot is growing, we need to
5653establish some rules. Submissions which do not conform to these rules
5654may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005655
Magnus Lilja0d28f342008-08-06 19:32:33 +02005656Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005657
Wolfgang Denk06682362008-12-30 22:56:11 +01005658Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5659see http://lists.denx.de/mailman/listinfo/u-boot
5660
wdenk2729af92004-05-03 20:45:30 +00005661When you send a patch, please include the following information with
5662it:
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk2729af92004-05-03 20:45:30 +00005664* For bug fixes: a description of the bug and how your patch fixes
5665 this bug. Please try to include a way of demonstrating that the
5666 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005667
wdenk2729af92004-05-03 20:45:30 +00005668* For new features: a description of the feature and your
5669 implementation.
wdenkc6097192002-11-03 00:24:07 +00005670
wdenk2729af92004-05-03 20:45:30 +00005671* A CHANGELOG entry as plaintext (separate from the patch)
5672
5673* For major contributions, your entry to the CREDITS file
5674
5675* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005676 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005677
5678* If your patch adds new configuration options, don't forget to
5679 document these in the README file.
5680
Wolfgang Denk218ca722008-03-26 10:40:12 +01005681* The patch itself. If you are using git (which is *strongly*
5682 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005683 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005684 the U-Boot mailing list, you will avoid most of the common problems
5685 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005686
Wolfgang Denk218ca722008-03-26 10:40:12 +01005687 If you cannot use git, use "diff -purN OLD NEW". If your version of
5688 diff does not support these options, then get the latest version of
5689 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005690
Wolfgang Denk218ca722008-03-26 10:40:12 +01005691 The current directory when running this command shall be the parent
5692 directory of the U-Boot source tree (i. e. please make sure that
5693 your patch includes sufficient directory information for the
5694 affected files).
5695
5696 We prefer patches as plain text. MIME attachments are discouraged,
5697 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005698
5699* If one logical set of modifications affects or creates several
5700 files, all these changes shall be submitted in a SINGLE patch file.
5701
5702* Changesets that contain different, unrelated modifications shall be
5703 submitted as SEPARATE patches, one patch per changeset.
5704
5705
5706Notes:
5707
5708* Before sending the patch, run the MAKEALL script on your patched
5709 source tree and make sure that no errors or warnings are reported
5710 for any of the boards.
5711
5712* Keep your modifications to the necessary minimum: A patch
5713 containing several unrelated changes or arbitrary reformats will be
5714 returned with a request to re-formatting / split it.
5715
5716* If you modify existing code, make sure that your new code does not
5717 add to the memory footprint of the code ;-) Small is beautiful!
5718 When adding new features, these should compile conditionally only
5719 (using #ifdef), and the resulting code with the new feature
5720 disabled must not need more memory than the old code without your
5721 modification.
wdenk90dc6702005-05-03 14:12:25 +00005722
Wolfgang Denk06682362008-12-30 22:56:11 +01005723* Remember that there is a size limit of 100 kB per message on the
5724 u-boot mailing list. Bigger patches will be moderated. If they are
5725 reasonable and not too big, they will be acknowledged. But patches
5726 bigger than the size limit should be avoided.