blob: 9804cea91447ec52e76e90289c8cfe05586dc4ee [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
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000137 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800184 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000186 /nds32 Files generic to NDS32 architecture
187 /cpu CPU specific files
188 /n1213 Files specific to Andes Technology N1213 CPUs
189 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /nios2 Files generic to Altera NIOS2 architecture
191 /cpu CPU specific files
192 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200193 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500194 /cpu CPU specific files
195 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
196 /mpc5xx Files specific to Freescale MPC5xx CPUs
197 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
198 /mpc8xx Files specific to Freescale MPC8xx CPUs
199 /mpc8220 Files specific to Freescale MPC8220 CPUs
200 /mpc824x Files specific to Freescale MPC824x CPUs
201 /mpc8260 Files specific to Freescale MPC8260 CPUs
202 /mpc85xx Files specific to Freescale MPC85xx CPUs
203 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
204 /lib Architecture specific library files
205 /sh Files generic to SH architecture
206 /cpu CPU specific files
207 /sh2 Files specific to sh2 CPUs
208 /sh3 Files specific to sh3 CPUs
209 /sh4 Files specific to sh4 CPUs
210 /lib Architecture specific library files
211 /sparc Files generic to SPARC architecture
212 /cpu CPU specific files
213 /leon2 Files specific to Gaisler LEON2 SPARC CPU
214 /leon3 Files specific to Gaisler LEON3 SPARC CPU
215 /lib Architecture specific library files
216/api Machine/arch independent API for external apps
217/board Board dependent files
218/common Misc architecture independent functions
219/disk Code for disk drive partition handling
220/doc Documentation (don't expect too much)
221/drivers Commonly used device drivers
222/examples Example code for standalone applications, etc.
223/fs Filesystem code (cramfs, ext2, jffs2, etc.)
224/include Header Files
225/lib Files generic to all architectures
226 /libfdt Library files to support flattened device trees
227 /lzma Library files to support LZMA decompression
228 /lzo Library files to support LZO decompression
229/net Networking code
230/post Power On Self Test
231/rtc Real Time Clock drivers
232/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000233
wdenkc6097192002-11-03 00:24:07 +0000234Software Configuration:
235=======================
236
237Configuration is usually done using C preprocessor defines; the
238rationale behind that is to avoid dead code whenever possible.
239
240There are two classes of configuration variables:
241
242* Configuration _OPTIONS_:
243 These are selectable by the user and have names beginning with
244 "CONFIG_".
245
246* Configuration _SETTINGS_:
247 These depend on the hardware etc. and should not be meddled with if
248 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200249 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000250
251Later we will add a configuration tool - probably similar to or even
252identical to what's used for the Linux kernel. Right now, we have to
253do the configuration by hand, which means creating some symbolic
254links and editing some configuration files. We use the TQM8xxL boards
255as an example here.
256
257
258Selection of Processor Architecture and Board Type:
259---------------------------------------------------
260
261For all supported boards there are ready-to-use default
262configurations available; just type "make <board_name>_config".
263
264Example: For a TQM823L module type:
265
266 cd u-boot
267 make TQM823L_config
268
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200269For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000270e.g. "make cogent_mpc8xx_config". And also configure the cogent
271directory according to the instructions in cogent/README.
272
273
274Configuration Options:
275----------------------
276
277Configuration depends on the combination of board and CPU type; all
278such information is kept in a configuration file
279"include/configs/<board_name>.h".
280
281Example: For a TQM823L module, all configuration settings are in
282"include/configs/TQM823L.h".
283
284
wdenk7f6c2cb2002-11-10 22:06:23 +0000285Many of the options are named exactly as the corresponding Linux
286kernel configuration options. The intention is to make it easier to
287build a config tool - later.
288
289
wdenkc6097192002-11-03 00:24:07 +0000290The following options need to be configured:
291
Kim Phillips26281142007-08-10 13:28:25 -0500292- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000293
Kim Phillips26281142007-08-10 13:28:25 -0500294- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200295
296- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100297 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000298
299- CPU Module Type: (if CONFIG_COGENT is defined)
300 Define exactly one of
301 CONFIG_CMA286_60_OLD
302--- FIXME --- not tested yet:
303 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304 CONFIG_CMA287_23, CONFIG_CMA287_50
305
306- Motherboard Type: (if CONFIG_COGENT is defined)
307 Define exactly one of
308 CONFIG_CMA101, CONFIG_CMA102
309
310- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311 Define one or more of
312 CONFIG_CMA302
313
314- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315 Define one or more of
316 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200317 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000318 a "rotator" |\-/|\-/
319
wdenk2535d602003-07-17 23:16:40 +0000320- Board flavour: (if CONFIG_MPC8260ADS is defined)
321 CONFIG_ADSTYPE
322 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200323 CONFIG_SYS_8260ADS - original MPC8260ADS
324 CONFIG_SYS_8266ADS - MPC8266ADS
325 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
326 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000327
Lei Wencf946c62011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
wdenkc6097192002-11-03 00:24:07 +0000333- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000334 Define exactly one of
335 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000336
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200337- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
339 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000340 e.g. if there is no 32KHz
341 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
343 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000344
wdenk66ca92a2004-09-28 17:59:53 +0000345- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_8xx_CPUCLK_MIN
347 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000348 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000349 See doc/README.MPC866
350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000352
wdenkba56f622004-02-06 23:19:44 +0000353 Define this to measure the actual CPU clock instead
354 of relying on the correctness of the configured
355 values. Mostly useful for board bringup to make sure
356 the PLL is locked at the intended frequency. Note
357 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200358 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000359
Heiko Schocher506f3912009-03-12 07:37:15 +0100360 CONFIG_SYS_DELAYED_ICACHE
361
362 Define this option if you want to enable the
363 ICache only when Code runs from RAM.
364
Kumar Gala66412c62011-02-18 05:40:54 -0600365- 85xx CPU Options:
366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala8f290842011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000377 CONFIG_SYS_PPC_E500_DEBUG_TLB
378
379 Enables a temporary TLB entry to be used during boot to work
380 around limitations in e500v1 and e500v2 external debugger
381 support. This reduces the portions of the boot code where
382 breakpoints and single stepping do not work. The value of this
383 symbol should be set to the TLB1 entry to be used for this
384 purpose.
385
Scott Wood33eee332012-08-14 10:14:53 +0000386 CONFIG_SYS_FSL_ERRATUM_A004510
387
388 Enables a workaround for erratum A004510. If set,
389 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
390 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
391
392 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
393 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
394
395 Defines one or two SoC revisions (low 8 bits of SVR)
396 for which the A004510 workaround should be applied.
397
398 The rest of SVR is either not relevant to the decision
399 of whether the erratum is present (e.g. p2040 versus
400 p2041) or is implied by the build target, which controls
401 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
402
403 See Freescale App Note 4493 for more information about
404 this erratum.
405
406 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
407
408 This is the value to write into CCSR offset 0x18600
409 according to the A004510 workaround.
410
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000411- Generic CPU options:
412 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
413
414 Defines the endianess of the CPU. Implementation of those
415 values is arch specific.
416
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100417- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200418 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100419
420 Defines the Monahans run mode to oscillator
421 ratio. Valid values are 8, 16, 24, 31. The core
422 frequency is this value multiplied by 13 MHz.
423
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200424 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200425
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100426 Defines the Monahans turbo mode to oscillator
427 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200428 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100429 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200430
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200431- MIPS CPU options:
432 CONFIG_SYS_INIT_SP_OFFSET
433
434 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
435 pointer. This is needed for the temporary stack before
436 relocation.
437
438 CONFIG_SYS_MIPS_CACHE_MODE
439
440 Cache operation mode for the MIPS CPU.
441 See also arch/mips/include/asm/mipsregs.h.
442 Possible values are:
443 CONF_CM_CACHABLE_NO_WA
444 CONF_CM_CACHABLE_WA
445 CONF_CM_UNCACHED
446 CONF_CM_CACHABLE_NONCOHERENT
447 CONF_CM_CACHABLE_CE
448 CONF_CM_CACHABLE_COW
449 CONF_CM_CACHABLE_CUW
450 CONF_CM_CACHABLE_ACCELERATED
451
452 CONFIG_SYS_XWAY_EBU_BOOTCFG
453
454 Special option for Lantiq XWAY SoCs for booting from NOR flash.
455 See also arch/mips/cpu/mips32/start.S.
456
457 CONFIG_XWAY_SWAP_BYTES
458
459 Enable compilation of tools/xway-swap-bytes needed for Lantiq
460 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
461 be swapped if a flash programmer is used.
462
Christian Rieschb67d8812012-02-02 00:44:39 +0000463- ARM options:
464 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
465
466 Select high exception vectors of the ARM core, e.g., do not
467 clear the V bit of the c1 register of CP15.
468
Aneesh V5356f542012-03-08 07:20:19 +0000469 CONFIG_SYS_THUMB_BUILD
470
471 Use this flag to build U-Boot using the Thumb instruction
472 set for ARM architectures. Thumb instruction set provides
473 better code density. For ARM architectures that support
474 Thumb2 this flag will result in Thumb2 code generated by
475 GCC.
476
wdenk5da627a2003-10-09 20:09:04 +0000477- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000478 CONFIG_CLOCKS_IN_MHZ
479
480 U-Boot stores all clock information in Hz
481 internally. For binary compatibility with older Linux
482 kernels (which expect the clocks passed in the
483 bd_info data to be in MHz) the environment variable
484 "clocks_in_mhz" can be defined so that U-Boot
485 converts clock data to MHZ before passing it to the
486 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000487 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100488 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000489 default environment.
490
wdenk5da627a2003-10-09 20:09:04 +0000491 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
492
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200493 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000494 expect it to be in bytes, others in MB.
495 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
496
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400497 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200498
499 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400500 passed using flattened device trees (based on open firmware
501 concepts).
502
503 CONFIG_OF_LIBFDT
504 * New libfdt-based support
505 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500506 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400507
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200508 OF_CPU - The proper name of the cpus node (only required for
509 MPC512X and MPC5xxx based boards).
510 OF_SOC - The proper name of the soc node (only required for
511 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200512 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600513 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200514
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200515 boards with QUICC Engines require OF_QE to set UCC MAC
516 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500517
Kumar Gala4e253132006-01-11 13:54:17 -0600518 CONFIG_OF_BOARD_SETUP
519
520 Board code has addition modification that it wants to make
521 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000522
Matthew McClintock02677682006-06-28 10:41:37 -0500523 CONFIG_OF_BOOT_CPU
524
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200525 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500526 param header, the default value is zero if undefined.
527
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200528 CONFIG_OF_IDE_FIXUP
529
530 U-Boot can detect if an IDE device is present or not.
531 If not, and this new config option is activated, U-Boot
532 removes the ATA node from the DTS before booting Linux,
533 so the Linux IDE driver does not probe the device and
534 crash. This is needed for buggy hardware (uc101) where
535 no pull down resistor is connected to the signal IDE5V_DD7.
536
Igor Grinberg7eb29392011-07-14 05:45:07 +0000537 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
538
539 This setting is mandatory for all boards that have only one
540 machine type and must be used to specify the machine type
541 number as it appears in the ARM machine registry
542 (see http://www.arm.linux.org.uk/developer/machines/).
543 Only boards that have multiple machine types supported
544 in a single configuration file and the machine type is
545 runtime discoverable, do not have to use this setting.
546
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100547- vxWorks boot parameters:
548
549 bootvx constructs a valid bootline using the following
550 environments variables: bootfile, ipaddr, serverip, hostname.
551 It loads the vxWorks image pointed bootfile.
552
553 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
554 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
555 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
556 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
557
558 CONFIG_SYS_VXWORKS_ADD_PARAMS
559
560 Add it at the end of the bootline. E.g "u=username pw=secret"
561
562 Note: If a "bootargs" environment is defined, it will overwride
563 the defaults discussed just above.
564
Aneesh V2c451f72011-06-16 23:30:47 +0000565- Cache Configuration:
566 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
567 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
568 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
569
Aneesh V93bc2192011-06-16 23:30:51 +0000570- Cache Configuration for ARM:
571 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
572 controller
573 CONFIG_SYS_PL310_BASE - Physical base address of PL310
574 controller register space
575
wdenk6705d812004-08-02 23:22:59 +0000576- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200577 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000578
579 Define this if you want support for Amba PrimeCell PL010 UARTs.
580
Andreas Engel48d01922008-09-08 14:30:53 +0200581 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000582
583 Define this if you want support for Amba PrimeCell PL011 UARTs.
584
585 CONFIG_PL011_CLOCK
586
587 If you have Amba PrimeCell PL011 UARTs, set this variable to
588 the clock speed of the UARTs.
589
590 CONFIG_PL01x_PORTS
591
592 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
593 define this to a list of base addresses for each (supported)
594 port. See e.g. include/configs/versatile.h
595
John Rigby910f1ae2011-04-19 10:42:39 +0000596 CONFIG_PL011_SERIAL_RLCR
597
598 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
599 have separate receive and transmit line control registers. Set
600 this variable to initialize the extra register.
601
602 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
603
604 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
605 boot loader that has already initialized the UART. Define this
606 variable to flush the UART at init time.
607
wdenk6705d812004-08-02 23:22:59 +0000608
wdenkc6097192002-11-03 00:24:07 +0000609- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000610 Depending on board, define exactly one serial port
611 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
612 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
613 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000614
615 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
616 port routines must be defined elsewhere
617 (i.e. serial_init(), serial_getc(), ...)
618
619 CONFIG_CFB_CONSOLE
620 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000621 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000622 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
623 (default big endian)
624 VIDEO_HW_RECTFILL graphic chip supports
625 rectangle fill
626 (cf. smiLynxEM)
627 VIDEO_HW_BITBLT graphic chip supports
628 bit-blit (cf. smiLynxEM)
629 VIDEO_VISIBLE_COLS visible pixel columns
630 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000631 VIDEO_VISIBLE_ROWS visible pixel rows
632 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000633 VIDEO_DATA_FORMAT graphic data format
634 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000635 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000636 VIDEO_KBD_INIT_FCT keyboard int fct
637 (i.e. i8042_kbd_init())
638 VIDEO_TSTC_FCT test char fct
639 (i.e. i8042_tstc)
640 VIDEO_GETC_FCT get char fct
641 (i.e. i8042_getc)
642 CONFIG_CONSOLE_CURSOR cursor drawing on/off
643 (requires blink timer
644 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200645 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000646 CONFIG_CONSOLE_TIME display time/date info in
647 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500648 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000649 CONFIG_VIDEO_LOGO display Linux logo in
650 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000651 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
652 linux_logo.h for logo.
653 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000654 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200655 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000656 the logo
657
wdenk43d96162003-03-06 00:02:04 +0000658 When CONFIG_CFB_CONSOLE is defined, video console is
659 default i/o. Serial console can be forced with
660 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000661
wdenkd4ca31c2004-01-02 14:00:00 +0000662 When CONFIG_SILENT_CONSOLE is defined, all console
663 messages (by U-Boot and Linux!) can be silenced with
664 the "silent" environment variable. See
665 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000666
wdenkc6097192002-11-03 00:24:07 +0000667- Console Baudrate:
668 CONFIG_BAUDRATE - in bps
669 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200670 CONFIG_SYS_BAUDRATE_TABLE, see below.
671 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000672
Heiko Schocherc92fac92009-01-30 12:55:38 +0100673- Console Rx buffer length
674 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
675 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100676 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100677 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
678 must be defined, to setup the maximum idle timeout for
679 the SMC.
680
Graeme Russ9558b482011-09-01 00:48:27 +0000681- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200682 Prior to the console being initialised (i.e. serial UART
683 initialised etc) all console output is silently discarded.
684 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
685 buffer any console messages prior to the console being
686 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
687 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
688 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200689 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200690 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000691
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200692 'Sane' compilers will generate smaller code if
693 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000694
Sonny Rao046a37b2011-11-02 09:52:08 +0000695- Safe printf() functions
696 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
697 the printf() functions. These are defined in
698 include/vsprintf.h and include snprintf(), vsnprintf() and
699 so on. Code size increase is approximately 300-500 bytes.
700 If this option is not given then these functions will
701 silently discard their buffer size argument - this means
702 you are not getting any overflow checking in this case.
703
wdenkc6097192002-11-03 00:24:07 +0000704- Boot Delay: CONFIG_BOOTDELAY - in seconds
705 Delay before automatically booting the default image;
706 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000707 set to -2 to autoboot with no delay and not check for abort
708 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000709
710 See doc/README.autoboot for these options that
711 work with CONFIG_BOOTDELAY. None are required.
712 CONFIG_BOOT_RETRY_TIME
713 CONFIG_BOOT_RETRY_MIN
714 CONFIG_AUTOBOOT_KEYED
715 CONFIG_AUTOBOOT_PROMPT
716 CONFIG_AUTOBOOT_DELAY_STR
717 CONFIG_AUTOBOOT_STOP_STR
718 CONFIG_AUTOBOOT_DELAY_STR2
719 CONFIG_AUTOBOOT_STOP_STR2
720 CONFIG_ZERO_BOOTDELAY_CHECK
721 CONFIG_RESET_TO_RETRY
722
723- Autoboot Command:
724 CONFIG_BOOTCOMMAND
725 Only needed when CONFIG_BOOTDELAY is enabled;
726 define a command string that is automatically executed
727 when no character is read on the console interface
728 within "Boot Delay" after reset.
729
730 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000731 This can be used to pass arguments to the bootm
732 command. The value of CONFIG_BOOTARGS goes into the
733 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000734
735 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000736 The value of these goes into the environment as
737 "ramboot" and "nfsboot" respectively, and can be used
738 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200739 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000740
741- Pre-Boot Commands:
742 CONFIG_PREBOOT
743
744 When this option is #defined, the existence of the
745 environment variable "preboot" will be checked
746 immediately before starting the CONFIG_BOOTDELAY
747 countdown and/or running the auto-boot command resp.
748 entering interactive mode.
749
750 This feature is especially useful when "preboot" is
751 automatically generated or modified. For an example
752 see the LWMON board specific code: here "preboot" is
753 modified when the user holds down a certain
754 combination of keys on the (special) keyboard when
755 booting the systems
756
757- Serial Download Echo Mode:
758 CONFIG_LOADS_ECHO
759 If defined to 1, all characters received during a
760 serial download (using the "loads" command) are
761 echoed back. This might be needed by some terminal
762 emulations (like "cu"), but may as well just take
763 time on others. This setting #define's the initial
764 value of the "loads_echo" environment variable.
765
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500766- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000767 CONFIG_KGDB_BAUDRATE
768 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200769 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000770
771- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500772 Monitor commands can be included or excluded
773 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000774 <config_cmd_all.h> and #undef'ing unwanted
775 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500776 and augmenting with additional #define's
777 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000778
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500779 The default command configuration includes all commands
780 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000781
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500782 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500783 CONFIG_CMD_BDI bdinfo
784 CONFIG_CMD_BEDBUG * Include BedBug Debugger
785 CONFIG_CMD_BMP * BMP support
786 CONFIG_CMD_BSP * Board specific commands
787 CONFIG_CMD_BOOTD bootd
788 CONFIG_CMD_CACHE * icache, dcache
789 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500790 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500791 CONFIG_CMD_DATE * support for RTC, date/time...
792 CONFIG_CMD_DHCP * DHCP support
793 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600794 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
795 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
796 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
797 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500798 CONFIG_CMD_DTT * Digital Therm and Thermostat
799 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500800 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500801 CONFIG_CMD_EEPROM * EEPROM read/write support
802 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500803 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500804 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500805 CONFIG_CMD_FDC * Floppy Disk Support
806 CONFIG_CMD_FAT * FAT partition support
807 CONFIG_CMD_FDOS * Dos diskette Support
808 CONFIG_CMD_FLASH flinfo, erase, protect
809 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500810 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000811 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500812 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
813 CONFIG_CMD_I2C * I2C serial bus support
814 CONFIG_CMD_IDE * IDE harddisk support
815 CONFIG_CMD_IMI iminfo
816 CONFIG_CMD_IMLS List all found images
817 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500818 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000819 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500820 CONFIG_CMD_IRQ * irqinfo
821 CONFIG_CMD_ITEST Integer/string test of 2 values
822 CONFIG_CMD_JFFS2 * JFFS2 Support
823 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500824 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000825 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
826 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500827 CONFIG_CMD_LOADB loadb
828 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400829 CONFIG_CMD_MD5SUM print md5 message digest
830 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500831 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
832 loop, loopw, mtest
833 CONFIG_CMD_MISC Misc functions like sleep etc
834 CONFIG_CMD_MMC * MMC memory mapped support
835 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100836 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500837 CONFIG_CMD_NAND * NAND support
838 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600839 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000840 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500841 CONFIG_CMD_PCI * pciinfo
842 CONFIG_CMD_PCMCIA * PCMCIA support
843 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
844 host
845 CONFIG_CMD_PORTIO * Port I/O
846 CONFIG_CMD_REGINFO * Register dump
847 CONFIG_CMD_RUN run command in env variable
848 CONFIG_CMD_SAVES * save S record dump
849 CONFIG_CMD_SCSI * SCSI Support
850 CONFIG_CMD_SDRAM * print SDRAM configuration information
851 (requires CONFIG_CMD_I2C)
852 CONFIG_CMD_SETGETDCR Support for DCR Register access
853 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700854 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100855 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400856 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200857 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500858 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000859 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000860 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000861 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
862 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500863 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500864 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000865 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000866
wdenkc6097192002-11-03 00:24:07 +0000867
868 EXAMPLE: If you want all functions except of network
869 support you can write:
870
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500871 #include "config_cmd_all.h"
872 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000873
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400874 Other Commands:
875 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000876
877 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500878 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000879 what you (and your U-Boot users) are doing. Data
880 cache cannot be enabled on systems like the 8xx or
881 8260 (where accesses to the IMMR region must be
882 uncached), and it cannot be disabled on all other
883 systems where we (mis-) use the data cache to hold an
884 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000885
886
887 XXX - this list needs to get updated!
888
Simon Glass45ba8072011-10-15 05:48:20 +0000889- Device tree:
890 CONFIG_OF_CONTROL
891 If this variable is defined, U-Boot will use a device tree
892 to configure its devices, instead of relying on statically
893 compiled #defines in the board file. This option is
894 experimental and only available on a few boards. The device
895 tree is available in the global data as gd->fdt_blob.
896
Simon Glass2c0f79e2011-10-24 19:15:31 +0000897 U-Boot needs to get its device tree from somewhere. This can
898 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000899
900 CONFIG_OF_EMBED
901 If this variable is defined, U-Boot will embed a device tree
902 binary in its image. This device tree file should be in the
903 board directory and called <soc>-<board>.dts. The binary file
904 is then picked up in board_init_f() and made available through
905 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000906
Simon Glass2c0f79e2011-10-24 19:15:31 +0000907 CONFIG_OF_SEPARATE
908 If this variable is defined, U-Boot will build a device tree
909 binary. It will be called u-boot.dtb. Architecture-specific
910 code will locate it at run-time. Generally this works by:
911
912 cat u-boot.bin u-boot.dtb >image.bin
913
914 and in fact, U-Boot does this for you, creating a file called
915 u-boot-dtb.bin which is useful in the common case. You can
916 still use the individual files if you need something more
917 exotic.
918
wdenkc6097192002-11-03 00:24:07 +0000919- Watchdog:
920 CONFIG_WATCHDOG
921 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000922 support for the SoC. There must be support in the SoC
923 specific code for a watchdog. For the 8xx and 8260
924 CPUs, the SIU Watchdog feature is enabled in the SYPCR
925 register. When supported for a specific SoC is
926 available, then no further board specific code should
927 be needed to use it.
928
929 CONFIG_HW_WATCHDOG
930 When using a watchdog circuitry external to the used
931 SoC, then define this variable and provide board
932 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000933
stroesec1551ea2003-04-04 15:53:41 +0000934- U-Boot Version:
935 CONFIG_VERSION_VARIABLE
936 If this variable is defined, an environment variable
937 named "ver" is created by U-Boot showing the U-Boot
938 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200939 Any change to this variable will be reverted at the
940 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000941
wdenkc6097192002-11-03 00:24:07 +0000942- Real-Time Clock:
943
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500944 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000945 has to be selected, too. Define exactly one of the
946 following options:
947
948 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
949 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000950 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000951 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000952 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000953 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000954 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000955 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100956 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000957 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200958 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200959 CONFIG_SYS_RV3029_TCR - enable trickle charger on
960 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000961
wdenkb37c7e52003-06-30 16:24:52 +0000962 Note that if the RTC uses I2C, then the I2C interface
963 must also be configured. See I2C Support, below.
964
Peter Tysere92739d2008-12-17 16:36:21 -0600965- GPIO Support:
966 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
967 CONFIG_PCA953X_INFO - enable pca953x info command
968
Chris Packham5dec49c2010-12-19 10:12:13 +0000969 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
970 chip-ngpio pairs that tell the PCA953X driver the number of
971 pins supported by a particular chip.
972
Peter Tysere92739d2008-12-17 16:36:21 -0600973 Note that if the GPIO device uses I2C, then the I2C interface
974 must also be configured. See I2C Support, below.
975
wdenkc6097192002-11-03 00:24:07 +0000976- Timestamp Support:
977
wdenk43d96162003-03-06 00:02:04 +0000978 When CONFIG_TIMESTAMP is selected, the timestamp
979 (date and time) of an image is printed by image
980 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500981 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000982
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000983- Partition Labels (disklabels) Supported:
984 Zero or more of the following:
985 CONFIG_MAC_PARTITION Apple's MacOS partition table.
986 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
987 Intel architecture, USB sticks, etc.
988 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
989 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
990 bootloader. Note 2TB partition limit; see
991 disk/part_efi.c
992 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000993
Wolfgang Denk218ca722008-03-26 10:40:12 +0100994 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
995 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000996 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000997
998- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000999 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1000 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001001
wdenk4d13cba2004-03-14 14:09:05 +00001002 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1003 be performed by calling the function
1004 ide_set_reset(int reset)
1005 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001006
1007- ATAPI Support:
1008 CONFIG_ATAPI
1009
1010 Set this to enable ATAPI support.
1011
wdenkc40b2952004-03-13 23:29:43 +00001012- LBA48 Support
1013 CONFIG_LBA48
1014
1015 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001016 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001017 Whithout these , LBA48 support uses 32bit variables and will 'only'
1018 support disks up to 2.1TB.
1019
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001020 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001021 When enabled, makes the IDE subsystem use 64bit sector addresses.
1022 Default is 32bit.
1023
wdenkc6097192002-11-03 00:24:07 +00001024- SCSI Support:
1025 At the moment only there is only support for the
1026 SYM53C8XX SCSI controller; define
1027 CONFIG_SCSI_SYM53C8XX to enable it.
1028
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001029 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1030 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1031 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001032 maximum numbers of LUNs, SCSI ID's and target
1033 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001034 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001035
1036- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001037 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001038 Support for Intel 8254x/8257x gigabit chips.
1039
1040 CONFIG_E1000_SPI
1041 Utility code for direct access to the SPI bus on Intel 8257x.
1042 This does not do anything useful unless you set at least one
1043 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1044
1045 CONFIG_E1000_SPI_GENERIC
1046 Allow generic access to the SPI bus on the Intel 8257x, for
1047 example with the "sspi" command.
1048
1049 CONFIG_CMD_E1000
1050 Management command for E1000 devices. When used on devices
1051 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001052
Andre Schwarzac3315c2008-03-06 16:45:44 +01001053 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001054 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001055
wdenkc6097192002-11-03 00:24:07 +00001056 CONFIG_EEPRO100
1057 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001058 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001059 write routine for first time initialisation.
1060
1061 CONFIG_TULIP
1062 Support for Digital 2114x chips.
1063 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1064 modem chip initialisation (KS8761/QS6611).
1065
1066 CONFIG_NATSEMI
1067 Support for National dp83815 chips.
1068
1069 CONFIG_NS8382X
1070 Support for National dp8382[01] gigabit chips.
1071
wdenk45219c42003-05-12 21:50:16 +00001072- NETWORK Support (other):
1073
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001074 CONFIG_DRIVER_AT91EMAC
1075 Support for AT91RM9200 EMAC.
1076
1077 CONFIG_RMII
1078 Define this to use reduced MII inteface
1079
1080 CONFIG_DRIVER_AT91EMAC_QUIET
1081 If this defined, the driver is quiet.
1082 The driver doen't show link status messages.
1083
Rob Herringefdd7312011-12-15 11:15:49 +00001084 CONFIG_CALXEDA_XGMAC
1085 Support for the Calxeda XGMAC device
1086
wdenk45219c42003-05-12 21:50:16 +00001087 CONFIG_DRIVER_LAN91C96
1088 Support for SMSC's LAN91C96 chips.
1089
1090 CONFIG_LAN91C96_BASE
1091 Define this to hold the physical address
1092 of the LAN91C96's I/O space
1093
1094 CONFIG_LAN91C96_USE_32_BIT
1095 Define this to enable 32 bit addressing
1096
wdenkf39748a2004-06-09 13:37:52 +00001097 CONFIG_DRIVER_SMC91111
1098 Support for SMSC's LAN91C111 chip
1099
1100 CONFIG_SMC91111_BASE
1101 Define this to hold the physical address
1102 of the device (I/O space)
1103
1104 CONFIG_SMC_USE_32_BIT
1105 Define this if data bus is 32 bits
1106
1107 CONFIG_SMC_USE_IOFUNCS
1108 Define this to use i/o functions instead of macros
1109 (some hardware wont work with macros)
1110
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001111 CONFIG_DRIVER_TI_EMAC
1112 Support for davinci emac
1113
1114 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1115 Define this if you have more then 3 PHYs.
1116
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001117 CONFIG_FTGMAC100
1118 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1119
1120 CONFIG_FTGMAC100_EGIGA
1121 Define this to use GE link update with gigabit PHY.
1122 Define this if FTGMAC100 is connected to gigabit PHY.
1123 If your system has 10/100 PHY only, it might not occur
1124 wrong behavior. Because PHY usually return timeout or
1125 useless data when polling gigabit status and gigabit
1126 control registers. This behavior won't affect the
1127 correctnessof 10/100 link speed update.
1128
Mike Rapoportc2fff332009-11-11 10:03:03 +02001129 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001130 Support for SMSC's LAN911x and LAN921x chips
1131
Mike Rapoportc2fff332009-11-11 10:03:03 +02001132 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001133 Define this to hold the physical address
1134 of the device (I/O space)
1135
Mike Rapoportc2fff332009-11-11 10:03:03 +02001136 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001137 Define this if data bus is 32 bits
1138
Mike Rapoportc2fff332009-11-11 10:03:03 +02001139 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001140 Define this if data bus is 16 bits. If your processor
1141 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001142 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001143
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001144 CONFIG_SH_ETHER
1145 Support for Renesas on-chip Ethernet controller
1146
1147 CONFIG_SH_ETHER_USE_PORT
1148 Define the number of ports to be used
1149
1150 CONFIG_SH_ETHER_PHY_ADDR
1151 Define the ETH PHY's address
1152
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001153 CONFIG_SH_ETHER_CACHE_WRITEBACK
1154 If this option is set, the driver enables cache flush.
1155
Vadim Bendebury5e124722011-10-17 08:36:14 +00001156- TPM Support:
1157 CONFIG_GENERIC_LPC_TPM
1158 Support for generic parallel port TPM devices. Only one device
1159 per system is supported at this time.
1160
1161 CONFIG_TPM_TIS_BASE_ADDRESS
1162 Base address where the generic TPM device is mapped
1163 to. Contemporary x86 systems usually map it at
1164 0xfed40000.
1165
wdenkc6097192002-11-03 00:24:07 +00001166- USB Support:
1167 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001168 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001169 CONFIG_USB_UHCI to enable it.
1170 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001171 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001172 storage devices.
1173 Note:
1174 Supported are USB Keyboards and USB Floppy drives
1175 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001176 MPC5200 USB requires additional defines:
1177 CONFIG_USB_CLOCK
1178 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001179 CONFIG_PSC3_USB
1180 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001181 CONFIG_USB_CONFIG
1182 for differential drivers: 0x00001000
1183 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001184 for differential drivers on PSC3: 0x00000100
1185 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001186 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001187 May be defined to allow interrupt polling
1188 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001189
Simon Glass9ab4ce22012-02-27 10:52:47 +00001190 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1191 txfilltuning field in the EHCI controller on reset.
1192
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001193- USB Device:
1194 Define the below if you wish to use the USB console.
1195 Once firmware is rebuilt from a serial console issue the
1196 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001197 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001198 it has found a new device. The environment variable usbtty
1199 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001200 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001201 Common Device Class Abstract Control Model serial device.
1202 If you select usbtty = gserial you should be able to enumerate
1203 a Linux host by
1204 # modprobe usbserial vendor=0xVendorID product=0xProductID
1205 else if using cdc_acm, simply setting the environment
1206 variable usbtty to be cdc_acm should suffice. The following
1207 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001208
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001209 CONFIG_USB_DEVICE
1210 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001211
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001212 CONFIG_USB_TTY
1213 Define this to have a tty type of device available to
1214 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001215
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301216 CONFIG_USBD_HS
1217 Define this to enable the high speed support for usb
1218 device and usbtty. If this feature is enabled, a routine
1219 int is_usbd_high_speed(void)
1220 also needs to be defined by the driver to dynamically poll
1221 whether the enumeration has succeded at high speed or full
1222 speed.
1223
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001224 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001225 Define this if you want stdin, stdout &/or stderr to
1226 be set to usbtty.
1227
1228 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001229 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001230 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001231 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001232
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001233 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001234 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001235 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001236
Wolfgang Denk386eda02006-06-14 18:14:56 +02001237 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001238 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001239 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001240 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1241 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1242 should pretend to be a Linux device to it's target host.
1243
1244 CONFIG_USBD_MANUFACTURER
1245 Define this string as the name of your company for
1246 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001247
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001248 CONFIG_USBD_PRODUCT_NAME
1249 Define this string as the name of your product
1250 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1251
1252 CONFIG_USBD_VENDORID
1253 Define this as your assigned Vendor ID from the USB
1254 Implementors Forum. This *must* be a genuine Vendor ID
1255 to avoid polluting the USB namespace.
1256 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001257
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001258 CONFIG_USBD_PRODUCTID
1259 Define this as the unique Product ID
1260 for your device
1261 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001262
Igor Grinbergd70a5602011-12-12 12:08:35 +02001263- ULPI Layer Support:
1264 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1265 the generic ULPI layer. The generic layer accesses the ULPI PHY
1266 via the platform viewport, so you need both the genric layer and
1267 the viewport enabled. Currently only Chipidea/ARC based
1268 viewport is supported.
1269 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1270 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001271 If your ULPI phy needs a different reference clock than the
1272 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1273 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001274
1275- MMC Support:
1276 The MMC controller on the Intel PXA is supported. To
1277 enable this define CONFIG_MMC. The MMC can be
1278 accessed from the boot prompt by mapping the device
1279 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001280 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1281 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001282
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001283 CONFIG_SH_MMCIF
1284 Support for Renesas on-chip MMCIF controller
1285
1286 CONFIG_SH_MMCIF_ADDR
1287 Define the base address of MMCIF registers
1288
1289 CONFIG_SH_MMCIF_CLK
1290 Define the clock frequency for MMCIF
1291
wdenk6705d812004-08-02 23:22:59 +00001292- Journaling Flash filesystem support:
1293 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1294 CONFIG_JFFS2_NAND_DEV
1295 Define these for a default partition on a NAND device
1296
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001297 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1298 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001299 Define these for a default partition on a NOR device
1300
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001301 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001302 Define this to create an own partition. You have to provide a
1303 function struct part_info* jffs2_part_info(int part_num)
1304
1305 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001306 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001307 to disable the command chpart. This is the default when you
1308 have not defined a custom partition
1309
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001310- FAT(File Allocation Table) filesystem write function support:
1311 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001312
1313 Define this to enable support for saving memory data as a
1314 file in FAT formatted partition.
1315
1316 This will also enable the command "fatwrite" enabling the
1317 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001318
wdenkc6097192002-11-03 00:24:07 +00001319- Keyboard Support:
1320 CONFIG_ISA_KEYBOARD
1321
1322 Define this to enable standard (PC-Style) keyboard
1323 support
1324
1325 CONFIG_I8042_KBD
1326 Standard PC keyboard driver with US (is default) and
1327 GERMAN key layout (switch via environment 'keymap=de') support.
1328 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1329 for cfb_console. Supports cursor blinking.
1330
1331- Video support:
1332 CONFIG_VIDEO
1333
1334 Define this to enable video support (for output to
1335 video).
1336
1337 CONFIG_VIDEO_CT69000
1338
1339 Enable Chips & Technologies 69000 Video chip
1340
1341 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001342 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001343 video output is selected via environment 'videoout'
1344 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1345 assumed.
wdenkc6097192002-11-03 00:24:07 +00001346
wdenkb79a11c2004-03-25 15:14:43 +00001347 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001348 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001349 are possible:
1350 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001351 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001352
1353 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1354 -------------+---------------------------------------------
1355 8 bits | 0x301* 0x303 0x305 0x161 0x307
1356 15 bits | 0x310 0x313 0x316 0x162 0x319
1357 16 bits | 0x311 0x314 0x317 0x163 0x31A
1358 24 bits | 0x312 0x315 0x318 ? 0x31B
1359 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001360 (i.e. setenv videomode 317; saveenv; reset;)
1361
wdenkb79a11c2004-03-25 15:14:43 +00001362 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001363 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001364
1365
stroesec1551ea2003-04-04 15:53:41 +00001366 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001367 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001368 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1369 or CONFIG_VIDEO_SED13806_16BPP
1370
Timur Tabi7d3053f2011-02-15 17:09:19 -06001371 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001372 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001373 SOCs that have a DIU should define this macro to enable DIU
1374 support, and should also define these other macros:
1375
1376 CONFIG_SYS_DIU_ADDR
1377 CONFIG_VIDEO
1378 CONFIG_CMD_BMP
1379 CONFIG_CFB_CONSOLE
1380 CONFIG_VIDEO_SW_CURSOR
1381 CONFIG_VGA_AS_SINGLE_DEVICE
1382 CONFIG_VIDEO_LOGO
1383 CONFIG_VIDEO_BMP_LOGO
1384
Timur Tabiba8e76b2011-04-11 14:18:22 -05001385 The DIU driver will look for the 'video-mode' environment
1386 variable, and if defined, enable the DIU as a console during
1387 boot. See the documentation file README.video for a
1388 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001389
wdenk682011f2003-06-03 23:54:09 +00001390- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001391 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001392
wdenk8bde7f72003-06-27 21:31:46 +00001393 Define this to enable a custom keyboard support.
1394 This simply calls drv_keyboard_init() which must be
1395 defined in your board-specific files.
1396 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001397
wdenkc6097192002-11-03 00:24:07 +00001398- LCD Support: CONFIG_LCD
1399
1400 Define this to enable LCD support (for output to LCD
1401 display); also select one of the supported displays
1402 by defining one of these:
1403
Stelian Pop39cf4802008-05-09 21:57:18 +02001404 CONFIG_ATMEL_LCD:
1405
1406 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1407
wdenkfd3103b2003-11-25 16:55:19 +00001408 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001409
wdenkfd3103b2003-11-25 16:55:19 +00001410 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001411
wdenkfd3103b2003-11-25 16:55:19 +00001412 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001413
wdenkfd3103b2003-11-25 16:55:19 +00001414 NEC NL6448BC20-08. 6.5", 640x480.
1415 Active, color, single scan.
1416
1417 CONFIG_NEC_NL6448BC33_54
1418
1419 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001420 Active, color, single scan.
1421
1422 CONFIG_SHARP_16x9
1423
1424 Sharp 320x240. Active, color, single scan.
1425 It isn't 16x9, and I am not sure what it is.
1426
1427 CONFIG_SHARP_LQ64D341
1428
1429 Sharp LQ64D341 display, 640x480.
1430 Active, color, single scan.
1431
1432 CONFIG_HLD1045
1433
1434 HLD1045 display, 640x480.
1435 Active, color, single scan.
1436
1437 CONFIG_OPTREX_BW
1438
1439 Optrex CBL50840-2 NF-FW 99 22 M5
1440 or
1441 Hitachi LMG6912RPFC-00T
1442 or
1443 Hitachi SP14Q002
1444
1445 320x240. Black & white.
1446
1447 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001448 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001449
wdenk7152b1d2003-09-05 23:19:14 +00001450- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001451
wdenk8bde7f72003-06-27 21:31:46 +00001452 If this option is set, the environment is checked for
1453 a variable "splashimage". If found, the usual display
1454 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001455 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001456 specified in "splashimage" is loaded instead. The
1457 console is redirected to the "nulldev", too. This
1458 allows for a "silent" boot where a splash screen is
1459 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001460
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001461 CONFIG_SPLASH_SCREEN_ALIGN
1462
1463 If this option is set the splash image can be freely positioned
1464 on the screen. Environment variable "splashpos" specifies the
1465 position as "x,y". If a positive number is given it is used as
1466 number of pixel from left/top. If a negative number is given it
1467 is used as number of pixel from right/bottom. You can also
1468 specify 'm' for centering the image.
1469
1470 Example:
1471 setenv splashpos m,m
1472 => image at center of screen
1473
1474 setenv splashpos 30,20
1475 => image at x = 30 and y = 20
1476
1477 setenv splashpos -10,m
1478 => vertically centered image
1479 at x = dspWidth - bmpWidth - 9
1480
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001481- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1482
1483 If this option is set, additionally to standard BMP
1484 images, gzipped BMP images can be displayed via the
1485 splashscreen support or the bmp command.
1486
Anatolij Gustschind5011762010-03-15 14:50:25 +01001487- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1488
1489 If this option is set, 8-bit RLE compressed BMP images
1490 can be displayed via the splashscreen support or the
1491 bmp command.
1492
Lei Wenf2b96df2012-09-28 04:26:47 +00001493- Do compresssing for memory range:
1494 CONFIG_CMD_ZIP
1495
1496 If this option is set, it would use zlib deflate method
1497 to compress the specified memory at its best effort.
1498
wdenkc29fdfc2003-08-29 20:57:53 +00001499- Compression support:
1500 CONFIG_BZIP2
1501
1502 If this option is set, support for bzip2 compressed
1503 images is included. If not, only uncompressed and gzip
1504 compressed images are supported.
1505
wdenk42d1f032003-10-15 23:53:47 +00001506 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001507 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001508 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001509
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001510 CONFIG_LZMA
1511
1512 If this option is set, support for lzma compressed
1513 images is included.
1514
1515 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1516 requires an amount of dynamic memory that is given by the
1517 formula:
1518
1519 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1520
1521 Where lc and lp stand for, respectively, Literal context bits
1522 and Literal pos bits.
1523
1524 This value is upper-bounded by 14MB in the worst case. Anyway,
1525 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1526 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1527 a very small buffer.
1528
1529 Use the lzmainfo tool to determinate the lc and lp values and
1530 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001531 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001532
wdenk17ea1172004-06-06 21:51:03 +00001533- MII/PHY support:
1534 CONFIG_PHY_ADDR
1535
1536 The address of PHY on MII bus.
1537
1538 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1539
1540 The clock frequency of the MII bus
1541
1542 CONFIG_PHY_GIGE
1543
1544 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001545 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001546
1547 CONFIG_PHY_RESET_DELAY
1548
1549 Some PHY like Intel LXT971A need extra delay after
1550 reset before any MII register access is possible.
1551 For such PHY, set this option to the usec delay
1552 required. (minimum 300usec for LXT971A)
1553
1554 CONFIG_PHY_CMD_DELAY (ppc4xx)
1555
1556 Some PHY like Intel LXT971A need extra delay after
1557 command issued before MII status register can be read
1558
wdenkc6097192002-11-03 00:24:07 +00001559- Ethernet address:
1560 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001561 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001562 CONFIG_ETH2ADDR
1563 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001564 CONFIG_ETH4ADDR
1565 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001566
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001567 Define a default value for Ethernet address to use
1568 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001569 is not determined automatically.
1570
1571- IP address:
1572 CONFIG_IPADDR
1573
1574 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001575 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001576 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001577 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001578
1579- Server IP address:
1580 CONFIG_SERVERIP
1581
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001582 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001583 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001584 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001585
Robin Getz97cfe862009-07-21 12:15:28 -04001586 CONFIG_KEEP_SERVERADDR
1587
1588 Keeps the server's MAC address, in the env 'serveraddr'
1589 for passing to bootargs (like Linux's netconsole option)
1590
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001591- Gateway IP address:
1592 CONFIG_GATEWAYIP
1593
1594 Defines a default value for the IP address of the
1595 default router where packets to other networks are
1596 sent to.
1597 (Environment variable "gatewayip")
1598
1599- Subnet mask:
1600 CONFIG_NETMASK
1601
1602 Defines a default value for the subnet mask (or
1603 routing prefix) which is used to determine if an IP
1604 address belongs to the local subnet or needs to be
1605 forwarded through a router.
1606 (Environment variable "netmask")
1607
David Updegraff53a5c422007-06-11 10:41:07 -05001608- Multicast TFTP Mode:
1609 CONFIG_MCAST_TFTP
1610
1611 Defines whether you want to support multicast TFTP as per
1612 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001613 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001614 driver in use must provide a function: mcast() to join/leave a
1615 multicast group.
1616
wdenkc6097192002-11-03 00:24:07 +00001617- BOOTP Recovery Mode:
1618 CONFIG_BOOTP_RANDOM_DELAY
1619
1620 If you have many targets in a network that try to
1621 boot using BOOTP, you may want to avoid that all
1622 systems send out BOOTP requests at precisely the same
1623 moment (which would happen for instance at recovery
1624 from a power failure, when all systems will try to
1625 boot, thus flooding the BOOTP server. Defining
1626 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1627 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001628 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001629
1630 1st BOOTP request: delay 0 ... 1 sec
1631 2nd BOOTP request: delay 0 ... 2 sec
1632 3rd BOOTP request: delay 0 ... 4 sec
1633 4th and following
1634 BOOTP requests: delay 0 ... 8 sec
1635
stroesefe389a82003-08-28 14:17:32 +00001636- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001637 You can fine tune the DHCP functionality by defining
1638 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001639
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001640 CONFIG_BOOTP_SUBNETMASK
1641 CONFIG_BOOTP_GATEWAY
1642 CONFIG_BOOTP_HOSTNAME
1643 CONFIG_BOOTP_NISDOMAIN
1644 CONFIG_BOOTP_BOOTPATH
1645 CONFIG_BOOTP_BOOTFILESIZE
1646 CONFIG_BOOTP_DNS
1647 CONFIG_BOOTP_DNS2
1648 CONFIG_BOOTP_SEND_HOSTNAME
1649 CONFIG_BOOTP_NTPSERVER
1650 CONFIG_BOOTP_TIMEOFFSET
1651 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001652 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001653
Wilson Callan5d110f02007-07-28 10:56:13 -04001654 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1655 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001656
Joe Hershberger2c00e092012-05-23 07:59:19 +00001657 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1658 after the configured retry count, the call will fail
1659 instead of starting over. This can be used to fail over
1660 to Link-local IP address configuration if the DHCP server
1661 is not available.
1662
stroesefe389a82003-08-28 14:17:32 +00001663 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1664 serverip from a DHCP server, it is possible that more
1665 than one DNS serverip is offered to the client.
1666 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1667 serverip will be stored in the additional environment
1668 variable "dnsip2". The first DNS serverip is always
1669 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001670 is defined.
stroesefe389a82003-08-28 14:17:32 +00001671
1672 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1673 to do a dynamic update of a DNS server. To do this, they
1674 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001675 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001676 of the "hostname" environment variable is passed as
1677 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001678
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001679 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1680
1681 A 32bit value in microseconds for a delay between
1682 receiving a "DHCP Offer" and sending the "DHCP Request".
1683 This fixes a problem with certain DHCP servers that don't
1684 respond 100% of the time to a "DHCP request". E.g. On an
1685 AT91RM9200 processor running at 180MHz, this delay needed
1686 to be *at least* 15,000 usec before a Windows Server 2003
1687 DHCP server would reply 100% of the time. I recommend at
1688 least 50,000 usec to be safe. The alternative is to hope
1689 that one of the retries will be successful but note that
1690 the DHCP timeout and retry process takes a longer than
1691 this delay.
1692
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001693 - Link-local IP address negotiation:
1694 Negotiate with other link-local clients on the local network
1695 for an address that doesn't require explicit configuration.
1696 This is especially useful if a DHCP server cannot be guaranteed
1697 to exist in all environments that the device must operate.
1698
1699 See doc/README.link-local for more information.
1700
wdenka3d991b2004-04-15 21:48:45 +00001701 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001702 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001703
1704 The device id used in CDP trigger frames.
1705
1706 CONFIG_CDP_DEVICE_ID_PREFIX
1707
1708 A two character string which is prefixed to the MAC address
1709 of the device.
1710
1711 CONFIG_CDP_PORT_ID
1712
1713 A printf format string which contains the ascii name of
1714 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001715 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001716
1717 CONFIG_CDP_CAPABILITIES
1718
1719 A 32bit integer which indicates the device capabilities;
1720 0x00000010 for a normal host which does not forwards.
1721
1722 CONFIG_CDP_VERSION
1723
1724 An ascii string containing the version of the software.
1725
1726 CONFIG_CDP_PLATFORM
1727
1728 An ascii string containing the name of the platform.
1729
1730 CONFIG_CDP_TRIGGER
1731
1732 A 32bit integer sent on the trigger.
1733
1734 CONFIG_CDP_POWER_CONSUMPTION
1735
1736 A 16bit integer containing the power consumption of the
1737 device in .1 of milliwatts.
1738
1739 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1740
1741 A byte containing the id of the VLAN.
1742
wdenkc6097192002-11-03 00:24:07 +00001743- Status LED: CONFIG_STATUS_LED
1744
1745 Several configurations allow to display the current
1746 status using a LED. For instance, the LED will blink
1747 fast while running U-Boot code, stop blinking as
1748 soon as a reply to a BOOTP request was received, and
1749 start blinking slow once the Linux kernel is running
1750 (supported by a status LED driver in the Linux
1751 kernel). Defining CONFIG_STATUS_LED enables this
1752 feature in U-Boot.
1753
1754- CAN Support: CONFIG_CAN_DRIVER
1755
1756 Defining CONFIG_CAN_DRIVER enables CAN driver support
1757 on those systems that support this (optional)
1758 feature, like the TQM8xxL modules.
1759
1760- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1761
wdenkb37c7e52003-06-30 16:24:52 +00001762 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001763 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001764 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001765
wdenk945af8d2003-07-16 21:53:01 +00001766 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001767 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001768 CONFIG_COMMANDS) and communicate with i2c based realtime
1769 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001770 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001771
Ben Warrenbb99ad62006-09-07 16:50:54 -04001772 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001773
wdenk945af8d2003-07-16 21:53:01 +00001774 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001775 bit-banging) driver instead of CPM or similar hardware
1776 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001777
wdenk945af8d2003-07-16 21:53:01 +00001778 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001779 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001781 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001782 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001783 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001784 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001785
Peter Tyser8d321b82010-04-12 22:28:21 -05001786 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001787 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001788 and so its address should therefore be cleared to 0 (See,
1789 eg, MPC823e User's Manual p.16-473). So, set
1790 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001791
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001792 CONFIG_SYS_I2C_INIT_MPC5XXX
1793
1794 When a board is reset during an i2c bus transfer
1795 chips might think that the current transfer is still
1796 in progress. Reset the slave devices by sending start
1797 commands until the slave device responds.
1798
wdenk945af8d2003-07-16 21:53:01 +00001799 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001800
1801 If you use the software i2c interface (CONFIG_SOFT_I2C)
1802 then the following macros need to be defined (examples are
1803 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001804
1805 I2C_INIT
1806
wdenkb37c7e52003-06-30 16:24:52 +00001807 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001808 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001809
wdenkba56f622004-02-06 23:19:44 +00001810 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001811
wdenkc6097192002-11-03 00:24:07 +00001812 I2C_PORT
1813
wdenk43d96162003-03-06 00:02:04 +00001814 (Only for MPC8260 CPU). The I/O port to use (the code
1815 assumes both bits are on the same port). Valid values
1816 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001817
1818 I2C_ACTIVE
1819
1820 The code necessary to make the I2C data line active
1821 (driven). If the data line is open collector, this
1822 define can be null.
1823
wdenkb37c7e52003-06-30 16:24:52 +00001824 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1825
wdenkc6097192002-11-03 00:24:07 +00001826 I2C_TRISTATE
1827
1828 The code necessary to make the I2C data line tri-stated
1829 (inactive). If the data line is open collector, this
1830 define can be null.
1831
wdenkb37c7e52003-06-30 16:24:52 +00001832 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1833
wdenkc6097192002-11-03 00:24:07 +00001834 I2C_READ
1835
1836 Code that returns TRUE if the I2C data line is high,
1837 FALSE if it is low.
1838
wdenkb37c7e52003-06-30 16:24:52 +00001839 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1840
wdenkc6097192002-11-03 00:24:07 +00001841 I2C_SDA(bit)
1842
1843 If <bit> is TRUE, sets the I2C data line high. If it
1844 is FALSE, it clears it (low).
1845
wdenkb37c7e52003-06-30 16:24:52 +00001846 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001847 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001848 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001849
wdenkc6097192002-11-03 00:24:07 +00001850 I2C_SCL(bit)
1851
1852 If <bit> is TRUE, sets the I2C clock line high. If it
1853 is FALSE, it clears it (low).
1854
wdenkb37c7e52003-06-30 16:24:52 +00001855 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001856 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001857 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001858
wdenkc6097192002-11-03 00:24:07 +00001859 I2C_DELAY
1860
1861 This delay is invoked four times per clock cycle so this
1862 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001863 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001864 like:
1865
wdenkb37c7e52003-06-30 16:24:52 +00001866 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001867
Mike Frysinger793b5722010-07-21 13:38:02 -04001868 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1869
1870 If your arch supports the generic GPIO framework (asm/gpio.h),
1871 then you may alternatively define the two GPIOs that are to be
1872 used as SCL / SDA. Any of the previous I2C_xxx macros will
1873 have GPIO-based defaults assigned to them as appropriate.
1874
1875 You should define these to the GPIO value as given directly to
1876 the generic GPIO functions.
1877
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001878 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001879
wdenk8bde7f72003-06-27 21:31:46 +00001880 When a board is reset during an i2c bus transfer
1881 chips might think that the current transfer is still
1882 in progress. On some boards it is possible to access
1883 the i2c SCLK line directly, either by using the
1884 processor pin as a GPIO or by having a second pin
1885 connected to the bus. If this option is defined a
1886 custom i2c_init_board() routine in boards/xxx/board.c
1887 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001888
Richard Retanubun26a33502010-04-12 15:08:17 -04001889 CONFIG_SYS_I2C_BOARD_LATE_INIT
1890
1891 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1892 defined a custom i2c_board_late_init() routine in
1893 boards/xxx/board.c is run AFTER the operations in i2c_init()
1894 is completed. This callpoint can be used to unreset i2c bus
1895 using CPU i2c controller register accesses for CPUs whose i2c
1896 controller provide such a method. It is called at the end of
1897 i2c_init() to allow i2c_init operations to setup the i2c bus
1898 controller on the CPU (e.g. setting bus speed & slave address).
1899
wdenk17ea1172004-06-06 21:51:03 +00001900 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1901
1902 This option enables configuration of bi_iic_fast[] flags
1903 in u-boot bd_info structure based on u-boot environment
1904 variable "i2cfast". (see also i2cfast)
1905
Ben Warrenbb99ad62006-09-07 16:50:54 -04001906 CONFIG_I2C_MULTI_BUS
1907
1908 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001909 must have a controller. At any point in time, only one bus is
1910 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001911 Note that bus numbering is zero-based.
1912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001913 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001914
1915 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001916 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001917 is set, specify a list of bus-device pairs. Otherwise, specify
1918 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001919
1920 e.g.
1921 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001922 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001923
1924 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1925
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001926 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001927 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001928
1929 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1930
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001931 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001932
1933 If defined, then this indicates the I2C bus number for DDR SPD.
1934 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001936 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001937
1938 If defined, then this indicates the I2C bus number for the RTC.
1939 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1940
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001941 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001942
1943 If defined, then this indicates the I2C bus number for the DTT.
1944 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1945
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001946 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001947
1948 If defined, specifies the I2C address of the DTT device.
1949 If not defined, then U-Boot uses predefined value for
1950 specified DTT device.
1951
Timur Tabibe5e6182006-11-03 19:15:00 -06001952 CONFIG_FSL_I2C
1953
1954 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001955 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001956
Heiko Schocher67b23a32008-10-15 09:39:47 +02001957 CONFIG_I2C_MUX
1958
1959 Define this option if you have I2C devices reached over 1 .. n
1960 I2C Muxes like the pca9544a. This option addes a new I2C
1961 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1962 new I2C Bus to the existing I2C Busses. If you select the
1963 new Bus with "i2c dev", u-bbot sends first the commandos for
1964 the muxes to activate this new "bus".
1965
1966 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1967 feature!
1968
1969 Example:
1970 Adding a new I2C Bus reached over 2 pca9544a muxes
1971 The First mux with address 70 and channel 6
1972 The Second mux with address 71 and channel 4
1973
1974 => i2c bus pca9544a:70:6:pca9544a:71:4
1975
1976 Use the "i2c bus" command without parameter, to get a list
1977 of I2C Busses with muxes:
1978
1979 => i2c bus
1980 Busses reached over muxes:
1981 Bus ID: 2
1982 reached over Mux(es):
1983 pca9544a@70 ch: 4
1984 Bus ID: 3
1985 reached over Mux(es):
1986 pca9544a@70 ch: 6
1987 pca9544a@71 ch: 4
1988 =>
1989
1990 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001991 u-boot first sends the command to the mux@70 to enable
1992 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001993 the channel 4.
1994
1995 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001996 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001997 the 2 muxes.
1998
1999 This option is actually implemented for the bitbanging
2000 algorithm in common/soft_i2c.c and for the Hardware I2C
2001 Bus on the MPC8260. But it should be not so difficult
2002 to add this option to other architectures.
2003
Andrew Dyer2ac69852008-12-29 17:36:01 -06002004 CONFIG_SOFT_I2C_READ_REPEATED_START
2005
2006 defining this will force the i2c_read() function in
2007 the soft_i2c driver to perform an I2C repeated start
2008 between writing the address pointer and reading the
2009 data. If this define is omitted the default behaviour
2010 of doing a stop-start sequence will be used. Most I2C
2011 devices can use either method, but some require one or
2012 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002013
wdenkc6097192002-11-03 00:24:07 +00002014- SPI Support: CONFIG_SPI
2015
2016 Enables SPI driver (so far only tested with
2017 SPI EEPROM, also an instance works with Crystal A/D and
2018 D/As on the SACSng board)
2019
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002020 CONFIG_SH_SPI
2021
2022 Enables the driver for SPI controller on SuperH. Currently
2023 only SH7757 is supported.
2024
wdenkc6097192002-11-03 00:24:07 +00002025 CONFIG_SPI_X
2026
2027 Enables extended (16-bit) SPI EEPROM addressing.
2028 (symmetrical to CONFIG_I2C_X)
2029
2030 CONFIG_SOFT_SPI
2031
wdenk43d96162003-03-06 00:02:04 +00002032 Enables a software (bit-bang) SPI driver rather than
2033 using hardware support. This is a general purpose
2034 driver that only requires three general I/O port pins
2035 (two outputs, one input) to function. If this is
2036 defined, the board configuration must define several
2037 SPI configuration items (port pins to use, etc). For
2038 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002039
Ben Warren04a9e112008-01-16 22:37:35 -05002040 CONFIG_HARD_SPI
2041
2042 Enables a hardware SPI driver for general-purpose reads
2043 and writes. As with CONFIG_SOFT_SPI, the board configuration
2044 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002045 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002046 example, see include/configs/mpc8349emds.h.
2047
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002048 CONFIG_MXC_SPI
2049
2050 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002051 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002052
Matthias Fuchs01335022007-12-27 17:12:34 +01002053- FPGA Support: CONFIG_FPGA
2054
2055 Enables FPGA subsystem.
2056
2057 CONFIG_FPGA_<vendor>
2058
2059 Enables support for specific chip vendors.
2060 (ALTERA, XILINX)
2061
2062 CONFIG_FPGA_<family>
2063
2064 Enables support for FPGA family.
2065 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2066
2067 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002068
wdenk43d96162003-03-06 00:02:04 +00002069 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002070
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002071 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002072
wdenk8bde7f72003-06-27 21:31:46 +00002073 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002074
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002075 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002076
wdenk43d96162003-03-06 00:02:04 +00002077 Enable checks on FPGA configuration interface busy
2078 status by the configuration function. This option
2079 will require a board or device specific function to
2080 be written.
wdenkc6097192002-11-03 00:24:07 +00002081
2082 CONFIG_FPGA_DELAY
2083
2084 If defined, a function that provides delays in the FPGA
2085 configuration driver.
2086
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002087 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002088 Allow Control-C to interrupt FPGA configuration
2089
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002090 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002091
wdenk43d96162003-03-06 00:02:04 +00002092 Check for configuration errors during FPGA bitfile
2093 loading. For example, abort during Virtex II
2094 configuration if the INIT_B line goes low (which
2095 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002096
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002097 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002098
wdenk43d96162003-03-06 00:02:04 +00002099 Maximum time to wait for the INIT_B line to deassert
2100 after PROB_B has been deasserted during a Virtex II
2101 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002102 ms.
wdenkc6097192002-11-03 00:24:07 +00002103
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002104 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002105
wdenk43d96162003-03-06 00:02:04 +00002106 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002107 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002108
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002109 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002110
wdenk43d96162003-03-06 00:02:04 +00002111 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002112 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002113
2114- Configuration Management:
2115 CONFIG_IDENT_STRING
2116
wdenk43d96162003-03-06 00:02:04 +00002117 If defined, this string will be added to the U-Boot
2118 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002119
2120- Vendor Parameter Protection:
2121
wdenk43d96162003-03-06 00:02:04 +00002122 U-Boot considers the values of the environment
2123 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002124 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002125 are set once by the board vendor / manufacturer, and
2126 protects these variables from casual modification by
2127 the user. Once set, these variables are read-only,
2128 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002129 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002130
2131 If CONFIG_ENV_OVERWRITE is #defined in your config
2132 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002133 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002134 these parameters.
2135
2136 Alternatively, if you #define _both_ CONFIG_ETHADDR
2137 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002138 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002139 which can be changed exactly ONCE by the user. [The
2140 serial# is unaffected by this, i. e. it remains
2141 read-only.]
2142
2143- Protected RAM:
2144 CONFIG_PRAM
2145
2146 Define this variable to enable the reservation of
2147 "protected RAM", i. e. RAM which is not overwritten
2148 by U-Boot. Define CONFIG_PRAM to hold the number of
2149 kB you want to reserve for pRAM. You can overwrite
2150 this default value by defining an environment
2151 variable "pram" to the number of kB you want to
2152 reserve. Note that the board info structure will
2153 still show the full amount of RAM. If pRAM is
2154 reserved, a new environment variable "mem" will
2155 automatically be defined to hold the amount of
2156 remaining RAM in a form that can be passed as boot
2157 argument to Linux, for instance like that:
2158
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002159 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002160 saveenv
2161
2162 This way you can tell Linux not to use this memory,
2163 either, which results in a memory region that will
2164 not be affected by reboots.
2165
2166 *WARNING* If your board configuration uses automatic
2167 detection of the RAM size, you must make sure that
2168 this memory test is non-destructive. So far, the
2169 following board configurations are known to be
2170 "pRAM-clean":
2171
2172 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2173 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002174 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002175
2176- Error Recovery:
2177 CONFIG_PANIC_HANG
2178
2179 Define this variable to stop the system in case of a
2180 fatal error, so that you have to reset it manually.
2181 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002182 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002183 automatically as fast as possible, but it may be
2184 useful during development since you can try to debug
2185 the conditions that lead to the situation.
2186
2187 CONFIG_NET_RETRY_COUNT
2188
wdenk43d96162003-03-06 00:02:04 +00002189 This variable defines the number of retries for
2190 network operations like ARP, RARP, TFTP, or BOOTP
2191 before giving up the operation. If not defined, a
2192 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002193
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002194 CONFIG_ARP_TIMEOUT
2195
2196 Timeout waiting for an ARP reply in milliseconds.
2197
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002198 CONFIG_NFS_TIMEOUT
2199
2200 Timeout in milliseconds used in NFS protocol.
2201 If you encounter "ERROR: Cannot umount" in nfs command,
2202 try longer timeout such as
2203 #define CONFIG_NFS_TIMEOUT 10000UL
2204
wdenkc6097192002-11-03 00:24:07 +00002205- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002206 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002207
2208 Enable auto completion of commands using TAB.
2209
Wolfgang Denka9398e02006-11-27 15:32:42 +01002210 Note that this feature has NOT been implemented yet
2211 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002212
2213
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002214 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002215
2216 Define this variable to enable the "hush" shell (from
2217 Busybox) as command line interpreter, thus enabling
2218 powerful command line syntax like
2219 if...then...else...fi conditionals or `&&' and '||'
2220 constructs ("shell scripts").
2221
2222 If undefined, you get the old, much simpler behaviour
2223 with a somewhat smaller memory footprint.
2224
2225
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002226 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002227
2228 This defines the secondary prompt string, which is
2229 printed when the command interpreter needs more input
2230 to complete a command. Usually "> ".
2231
2232 Note:
2233
wdenk8bde7f72003-06-27 21:31:46 +00002234 In the current implementation, the local variables
2235 space and global environment variables space are
2236 separated. Local variables are those you define by
2237 simply typing `name=value'. To access a local
2238 variable later on, you have write `$name' or
2239 `${name}'; to execute the contents of a variable
2240 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002241
wdenk43d96162003-03-06 00:02:04 +00002242 Global environment variables are those you use
2243 setenv/printenv to work with. To run a command stored
2244 in such a variable, you need to use the run command,
2245 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002246
2247 To store commands and special characters in a
2248 variable, please use double quotation marks
2249 surrounding the whole text of the variable, instead
2250 of the backslashes before semicolons and special
2251 symbols.
2252
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002253- Commandline Editing and History:
2254 CONFIG_CMDLINE_EDITING
2255
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002256 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002257 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002258
wdenka8c7c702003-12-06 19:49:23 +00002259- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002260 CONFIG_EXTRA_ENV_SETTINGS
2261
wdenk43d96162003-03-06 00:02:04 +00002262 Define this to contain any number of null terminated
2263 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002264 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002265
wdenk43d96162003-03-06 00:02:04 +00002266 For example, place something like this in your
2267 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002268
2269 #define CONFIG_EXTRA_ENV_SETTINGS \
2270 "myvar1=value1\0" \
2271 "myvar2=value2\0"
2272
wdenk43d96162003-03-06 00:02:04 +00002273 Warning: This method is based on knowledge about the
2274 internal format how the environment is stored by the
2275 U-Boot code. This is NOT an official, exported
2276 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002277 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002278 You better know what you are doing here.
2279
wdenk43d96162003-03-06 00:02:04 +00002280 Note: overly (ab)use of the default environment is
2281 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002282 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002283 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002284
Stephen Warren5e724ca2012-05-22 09:21:54 +00002285 CONFIG_ENV_VARS_UBOOT_CONFIG
2286
2287 Define this in order to add variables describing the
2288 U-Boot build configuration to the default environment.
2289 These will be named arch, cpu, board, vendor, and soc.
2290
2291 Enabling this option will cause the following to be defined:
2292
2293 - CONFIG_SYS_ARCH
2294 - CONFIG_SYS_CPU
2295 - CONFIG_SYS_BOARD
2296 - CONFIG_SYS_VENDOR
2297 - CONFIG_SYS_SOC
2298
wdenka8c7c702003-12-06 19:49:23 +00002299- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002300 CONFIG_HAS_DATAFLASH
2301
wdenk8bde7f72003-06-27 21:31:46 +00002302 Defining this option enables DataFlash features and
2303 allows to read/write in Dataflash via the standard
2304 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002305
Eric Nelsonf61ec452012-01-31 10:52:08 -07002306- Serial Flash support
2307 CONFIG_CMD_SF
2308
2309 Defining this option enables SPI flash commands
2310 'sf probe/read/write/erase/update'.
2311
2312 Usage requires an initial 'probe' to define the serial
2313 flash parameters, followed by read/write/erase/update
2314 commands.
2315
2316 The following defaults may be provided by the platform
2317 to handle the common case when only a single serial
2318 flash is present on the system.
2319
2320 CONFIG_SF_DEFAULT_BUS Bus identifier
2321 CONFIG_SF_DEFAULT_CS Chip-select
2322 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2323 CONFIG_SF_DEFAULT_SPEED in Hz
2324
wdenk3f85ce22004-02-23 16:11:30 +00002325- SystemACE Support:
2326 CONFIG_SYSTEMACE
2327
2328 Adding this option adds support for Xilinx SystemACE
2329 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002330 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002331 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002332
2333 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002334 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002335
2336 When SystemACE support is added, the "ace" device type
2337 becomes available to the fat commands, i.e. fatls.
2338
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002339- TFTP Fixed UDP Port:
2340 CONFIG_TFTP_PORT
2341
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002342 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002343 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002344 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002345 number generator is used.
2346
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002347 Also, the environment variable tftpdstp is used to supply
2348 the TFTP UDP destination port value. If tftpdstp isn't
2349 defined, the normal port 69 is used.
2350
2351 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002352 blindly start the TFTP transfer using the pre-configured
2353 target IP address and UDP port. This has the effect of
2354 "punching through" the (Windows XP) firewall, allowing
2355 the remainder of the TFTP transfer to proceed normally.
2356 A better solution is to properly configure the firewall,
2357 but sometimes that is not allowed.
2358
wdenka8c7c702003-12-06 19:49:23 +00002359- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002360 CONFIG_SHOW_BOOT_PROGRESS
2361
wdenk43d96162003-03-06 00:02:04 +00002362 Defining this option allows to add some board-
2363 specific code (calling a user-provided function
2364 "show_boot_progress(int)") that enables you to show
2365 the system's boot progress on some display (for
2366 example, some LED's) on your board. At the moment,
2367 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002368
Simon Glass3a608ca2012-02-13 13:51:19 +00002369- Detailed boot stage timing
2370 CONFIG_BOOTSTAGE
2371 Define this option to get detailed timing of each stage
2372 of the boot process.
2373
2374 CONFIG_BOOTSTAGE_USER_COUNT
2375 This is the number of available user bootstage records.
2376 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2377 a new ID will be allocated from this stash. If you exceed
2378 the limit, recording will stop.
2379
2380 CONFIG_BOOTSTAGE_REPORT
2381 Define this to print a report before boot, similar to this:
2382
2383 Timer summary in microseconds:
2384 Mark Elapsed Stage
2385 0 0 reset
2386 3,575,678 3,575,678 board_init_f start
2387 3,575,695 17 arch_cpu_init A9
2388 3,575,777 82 arch_cpu_init done
2389 3,659,598 83,821 board_init_r start
2390 3,910,375 250,777 main_loop
2391 29,916,167 26,005,792 bootm_start
2392 30,361,327 445,160 start_kernel
2393
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002394Legacy uImage format:
2395
wdenkc6097192002-11-03 00:24:07 +00002396 Arg Where When
2397 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002398 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002399 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002400 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002401 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002402 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002403 4 common/cmd_bootm.c Image data has correct checksum
2404 -4 common/cmd_bootm.c Image is for unsupported architecture
2405 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002406 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002407 6 common/cmd_bootm.c Image Type check OK
2408 -6 common/cmd_bootm.c gunzip uncompression error
2409 -7 common/cmd_bootm.c Unimplemented compression type
2410 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002411 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002412 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002413
2414 9 common/image.c Start initial ramdisk verification
2415 -10 common/image.c Ramdisk header has bad magic number
2416 -11 common/image.c Ramdisk header has bad checksum
2417 10 common/image.c Ramdisk header is OK
2418 -12 common/image.c Ramdisk data has bad checksum
2419 11 common/image.c Ramdisk data has correct checksum
2420 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002421 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002422 13 common/image.c Start multifile image verification
2423 14 common/image.c No initial ramdisk, no multifile, continue.
2424
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002425 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002426
Stefan Roesea47a12b2010-04-15 16:07:28 +02002427 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002428 -31 post/post.c POST test failed, detected by post_output_backlog()
2429 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002430
Heiko Schocher566a4942007-06-22 19:11:54 +02002431 34 common/cmd_doc.c before loading a Image from a DOC device
2432 -35 common/cmd_doc.c Bad usage of "doc" command
2433 35 common/cmd_doc.c correct usage of "doc" command
2434 -36 common/cmd_doc.c No boot device
2435 36 common/cmd_doc.c correct boot device
2436 -37 common/cmd_doc.c Unknown Chip ID on boot device
2437 37 common/cmd_doc.c correct chip ID found, device available
2438 -38 common/cmd_doc.c Read Error on boot device
2439 38 common/cmd_doc.c reading Image header from DOC device OK
2440 -39 common/cmd_doc.c Image header has bad magic number
2441 39 common/cmd_doc.c Image header has correct magic number
2442 -40 common/cmd_doc.c Error reading Image from DOC device
2443 40 common/cmd_doc.c Image header has correct magic number
2444 41 common/cmd_ide.c before loading a Image from a IDE device
2445 -42 common/cmd_ide.c Bad usage of "ide" command
2446 42 common/cmd_ide.c correct usage of "ide" command
2447 -43 common/cmd_ide.c No boot device
2448 43 common/cmd_ide.c boot device found
2449 -44 common/cmd_ide.c Device not available
2450 44 common/cmd_ide.c Device available
2451 -45 common/cmd_ide.c wrong partition selected
2452 45 common/cmd_ide.c partition selected
2453 -46 common/cmd_ide.c Unknown partition table
2454 46 common/cmd_ide.c valid partition table found
2455 -47 common/cmd_ide.c Invalid partition type
2456 47 common/cmd_ide.c correct partition type
2457 -48 common/cmd_ide.c Error reading Image Header on boot device
2458 48 common/cmd_ide.c reading Image Header from IDE device OK
2459 -49 common/cmd_ide.c Image header has bad magic number
2460 49 common/cmd_ide.c Image header has correct magic number
2461 -50 common/cmd_ide.c Image header has bad checksum
2462 50 common/cmd_ide.c Image header has correct checksum
2463 -51 common/cmd_ide.c Error reading Image from IDE device
2464 51 common/cmd_ide.c reading Image from IDE device OK
2465 52 common/cmd_nand.c before loading a Image from a NAND device
2466 -53 common/cmd_nand.c Bad usage of "nand" command
2467 53 common/cmd_nand.c correct usage of "nand" command
2468 -54 common/cmd_nand.c No boot device
2469 54 common/cmd_nand.c boot device found
2470 -55 common/cmd_nand.c Unknown Chip ID on boot device
2471 55 common/cmd_nand.c correct chip ID found, device available
2472 -56 common/cmd_nand.c Error reading Image Header on boot device
2473 56 common/cmd_nand.c reading Image Header from NAND device OK
2474 -57 common/cmd_nand.c Image header has bad magic number
2475 57 common/cmd_nand.c Image header has correct magic number
2476 -58 common/cmd_nand.c Error reading Image from NAND device
2477 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002478
Heiko Schocher566a4942007-06-22 19:11:54 +02002479 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002480
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002481 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002482 -64 net/eth.c no Ethernet found.
2483 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002484
Heiko Schocher566a4942007-06-22 19:11:54 +02002485 -80 common/cmd_net.c usage wrong
2486 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002487 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002488 81 common/cmd_net.c NetLoop() back without error
2489 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2490 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002491 83 common/cmd_net.c running "source" command
2492 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002493 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002494
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002495FIT uImage format:
2496
2497 Arg Where When
2498 100 common/cmd_bootm.c Kernel FIT Image has correct format
2499 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2500 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2501 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2502 102 common/cmd_bootm.c Kernel unit name specified
2503 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002504 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002505 104 common/cmd_bootm.c Got kernel subimage node offset
2506 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2507 105 common/cmd_bootm.c Kernel subimage hash verification OK
2508 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2509 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002510 -106 common/cmd_bootm.c Kernel subimage has wrong type
2511 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002512 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2513 108 common/cmd_bootm.c Got kernel subimage data/size
2514 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2515 -109 common/cmd_bootm.c Can't get kernel subimage type
2516 -110 common/cmd_bootm.c Can't get kernel subimage comp
2517 -111 common/cmd_bootm.c Can't get kernel subimage os
2518 -112 common/cmd_bootm.c Can't get kernel subimage load address
2519 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2520
2521 120 common/image.c Start initial ramdisk verification
2522 -120 common/image.c Ramdisk FIT image has incorrect format
2523 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002524 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002525 -122 common/image.c Can't get configuration for ramdisk subimage
2526 123 common/image.c Ramdisk unit name specified
2527 -124 common/image.c Can't get ramdisk subimage node offset
2528 125 common/image.c Got ramdisk subimage node offset
2529 -125 common/image.c Ramdisk subimage hash verification failed
2530 126 common/image.c Ramdisk subimage hash verification OK
2531 -126 common/image.c Ramdisk subimage for unsupported architecture
2532 127 common/image.c Architecture check OK
2533 -127 common/image.c Can't get ramdisk subimage data/size
2534 128 common/image.c Got ramdisk subimage data/size
2535 129 common/image.c Can't get ramdisk load address
2536 -129 common/image.c Got ramdisk load address
2537
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002538 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002539 131 common/cmd_doc.c FIT image format OK
2540
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002541 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002542 141 common/cmd_ide.c FIT image format OK
2543
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002544 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002545 151 common/cmd_nand.c FIT image format OK
2546
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002547- Standalone program support:
2548 CONFIG_STANDALONE_LOAD_ADDR
2549
Wolfgang Denk6feff892011-10-09 21:06:34 +02002550 This option defines a board specific value for the
2551 address where standalone program gets loaded, thus
2552 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002553 settings.
2554
2555- Frame Buffer Address:
2556 CONFIG_FB_ADDR
2557
2558 Define CONFIG_FB_ADDR if you want to use specific
2559 address for frame buffer.
2560 Then system will reserve the frame buffer address to
2561 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002562 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002563
2564 Please see board_init_f function.
2565
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002566- Automatic software updates via TFTP server
2567 CONFIG_UPDATE_TFTP
2568 CONFIG_UPDATE_TFTP_CNT_MAX
2569 CONFIG_UPDATE_TFTP_MSEC_MAX
2570
2571 These options enable and control the auto-update feature;
2572 for a more detailed description refer to doc/README.update.
2573
2574- MTD Support (mtdparts command, UBI support)
2575 CONFIG_MTD_DEVICE
2576
2577 Adds the MTD device infrastructure from the Linux kernel.
2578 Needed for mtdparts command support.
2579
2580 CONFIG_MTD_PARTITIONS
2581
2582 Adds the MTD partitioning infrastructure from the Linux
2583 kernel. Needed for UBI support.
2584
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002585- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002586 CONFIG_SPL
2587 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002588
Tom Rini95579792012-02-14 07:29:40 +00002589 CONFIG_SPL_LDSCRIPT
2590 LDSCRIPT for linking the SPL binary.
2591
2592 CONFIG_SPL_MAX_SIZE
2593 Maximum binary size (text, data and rodata) of the SPL binary.
2594
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002595 CONFIG_SPL_TEXT_BASE
2596 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002597
Tom Rini95579792012-02-14 07:29:40 +00002598 CONFIG_SPL_BSS_START_ADDR
2599 Link address for the BSS within the SPL binary.
2600
2601 CONFIG_SPL_BSS_MAX_SIZE
2602 Maximum binary size of the BSS section of the SPL binary.
2603
2604 CONFIG_SPL_STACK
2605 Adress of the start of the stack SPL will use
2606
2607 CONFIG_SYS_SPL_MALLOC_START
2608 Starting address of the malloc pool used in SPL.
2609
2610 CONFIG_SYS_SPL_MALLOC_SIZE
2611 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002612
Tom Rini47f7bca2012-08-13 12:03:19 -07002613 CONFIG_SPL_FRAMEWORK
2614 Enable the SPL framework under common/. This framework
2615 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2616 NAND loading of the Linux Kernel.
2617
Tom Rini861a86f2012-08-13 11:37:56 -07002618 CONFIG_SPL_DISPLAY_PRINT
2619 For ARM, enable an optional function to print more information
2620 about the running system.
2621
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002622 CONFIG_SPL_LIBCOMMON_SUPPORT
2623 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002624
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002625 CONFIG_SPL_LIBDISK_SUPPORT
2626 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002627
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002628 CONFIG_SPL_I2C_SUPPORT
2629 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002630
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002631 CONFIG_SPL_GPIO_SUPPORT
2632 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002633
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002634 CONFIG_SPL_MMC_SUPPORT
2635 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002636
Tom Rini95579792012-02-14 07:29:40 +00002637 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2638 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2639 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2640 Address, size and partition on the MMC to load U-Boot from
2641 when the MMC is being used in raw mode.
2642
2643 CONFIG_SPL_FAT_SUPPORT
2644 Support for fs/fat/libfat.o in SPL binary
2645
2646 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2647 Filename to read to load U-Boot when reading from FAT
2648
2649 CONFIG_SPL_NAND_SIMPLE
2650 Support for drivers/mtd/nand/libnand.o in SPL binary
2651
2652 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2653 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2654 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2655 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2656 CONFIG_SYS_NAND_ECCBYTES
2657 Defines the size and behavior of the NAND that SPL uses
2658 to read U-Boot with CONFIG_SPL_NAND_SIMPLE
2659
2660 CONFIG_SYS_NAND_U_BOOT_OFFS
2661 Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
2662 from.
2663
2664 CONFIG_SYS_NAND_U_BOOT_START
2665 Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
2666 to.
2667
2668 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2669 Define this if you need to first read the OOB and then the
2670 data. This is used for example on davinci plattforms.
2671
2672 CONFIG_SPL_OMAP3_ID_NAND
2673 Support for an OMAP3-specific set of functions to return the
2674 ID and MFR of the first attached NAND chip, if present.
2675
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002676 CONFIG_SPL_SERIAL_SUPPORT
2677 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002678
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002679 CONFIG_SPL_SPI_FLASH_SUPPORT
2680 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002681
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002682 CONFIG_SPL_SPI_SUPPORT
2683 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002684
Pavel Machekc57b9532012-08-30 22:42:11 +02002685 CONFIG_SPL_RAM_DEVICE
2686 Support for running image already present in ram, in SPL binary
2687
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002688 CONFIG_SPL_LIBGENERIC_SUPPORT
2689 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002690
wdenkc6097192002-11-03 00:24:07 +00002691Modem Support:
2692--------------
2693
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002694[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002695
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002696- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002697 CONFIG_MODEM_SUPPORT
2698
2699- RTS/CTS Flow control enable:
2700 CONFIG_HWFLOW
2701
2702- Modem debug support:
2703 CONFIG_MODEM_SUPPORT_DEBUG
2704
wdenk43d96162003-03-06 00:02:04 +00002705 Enables debugging stuff (char screen[1024], dbg())
2706 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002707
wdenka8c7c702003-12-06 19:49:23 +00002708- Interrupt support (PPC):
2709
wdenkd4ca31c2004-01-02 14:00:00 +00002710 There are common interrupt_init() and timer_interrupt()
2711 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002712 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002713 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002714 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002715 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002716 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002717 specific handling. If board has watchdog / status_led
2718 / other_activity_monitor it works automatically from
2719 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002720
wdenkc6097192002-11-03 00:24:07 +00002721- General:
2722
wdenk43d96162003-03-06 00:02:04 +00002723 In the target system modem support is enabled when a
2724 specific key (key combination) is pressed during
2725 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002726 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002727 board_init(). Currently key_pressed() is a dummy
2728 function, returning 1 and thus enabling modem
2729 initialization.
wdenkc6097192002-11-03 00:24:07 +00002730
wdenk43d96162003-03-06 00:02:04 +00002731 If there are no modem init strings in the
2732 environment, U-Boot proceed to autoboot; the
2733 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002734 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002735
2736 See also: doc/README.Modem
2737
Helmut Raiger9660e442011-10-20 04:19:47 +00002738Board initialization settings:
2739------------------------------
2740
2741During Initialization u-boot calls a number of board specific functions
2742to allow the preparation of board specific prerequisites, e.g. pin setup
2743before drivers are initialized. To enable these callbacks the
2744following configuration macros have to be defined. Currently this is
2745architecture specific, so please check arch/your_architecture/lib/board.c
2746typically in board_init_f() and board_init_r().
2747
2748- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2749- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2750- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2751- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002752
wdenkc6097192002-11-03 00:24:07 +00002753Configuration Settings:
2754-----------------------
2755
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002756- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002757 undefine this when you're short of memory.
2758
Peter Tyser2fb26042009-01-27 18:03:12 -06002759- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2760 width of the commands listed in the 'help' command output.
2761
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002762- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002763 prompt for user input.
2764
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002765- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002766
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002767- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002768
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002769- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002770
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002771- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002772 the application (usually a Linux kernel) when it is
2773 booted
2774
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002775- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002776 List of legal baudrate settings for this board.
2777
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002778- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002779 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002781- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002782 If the board specific function
2783 extern int overwrite_console (void);
2784 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002785 serial port, else the settings in the environment are used.
2786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002787- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002788 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002789
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002790- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002791 Enable overwrite of previous console environment settings.
2792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002793- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002794 Begin and End addresses of the area used by the
2795 simple memory test.
2796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002797- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002798 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002799
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002800- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002801 Scratch address used by the alternate memory test
2802 You only need to set this if address zero isn't writeable
2803
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002804- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2805 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002806 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002807 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002808 fixing up gd->ram_size the Linux kernel should gets passed
2809 the now "corrected" memory size and won't touch it either.
2810 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002811 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002812 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002813 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002814
2815 This option can be used as a workaround for the 440EPx/GRx
2816 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2817 be touched.
2818
2819 WARNING: Please make sure that this value is a multiple of
2820 the Linux page size (normally 4k). If this is not the case,
2821 then the end address of the Linux memory will be located at a
2822 non page size aligned address and this could cause major
2823 problems.
2824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002825- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002826 Default load address for network file downloads
2827
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002828- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002829 Enable temporary baudrate change while serial download
2830
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002831- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002832 Physical start address of SDRAM. _Must_ be 0 here.
2833
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002834- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002835 Physical start address of Motherboard I/O (if using a
2836 Cogent motherboard)
2837
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002838- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002839 Physical start address of Flash memory.
2840
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002841- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002842 Physical start address of boot monitor code (set by
2843 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002844 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002845 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002846
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002847- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002848 Size of memory reserved for monitor code, used to
2849 determine _at_compile_time_ (!) if the environment is
2850 embedded within the U-Boot image, or in a separate
2851 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002852
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002853- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002854 Size of DRAM reserved for malloc() use.
2855
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002856- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002857 Normally compressed uImages are limited to an
2858 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002859 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002860 to adjust this setting to your needs.
2861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002862- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002863 Maximum size of memory mapped by the startup code of
2864 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002865 the Linux kernel (bd_info, boot arguments, FDT blob if
2866 used) must be put below this limit, unless "bootm_low"
2867 enviroment variable is defined and non-zero. In such case
2868 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002869 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002870 variable "bootm_mapsize" will override the value of
2871 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2872 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002873
John Rigbyfca43cc2010-10-13 13:57:35 -06002874- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2875 Enable initrd_high functionality. If defined then the
2876 initrd_high feature is enabled and the bootm ramdisk subcommand
2877 is enabled.
2878
2879- CONFIG_SYS_BOOT_GET_CMDLINE:
2880 Enables allocating and saving kernel cmdline in space between
2881 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2882
2883- CONFIG_SYS_BOOT_GET_KBD:
2884 Enables allocating and saving a kernel copy of the bd_info in
2885 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2886
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002887- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002888 Max number of Flash memory banks
2889
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002890- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002891 Max number of sectors on a Flash chip
2892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002893- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002894 Timeout for Flash erase operations (in ms)
2895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002896- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002897 Timeout for Flash write operations (in ms)
2898
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002899- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002900 Timeout for Flash set sector lock bit operation (in ms)
2901
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002902- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002903 Timeout for Flash clear lock bits operation (in ms)
2904
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002905- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002906 If defined, hardware flash sectors protection is used
2907 instead of U-Boot software protection.
2908
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002909- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002910
2911 Enable TFTP transfers directly to flash memory;
2912 without this option such a download has to be
2913 performed in two steps: (1) download to RAM, and (2)
2914 copy from RAM to flash.
2915
2916 The two-step approach is usually more reliable, since
2917 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002918 the flash, but in some situations (when system RAM is
2919 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002920 downloaded image) this option may be very useful.
2921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002922- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002923 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002924 common flash structure for storing flash geometry.
2925
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002926- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002927 This option also enables the building of the cfi_flash driver
2928 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002929
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002930- CONFIG_FLASH_CFI_MTD
2931 This option enables the building of the cfi_mtd driver
2932 in the drivers directory. The driver exports CFI flash
2933 to the MTD layer.
2934
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002935- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002936 Use buffered writes to flash.
2937
2938- CONFIG_FLASH_SPANSION_S29WS_N
2939 s29ws-n MirrorBit flash has non-standard addresses for buffered
2940 write commands.
2941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002942- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002943 If this option is defined, the common CFI flash doesn't
2944 print it's warning upon not recognized FLASH banks. This
2945 is useful, if some of the configured banks are only
2946 optionally available.
2947
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002948- CONFIG_FLASH_SHOW_PROGRESS
2949 If defined (must be an integer), print out countdown
2950 digits and dots. Recommended value: 45 (9..1) for 80
2951 column displays, 15 (3..1) for 40 column displays.
2952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002953- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002954 Defines the number of Ethernet receive buffers. On some
2955 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002956 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2957 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002958 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002959 Defaults to 4 if not defined.
2960
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002961- CONFIG_ENV_MAX_ENTRIES
2962
Wolfgang Denk071bc922010-10-27 22:48:30 +02002963 Maximum number of entries in the hash table that is used
2964 internally to store the environment settings. The default
2965 setting is supposed to be generous and should work in most
2966 cases. This setting can be used to tune behaviour; see
2967 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002968
wdenkc6097192002-11-03 00:24:07 +00002969The following definitions that deal with the placement and management
2970of environment data (variable area); in general, we support the
2971following configurations:
2972
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002973- CONFIG_BUILD_ENVCRC:
2974
2975 Builds up envcrc with the target environment so that external utils
2976 may easily extract it and embed it in final U-Boot images.
2977
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002978- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002979
2980 Define this if the environment is in flash memory.
2981
2982 a) The environment occupies one whole flash sector, which is
2983 "embedded" in the text segment with the U-Boot code. This
2984 happens usually with "bottom boot sector" or "top boot
2985 sector" type flash chips, which have several smaller
2986 sectors at the start or the end. For instance, such a
2987 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2988 such a case you would place the environment in one of the
2989 4 kB sectors - with U-Boot code before and after it. With
2990 "top boot sector" type flash chips, you would put the
2991 environment in one of the last sectors, leaving a gap
2992 between U-Boot and the environment.
2993
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002994 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002995
2996 Offset of environment data (variable area) to the
2997 beginning of flash memory; for instance, with bottom boot
2998 type flash chips the second sector can be used: the offset
2999 for this sector is given here.
3000
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003001 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003002
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003003 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003004
3005 This is just another way to specify the start address of
3006 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003007 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003008
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003009 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003010
3011 Size of the sector containing the environment.
3012
3013
3014 b) Sometimes flash chips have few, equal sized, BIG sectors.
3015 In such a case you don't want to spend a whole sector for
3016 the environment.
3017
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003018 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003019
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003020 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003021 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003022 of this flash sector for the environment. This saves
3023 memory for the RAM copy of the environment.
3024
3025 It may also save flash memory if you decide to use this
3026 when your environment is "embedded" within U-Boot code,
3027 since then the remainder of the flash sector could be used
3028 for U-Boot code. It should be pointed out that this is
3029 STRONGLY DISCOURAGED from a robustness point of view:
3030 updating the environment in flash makes it always
3031 necessary to erase the WHOLE sector. If something goes
3032 wrong before the contents has been restored from a copy in
3033 RAM, your target system will be dead.
3034
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003035 - CONFIG_ENV_ADDR_REDUND
3036 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003037
wdenk43d96162003-03-06 00:02:04 +00003038 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003039 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003040 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003041 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003042
3043BE CAREFUL! Any changes to the flash layout, and some changes to the
3044source code will make it necessary to adapt <board>/u-boot.lds*
3045accordingly!
3046
3047
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003048- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003049
3050 Define this if you have some non-volatile memory device
3051 (NVRAM, battery buffered SRAM) which you want to use for the
3052 environment.
3053
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003054 - CONFIG_ENV_ADDR:
3055 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003056
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003057 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003058 want to use for environment. It is assumed that this memory
3059 can just be read and written to, without any special
3060 provision.
3061
3062BE CAREFUL! The first access to the environment happens quite early
3063in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003064console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003065U-Boot will hang.
3066
3067Please note that even with NVRAM we still use a copy of the
3068environment in RAM: we could work on NVRAM directly, but we want to
3069keep settings there always unmodified except somebody uses "saveenv"
3070to save the current settings.
3071
3072
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003073- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003074
3075 Use this if you have an EEPROM or similar serial access
3076 device and a driver for it.
3077
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003078 - CONFIG_ENV_OFFSET:
3079 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003080
3081 These two #defines specify the offset and size of the
3082 environment area within the total memory of your EEPROM.
3083
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003084 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003085 If defined, specified the chip address of the EEPROM device.
3086 The default address is zero.
3087
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003088 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003089 If defined, the number of bits used to address bytes in a
3090 single page in the EEPROM device. A 64 byte page, for example
3091 would require six bits.
3092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003093 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003094 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003095 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003096
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003097 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003098 The length in bytes of the EEPROM memory array address. Note
3099 that this is NOT the chip address length!
3100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003101 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003102 EEPROM chips that implement "address overflow" are ones
3103 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3104 address and the extra bits end up in the "chip address" bit
3105 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3106 byte chips.
3107
3108 Note that we consider the length of the address field to
3109 still be one byte because the extra address bits are hidden
3110 in the chip address.
3111
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003112 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003113 The size in bytes of the EEPROM device.
3114
Heiko Schocher548738b2010-01-07 08:55:40 +01003115 - CONFIG_ENV_EEPROM_IS_ON_I2C
3116 define this, if you have I2C and SPI activated, and your
3117 EEPROM, which holds the environment, is on the I2C bus.
3118
3119 - CONFIG_I2C_ENV_EEPROM_BUS
3120 if you have an Environment on an EEPROM reached over
3121 I2C muxes, you can define here, how to reach this
3122 EEPROM. For example:
3123
Wolfgang Denka9046b92010-06-13 17:48:15 +02003124 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003125
3126 EEPROM which holds the environment, is reached over
3127 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003128
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003129- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003130
wdenkd4ca31c2004-01-02 14:00:00 +00003131 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003132 want to use for the environment.
3133
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003134 - CONFIG_ENV_OFFSET:
3135 - CONFIG_ENV_ADDR:
3136 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003137
3138 These three #defines specify the offset and size of the
3139 environment area within the total memory of your DataFlash placed
3140 at the specified address.
3141
Liu Gang0a85a9e2012-03-08 00:33:20 +00003142- CONFIG_ENV_IS_IN_REMOTE:
3143
3144 Define this if you have a remote memory space which you
3145 want to use for the local device's environment.
3146
3147 - CONFIG_ENV_ADDR:
3148 - CONFIG_ENV_SIZE:
3149
3150 These two #defines specify the address and size of the
3151 environment area within the remote memory space. The
3152 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003153 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003154
3155BE CAREFUL! For some special cases, the local device can not use
3156"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003157environment stored in a remote NOR flash by SRIO or PCIE link,
3158but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003159
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003160- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003161
3162 Define this if you have a NAND device which you want to use
3163 for the environment.
3164
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003165 - CONFIG_ENV_OFFSET:
3166 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003167
3168 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003169 area within the first NAND device. CONFIG_ENV_OFFSET must be
3170 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003171
Scott Woodfdd813d2010-09-17 14:38:37 -05003172 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003173
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003174 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003175 size used to hold a redundant copy of the environment data, so
3176 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003177 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003178 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003179
Scott Woodfdd813d2010-09-17 14:38:37 -05003180 - CONFIG_ENV_RANGE (optional):
3181
3182 Specifies the length of the region in which the environment
3183 can be written. This should be a multiple of the NAND device's
3184 block size. Specifying a range with more erase blocks than
3185 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3186 the range to be avoided.
3187
3188 - CONFIG_ENV_OFFSET_OOB (optional):
3189
3190 Enables support for dynamically retrieving the offset of the
3191 environment from block zero's out-of-band data. The
3192 "nand env.oob" command can be used to record this offset.
3193 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3194 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003195
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003196- CONFIG_NAND_ENV_DST
3197
3198 Defines address in RAM to which the nand_spl code should copy the
3199 environment. If redundant environment is used, it will be copied to
3200 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3201
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003202- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003203
3204 Defines offset to the initial SPI buffer area in DPRAM. The
3205 area is used at an early stage (ROM part) if the environment
3206 is configured to reside in the SPI EEPROM: We need a 520 byte
3207 scratch DPRAM area. It is used between the two initialization
3208 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3209 to be a good choice since it makes it far enough from the
3210 start of the data area as well as from the stack pointer.
3211
Bruce Adlere881cb52007-11-02 13:15:42 -07003212Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003213has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003214created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003215until then to read environment variables.
3216
wdenk85ec0bc2003-03-31 16:34:49 +00003217The environment is protected by a CRC32 checksum. Before the monitor
3218is relocated into RAM, as a result of a bad CRC you will be working
3219with the compiled-in default environment - *silently*!!! [This is
3220necessary, because the first environment variable we need is the
3221"baudrate" setting for the console - if we have a bad CRC, we don't
3222have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003223
3224Note: once the monitor has been relocated, then it will complain if
3225the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003226use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003227
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003228- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003229 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003230
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003231 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003232 also needs to be defined.
3233
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003234- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003235 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003236
Ron Madridf5675aa2009-02-18 14:30:44 -08003237- CONFIG_NS16550_MIN_FUNCTIONS:
3238 Define this if you desire to only have use of the NS16550_init
3239 and NS16550_putc functions for the serial driver located at
3240 drivers/serial/ns16550.c. This option is useful for saving
3241 space for already greatly restricted images, including but not
3242 limited to NAND_SPL configurations.
3243
wdenkc6097192002-11-03 00:24:07 +00003244Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003245---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003246
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003247- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003248 Cache Line Size of the CPU.
3249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003250- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003251 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003252
wdenk42d1f032003-10-15 23:53:47 +00003253 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3254 and RPXsuper) to be able to adjust the position of
3255 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003256
Timur Tabie46fedf2011-08-04 18:03:41 -05003257- CONFIG_SYS_CCSRBAR_DEFAULT:
3258 Default (power-on reset) physical address of CCSR on Freescale
3259 PowerPC SOCs.
3260
3261- CONFIG_SYS_CCSRBAR:
3262 Virtual address of CCSR. On a 32-bit build, this is typically
3263 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3264
3265 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3266 for cross-platform code that uses that macro instead.
3267
3268- CONFIG_SYS_CCSRBAR_PHYS:
3269 Physical address of CCSR. CCSR can be relocated to a new
3270 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003271 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003272 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3273 is typically relocated on 36-bit builds. It is recommended
3274 that this macro be defined via the _HIGH and _LOW macros:
3275
3276 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3277 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3278
3279- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003280 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3281 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003282 used in assembly code, so it must not contain typecasts or
3283 integer size suffixes (e.g. "ULL").
3284
3285- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3286 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3287 used in assembly code, so it must not contain typecasts or
3288 integer size suffixes (e.g. "ULL").
3289
3290- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3291 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3292 forced to a value that ensures that CCSR is not relocated.
3293
wdenk7f6c2cb2002-11-10 22:06:23 +00003294- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003295 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003296
3297 the default drive number (default value 0)
3298
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003299 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003300
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003301 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003302 (default value 1)
3303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003304 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003305
wdenk43d96162003-03-06 00:02:04 +00003306 defines the offset of register from address. It
3307 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003308 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003309
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003310 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3311 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003312 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003313
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003314 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003315 fdc_hw_init() is called at the beginning of the FDC
3316 setup. fdc_hw_init() must be provided by the board
3317 source code. It is used to make hardware dependant
3318 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003319
Macpaul Lin0abddf82011-04-11 20:45:32 +00003320- CONFIG_IDE_AHB:
3321 Most IDE controllers were designed to be connected with PCI
3322 interface. Only few of them were designed for AHB interface.
3323 When software is doing ATA command and data transfer to
3324 IDE devices through IDE-AHB controller, some additional
3325 registers accessing to these kind of IDE-AHB controller
3326 is requierd.
3327
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003328- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003329 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003330 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003331
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003332- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003333
wdenk7152b1d2003-09-05 23:19:14 +00003334 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003335 initial data and stack; please note that this must be
3336 writable memory that is working WITHOUT special
3337 initialization, i. e. you CANNOT use normal RAM which
3338 will become available only after programming the
3339 memory controller and running certain initialization
3340 sequences.
3341
3342 U-Boot uses the following memory types:
3343 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3344 - MPC824X: data cache
3345 - PPC4xx: data cache
3346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003347- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003348
3349 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003350 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3351 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003352 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003353 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003354 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3355 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3356 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003357
3358 Note:
3359 On the MPC824X (or other systems that use the data
3360 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003361 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003362 point to an otherwise UNUSED address space between
3363 the top of RAM and the start of the PCI space.
3364
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003365- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003366
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003367- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003368
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003369- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003370
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003371- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003373- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003374
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003375- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003376
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003377- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003378 SDRAM timing
3379
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003380- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003381 periodic timer for refresh
3382
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003383- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003384
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003385- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3386 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3387 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3388 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003389 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3390
3391- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003392 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3393 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003394 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3395
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003396- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3397 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003398 Machine Mode Register and Memory Periodic Timer
3399 Prescaler definitions (SDRAM timing)
3400
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003401- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003402 enable I2C microcode relocation patch (MPC8xx);
3403 define relocation offset in DPRAM [DSP2]
3404
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003405- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003406 enable SMC microcode relocation patch (MPC8xx);
3407 define relocation offset in DPRAM [SMC1]
3408
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003409- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003410 enable SPI microcode relocation patch (MPC8xx);
3411 define relocation offset in DPRAM [SCC4]
3412
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003413- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003414 Use OSCM clock mode on MBX8xx board. Be careful,
3415 wrong setting might damage your board. Read
3416 doc/README.MBX before setting this variable!
3417
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003418- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003419 Offset of the bootmode word in DPRAM used by post
3420 (Power On Self Tests). This definition overrides
3421 #define'd default value in commproc.h resp.
3422 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003423
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003424- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3425 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3426 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3427 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3428 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3429 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3430 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3431 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003432 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003433
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003434- CONFIG_PCI_DISABLE_PCIE:
3435 Disable PCI-Express on systems where it is supported but not
3436 required.
3437
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003438- CONFIG_PCI_ENUM_ONLY
3439 Only scan through and get the devices on the busses.
3440 Don't do any setup work, presumably because someone or
3441 something has already done it, and we don't need to do it
3442 a second time. Useful for platforms that are pre-booted
3443 by coreboot or similar.
3444
Kumar Galaa09b9b62010-12-30 12:09:53 -06003445- CONFIG_SYS_SRIO:
3446 Chip has SRIO or not
3447
3448- CONFIG_SRIO1:
3449 Board has SRIO 1 port available
3450
3451- CONFIG_SRIO2:
3452 Board has SRIO 2 port available
3453
3454- CONFIG_SYS_SRIOn_MEM_VIRT:
3455 Virtual Address of SRIO port 'n' memory region
3456
3457- CONFIG_SYS_SRIOn_MEM_PHYS:
3458 Physical Address of SRIO port 'n' memory region
3459
3460- CONFIG_SYS_SRIOn_MEM_SIZE:
3461 Size of SRIO port 'n' memory region
3462
Alex Watermaneced4622011-05-19 15:08:36 -04003463- CONFIG_SYS_NDFC_16
3464 Defined to tell the NDFC that the NAND chip is using a
3465 16 bit bus.
3466
3467- CONFIG_SYS_NDFC_EBC0_CFG
3468 Sets the EBC0_CFG register for the NDFC. If not defined
3469 a default value will be used.
3470
Ben Warrenbb99ad62006-09-07 16:50:54 -04003471- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003472 Get DDR timing information from an I2C EEPROM. Common
3473 with pluggable memory modules such as SODIMMs
3474
Ben Warrenbb99ad62006-09-07 16:50:54 -04003475 SPD_EEPROM_ADDRESS
3476 I2C address of the SPD EEPROM
3477
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003478- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003479 If SPD EEPROM is on an I2C bus other than the first
3480 one, specify here. Note that the value must resolve
3481 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003482
York Sun1b3e3c42011-06-07 09:42:16 +08003483- CONFIG_SYS_DDR_RAW_TIMING
3484 Get DDR timing information from other than SPD. Common with
3485 soldered DDR chips onboard without SPD. DDR raw timing
3486 parameters are extracted from datasheet and hard-coded into
3487 header files or board specific files.
3488
York Sun6f5e1dc2011-09-16 13:21:35 -07003489- CONFIG_FSL_DDR_INTERACTIVE
3490 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3491
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003492- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003493 Only for 83xx systems. If specified, then DDR should
3494 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003495
wdenkc26e4542004-04-18 10:13:26 +00003496- CONFIG_ETHER_ON_FEC[12]
3497 Define to enable FEC[12] on a 8xx series processor.
3498
3499- CONFIG_FEC[12]_PHY
3500 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003501 to the given FEC; i. e.
3502 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003503 means that the PHY with address 4 is connected to FEC1
3504
3505 When set to -1, means to probe for first available.
3506
3507- CONFIG_FEC[12]_PHY_NORXERR
3508 The PHY does not have a RXERR line (RMII only).
3509 (so program the FEC to ignore it).
3510
3511- CONFIG_RMII
3512 Enable RMII mode for all FECs.
3513 Note that this is a global option, we can't
3514 have one FEC in standard MII mode and another in RMII mode.
3515
wdenk5cf91d62004-04-23 20:32:05 +00003516- CONFIG_CRC32_VERIFY
3517 Add a verify option to the crc32 command.
3518 The syntax is:
3519
3520 => crc32 -v <address> <count> <crc32>
3521
3522 Where address/count indicate a memory area
3523 and crc32 is the correct crc32 which the
3524 area should have.
3525
wdenk56523f12004-07-11 17:40:54 +00003526- CONFIG_LOOPW
3527 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003528 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003529
stroese7b466642004-12-16 18:46:55 +00003530- CONFIG_MX_CYCLIC
3531 Add the "mdc" and "mwc" memory commands. These are cyclic
3532 "md/mw" commands.
3533 Examples:
3534
wdenkefe2a4d2004-12-16 21:44:03 +00003535 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003536 This command will print 4 bytes (10,11,12,13) each 500 ms.
3537
wdenkefe2a4d2004-12-16 21:44:03 +00003538 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003539 This command will write 12345678 to address 100 all 10 ms.
3540
wdenkefe2a4d2004-12-16 21:44:03 +00003541 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003542 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003543
wdenk8aa1a2d2005-04-04 12:44:11 +00003544- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003545 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003546 low level initializations (like setting up the memory
3547 controller) are omitted and/or U-Boot does not
3548 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003549
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003550 Normally this variable MUST NOT be defined. The only
3551 exception is when U-Boot is loaded (to RAM) by some
3552 other boot loader or by a debugger which performs
3553 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003554
Aneesh V401bb302011-07-13 05:11:07 +00003555- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003556 Modifies the behaviour of start.S when compiling a loader
3557 that is executed before the actual U-Boot. E.g. when
3558 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003559
Matthias Weisserd8834a12011-03-10 21:36:32 +00003560- CONFIG_USE_ARCH_MEMCPY
3561 CONFIG_USE_ARCH_MEMSET
3562 If these options are used a optimized version of memcpy/memset will
3563 be used if available. These functions may be faster under some
3564 conditions but may increase the binary size.
3565
Timur Tabif2717b42011-11-22 09:21:25 -06003566Freescale QE/FMAN Firmware Support:
3567-----------------------------------
3568
3569The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3570loading of "firmware", which is encoded in the QE firmware binary format.
3571This firmware often needs to be loaded during U-Boot booting, so macros
3572are used to identify the storage device (NOR flash, SPI, etc) and the address
3573within that device.
3574
3575- CONFIG_SYS_QE_FMAN_FW_ADDR
3576 The address in the storage device where the firmware is located. The
3577 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3578 is also specified.
3579
3580- CONFIG_SYS_QE_FMAN_FW_LENGTH
3581 The maximum possible size of the firmware. The firmware binary format
3582 has a field that specifies the actual size of the firmware, but it
3583 might not be possible to read any part of the firmware unless some
3584 local storage is allocated to hold the entire firmware first.
3585
3586- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3587 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3588 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3589 virtual address in NOR flash.
3590
3591- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3592 Specifies that QE/FMAN firmware is located in NAND flash.
3593 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3594
3595- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3596 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3597 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3598
3599- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3600 Specifies that QE/FMAN firmware is located on the primary SPI
3601 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3602
Liu Gang292dc6c2012-03-08 00:33:18 +00003603- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3604 Specifies that QE/FMAN firmware is located in the remote (master)
3605 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003606 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3607 window->master inbound window->master LAW->the ucode address in
3608 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003609
wdenkc6097192002-11-03 00:24:07 +00003610Building the Software:
3611======================
3612
Wolfgang Denk218ca722008-03-26 10:40:12 +01003613Building U-Boot has been tested in several native build environments
3614and in many different cross environments. Of course we cannot support
3615all possibly existing versions of cross development tools in all
3616(potentially obsolete) versions. In case of tool chain problems we
3617recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3618which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003619
Wolfgang Denk218ca722008-03-26 10:40:12 +01003620If you are not using a native environment, it is assumed that you
3621have GNU cross compiling tools available in your path. In this case,
3622you must set the environment variable CROSS_COMPILE in your shell.
3623Note that no changes to the Makefile or any other source files are
3624necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003625
Wolfgang Denk218ca722008-03-26 10:40:12 +01003626 $ CROSS_COMPILE=ppc_4xx-
3627 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003628
Peter Tyser2f8d3962009-03-13 18:54:51 -05003629Note: If you wish to generate Windows versions of the utilities in
3630 the tools directory you can use the MinGW toolchain
3631 (http://www.mingw.org). Set your HOST tools to the MinGW
3632 toolchain and execute 'make tools'. For example:
3633
3634 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3635
3636 Binaries such as tools/mkimage.exe will be created which can
3637 be executed on computers running Windows.
3638
Wolfgang Denk218ca722008-03-26 10:40:12 +01003639U-Boot is intended to be simple to build. After installing the
3640sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003641is done by typing:
3642
3643 make NAME_config
3644
Wolfgang Denk218ca722008-03-26 10:40:12 +01003645where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003646rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003647
wdenk2729af92004-05-03 20:45:30 +00003648Note: for some board special configuration names may exist; check if
3649 additional information is available from the board vendor; for
3650 instance, the TQM823L systems are available without (standard)
3651 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003652 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003653
wdenk2729af92004-05-03 20:45:30 +00003654 make TQM823L_config
3655 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003656
wdenk2729af92004-05-03 20:45:30 +00003657 make TQM823L_LCD_config
3658 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003659
wdenk2729af92004-05-03 20:45:30 +00003660 etc.
wdenkc6097192002-11-03 00:24:07 +00003661
wdenkc6097192002-11-03 00:24:07 +00003662
wdenk2729af92004-05-03 20:45:30 +00003663Finally, type "make all", and you should get some working U-Boot
3664images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003665
wdenk2729af92004-05-03 20:45:30 +00003666- "u-boot.bin" is a raw binary image
3667- "u-boot" is an image in ELF binary format
3668- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003669
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003670By default the build is performed locally and the objects are saved
3671in the source directory. One of the two methods can be used to change
3672this behavior and build U-Boot to some external directory:
3673
36741. Add O= to the make command line invocations:
3675
3676 make O=/tmp/build distclean
3677 make O=/tmp/build NAME_config
3678 make O=/tmp/build all
3679
36802. Set environment variable BUILD_DIR to point to the desired location:
3681
3682 export BUILD_DIR=/tmp/build
3683 make distclean
3684 make NAME_config
3685 make all
3686
3687Note that the command line "O=" setting overrides the BUILD_DIR environment
3688variable.
3689
wdenkc6097192002-11-03 00:24:07 +00003690
wdenk2729af92004-05-03 20:45:30 +00003691Please be aware that the Makefiles assume you are using GNU make, so
3692for instance on NetBSD you might need to use "gmake" instead of
3693native "make".
wdenkc6097192002-11-03 00:24:07 +00003694
wdenkc6097192002-11-03 00:24:07 +00003695
wdenk2729af92004-05-03 20:45:30 +00003696If the system board that you have is not listed, then you will need
3697to port U-Boot to your hardware platform. To do this, follow these
3698steps:
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk2729af92004-05-03 20:45:30 +000037001. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00003701 "boards.cfg" file, using the existing entries as examples.
3702 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000037032. Create a new directory to hold your board specific code. Add any
3704 files you need. In your board directory, you will need at least
3705 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
37063. Create a new configuration file "include/configs/<board>.h" for
3707 your board
37083. If you're porting U-Boot to a new CPU, then also create a new
3709 directory to hold your CPU specific code. Add any files you need.
37104. Run "make <board>_config" with your new name.
37115. Type "make", and you should get a working "u-boot.srec" file
3712 to be installed on your target system.
37136. Debug and solve any problems that might arise.
3714 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003715
wdenkc6097192002-11-03 00:24:07 +00003716
wdenk2729af92004-05-03 20:45:30 +00003717Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3718==============================================================
wdenkc6097192002-11-03 00:24:07 +00003719
Wolfgang Denk218ca722008-03-26 10:40:12 +01003720If you have modified U-Boot sources (for instance added a new board
3721or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003722provide feedback to the other developers. The feedback normally takes
3723the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003724official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003725
Wolfgang Denk218ca722008-03-26 10:40:12 +01003726But before you submit such a patch, please verify that your modifi-
3727cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003728the supported boards compile WITHOUT ANY compiler warnings. To do so,
3729just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003730for ALL supported system. Be warned, this will take a while. You can
3731select which (cross) compiler to use by passing a `CROSS_COMPILE'
3732environment variable to the script, i. e. to use the ELDK cross tools
3733you can type
wdenkc6097192002-11-03 00:24:07 +00003734
wdenk2729af92004-05-03 20:45:30 +00003735 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003736
wdenk2729af92004-05-03 20:45:30 +00003737or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003738
wdenk2729af92004-05-03 20:45:30 +00003739 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003740
Wolfgang Denk218ca722008-03-26 10:40:12 +01003741When using the MAKEALL script, the default behaviour is to build
3742U-Boot in the source directory. This location can be changed by
3743setting the BUILD_DIR environment variable. Also, for each target
3744built, the MAKEALL script saves two log files (<target>.ERR and
3745<target>.MAKEALL) in the <source dir>/LOG directory. This default
3746location can be changed by setting the MAKEALL_LOGDIR environment
3747variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003748
3749 export BUILD_DIR=/tmp/build
3750 export MAKEALL_LOGDIR=/tmp/log
3751 CROSS_COMPILE=ppc_8xx- MAKEALL
3752
Wolfgang Denk218ca722008-03-26 10:40:12 +01003753With the above settings build objects are saved in the /tmp/build,
3754log files are saved in the /tmp/log and the source tree remains clean
3755during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003756
3757
wdenk2729af92004-05-03 20:45:30 +00003758See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003759
wdenkc6097192002-11-03 00:24:07 +00003760
wdenk2729af92004-05-03 20:45:30 +00003761Monitor Commands - Overview:
3762============================
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk2729af92004-05-03 20:45:30 +00003764go - start application at address 'addr'
3765run - run commands in an environment variable
3766bootm - boot application image from memory
3767bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003768bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003769tftpboot- boot image via network using TFTP protocol
3770 and env variables "ipaddr" and "serverip"
3771 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003772tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003773rarpboot- boot image via network using RARP/TFTP protocol
3774diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3775loads - load S-Record file over serial line
3776loadb - load binary file over serial line (kermit mode)
3777md - memory display
3778mm - memory modify (auto-incrementing)
3779nm - memory modify (constant address)
3780mw - memory write (fill)
3781cp - memory copy
3782cmp - memory compare
3783crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003784i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003785sspi - SPI utility commands
3786base - print or set address offset
3787printenv- print environment variables
3788setenv - set environment variables
3789saveenv - save environment variables to persistent storage
3790protect - enable or disable FLASH write protection
3791erase - erase FLASH memory
3792flinfo - print FLASH memory information
3793bdinfo - print Board Info structure
3794iminfo - print header information for application image
3795coninfo - print console devices and informations
3796ide - IDE sub-system
3797loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003798loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003799mtest - simple RAM test
3800icache - enable or disable instruction cache
3801dcache - enable or disable data cache
3802reset - Perform RESET of the CPU
3803echo - echo args to console
3804version - print monitor version
3805help - print online help
3806? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003807
wdenkc6097192002-11-03 00:24:07 +00003808
wdenk2729af92004-05-03 20:45:30 +00003809Monitor Commands - Detailed Description:
3810========================================
wdenkc6097192002-11-03 00:24:07 +00003811
wdenk2729af92004-05-03 20:45:30 +00003812TODO.
wdenkc6097192002-11-03 00:24:07 +00003813
wdenk2729af92004-05-03 20:45:30 +00003814For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003815
3816
wdenk2729af92004-05-03 20:45:30 +00003817Environment Variables:
3818======================
wdenkc6097192002-11-03 00:24:07 +00003819
wdenk2729af92004-05-03 20:45:30 +00003820U-Boot supports user configuration using Environment Variables which
3821can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003822
wdenk2729af92004-05-03 20:45:30 +00003823Environment Variables are set using "setenv", printed using
3824"printenv", and saved to Flash using "saveenv". Using "setenv"
3825without a value can be used to delete a variable from the
3826environment. As long as you don't save the environment you are
3827working with an in-memory copy. In case the Flash area containing the
3828environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003829
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003830Some configuration options can be set using Environment Variables.
3831
3832List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003833
wdenk2729af92004-05-03 20:45:30 +00003834 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003835
wdenk2729af92004-05-03 20:45:30 +00003836 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003837
wdenk2729af92004-05-03 20:45:30 +00003838 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003841
wdenk2729af92004-05-03 20:45:30 +00003842 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003843
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003844 bootm_low - Memory range available for image processing in the bootm
3845 command can be restricted. This variable is given as
3846 a hexadecimal number and defines lowest address allowed
3847 for use by the bootm command. See also "bootm_size"
3848 environment variable. Address defined by "bootm_low" is
3849 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003850 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3851 bootm_mapsize.
3852
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003853 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003854 This variable is given as a hexadecimal number and it
3855 defines the size of the memory region starting at base
3856 address bootm_low that is accessible by the Linux kernel
3857 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3858 as the default value if it is defined, and bootm_size is
3859 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003860
3861 bootm_size - Memory range available for image processing in the bootm
3862 command can be restricted. This variable is given as
3863 a hexadecimal number and defines the size of the region
3864 allowed for use by the bootm command. See also "bootm_low"
3865 environment variable.
3866
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003867 updatefile - Location of the software update file on a TFTP server, used
3868 by the automatic software update feature. Please refer to
3869 documentation in doc/README.update for more details.
3870
wdenk2729af92004-05-03 20:45:30 +00003871 autoload - if set to "no" (any string beginning with 'n'),
3872 "bootp" will just load perform a lookup of the
3873 configuration from the BOOTP server, but not try to
3874 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003875
wdenk2729af92004-05-03 20:45:30 +00003876 autostart - if set to "yes", an image loaded using the "bootp",
3877 "rarpboot", "tftpboot" or "diskboot" commands will
3878 be automatically started (by internally calling
3879 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003880
wdenk2729af92004-05-03 20:45:30 +00003881 If set to "no", a standalone image passed to the
3882 "bootm" command will be copied to the load address
3883 (and eventually uncompressed), but NOT be started.
3884 This can be used to load and uncompress arbitrary
3885 data.
wdenkc6097192002-11-03 00:24:07 +00003886
David A. Longa28afca2011-07-09 16:40:19 -04003887 fdt_high - if set this restricts the maximum address that the
3888 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003889 For example, if you have a system with 1 GB memory
3890 at physical address 0x10000000, while Linux kernel
3891 only recognizes the first 704 MB as low memory, you
3892 may need to set fdt_high as 0x3C000000 to have the
3893 device tree blob be copied to the maximum address
3894 of the 704 MB low memory, so that Linux kernel can
3895 access it during the boot procedure.
3896
David A. Longa28afca2011-07-09 16:40:19 -04003897 If this is set to the special value 0xFFFFFFFF then
3898 the fdt will not be copied at all on boot. For this
3899 to work it must reside in writable memory, have
3900 sufficient padding on the end of it for u-boot to
3901 add the information it needs into it, and the memory
3902 must be accessible by the kernel.
3903
Simon Glasseea63e02011-10-24 19:15:34 +00003904 fdtcontroladdr- if set this is the address of the control flattened
3905 device tree used by U-Boot when CONFIG_OF_CONTROL is
3906 defined.
3907
wdenk17ea1172004-06-06 21:51:03 +00003908 i2cfast - (PPC405GP|PPC405EP only)
3909 if set to 'y' configures Linux I2C driver for fast
3910 mode (400kHZ). This environment variable is used in
3911 initialization code. So, for changes to be effective
3912 it must be saved and board must be reset.
3913
wdenk2729af92004-05-03 20:45:30 +00003914 initrd_high - restrict positioning of initrd images:
3915 If this variable is not set, initrd images will be
3916 copied to the highest possible address in RAM; this
3917 is usually what you want since it allows for
3918 maximum initrd size. If for some reason you want to
3919 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003920 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003921 variable to a value of "no" or "off" or "0".
3922 Alternatively, you can set it to a maximum upper
3923 address to use (U-Boot will still check that it
3924 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003925
wdenk2729af92004-05-03 20:45:30 +00003926 For instance, when you have a system with 16 MB
3927 RAM, and want to reserve 4 MB from use by Linux,
3928 you can do this by adding "mem=12M" to the value of
3929 the "bootargs" variable. However, now you must make
3930 sure that the initrd image is placed in the first
3931 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003932
wdenk2729af92004-05-03 20:45:30 +00003933 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003934
wdenk2729af92004-05-03 20:45:30 +00003935 If you set initrd_high to 0xFFFFFFFF, this is an
3936 indication to U-Boot that all addresses are legal
3937 for the Linux kernel, including addresses in flash
3938 memory. In this case U-Boot will NOT COPY the
3939 ramdisk at all. This may be useful to reduce the
3940 boot time on your system, but requires that this
3941 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003942
wdenk2729af92004-05-03 20:45:30 +00003943 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945 loadaddr - Default load address for commands like "bootp",
3946 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003947
wdenk2729af92004-05-03 20:45:30 +00003948 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003949
wdenk2729af92004-05-03 20:45:30 +00003950 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003951
wdenk2729af92004-05-03 20:45:30 +00003952 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003953
wdenk2729af92004-05-03 20:45:30 +00003954 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003955
wdenk2729af92004-05-03 20:45:30 +00003956 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003957
Mike Frysingere2a53452011-10-02 10:01:27 +00003958 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003959
Mike Frysingere2a53452011-10-02 10:01:27 +00003960 ethact - controls which interface is currently active.
3961 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003962
Heiko Schocher48690d82010-07-20 17:45:02 +02003963 => setenv ethact FEC
3964 => ping 192.168.0.1 # traffic sent on FEC
3965 => setenv ethact SCC
3966 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003967
Matthias Fuchse1692572008-01-17 07:45:05 +01003968 ethrotate - When set to "no" U-Boot does not go through all
3969 available network interfaces.
3970 It just stays at the currently selected interface.
3971
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003972 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003973 either succeed or fail without retrying.
3974 When set to "once" the network operation will
3975 fail when all the available network interfaces
3976 are tried once without success.
3977 Useful on scripts which control the retry operation
3978 themselves.
wdenkc6097192002-11-03 00:24:07 +00003979
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003980 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003981
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003982 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003983 UDP source port.
3984
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003985 tftpdstport - If this is set, the value is used for TFTP's UDP
3986 destination port instead of the Well Know Port 69.
3987
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003988 tftpblocksize - Block size to use for TFTP transfers; if not set,
3989 we use the TFTP server's default block size
3990
3991 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3992 seconds, minimum value is 1000 = 1 second). Defines
3993 when a packet is considered to be lost so it has to
3994 be retransmitted. The default is 5000 = 5 seconds.
3995 Lowering this value may make downloads succeed
3996 faster in networks with high packet loss rates or
3997 with unreliable TFTP servers.
3998
3999 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004000 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004001 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004002
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004003The following image location variables contain the location of images
4004used in booting. The "Image" column gives the role of the image and is
4005not an environment variable name. The other columns are environment
4006variable names. "File Name" gives the name of the file on a TFTP
4007server, "RAM Address" gives the location in RAM the image will be
4008loaded to, and "Flash Location" gives the image's address in NOR
4009flash or offset in NAND flash.
4010
4011*Note* - these variables don't have to be defined for all boards, some
4012boards currenlty use other variables for these purposes, and some
4013boards use these variables for other purposes.
4014
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004015Image File Name RAM Address Flash Location
4016----- --------- ----------- --------------
4017u-boot u-boot u-boot_addr_r u-boot_addr
4018Linux kernel bootfile kernel_addr_r kernel_addr
4019device tree blob fdtfile fdt_addr_r fdt_addr
4020ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022The following environment variables may be used and automatically
4023updated by the network boot commands ("bootp" and "rarpboot"),
4024depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004025
wdenk2729af92004-05-03 20:45:30 +00004026 bootfile - see above
4027 dnsip - IP address of your Domain Name Server
4028 dnsip2 - IP address of your secondary Domain Name Server
4029 gatewayip - IP address of the Gateway (Router) to use
4030 hostname - Target hostname
4031 ipaddr - see above
4032 netmask - Subnet Mask
4033 rootpath - Pathname of the root filesystem on the NFS server
4034 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004035
wdenka3d991b2004-04-15 21:48:45 +00004036
wdenk2729af92004-05-03 20:45:30 +00004037There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004038
wdenk2729af92004-05-03 20:45:30 +00004039 serial# - contains hardware identification information such
4040 as type string and/or serial number
4041 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004042
wdenk2729af92004-05-03 20:45:30 +00004043These variables can be set only once (usually during manufacturing of
4044the board). U-Boot refuses to delete or overwrite these variables
4045once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004046
4047
wdenk2729af92004-05-03 20:45:30 +00004048Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004049
wdenk2729af92004-05-03 20:45:30 +00004050 ver - Contains the U-Boot version string as printed
4051 with the "version" command. This variable is
4052 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004053
wdenkc6097192002-11-03 00:24:07 +00004054
wdenk2729af92004-05-03 20:45:30 +00004055Please note that changes to some configuration parameters may take
4056only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004057
stroesec1551ea2003-04-04 15:53:41 +00004058
wdenk2729af92004-05-03 20:45:30 +00004059Command Line Parsing:
4060=====================
stroesec1551ea2003-04-04 15:53:41 +00004061
wdenk2729af92004-05-03 20:45:30 +00004062There are two different command line parsers available with U-Boot:
4063the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004064
wdenk2729af92004-05-03 20:45:30 +00004065Old, simple command line parser:
4066--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004067
wdenk2729af92004-05-03 20:45:30 +00004068- supports environment variables (through setenv / saveenv commands)
4069- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004070- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004071- special characters ('$', ';') can be escaped by prefixing with '\',
4072 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004073 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004074- You can also escape text by enclosing in single apostrophes, for example:
4075 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004076
wdenk2729af92004-05-03 20:45:30 +00004077Hush shell:
4078-----------
wdenkf07771c2003-05-28 08:06:31 +00004079
wdenk2729af92004-05-03 20:45:30 +00004080- similar to Bourne shell, with control structures like
4081 if...then...else...fi, for...do...done; while...do...done,
4082 until...do...done, ...
4083- supports environment ("global") variables (through setenv / saveenv
4084 commands) and local shell variables (through standard shell syntax
4085 "name=value"); only environment variables can be used with "run"
4086 command
wdenkf07771c2003-05-28 08:06:31 +00004087
wdenk2729af92004-05-03 20:45:30 +00004088General rules:
4089--------------
wdenkf07771c2003-05-28 08:06:31 +00004090
wdenk2729af92004-05-03 20:45:30 +00004091(1) If a command line (or an environment variable executed by a "run"
4092 command) contains several commands separated by semicolon, and
4093 one of these commands fails, then the remaining commands will be
4094 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004095
wdenk2729af92004-05-03 20:45:30 +00004096(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004097 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004098 command will cause "run" to terminate, i. e. the remaining
4099 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004100
wdenk2729af92004-05-03 20:45:30 +00004101Note for Redundant Ethernet Interfaces:
4102=======================================
wdenkf07771c2003-05-28 08:06:31 +00004103
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004104Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004105such configurations and is capable of automatic selection of a
4106"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4109MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4110"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004111
wdenk2729af92004-05-03 20:45:30 +00004112If the network interface stores some valid MAC address (for instance
4113in SROM), this is used as default address if there is NO correspon-
4114ding setting in the environment; if the corresponding environment
4115variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004116
wdenk2729af92004-05-03 20:45:30 +00004117o If the SROM has a valid MAC address, and there is no address in the
4118 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004119
wdenk2729af92004-05-03 20:45:30 +00004120o If there is no valid address in the SROM, and a definition in the
4121 environment exists, then the value from the environment variable is
4122 used.
wdenkc6097192002-11-03 00:24:07 +00004123
wdenk2729af92004-05-03 20:45:30 +00004124o If both the SROM and the environment contain a MAC address, and
4125 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004126
wdenk2729af92004-05-03 20:45:30 +00004127o If both the SROM and the environment contain a MAC address, and the
4128 addresses differ, the value from the environment is used and a
4129 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131o If neither SROM nor the environment contain a MAC address, an error
4132 is raised.
wdenkc6097192002-11-03 00:24:07 +00004133
Ben Warrenecee9322010-04-26 11:11:46 -07004134If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004135will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004136may be skipped by setting the appropriate 'ethmacskip' environment variable.
4137The naming convention is as follows:
4138"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004139
wdenk2729af92004-05-03 20:45:30 +00004140Image Formats:
4141==============
wdenkc6097192002-11-03 00:24:07 +00004142
Marian Balakowicz3310c542008-03-12 12:13:13 +01004143U-Boot is capable of booting (and performing other auxiliary operations on)
4144images in two formats:
4145
4146New uImage format (FIT)
4147-----------------------
4148
4149Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4150to Flattened Device Tree). It allows the use of images with multiple
4151components (several kernels, ramdisks, etc.), with contents protected by
4152SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4153
4154
4155Old uImage format
4156-----------------
4157
4158Old image format is based on binary files which can be basically anything,
4159preceded by a special header; see the definitions in include/image.h for
4160details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4163 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004164 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4165 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4166 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004167* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004168 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4169 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004170* Compression Type (uncompressed, gzip, bzip2)
4171* Load Address
4172* Entry Point
4173* Image Name
4174* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004175
wdenk2729af92004-05-03 20:45:30 +00004176The header is marked by a special Magic Number, and both the header
4177and the data portions of the image are secured against corruption by
4178CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004179
wdenkc6097192002-11-03 00:24:07 +00004180
wdenk2729af92004-05-03 20:45:30 +00004181Linux Support:
4182==============
wdenkc6097192002-11-03 00:24:07 +00004183
wdenk2729af92004-05-03 20:45:30 +00004184Although U-Boot should support any OS or standalone application
4185easily, the main focus has always been on Linux during the design of
4186U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004187
wdenk2729af92004-05-03 20:45:30 +00004188U-Boot includes many features that so far have been part of some
4189special "boot loader" code within the Linux kernel. Also, any
4190"initrd" images to be used are no longer part of one big Linux image;
4191instead, kernel and "initrd" are separate images. This implementation
4192serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004193
wdenk2729af92004-05-03 20:45:30 +00004194- the same features can be used for other OS or standalone
4195 applications (for instance: using compressed images to reduce the
4196 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004197
wdenk2729af92004-05-03 20:45:30 +00004198- it becomes much easier to port new Linux kernel versions because
4199 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004200
wdenk2729af92004-05-03 20:45:30 +00004201- the same Linux kernel image can now be used with different "initrd"
4202 images; of course this also means that different kernel images can
4203 be run with the same "initrd". This makes testing easier (you don't
4204 have to build a new "zImage.initrd" Linux image when you just
4205 change a file in your "initrd"). Also, a field-upgrade of the
4206 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004207
wdenkc6097192002-11-03 00:24:07 +00004208
wdenk2729af92004-05-03 20:45:30 +00004209Linux HOWTO:
4210============
wdenkc6097192002-11-03 00:24:07 +00004211
wdenk2729af92004-05-03 20:45:30 +00004212Porting Linux to U-Boot based systems:
4213---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004214
wdenk2729af92004-05-03 20:45:30 +00004215U-Boot cannot save you from doing all the necessary modifications to
4216configure the Linux device drivers for use with your target hardware
4217(no, we don't intend to provide a full virtual machine interface to
4218Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004219
Stefan Roesea47a12b2010-04-15 16:07:28 +02004220But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004221
wdenk2729af92004-05-03 20:45:30 +00004222Just make sure your machine specific header file (for instance
4223include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004224Information structure as we define in include/asm-<arch>/u-boot.h,
4225and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004226as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004227
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229Configuring the Linux kernel:
4230-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004231
wdenk2729af92004-05-03 20:45:30 +00004232No specific requirements for U-Boot. Make sure you have some root
4233device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004234
wdenkc6097192002-11-03 00:24:07 +00004235
wdenk2729af92004-05-03 20:45:30 +00004236Building a Linux Image:
4237-----------------------
wdenkc6097192002-11-03 00:24:07 +00004238
wdenk2729af92004-05-03 20:45:30 +00004239With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4240not used. If you use recent kernel source, a new build target
4241"uImage" will exist which automatically builds an image usable by
4242U-Boot. Most older kernels also have support for a "pImage" target,
4243which was introduced for our predecessor project PPCBoot and uses a
4244100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk2729af92004-05-03 20:45:30 +00004246Example:
wdenkc6097192002-11-03 00:24:07 +00004247
wdenk2729af92004-05-03 20:45:30 +00004248 make TQM850L_config
4249 make oldconfig
4250 make dep
4251 make uImage
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253The "uImage" build target uses a special tool (in 'tools/mkimage') to
4254encapsulate a compressed Linux kernel image with header information,
4255CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004256
wdenk2729af92004-05-03 20:45:30 +00004257* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004258
wdenk2729af92004-05-03 20:45:30 +00004259* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004260
wdenk2729af92004-05-03 20:45:30 +00004261 ${CROSS_COMPILE}-objcopy -O binary \
4262 -R .note -R .comment \
4263 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004264
wdenk2729af92004-05-03 20:45:30 +00004265* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004268
wdenk2729af92004-05-03 20:45:30 +00004269* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004270
wdenk2729af92004-05-03 20:45:30 +00004271 mkimage -A ppc -O linux -T kernel -C gzip \
4272 -a 0 -e 0 -n "Linux Kernel Image" \
4273 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004274
wdenk24ee89b2002-11-03 17:56:27 +00004275
wdenk2729af92004-05-03 20:45:30 +00004276The "mkimage" tool can also be used to create ramdisk images for use
4277with U-Boot, either separated from the Linux kernel image, or
4278combined into one file. "mkimage" encapsulates the images with a 64
4279byte header containing information about target architecture,
4280operating system, image type, compression method, entry points, time
4281stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004282
wdenk2729af92004-05-03 20:45:30 +00004283"mkimage" can be called in two ways: to verify existing images and
4284print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004285
wdenk2729af92004-05-03 20:45:30 +00004286In the first form (with "-l" option) mkimage lists the information
4287contained in the header of an existing U-Boot image; this includes
4288checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004289
wdenk2729af92004-05-03 20:45:30 +00004290 tools/mkimage -l image
4291 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004292
wdenk2729af92004-05-03 20:45:30 +00004293The second form (with "-d" option) is used to build a U-Boot image
4294from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004295
wdenk2729af92004-05-03 20:45:30 +00004296 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4297 -n name -d data_file image
4298 -A ==> set architecture to 'arch'
4299 -O ==> set operating system to 'os'
4300 -T ==> set image type to 'type'
4301 -C ==> set compression type 'comp'
4302 -a ==> set load address to 'addr' (hex)
4303 -e ==> set entry point to 'ep' (hex)
4304 -n ==> set image name to 'name'
4305 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004306
wdenk69459792004-05-29 16:53:29 +00004307Right now, all Linux kernels for PowerPC systems use the same load
4308address (0x00000000), but the entry point address depends on the
4309kernel version:
wdenkc6097192002-11-03 00:24:07 +00004310
wdenk2729af92004-05-03 20:45:30 +00004311- 2.2.x kernels have the entry point at 0x0000000C,
4312- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004313
wdenk2729af92004-05-03 20:45:30 +00004314So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004315
wdenk2729af92004-05-03 20:45:30 +00004316 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4317 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004318 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004319 > examples/uImage.TQM850L
4320 Image Name: 2.4.4 kernel for TQM850L
4321 Created: Wed Jul 19 02:34:59 2000
4322 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4323 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4324 Load Address: 0x00000000
4325 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004328
wdenk2729af92004-05-03 20:45:30 +00004329 -> tools/mkimage -l examples/uImage.TQM850L
4330 Image Name: 2.4.4 kernel for TQM850L
4331 Created: Wed Jul 19 02:34:59 2000
4332 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4333 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4334 Load Address: 0x00000000
4335 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004336
wdenk2729af92004-05-03 20:45:30 +00004337NOTE: for embedded systems where boot time is critical you can trade
4338speed for memory and install an UNCOMPRESSED image instead: this
4339needs more space in Flash, but boots much faster since it does not
4340need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004341
Stefan Roesea47a12b2010-04-15 16:07:28 +02004342 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004343 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4344 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004345 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004346 > examples/uImage.TQM850L-uncompressed
4347 Image Name: 2.4.4 kernel for TQM850L
4348 Created: Wed Jul 19 02:34:59 2000
4349 Image Type: PowerPC Linux Kernel Image (uncompressed)
4350 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4351 Load Address: 0x00000000
4352 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004353
wdenkc6097192002-11-03 00:24:07 +00004354
wdenk2729af92004-05-03 20:45:30 +00004355Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4356when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004357
wdenk2729af92004-05-03 20:45:30 +00004358 -> tools/mkimage -n 'Simple Ramdisk Image' \
4359 > -A ppc -O linux -T ramdisk -C gzip \
4360 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4361 Image Name: Simple Ramdisk Image
4362 Created: Wed Jan 12 14:01:50 2000
4363 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4364 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4365 Load Address: 0x00000000
4366 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004367
wdenkdb01a2e2004-04-15 23:14:49 +00004368
wdenk2729af92004-05-03 20:45:30 +00004369Installing a Linux Image:
4370-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004371
wdenk2729af92004-05-03 20:45:30 +00004372To downloading a U-Boot image over the serial (console) interface,
4373you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004374
wdenk2729af92004-05-03 20:45:30 +00004375 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004376
wdenk2729af92004-05-03 20:45:30 +00004377The 'objcopy' does not understand the information in the U-Boot
4378image header, so the resulting S-Record file will be relative to
4379address 0x00000000. To load it to a given address, you need to
4380specify the target address as 'offset' parameter with the 'loads'
4381command.
wdenkc6097192002-11-03 00:24:07 +00004382
wdenk2729af92004-05-03 20:45:30 +00004383Example: install the image to address 0x40100000 (which on the
4384TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004387
wdenk2729af92004-05-03 20:45:30 +00004388 .......... done
4389 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004390
wdenk2729af92004-05-03 20:45:30 +00004391 => loads 40100000
4392 ## Ready for S-Record download ...
4393 ~>examples/image.srec
4394 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4395 ...
4396 15989 15990 15991 15992
4397 [file transfer complete]
4398 [connected]
4399 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004400
4401
wdenk2729af92004-05-03 20:45:30 +00004402You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004403this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004404corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004407
wdenk2729af92004-05-03 20:45:30 +00004408 ## Checking Image at 40100000 ...
4409 Image Name: 2.2.13 for initrd on TQM850L
4410 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4411 Data Size: 335725 Bytes = 327 kB = 0 MB
4412 Load Address: 00000000
4413 Entry Point: 0000000c
4414 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004415
4416
wdenk2729af92004-05-03 20:45:30 +00004417Boot Linux:
4418-----------
wdenkc6097192002-11-03 00:24:07 +00004419
wdenk2729af92004-05-03 20:45:30 +00004420The "bootm" command is used to boot an application that is stored in
4421memory (RAM or Flash). In case of a Linux kernel image, the contents
4422of the "bootargs" environment variable is passed to the kernel as
4423parameters. You can check and modify this variable using the
4424"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004425
4426
wdenk2729af92004-05-03 20:45:30 +00004427 => printenv bootargs
4428 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004429
wdenk2729af92004-05-03 20:45:30 +00004430 => 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 +00004431
wdenk2729af92004-05-03 20:45:30 +00004432 => printenv bootargs
4433 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 +00004434
wdenk2729af92004-05-03 20:45:30 +00004435 => bootm 40020000
4436 ## Booting Linux kernel at 40020000 ...
4437 Image Name: 2.2.13 for NFS on TQM850L
4438 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4439 Data Size: 381681 Bytes = 372 kB = 0 MB
4440 Load Address: 00000000
4441 Entry Point: 0000000c
4442 Verifying Checksum ... OK
4443 Uncompressing Kernel Image ... OK
4444 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
4445 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4446 time_init: decrementer frequency = 187500000/60
4447 Calibrating delay loop... 49.77 BogoMIPS
4448 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4449 ...
wdenkc6097192002-11-03 00:24:07 +00004450
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004451If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004452the memory addresses of both the kernel and the initrd image (PPBCOOT
4453format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk2729af92004-05-03 20:45:30 +00004455 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004456
wdenk2729af92004-05-03 20:45:30 +00004457 ## Checking Image at 40100000 ...
4458 Image Name: 2.2.13 for initrd on TQM850L
4459 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4460 Data Size: 335725 Bytes = 327 kB = 0 MB
4461 Load Address: 00000000
4462 Entry Point: 0000000c
4463 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004464
wdenk2729af92004-05-03 20:45:30 +00004465 ## Checking Image at 40200000 ...
4466 Image Name: Simple Ramdisk Image
4467 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4468 Data Size: 566530 Bytes = 553 kB = 0 MB
4469 Load Address: 00000000
4470 Entry Point: 00000000
4471 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004472
wdenk2729af92004-05-03 20:45:30 +00004473 => bootm 40100000 40200000
4474 ## Booting Linux kernel at 40100000 ...
4475 Image Name: 2.2.13 for initrd on TQM850L
4476 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4477 Data Size: 335725 Bytes = 327 kB = 0 MB
4478 Load Address: 00000000
4479 Entry Point: 0000000c
4480 Verifying Checksum ... OK
4481 Uncompressing Kernel Image ... OK
4482 ## Loading RAMDisk Image at 40200000 ...
4483 Image Name: Simple Ramdisk Image
4484 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4485 Data Size: 566530 Bytes = 553 kB = 0 MB
4486 Load Address: 00000000
4487 Entry Point: 00000000
4488 Verifying Checksum ... OK
4489 Loading Ramdisk ... OK
4490 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
4491 Boot arguments: root=/dev/ram
4492 time_init: decrementer frequency = 187500000/60
4493 Calibrating delay loop... 49.77 BogoMIPS
4494 ...
4495 RAMDISK: Compressed image found at block 0
4496 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004497
wdenk2729af92004-05-03 20:45:30 +00004498 bash#
wdenkc6097192002-11-03 00:24:07 +00004499
Matthew McClintock02677682006-06-28 10:41:37 -05004500Boot Linux and pass a flat device tree:
4501-----------
4502
4503First, U-Boot must be compiled with the appropriate defines. See the section
4504titled "Linux Kernel Interface" above for a more in depth explanation. The
4505following is an example of how to start a kernel and pass an updated
4506flat device tree:
4507
4508=> print oftaddr
4509oftaddr=0x300000
4510=> print oft
4511oft=oftrees/mpc8540ads.dtb
4512=> tftp $oftaddr $oft
4513Speed: 1000, full duplex
4514Using TSEC0 device
4515TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4516Filename 'oftrees/mpc8540ads.dtb'.
4517Load address: 0x300000
4518Loading: #
4519done
4520Bytes transferred = 4106 (100a hex)
4521=> tftp $loadaddr $bootfile
4522Speed: 1000, full duplex
4523Using TSEC0 device
4524TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4525Filename 'uImage'.
4526Load address: 0x200000
4527Loading:############
4528done
4529Bytes transferred = 1029407 (fb51f hex)
4530=> print loadaddr
4531loadaddr=200000
4532=> print oftaddr
4533oftaddr=0x300000
4534=> bootm $loadaddr - $oftaddr
4535## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004536 Image Name: Linux-2.6.17-dirty
4537 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4538 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004539 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004540 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004541 Verifying Checksum ... OK
4542 Uncompressing Kernel Image ... OK
4543Booting using flat device tree at 0x300000
4544Using MPC85xx ADS machine description
4545Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4546[snip]
4547
4548
wdenk2729af92004-05-03 20:45:30 +00004549More About U-Boot Image Types:
4550------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004551
wdenk2729af92004-05-03 20:45:30 +00004552U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004553
wdenk2729af92004-05-03 20:45:30 +00004554 "Standalone Programs" are directly runnable in the environment
4555 provided by U-Boot; it is expected that (if they behave
4556 well) you can continue to work in U-Boot after return from
4557 the Standalone Program.
4558 "OS Kernel Images" are usually images of some Embedded OS which
4559 will take over control completely. Usually these programs
4560 will install their own set of exception handlers, device
4561 drivers, set up the MMU, etc. - this means, that you cannot
4562 expect to re-enter U-Boot except by resetting the CPU.
4563 "RAMDisk Images" are more or less just data blocks, and their
4564 parameters (address, size) are passed to an OS kernel that is
4565 being started.
4566 "Multi-File Images" contain several images, typically an OS
4567 (Linux) kernel image and one or more data images like
4568 RAMDisks. This construct is useful for instance when you want
4569 to boot over the network using BOOTP etc., where the boot
4570 server provides just a single image file, but you want to get
4571 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004572
wdenk2729af92004-05-03 20:45:30 +00004573 "Multi-File Images" start with a list of image sizes, each
4574 image size (in bytes) specified by an "uint32_t" in network
4575 byte order. This list is terminated by an "(uint32_t)0".
4576 Immediately after the terminating 0 follow the images, one by
4577 one, all aligned on "uint32_t" boundaries (size rounded up to
4578 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004579
wdenk2729af92004-05-03 20:45:30 +00004580 "Firmware Images" are binary images containing firmware (like
4581 U-Boot or FPGA images) which usually will be programmed to
4582 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004583
wdenk2729af92004-05-03 20:45:30 +00004584 "Script files" are command sequences that will be executed by
4585 U-Boot's command interpreter; this feature is especially
4586 useful when you configure U-Boot to use a real shell (hush)
4587 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004588
Marek Vasut44f074c2012-03-14 21:52:45 +00004589Booting the Linux zImage:
4590-------------------------
4591
4592On some platforms, it's possible to boot Linux zImage. This is done
4593using the "bootz" command. The syntax of "bootz" command is the same
4594as the syntax of "bootm" command.
4595
Marek Vasut017e1f32012-03-18 11:47:58 +00004596Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4597kernel with raw initrd images. The syntax is slightly different, the
4598address of the initrd must be augmented by it's size, in the following
4599format: "<initrd addres>:<initrd size>".
4600
wdenkc6097192002-11-03 00:24:07 +00004601
wdenk2729af92004-05-03 20:45:30 +00004602Standalone HOWTO:
4603=================
wdenkc6097192002-11-03 00:24:07 +00004604
wdenk2729af92004-05-03 20:45:30 +00004605One of the features of U-Boot is that you can dynamically load and
4606run "standalone" applications, which can use some resources of
4607U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004608
wdenk2729af92004-05-03 20:45:30 +00004609Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004610
wdenk2729af92004-05-03 20:45:30 +00004611"Hello World" Demo:
4612-------------------
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk2729af92004-05-03 20:45:30 +00004614'examples/hello_world.c' contains a small "Hello World" Demo
4615application; it is automatically compiled when you build U-Boot.
4616It's configured to run at address 0x00040004, so you can play with it
4617like that:
wdenkc6097192002-11-03 00:24:07 +00004618
wdenk2729af92004-05-03 20:45:30 +00004619 => loads
4620 ## Ready for S-Record download ...
4621 ~>examples/hello_world.srec
4622 1 2 3 4 5 6 7 8 9 10 11 ...
4623 [file transfer complete]
4624 [connected]
4625 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004626
wdenk2729af92004-05-03 20:45:30 +00004627 => go 40004 Hello World! This is a test.
4628 ## Starting application at 0x00040004 ...
4629 Hello World
4630 argc = 7
4631 argv[0] = "40004"
4632 argv[1] = "Hello"
4633 argv[2] = "World!"
4634 argv[3] = "This"
4635 argv[4] = "is"
4636 argv[5] = "a"
4637 argv[6] = "test."
4638 argv[7] = "<NULL>"
4639 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004640
wdenk2729af92004-05-03 20:45:30 +00004641 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk2729af92004-05-03 20:45:30 +00004643Another example, which demonstrates how to register a CPM interrupt
4644handler with the U-Boot code, can be found in 'examples/timer.c'.
4645Here, a CPM timer is set up to generate an interrupt every second.
4646The interrupt service routine is trivial, just printing a '.'
4647character, but this is just a demo program. The application can be
4648controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004649
wdenk2729af92004-05-03 20:45:30 +00004650 ? - print current values og the CPM Timer registers
4651 b - enable interrupts and start timer
4652 e - stop timer and disable interrupts
4653 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004654
wdenk2729af92004-05-03 20:45:30 +00004655 => loads
4656 ## Ready for S-Record download ...
4657 ~>examples/timer.srec
4658 1 2 3 4 5 6 7 8 9 10 11 ...
4659 [file transfer complete]
4660 [connected]
4661 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk2729af92004-05-03 20:45:30 +00004663 => go 40004
4664 ## Starting application at 0x00040004 ...
4665 TIMERS=0xfff00980
4666 Using timer 1
4667 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004668
wdenk2729af92004-05-03 20:45:30 +00004669Hit 'b':
4670 [q, b, e, ?] Set interval 1000000 us
4671 Enabling timer
4672Hit '?':
4673 [q, b, e, ?] ........
4674 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4675Hit '?':
4676 [q, b, e, ?] .
4677 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4678Hit '?':
4679 [q, b, e, ?] .
4680 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4681Hit '?':
4682 [q, b, e, ?] .
4683 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4684Hit 'e':
4685 [q, b, e, ?] ...Stopping timer
4686Hit 'q':
4687 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004688
4689
wdenk2729af92004-05-03 20:45:30 +00004690Minicom warning:
4691================
wdenk85ec0bc2003-03-31 16:34:49 +00004692
wdenk2729af92004-05-03 20:45:30 +00004693Over time, many people have reported problems when trying to use the
4694"minicom" terminal emulation program for serial download. I (wd)
4695consider minicom to be broken, and recommend not to use it. Under
4696Unix, I recommend to use C-Kermit for general purpose use (and
4697especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004698use "cu" for S-Record download ("loads" command). See
4699http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4700for help with kermit.
4701
wdenk85ec0bc2003-03-31 16:34:49 +00004702
wdenk2729af92004-05-03 20:45:30 +00004703Nevertheless, if you absolutely want to use it try adding this
4704configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004705
wdenk2729af92004-05-03 20:45:30 +00004706 Name Program Name U/D FullScr IO-Red. Multi
4707 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4708 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004709
4710
wdenk2729af92004-05-03 20:45:30 +00004711NetBSD Notes:
4712=============
wdenkc6097192002-11-03 00:24:07 +00004713
wdenk2729af92004-05-03 20:45:30 +00004714Starting at version 0.9.2, U-Boot supports NetBSD both as host
4715(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004716
wdenk2729af92004-05-03 20:45:30 +00004717Building requires a cross environment; it is known to work on
4718NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4719need gmake since the Makefiles are not compatible with BSD make).
4720Note that the cross-powerpc package does not install include files;
4721attempting to build U-Boot will fail because <machine/ansi.h> is
4722missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004723
wdenk2729af92004-05-03 20:45:30 +00004724 # cd /usr/pkg/cross/powerpc-netbsd/include
4725 # mkdir powerpc
4726 # ln -s powerpc machine
4727 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4728 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004729
wdenk2729af92004-05-03 20:45:30 +00004730Native builds *don't* work due to incompatibilities between native
4731and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004732
wdenk2729af92004-05-03 20:45:30 +00004733Booting assumes that (the first part of) the image booted is a
4734stage-2 loader which in turn loads and then invokes the kernel
4735proper. Loader sources will eventually appear in the NetBSD source
4736tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004737meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004738
4739
wdenk2729af92004-05-03 20:45:30 +00004740Implementation Internals:
4741=========================
wdenkc6097192002-11-03 00:24:07 +00004742
wdenk2729af92004-05-03 20:45:30 +00004743The following is not intended to be a complete description of every
4744implementation detail. However, it should help to understand the
4745inner workings of U-Boot and make it easier to port it to custom
4746hardware.
wdenkc6097192002-11-03 00:24:07 +00004747
4748
wdenk2729af92004-05-03 20:45:30 +00004749Initial Stack, Global Data:
4750---------------------------
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk2729af92004-05-03 20:45:30 +00004752The implementation of U-Boot is complicated by the fact that U-Boot
4753starts running out of ROM (flash memory), usually without access to
4754system RAM (because the memory controller is not initialized yet).
4755This means that we don't have writable Data or BSS segments, and BSS
4756is not initialized as zero. To be able to get a C environment working
4757at all, we have to allocate at least a minimal stack. Implementation
4758options for this are defined and restricted by the CPU used: Some CPU
4759models provide on-chip memory (like the IMMR area on MPC8xx and
4760MPC826x processors), on others (parts of) the data cache can be
4761locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004762
Wolfgang Denk218ca722008-03-26 10:40:12 +01004763 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004764 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004765
wdenk2729af92004-05-03 20:45:30 +00004766 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4767 From: "Chris Hallinan" <clh@net1plus.com>
4768 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4769 ...
wdenk43d96162003-03-06 00:02:04 +00004770
wdenk2729af92004-05-03 20:45:30 +00004771 Correct me if I'm wrong, folks, but the way I understand it
4772 is this: Using DCACHE as initial RAM for Stack, etc, does not
4773 require any physical RAM backing up the cache. The cleverness
4774 is that the cache is being used as a temporary supply of
4775 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004776 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004777 can see how this works by studying the cache architecture and
4778 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004779
wdenk2729af92004-05-03 20:45:30 +00004780 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4781 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004782 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004783 option should work for you. Using CS 4 should be fine if your
4784 board designers haven't used it for something that would
4785 cause you grief during the initial boot! It is frequently not
4786 used.
wdenk43d96162003-03-06 00:02:04 +00004787
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004788 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004789 with your processor/board/system design. The default value
4790 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004791 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004792 than your SDRAM module. If you have a 64MB SDRAM module, set
4793 it above 400_0000. Just make sure your board has no resources
4794 that are supposed to respond to that address! That code in
4795 start.S has been around a while and should work as is when
4796 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004797
wdenk2729af92004-05-03 20:45:30 +00004798 -Chris Hallinan
4799 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004800
wdenk2729af92004-05-03 20:45:30 +00004801It is essential to remember this, since it has some impact on the C
4802code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004803
wdenk2729af92004-05-03 20:45:30 +00004804* Initialized global data (data segment) is read-only. Do not attempt
4805 to write it.
wdenkc6097192002-11-03 00:24:07 +00004806
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004807* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004808 as zero data - BSS segment) at all - this is undefined, initiali-
4809 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004810
wdenk2729af92004-05-03 20:45:30 +00004811* Stack space is very limited. Avoid big data buffers or things like
4812 that.
wdenkc6097192002-11-03 00:24:07 +00004813
wdenk2729af92004-05-03 20:45:30 +00004814Having only the stack as writable memory limits means we cannot use
4815normal global data to share information beween the code. But it
4816turned out that the implementation of U-Boot can be greatly
4817simplified by making a global data structure (gd_t) available to all
4818functions. We could pass a pointer to this data as argument to _all_
4819functions, but this would bloat the code. Instead we use a feature of
4820the GCC compiler (Global Register Variables) to share the data: we
4821place a pointer (gd) to the global data into a register which we
4822reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004823
wdenk2729af92004-05-03 20:45:30 +00004824When choosing a register for such a purpose we are restricted by the
4825relevant (E)ABI specifications for the current architecture, and by
4826GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk2729af92004-05-03 20:45:30 +00004828For PowerPC, the following registers have specific use:
4829 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004830 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004831 R3-R4: parameter passing and return values
4832 R5-R10: parameter passing
4833 R13: small data area pointer
4834 R30: GOT pointer
4835 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004836
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004837 (U-Boot also uses R12 as internal GOT pointer. r12
4838 is a volatile register so r12 needs to be reset when
4839 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004840
Wolfgang Denke7670f62008-02-14 22:43:22 +01004841 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004842
wdenk2729af92004-05-03 20:45:30 +00004843 Note: on PPC, we could use a static initializer (since the
4844 address of the global data structure is known at compile time),
4845 but it turned out that reserving a register results in somewhat
4846 smaller code - although the code savings are not that big (on
4847 average for all boards 752 bytes for the whole U-Boot image,
4848 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004849
Robin Getzc4db3352009-08-17 15:23:02 +00004850On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004851 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4852
Robin Getzc4db3352009-08-17 15:23:02 +00004853 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004854
wdenk2729af92004-05-03 20:45:30 +00004855On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004856
wdenk2729af92004-05-03 20:45:30 +00004857 R0: function argument word/integer result
4858 R1-R3: function argument word
4859 R9: GOT pointer
4860 R10: stack limit (used only if stack checking if enabled)
4861 R11: argument (frame) pointer
4862 R12: temporary workspace
4863 R13: stack pointer
4864 R14: link register
4865 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004866
wdenk2729af92004-05-03 20:45:30 +00004867 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004868
Thomas Chou0df01fd2010-05-21 11:08:03 +08004869On Nios II, the ABI is documented here:
4870 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4871
4872 ==> U-Boot will use gp to hold a pointer to the global data
4873
4874 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4875 to access small data sections, so gp is free.
4876
Macpaul Linafc1ce82011-10-19 20:41:11 +00004877On NDS32, the following registers are used:
4878
4879 R0-R1: argument/return
4880 R2-R5: argument
4881 R15: temporary register for assembler
4882 R16: trampoline register
4883 R28: frame pointer (FP)
4884 R29: global pointer (GP)
4885 R30: link register (LP)
4886 R31: stack pointer (SP)
4887 PC: program counter (PC)
4888
4889 ==> U-Boot will use R10 to hold a pointer to the global data
4890
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004891NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4892or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004893
wdenk2729af92004-05-03 20:45:30 +00004894Memory Management:
4895------------------
wdenkc6097192002-11-03 00:24:07 +00004896
wdenk2729af92004-05-03 20:45:30 +00004897U-Boot runs in system state and uses physical addresses, i.e. the
4898MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004899
wdenk2729af92004-05-03 20:45:30 +00004900The available memory is mapped to fixed addresses using the memory
4901controller. In this process, a contiguous block is formed for each
4902memory type (Flash, SDRAM, SRAM), even when it consists of several
4903physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004904
wdenk2729af92004-05-03 20:45:30 +00004905U-Boot is installed in the first 128 kB of the first Flash bank (on
4906TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4907booting and sizing and initializing DRAM, the code relocates itself
4908to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004909memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004910configuration setting]. Below that, a structure with global Board
4911Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004912
wdenk2729af92004-05-03 20:45:30 +00004913Additionally, some exception handler code is copied to the low 8 kB
4914of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004915
wdenk2729af92004-05-03 20:45:30 +00004916So a typical memory configuration with 16 MB of DRAM could look like
4917this:
wdenkc6097192002-11-03 00:24:07 +00004918
wdenk2729af92004-05-03 20:45:30 +00004919 0x0000 0000 Exception Vector code
4920 :
4921 0x0000 1FFF
4922 0x0000 2000 Free for Application Use
4923 :
4924 :
wdenkc6097192002-11-03 00:24:07 +00004925
wdenk2729af92004-05-03 20:45:30 +00004926 :
4927 :
4928 0x00FB FF20 Monitor Stack (Growing downward)
4929 0x00FB FFAC Board Info Data and permanent copy of global data
4930 0x00FC 0000 Malloc Arena
4931 :
4932 0x00FD FFFF
4933 0x00FE 0000 RAM Copy of Monitor Code
4934 ... eventually: LCD or video framebuffer
4935 ... eventually: pRAM (Protected RAM - unchanged by reset)
4936 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004937
4938
wdenk2729af92004-05-03 20:45:30 +00004939System Initialization:
4940----------------------
wdenkc6097192002-11-03 00:24:07 +00004941
wdenk2729af92004-05-03 20:45:30 +00004942In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004943(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004944configuration for CS0# this is a mirror of the onboard Flash memory.
4945To be able to re-map memory U-Boot then jumps to its link address.
4946To be able to implement the initialization code in C, a (small!)
4947initial stack is set up in the internal Dual Ported RAM (in case CPUs
4948which provide such a feature like MPC8xx or MPC8260), or in a locked
4949part of the data cache. After that, U-Boot initializes the CPU core,
4950the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004951
wdenk2729af92004-05-03 20:45:30 +00004952Next, all (potentially) available memory banks are mapped using a
4953preliminary mapping. For example, we put them on 512 MB boundaries
4954(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4955on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4956programmed for SDRAM access. Using the temporary configuration, a
4957simple memory test is run that determines the size of the SDRAM
4958banks.
wdenkc6097192002-11-03 00:24:07 +00004959
wdenk2729af92004-05-03 20:45:30 +00004960When there is more than one SDRAM bank, and the banks are of
4961different size, the largest is mapped first. For equal size, the first
4962bank (CS2#) is mapped first. The first mapping is always for address
49630x00000000, with any additional banks following immediately to create
4964contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004965
wdenk2729af92004-05-03 20:45:30 +00004966Then, the monitor installs itself at the upper end of the SDRAM area
4967and allocates memory for use by malloc() and for the global Board
4968Info data; also, the exception vector code is copied to the low RAM
4969pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004970
wdenk2729af92004-05-03 20:45:30 +00004971Only after this relocation will you have a "normal" C environment;
4972until that you are restricted in several ways, mostly because you are
4973running from ROM, and because the code will have to be relocated to a
4974new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004975
4976
wdenk2729af92004-05-03 20:45:30 +00004977U-Boot Porting Guide:
4978----------------------
wdenkc6097192002-11-03 00:24:07 +00004979
wdenk2729af92004-05-03 20:45:30 +00004980[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4981list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004982
4983
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004984int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004985{
4986 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004987
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004988 signal(SIGALRM, no_more_time);
4989 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004990
wdenk2729af92004-05-03 20:45:30 +00004991 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004992 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004993 return 0;
4994 }
4995
wdenk2729af92004-05-03 20:45:30 +00004996 Download latest U-Boot source;
4997
Wolfgang Denk06682362008-12-30 22:56:11 +01004998 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004999
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005000 if (clueless)
5001 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005002
wdenk2729af92004-05-03 20:45:30 +00005003 while (learning) {
5004 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005005 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5006 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005007 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005008 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005009 }
wdenkc6097192002-11-03 00:24:07 +00005010
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005011 if (available_money > toLocalCurrency ($2500))
5012 Buy a BDI3000;
5013 else
wdenk2729af92004-05-03 20:45:30 +00005014 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005015
5016 if (a similar board exists) { /* hopefully... */
5017 cp -a board/<similar> board/<myboard>
5018 cp include/configs/<similar>.h include/configs/<myboard>.h
5019 } else {
5020 Create your own board support subdirectory;
5021 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005022 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005023 Edit new board/<myboard> files
5024 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005025
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005026 while (!accepted) {
5027 while (!running) {
5028 do {
5029 Add / modify source code;
5030 } until (compiles);
5031 Debug;
5032 if (clueless)
5033 email("Hi, I am having problems...");
5034 }
5035 Send patch file to the U-Boot email list;
5036 if (reasonable critiques)
5037 Incorporate improvements from email list code review;
5038 else
5039 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005040 }
wdenkc6097192002-11-03 00:24:07 +00005041
wdenk2729af92004-05-03 20:45:30 +00005042 return 0;
5043}
5044
5045void no_more_time (int sig)
5046{
5047 hire_a_guru();
5048}
wdenkc6097192002-11-03 00:24:07 +00005049
5050
wdenk2729af92004-05-03 20:45:30 +00005051Coding Standards:
5052-----------------
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk2729af92004-05-03 20:45:30 +00005054All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005055coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005056"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005057
Detlev Zundel2c051652006-09-01 15:39:02 +02005058Source files originating from a different project (for example the
5059MTD subsystem) are generally exempt from these guidelines and are not
5060reformated to ease subsequent migration to newer versions of those
5061sources.
5062
5063Please note that U-Boot is implemented in C (and to some small parts in
5064Assembler); no C++ is used, so please do not use C++ style comments (//)
5065in your code.
wdenk2729af92004-05-03 20:45:30 +00005066
5067Please also stick to the following formatting rules:
5068- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005069- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005070- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005071- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005072- do not add trailing empty lines to source files
5073
5074Submissions which do not conform to the standards may be returned
5075with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005076
5077
wdenk2729af92004-05-03 20:45:30 +00005078Submitting Patches:
5079-------------------
wdenkc6097192002-11-03 00:24:07 +00005080
wdenk2729af92004-05-03 20:45:30 +00005081Since the number of patches for U-Boot is growing, we need to
5082establish some rules. Submissions which do not conform to these rules
5083may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005084
Magnus Lilja0d28f342008-08-06 19:32:33 +02005085Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005086
Wolfgang Denk06682362008-12-30 22:56:11 +01005087Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5088see http://lists.denx.de/mailman/listinfo/u-boot
5089
wdenk2729af92004-05-03 20:45:30 +00005090When you send a patch, please include the following information with
5091it:
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk2729af92004-05-03 20:45:30 +00005093* For bug fixes: a description of the bug and how your patch fixes
5094 this bug. Please try to include a way of demonstrating that the
5095 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk2729af92004-05-03 20:45:30 +00005097* For new features: a description of the feature and your
5098 implementation.
wdenkc6097192002-11-03 00:24:07 +00005099
wdenk2729af92004-05-03 20:45:30 +00005100* A CHANGELOG entry as plaintext (separate from the patch)
5101
5102* For major contributions, your entry to the CREDITS file
5103
5104* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005105 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005106
5107* If your patch adds new configuration options, don't forget to
5108 document these in the README file.
5109
Wolfgang Denk218ca722008-03-26 10:40:12 +01005110* The patch itself. If you are using git (which is *strongly*
5111 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005112 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005113 the U-Boot mailing list, you will avoid most of the common problems
5114 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005115
Wolfgang Denk218ca722008-03-26 10:40:12 +01005116 If you cannot use git, use "diff -purN OLD NEW". If your version of
5117 diff does not support these options, then get the latest version of
5118 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005119
Wolfgang Denk218ca722008-03-26 10:40:12 +01005120 The current directory when running this command shall be the parent
5121 directory of the U-Boot source tree (i. e. please make sure that
5122 your patch includes sufficient directory information for the
5123 affected files).
5124
5125 We prefer patches as plain text. MIME attachments are discouraged,
5126 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005127
5128* If one logical set of modifications affects or creates several
5129 files, all these changes shall be submitted in a SINGLE patch file.
5130
5131* Changesets that contain different, unrelated modifications shall be
5132 submitted as SEPARATE patches, one patch per changeset.
5133
5134
5135Notes:
5136
5137* Before sending the patch, run the MAKEALL script on your patched
5138 source tree and make sure that no errors or warnings are reported
5139 for any of the boards.
5140
5141* Keep your modifications to the necessary minimum: A patch
5142 containing several unrelated changes or arbitrary reformats will be
5143 returned with a request to re-formatting / split it.
5144
5145* If you modify existing code, make sure that your new code does not
5146 add to the memory footprint of the code ;-) Small is beautiful!
5147 When adding new features, these should compile conditionally only
5148 (using #ifdef), and the resulting code with the new feature
5149 disabled must not need more memory than the old code without your
5150 modification.
wdenk90dc6702005-05-03 14:12:25 +00005151
Wolfgang Denk06682362008-12-30 22:56:11 +01005152* Remember that there is a size limit of 100 kB per message on the
5153 u-boot mailing list. Bigger patches will be moderated. If they are
5154 reasonable and not too big, they will be acknowledged. But patches
5155 bigger than the size limit should be avoided.