blob: 4dad1594eb17a8678e4db4d5c31f6782fa5825a3 [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:
York Sunffd06e02012-10-08 07:44:30 +0000366 CONFIG_SYS_PPC64
367
368 Specifies that the core is a 64-bit PowerPC implementation (implements
369 the "64" category of the Power ISA). This is necessary for ePAPR
370 compliance, among other possible reasons.
371
Kumar Gala66412c62011-02-18 05:40:54 -0600372 CONFIG_SYS_FSL_TBCLK_DIV
373
374 Defines the core time base clock divider ratio compared to the
375 system clock. On most PQ3 devices this is 8, on newer QorIQ
376 devices it can be 16 or 32. The ratio varies from SoC to Soc.
377
Kumar Gala8f290842011-05-20 00:39:21 -0500378 CONFIG_SYS_FSL_PCIE_COMPAT
379
380 Defines the string to utilize when trying to match PCIe device
381 tree nodes for the given platform.
382
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000383 CONFIG_SYS_PPC_E500_DEBUG_TLB
384
385 Enables a temporary TLB entry to be used during boot to work
386 around limitations in e500v1 and e500v2 external debugger
387 support. This reduces the portions of the boot code where
388 breakpoints and single stepping do not work. The value of this
389 symbol should be set to the TLB1 entry to be used for this
390 purpose.
391
Scott Wood33eee332012-08-14 10:14:53 +0000392 CONFIG_SYS_FSL_ERRATUM_A004510
393
394 Enables a workaround for erratum A004510. If set,
395 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
396 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
397
398 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
399 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
400
401 Defines one or two SoC revisions (low 8 bits of SVR)
402 for which the A004510 workaround should be applied.
403
404 The rest of SVR is either not relevant to the decision
405 of whether the erratum is present (e.g. p2040 versus
406 p2041) or is implied by the build target, which controls
407 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
408
409 See Freescale App Note 4493 for more information about
410 this erratum.
411
412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413
414 This is the value to write into CCSR offset 0x18600
415 according to the A004510 workaround.
416
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000417- Generic CPU options:
418 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
419
420 Defines the endianess of the CPU. Implementation of those
421 values is arch specific.
422
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100423- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200424 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100425
426 Defines the Monahans run mode to oscillator
427 ratio. Valid values are 8, 16, 24, 31. The core
428 frequency is this value multiplied by 13 MHz.
429
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200430 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200431
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100432 Defines the Monahans turbo mode to oscillator
433 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200434 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100435 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200436
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200437- MIPS CPU options:
438 CONFIG_SYS_INIT_SP_OFFSET
439
440 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
441 pointer. This is needed for the temporary stack before
442 relocation.
443
444 CONFIG_SYS_MIPS_CACHE_MODE
445
446 Cache operation mode for the MIPS CPU.
447 See also arch/mips/include/asm/mipsregs.h.
448 Possible values are:
449 CONF_CM_CACHABLE_NO_WA
450 CONF_CM_CACHABLE_WA
451 CONF_CM_UNCACHED
452 CONF_CM_CACHABLE_NONCOHERENT
453 CONF_CM_CACHABLE_CE
454 CONF_CM_CACHABLE_COW
455 CONF_CM_CACHABLE_CUW
456 CONF_CM_CACHABLE_ACCELERATED
457
458 CONFIG_SYS_XWAY_EBU_BOOTCFG
459
460 Special option for Lantiq XWAY SoCs for booting from NOR flash.
461 See also arch/mips/cpu/mips32/start.S.
462
463 CONFIG_XWAY_SWAP_BYTES
464
465 Enable compilation of tools/xway-swap-bytes needed for Lantiq
466 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
467 be swapped if a flash programmer is used.
468
Christian Rieschb67d8812012-02-02 00:44:39 +0000469- ARM options:
470 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
471
472 Select high exception vectors of the ARM core, e.g., do not
473 clear the V bit of the c1 register of CP15.
474
Aneesh V5356f542012-03-08 07:20:19 +0000475 CONFIG_SYS_THUMB_BUILD
476
477 Use this flag to build U-Boot using the Thumb instruction
478 set for ARM architectures. Thumb instruction set provides
479 better code density. For ARM architectures that support
480 Thumb2 this flag will result in Thumb2 code generated by
481 GCC.
482
wdenk5da627a2003-10-09 20:09:04 +0000483- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000484 CONFIG_CLOCKS_IN_MHZ
485
486 U-Boot stores all clock information in Hz
487 internally. For binary compatibility with older Linux
488 kernels (which expect the clocks passed in the
489 bd_info data to be in MHz) the environment variable
490 "clocks_in_mhz" can be defined so that U-Boot
491 converts clock data to MHZ before passing it to the
492 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000493 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100494 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000495 default environment.
496
wdenk5da627a2003-10-09 20:09:04 +0000497 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
498
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200499 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000500 expect it to be in bytes, others in MB.
501 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
502
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400503 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200504
505 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400506 passed using flattened device trees (based on open firmware
507 concepts).
508
509 CONFIG_OF_LIBFDT
510 * New libfdt-based support
511 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500512 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400513
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200514 OF_CPU - The proper name of the cpus node (only required for
515 MPC512X and MPC5xxx based boards).
516 OF_SOC - The proper name of the soc node (only required for
517 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200518 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600519 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200520
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200521 boards with QUICC Engines require OF_QE to set UCC MAC
522 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500523
Kumar Gala4e253132006-01-11 13:54:17 -0600524 CONFIG_OF_BOARD_SETUP
525
526 Board code has addition modification that it wants to make
527 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000528
Matthew McClintock02677682006-06-28 10:41:37 -0500529 CONFIG_OF_BOOT_CPU
530
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200531 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500532 param header, the default value is zero if undefined.
533
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200534 CONFIG_OF_IDE_FIXUP
535
536 U-Boot can detect if an IDE device is present or not.
537 If not, and this new config option is activated, U-Boot
538 removes the ATA node from the DTS before booting Linux,
539 so the Linux IDE driver does not probe the device and
540 crash. This is needed for buggy hardware (uc101) where
541 no pull down resistor is connected to the signal IDE5V_DD7.
542
Igor Grinberg7eb29392011-07-14 05:45:07 +0000543 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
544
545 This setting is mandatory for all boards that have only one
546 machine type and must be used to specify the machine type
547 number as it appears in the ARM machine registry
548 (see http://www.arm.linux.org.uk/developer/machines/).
549 Only boards that have multiple machine types supported
550 in a single configuration file and the machine type is
551 runtime discoverable, do not have to use this setting.
552
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100553- vxWorks boot parameters:
554
555 bootvx constructs a valid bootline using the following
556 environments variables: bootfile, ipaddr, serverip, hostname.
557 It loads the vxWorks image pointed bootfile.
558
559 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
560 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
561 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
562 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
563
564 CONFIG_SYS_VXWORKS_ADD_PARAMS
565
566 Add it at the end of the bootline. E.g "u=username pw=secret"
567
568 Note: If a "bootargs" environment is defined, it will overwride
569 the defaults discussed just above.
570
Aneesh V2c451f72011-06-16 23:30:47 +0000571- Cache Configuration:
572 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
573 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
574 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
575
Aneesh V93bc2192011-06-16 23:30:51 +0000576- Cache Configuration for ARM:
577 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
578 controller
579 CONFIG_SYS_PL310_BASE - Physical base address of PL310
580 controller register space
581
wdenk6705d812004-08-02 23:22:59 +0000582- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200583 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000584
585 Define this if you want support for Amba PrimeCell PL010 UARTs.
586
Andreas Engel48d01922008-09-08 14:30:53 +0200587 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000588
589 Define this if you want support for Amba PrimeCell PL011 UARTs.
590
591 CONFIG_PL011_CLOCK
592
593 If you have Amba PrimeCell PL011 UARTs, set this variable to
594 the clock speed of the UARTs.
595
596 CONFIG_PL01x_PORTS
597
598 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
599 define this to a list of base addresses for each (supported)
600 port. See e.g. include/configs/versatile.h
601
John Rigby910f1ae2011-04-19 10:42:39 +0000602 CONFIG_PL011_SERIAL_RLCR
603
604 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
605 have separate receive and transmit line control registers. Set
606 this variable to initialize the extra register.
607
608 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
609
610 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
611 boot loader that has already initialized the UART. Define this
612 variable to flush the UART at init time.
613
wdenk6705d812004-08-02 23:22:59 +0000614
wdenkc6097192002-11-03 00:24:07 +0000615- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000616 Depending on board, define exactly one serial port
617 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
618 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
619 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000620
621 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
622 port routines must be defined elsewhere
623 (i.e. serial_init(), serial_getc(), ...)
624
625 CONFIG_CFB_CONSOLE
626 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000627 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000628 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
629 (default big endian)
630 VIDEO_HW_RECTFILL graphic chip supports
631 rectangle fill
632 (cf. smiLynxEM)
633 VIDEO_HW_BITBLT graphic chip supports
634 bit-blit (cf. smiLynxEM)
635 VIDEO_VISIBLE_COLS visible pixel columns
636 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000637 VIDEO_VISIBLE_ROWS visible pixel rows
638 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000639 VIDEO_DATA_FORMAT graphic data format
640 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000641 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000642 VIDEO_KBD_INIT_FCT keyboard int fct
643 (i.e. i8042_kbd_init())
644 VIDEO_TSTC_FCT test char fct
645 (i.e. i8042_tstc)
646 VIDEO_GETC_FCT get char fct
647 (i.e. i8042_getc)
648 CONFIG_CONSOLE_CURSOR cursor drawing on/off
649 (requires blink timer
650 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200651 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000652 CONFIG_CONSOLE_TIME display time/date info in
653 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500654 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000655 CONFIG_VIDEO_LOGO display Linux logo in
656 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000657 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
658 linux_logo.h for logo.
659 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000660 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200661 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000662 the logo
663
wdenk43d96162003-03-06 00:02:04 +0000664 When CONFIG_CFB_CONSOLE is defined, video console is
665 default i/o. Serial console can be forced with
666 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000667
wdenkd4ca31c2004-01-02 14:00:00 +0000668 When CONFIG_SILENT_CONSOLE is defined, all console
669 messages (by U-Boot and Linux!) can be silenced with
670 the "silent" environment variable. See
671 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000672
wdenkc6097192002-11-03 00:24:07 +0000673- Console Baudrate:
674 CONFIG_BAUDRATE - in bps
675 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200676 CONFIG_SYS_BAUDRATE_TABLE, see below.
677 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000678
Heiko Schocherc92fac92009-01-30 12:55:38 +0100679- Console Rx buffer length
680 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
681 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100682 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100683 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
684 must be defined, to setup the maximum idle timeout for
685 the SMC.
686
Graeme Russ9558b482011-09-01 00:48:27 +0000687- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200688 Prior to the console being initialised (i.e. serial UART
689 initialised etc) all console output is silently discarded.
690 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
691 buffer any console messages prior to the console being
692 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
693 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
694 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200695 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200696 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000697
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200698 'Sane' compilers will generate smaller code if
699 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000700
Sonny Rao046a37b2011-11-02 09:52:08 +0000701- Safe printf() functions
702 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
703 the printf() functions. These are defined in
704 include/vsprintf.h and include snprintf(), vsnprintf() and
705 so on. Code size increase is approximately 300-500 bytes.
706 If this option is not given then these functions will
707 silently discard their buffer size argument - this means
708 you are not getting any overflow checking in this case.
709
wdenkc6097192002-11-03 00:24:07 +0000710- Boot Delay: CONFIG_BOOTDELAY - in seconds
711 Delay before automatically booting the default image;
712 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000713 set to -2 to autoboot with no delay and not check for abort
714 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000715
716 See doc/README.autoboot for these options that
717 work with CONFIG_BOOTDELAY. None are required.
718 CONFIG_BOOT_RETRY_TIME
719 CONFIG_BOOT_RETRY_MIN
720 CONFIG_AUTOBOOT_KEYED
721 CONFIG_AUTOBOOT_PROMPT
722 CONFIG_AUTOBOOT_DELAY_STR
723 CONFIG_AUTOBOOT_STOP_STR
724 CONFIG_AUTOBOOT_DELAY_STR2
725 CONFIG_AUTOBOOT_STOP_STR2
726 CONFIG_ZERO_BOOTDELAY_CHECK
727 CONFIG_RESET_TO_RETRY
728
729- Autoboot Command:
730 CONFIG_BOOTCOMMAND
731 Only needed when CONFIG_BOOTDELAY is enabled;
732 define a command string that is automatically executed
733 when no character is read on the console interface
734 within "Boot Delay" after reset.
735
736 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000737 This can be used to pass arguments to the bootm
738 command. The value of CONFIG_BOOTARGS goes into the
739 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000740
741 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000742 The value of these goes into the environment as
743 "ramboot" and "nfsboot" respectively, and can be used
744 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200745 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000746
747- Pre-Boot Commands:
748 CONFIG_PREBOOT
749
750 When this option is #defined, the existence of the
751 environment variable "preboot" will be checked
752 immediately before starting the CONFIG_BOOTDELAY
753 countdown and/or running the auto-boot command resp.
754 entering interactive mode.
755
756 This feature is especially useful when "preboot" is
757 automatically generated or modified. For an example
758 see the LWMON board specific code: here "preboot" is
759 modified when the user holds down a certain
760 combination of keys on the (special) keyboard when
761 booting the systems
762
763- Serial Download Echo Mode:
764 CONFIG_LOADS_ECHO
765 If defined to 1, all characters received during a
766 serial download (using the "loads" command) are
767 echoed back. This might be needed by some terminal
768 emulations (like "cu"), but may as well just take
769 time on others. This setting #define's the initial
770 value of the "loads_echo" environment variable.
771
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500772- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000773 CONFIG_KGDB_BAUDRATE
774 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200775 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000776
777- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500778 Monitor commands can be included or excluded
779 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000780 <config_cmd_all.h> and #undef'ing unwanted
781 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500782 and augmenting with additional #define's
783 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000784
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500785 The default command configuration includes all commands
786 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000787
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500788 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500789 CONFIG_CMD_BDI bdinfo
790 CONFIG_CMD_BEDBUG * Include BedBug Debugger
791 CONFIG_CMD_BMP * BMP support
792 CONFIG_CMD_BSP * Board specific commands
793 CONFIG_CMD_BOOTD bootd
794 CONFIG_CMD_CACHE * icache, dcache
795 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500796 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500797 CONFIG_CMD_DATE * support for RTC, date/time...
798 CONFIG_CMD_DHCP * DHCP support
799 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600800 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
801 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
802 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
803 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500804 CONFIG_CMD_DTT * Digital Therm and Thermostat
805 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500806 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500807 CONFIG_CMD_EEPROM * EEPROM read/write support
808 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500809 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500810 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500811 CONFIG_CMD_FDC * Floppy Disk Support
812 CONFIG_CMD_FAT * FAT partition support
813 CONFIG_CMD_FDOS * Dos diskette Support
814 CONFIG_CMD_FLASH flinfo, erase, protect
815 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500816 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000817 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500818 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
819 CONFIG_CMD_I2C * I2C serial bus support
820 CONFIG_CMD_IDE * IDE harddisk support
821 CONFIG_CMD_IMI iminfo
822 CONFIG_CMD_IMLS List all found images
823 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500824 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +0000825 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500826 CONFIG_CMD_IRQ * irqinfo
827 CONFIG_CMD_ITEST Integer/string test of 2 values
828 CONFIG_CMD_JFFS2 * JFFS2 Support
829 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500830 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000831 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
832 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500833 CONFIG_CMD_LOADB loadb
834 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400835 CONFIG_CMD_MD5SUM print md5 message digest
836 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500837 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
838 loop, loopw, mtest
839 CONFIG_CMD_MISC Misc functions like sleep etc
840 CONFIG_CMD_MMC * MMC memory mapped support
841 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100842 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500843 CONFIG_CMD_NAND * NAND support
844 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600845 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000846 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500847 CONFIG_CMD_PCI * pciinfo
848 CONFIG_CMD_PCMCIA * PCMCIA support
849 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
850 host
851 CONFIG_CMD_PORTIO * Port I/O
852 CONFIG_CMD_REGINFO * Register dump
853 CONFIG_CMD_RUN run command in env variable
854 CONFIG_CMD_SAVES * save S record dump
855 CONFIG_CMD_SCSI * SCSI Support
856 CONFIG_CMD_SDRAM * print SDRAM configuration information
857 (requires CONFIG_CMD_I2C)
858 CONFIG_CMD_SETGETDCR Support for DCR Register access
859 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700860 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100861 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400862 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200863 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500864 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000865 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000866 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +0000867 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
868 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500869 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500870 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000871 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000872
wdenkc6097192002-11-03 00:24:07 +0000873
874 EXAMPLE: If you want all functions except of network
875 support you can write:
876
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500877 #include "config_cmd_all.h"
878 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000879
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400880 Other Commands:
881 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000882
883 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500884 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000885 what you (and your U-Boot users) are doing. Data
886 cache cannot be enabled on systems like the 8xx or
887 8260 (where accesses to the IMMR region must be
888 uncached), and it cannot be disabled on all other
889 systems where we (mis-) use the data cache to hold an
890 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000891
892
893 XXX - this list needs to get updated!
894
Simon Glass45ba8072011-10-15 05:48:20 +0000895- Device tree:
896 CONFIG_OF_CONTROL
897 If this variable is defined, U-Boot will use a device tree
898 to configure its devices, instead of relying on statically
899 compiled #defines in the board file. This option is
900 experimental and only available on a few boards. The device
901 tree is available in the global data as gd->fdt_blob.
902
Simon Glass2c0f79e2011-10-24 19:15:31 +0000903 U-Boot needs to get its device tree from somewhere. This can
904 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000905
906 CONFIG_OF_EMBED
907 If this variable is defined, U-Boot will embed a device tree
908 binary in its image. This device tree file should be in the
909 board directory and called <soc>-<board>.dts. The binary file
910 is then picked up in board_init_f() and made available through
911 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000912
Simon Glass2c0f79e2011-10-24 19:15:31 +0000913 CONFIG_OF_SEPARATE
914 If this variable is defined, U-Boot will build a device tree
915 binary. It will be called u-boot.dtb. Architecture-specific
916 code will locate it at run-time. Generally this works by:
917
918 cat u-boot.bin u-boot.dtb >image.bin
919
920 and in fact, U-Boot does this for you, creating a file called
921 u-boot-dtb.bin which is useful in the common case. You can
922 still use the individual files if you need something more
923 exotic.
924
wdenkc6097192002-11-03 00:24:07 +0000925- Watchdog:
926 CONFIG_WATCHDOG
927 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000928 support for the SoC. There must be support in the SoC
929 specific code for a watchdog. For the 8xx and 8260
930 CPUs, the SIU Watchdog feature is enabled in the SYPCR
931 register. When supported for a specific SoC is
932 available, then no further board specific code should
933 be needed to use it.
934
935 CONFIG_HW_WATCHDOG
936 When using a watchdog circuitry external to the used
937 SoC, then define this variable and provide board
938 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000939
stroesec1551ea2003-04-04 15:53:41 +0000940- U-Boot Version:
941 CONFIG_VERSION_VARIABLE
942 If this variable is defined, an environment variable
943 named "ver" is created by U-Boot showing the U-Boot
944 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +0200945 Any change to this variable will be reverted at the
946 next reset.
stroesec1551ea2003-04-04 15:53:41 +0000947
wdenkc6097192002-11-03 00:24:07 +0000948- Real-Time Clock:
949
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500950 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000951 has to be selected, too. Define exactly one of the
952 following options:
953
954 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
955 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000956 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000957 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000958 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000959 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000960 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000961 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100962 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000963 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200964 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200965 CONFIG_SYS_RV3029_TCR - enable trickle charger on
966 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000967
wdenkb37c7e52003-06-30 16:24:52 +0000968 Note that if the RTC uses I2C, then the I2C interface
969 must also be configured. See I2C Support, below.
970
Peter Tysere92739d2008-12-17 16:36:21 -0600971- GPIO Support:
972 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
973 CONFIG_PCA953X_INFO - enable pca953x info command
974
Chris Packham5dec49c2010-12-19 10:12:13 +0000975 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
976 chip-ngpio pairs that tell the PCA953X driver the number of
977 pins supported by a particular chip.
978
Peter Tysere92739d2008-12-17 16:36:21 -0600979 Note that if the GPIO device uses I2C, then the I2C interface
980 must also be configured. See I2C Support, below.
981
wdenkc6097192002-11-03 00:24:07 +0000982- Timestamp Support:
983
wdenk43d96162003-03-06 00:02:04 +0000984 When CONFIG_TIMESTAMP is selected, the timestamp
985 (date and time) of an image is printed by image
986 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500987 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000988
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000989- Partition Labels (disklabels) Supported:
990 Zero or more of the following:
991 CONFIG_MAC_PARTITION Apple's MacOS partition table.
992 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
993 Intel architecture, USB sticks, etc.
994 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
995 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
996 bootloader. Note 2TB partition limit; see
997 disk/part_efi.c
998 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000999
Wolfgang Denk218ca722008-03-26 10:40:12 +01001000 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1001 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001002 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001003
1004- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001005 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1006 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001007
wdenk4d13cba2004-03-14 14:09:05 +00001008 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1009 be performed by calling the function
1010 ide_set_reset(int reset)
1011 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001012
1013- ATAPI Support:
1014 CONFIG_ATAPI
1015
1016 Set this to enable ATAPI support.
1017
wdenkc40b2952004-03-13 23:29:43 +00001018- LBA48 Support
1019 CONFIG_LBA48
1020
1021 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001022 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001023 Whithout these , LBA48 support uses 32bit variables and will 'only'
1024 support disks up to 2.1TB.
1025
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001026 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001027 When enabled, makes the IDE subsystem use 64bit sector addresses.
1028 Default is 32bit.
1029
wdenkc6097192002-11-03 00:24:07 +00001030- SCSI Support:
1031 At the moment only there is only support for the
1032 SYM53C8XX SCSI controller; define
1033 CONFIG_SCSI_SYM53C8XX to enable it.
1034
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001035 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1036 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1037 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001038 maximum numbers of LUNs, SCSI ID's and target
1039 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001040 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001041
1042- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001043 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001044 Support for Intel 8254x/8257x gigabit chips.
1045
1046 CONFIG_E1000_SPI
1047 Utility code for direct access to the SPI bus on Intel 8257x.
1048 This does not do anything useful unless you set at least one
1049 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1050
1051 CONFIG_E1000_SPI_GENERIC
1052 Allow generic access to the SPI bus on the Intel 8257x, for
1053 example with the "sspi" command.
1054
1055 CONFIG_CMD_E1000
1056 Management command for E1000 devices. When used on devices
1057 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001058
Andre Schwarzac3315c2008-03-06 16:45:44 +01001059 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001060 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001061
wdenkc6097192002-11-03 00:24:07 +00001062 CONFIG_EEPRO100
1063 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001064 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001065 write routine for first time initialisation.
1066
1067 CONFIG_TULIP
1068 Support for Digital 2114x chips.
1069 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1070 modem chip initialisation (KS8761/QS6611).
1071
1072 CONFIG_NATSEMI
1073 Support for National dp83815 chips.
1074
1075 CONFIG_NS8382X
1076 Support for National dp8382[01] gigabit chips.
1077
wdenk45219c42003-05-12 21:50:16 +00001078- NETWORK Support (other):
1079
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001080 CONFIG_DRIVER_AT91EMAC
1081 Support for AT91RM9200 EMAC.
1082
1083 CONFIG_RMII
1084 Define this to use reduced MII inteface
1085
1086 CONFIG_DRIVER_AT91EMAC_QUIET
1087 If this defined, the driver is quiet.
1088 The driver doen't show link status messages.
1089
Rob Herringefdd7312011-12-15 11:15:49 +00001090 CONFIG_CALXEDA_XGMAC
1091 Support for the Calxeda XGMAC device
1092
wdenk45219c42003-05-12 21:50:16 +00001093 CONFIG_DRIVER_LAN91C96
1094 Support for SMSC's LAN91C96 chips.
1095
1096 CONFIG_LAN91C96_BASE
1097 Define this to hold the physical address
1098 of the LAN91C96's I/O space
1099
1100 CONFIG_LAN91C96_USE_32_BIT
1101 Define this to enable 32 bit addressing
1102
wdenkf39748a2004-06-09 13:37:52 +00001103 CONFIG_DRIVER_SMC91111
1104 Support for SMSC's LAN91C111 chip
1105
1106 CONFIG_SMC91111_BASE
1107 Define this to hold the physical address
1108 of the device (I/O space)
1109
1110 CONFIG_SMC_USE_32_BIT
1111 Define this if data bus is 32 bits
1112
1113 CONFIG_SMC_USE_IOFUNCS
1114 Define this to use i/o functions instead of macros
1115 (some hardware wont work with macros)
1116
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001117 CONFIG_DRIVER_TI_EMAC
1118 Support for davinci emac
1119
1120 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1121 Define this if you have more then 3 PHYs.
1122
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001123 CONFIG_FTGMAC100
1124 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1125
1126 CONFIG_FTGMAC100_EGIGA
1127 Define this to use GE link update with gigabit PHY.
1128 Define this if FTGMAC100 is connected to gigabit PHY.
1129 If your system has 10/100 PHY only, it might not occur
1130 wrong behavior. Because PHY usually return timeout or
1131 useless data when polling gigabit status and gigabit
1132 control registers. This behavior won't affect the
1133 correctnessof 10/100 link speed update.
1134
Mike Rapoportc2fff332009-11-11 10:03:03 +02001135 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001136 Support for SMSC's LAN911x and LAN921x chips
1137
Mike Rapoportc2fff332009-11-11 10:03:03 +02001138 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001139 Define this to hold the physical address
1140 of the device (I/O space)
1141
Mike Rapoportc2fff332009-11-11 10:03:03 +02001142 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001143 Define this if data bus is 32 bits
1144
Mike Rapoportc2fff332009-11-11 10:03:03 +02001145 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001146 Define this if data bus is 16 bits. If your processor
1147 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001148 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001149
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001150 CONFIG_SH_ETHER
1151 Support for Renesas on-chip Ethernet controller
1152
1153 CONFIG_SH_ETHER_USE_PORT
1154 Define the number of ports to be used
1155
1156 CONFIG_SH_ETHER_PHY_ADDR
1157 Define the ETH PHY's address
1158
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001159 CONFIG_SH_ETHER_CACHE_WRITEBACK
1160 If this option is set, the driver enables cache flush.
1161
Vadim Bendebury5e124722011-10-17 08:36:14 +00001162- TPM Support:
1163 CONFIG_GENERIC_LPC_TPM
1164 Support for generic parallel port TPM devices. Only one device
1165 per system is supported at this time.
1166
1167 CONFIG_TPM_TIS_BASE_ADDRESS
1168 Base address where the generic TPM device is mapped
1169 to. Contemporary x86 systems usually map it at
1170 0xfed40000.
1171
wdenkc6097192002-11-03 00:24:07 +00001172- USB Support:
1173 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001174 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001175 CONFIG_USB_UHCI to enable it.
1176 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001177 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001178 storage devices.
1179 Note:
1180 Supported are USB Keyboards and USB Floppy drives
1181 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001182 MPC5200 USB requires additional defines:
1183 CONFIG_USB_CLOCK
1184 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001185 CONFIG_PSC3_USB
1186 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001187 CONFIG_USB_CONFIG
1188 for differential drivers: 0x00001000
1189 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001190 for differential drivers on PSC3: 0x00000100
1191 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001192 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001193 May be defined to allow interrupt polling
1194 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001195
Simon Glass9ab4ce22012-02-27 10:52:47 +00001196 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1197 txfilltuning field in the EHCI controller on reset.
1198
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001199- USB Device:
1200 Define the below if you wish to use the USB console.
1201 Once firmware is rebuilt from a serial console issue the
1202 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001203 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001204 it has found a new device. The environment variable usbtty
1205 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001206 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001207 Common Device Class Abstract Control Model serial device.
1208 If you select usbtty = gserial you should be able to enumerate
1209 a Linux host by
1210 # modprobe usbserial vendor=0xVendorID product=0xProductID
1211 else if using cdc_acm, simply setting the environment
1212 variable usbtty to be cdc_acm should suffice. The following
1213 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001214
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001215 CONFIG_USB_DEVICE
1216 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001217
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001218 CONFIG_USB_TTY
1219 Define this to have a tty type of device available to
1220 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001221
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301222 CONFIG_USBD_HS
1223 Define this to enable the high speed support for usb
1224 device and usbtty. If this feature is enabled, a routine
1225 int is_usbd_high_speed(void)
1226 also needs to be defined by the driver to dynamically poll
1227 whether the enumeration has succeded at high speed or full
1228 speed.
1229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001230 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001231 Define this if you want stdin, stdout &/or stderr to
1232 be set to usbtty.
1233
1234 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001235 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001236 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001237 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001238
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001239 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001240 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001241 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001242
Wolfgang Denk386eda02006-06-14 18:14:56 +02001243 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001244 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001245 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001246 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1247 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1248 should pretend to be a Linux device to it's target host.
1249
1250 CONFIG_USBD_MANUFACTURER
1251 Define this string as the name of your company for
1252 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001253
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001254 CONFIG_USBD_PRODUCT_NAME
1255 Define this string as the name of your product
1256 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1257
1258 CONFIG_USBD_VENDORID
1259 Define this as your assigned Vendor ID from the USB
1260 Implementors Forum. This *must* be a genuine Vendor ID
1261 to avoid polluting the USB namespace.
1262 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001263
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001264 CONFIG_USBD_PRODUCTID
1265 Define this as the unique Product ID
1266 for your device
1267 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001268
Igor Grinbergd70a5602011-12-12 12:08:35 +02001269- ULPI Layer Support:
1270 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1271 the generic ULPI layer. The generic layer accesses the ULPI PHY
1272 via the platform viewport, so you need both the genric layer and
1273 the viewport enabled. Currently only Chipidea/ARC based
1274 viewport is supported.
1275 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1276 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001277 If your ULPI phy needs a different reference clock than the
1278 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1279 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001280
1281- MMC Support:
1282 The MMC controller on the Intel PXA is supported. To
1283 enable this define CONFIG_MMC. The MMC can be
1284 accessed from the boot prompt by mapping the device
1285 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001286 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1287 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001288
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001289 CONFIG_SH_MMCIF
1290 Support for Renesas on-chip MMCIF controller
1291
1292 CONFIG_SH_MMCIF_ADDR
1293 Define the base address of MMCIF registers
1294
1295 CONFIG_SH_MMCIF_CLK
1296 Define the clock frequency for MMCIF
1297
wdenk6705d812004-08-02 23:22:59 +00001298- Journaling Flash filesystem support:
1299 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1300 CONFIG_JFFS2_NAND_DEV
1301 Define these for a default partition on a NAND device
1302
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001303 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1304 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001305 Define these for a default partition on a NOR device
1306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001307 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001308 Define this to create an own partition. You have to provide a
1309 function struct part_info* jffs2_part_info(int part_num)
1310
1311 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001312 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001313 to disable the command chpart. This is the default when you
1314 have not defined a custom partition
1315
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001316- FAT(File Allocation Table) filesystem write function support:
1317 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001318
1319 Define this to enable support for saving memory data as a
1320 file in FAT formatted partition.
1321
1322 This will also enable the command "fatwrite" enabling the
1323 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001324
wdenkc6097192002-11-03 00:24:07 +00001325- Keyboard Support:
1326 CONFIG_ISA_KEYBOARD
1327
1328 Define this to enable standard (PC-Style) keyboard
1329 support
1330
1331 CONFIG_I8042_KBD
1332 Standard PC keyboard driver with US (is default) and
1333 GERMAN key layout (switch via environment 'keymap=de') support.
1334 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1335 for cfb_console. Supports cursor blinking.
1336
1337- Video support:
1338 CONFIG_VIDEO
1339
1340 Define this to enable video support (for output to
1341 video).
1342
1343 CONFIG_VIDEO_CT69000
1344
1345 Enable Chips & Technologies 69000 Video chip
1346
1347 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001348 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001349 video output is selected via environment 'videoout'
1350 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1351 assumed.
wdenkc6097192002-11-03 00:24:07 +00001352
wdenkb79a11c2004-03-25 15:14:43 +00001353 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001354 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001355 are possible:
1356 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001357 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001358
1359 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1360 -------------+---------------------------------------------
1361 8 bits | 0x301* 0x303 0x305 0x161 0x307
1362 15 bits | 0x310 0x313 0x316 0x162 0x319
1363 16 bits | 0x311 0x314 0x317 0x163 0x31A
1364 24 bits | 0x312 0x315 0x318 ? 0x31B
1365 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001366 (i.e. setenv videomode 317; saveenv; reset;)
1367
wdenkb79a11c2004-03-25 15:14:43 +00001368 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001369 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001370
1371
stroesec1551ea2003-04-04 15:53:41 +00001372 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001373 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001374 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1375 or CONFIG_VIDEO_SED13806_16BPP
1376
Timur Tabi7d3053f2011-02-15 17:09:19 -06001377 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001378 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001379 SOCs that have a DIU should define this macro to enable DIU
1380 support, and should also define these other macros:
1381
1382 CONFIG_SYS_DIU_ADDR
1383 CONFIG_VIDEO
1384 CONFIG_CMD_BMP
1385 CONFIG_CFB_CONSOLE
1386 CONFIG_VIDEO_SW_CURSOR
1387 CONFIG_VGA_AS_SINGLE_DEVICE
1388 CONFIG_VIDEO_LOGO
1389 CONFIG_VIDEO_BMP_LOGO
1390
Timur Tabiba8e76b2011-04-11 14:18:22 -05001391 The DIU driver will look for the 'video-mode' environment
1392 variable, and if defined, enable the DIU as a console during
1393 boot. See the documentation file README.video for a
1394 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001395
wdenk682011f2003-06-03 23:54:09 +00001396- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001397 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001398
wdenk8bde7f72003-06-27 21:31:46 +00001399 Define this to enable a custom keyboard support.
1400 This simply calls drv_keyboard_init() which must be
1401 defined in your board-specific files.
1402 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001403
wdenkc6097192002-11-03 00:24:07 +00001404- LCD Support: CONFIG_LCD
1405
1406 Define this to enable LCD support (for output to LCD
1407 display); also select one of the supported displays
1408 by defining one of these:
1409
Stelian Pop39cf4802008-05-09 21:57:18 +02001410 CONFIG_ATMEL_LCD:
1411
1412 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1413
wdenkfd3103b2003-11-25 16:55:19 +00001414 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001415
wdenkfd3103b2003-11-25 16:55:19 +00001416 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001417
wdenkfd3103b2003-11-25 16:55:19 +00001418 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001419
wdenkfd3103b2003-11-25 16:55:19 +00001420 NEC NL6448BC20-08. 6.5", 640x480.
1421 Active, color, single scan.
1422
1423 CONFIG_NEC_NL6448BC33_54
1424
1425 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001426 Active, color, single scan.
1427
1428 CONFIG_SHARP_16x9
1429
1430 Sharp 320x240. Active, color, single scan.
1431 It isn't 16x9, and I am not sure what it is.
1432
1433 CONFIG_SHARP_LQ64D341
1434
1435 Sharp LQ64D341 display, 640x480.
1436 Active, color, single scan.
1437
1438 CONFIG_HLD1045
1439
1440 HLD1045 display, 640x480.
1441 Active, color, single scan.
1442
1443 CONFIG_OPTREX_BW
1444
1445 Optrex CBL50840-2 NF-FW 99 22 M5
1446 or
1447 Hitachi LMG6912RPFC-00T
1448 or
1449 Hitachi SP14Q002
1450
1451 320x240. Black & white.
1452
1453 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001454 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001455
wdenk7152b1d2003-09-05 23:19:14 +00001456- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001457
wdenk8bde7f72003-06-27 21:31:46 +00001458 If this option is set, the environment is checked for
1459 a variable "splashimage". If found, the usual display
1460 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001461 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001462 specified in "splashimage" is loaded instead. The
1463 console is redirected to the "nulldev", too. This
1464 allows for a "silent" boot where a splash screen is
1465 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001466
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001467 CONFIG_SPLASH_SCREEN_ALIGN
1468
1469 If this option is set the splash image can be freely positioned
1470 on the screen. Environment variable "splashpos" specifies the
1471 position as "x,y". If a positive number is given it is used as
1472 number of pixel from left/top. If a negative number is given it
1473 is used as number of pixel from right/bottom. You can also
1474 specify 'm' for centering the image.
1475
1476 Example:
1477 setenv splashpos m,m
1478 => image at center of screen
1479
1480 setenv splashpos 30,20
1481 => image at x = 30 and y = 20
1482
1483 setenv splashpos -10,m
1484 => vertically centered image
1485 at x = dspWidth - bmpWidth - 9
1486
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001487- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1488
1489 If this option is set, additionally to standard BMP
1490 images, gzipped BMP images can be displayed via the
1491 splashscreen support or the bmp command.
1492
Anatolij Gustschind5011762010-03-15 14:50:25 +01001493- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1494
1495 If this option is set, 8-bit RLE compressed BMP images
1496 can be displayed via the splashscreen support or the
1497 bmp command.
1498
Lei Wenf2b96df2012-09-28 04:26:47 +00001499- Do compresssing for memory range:
1500 CONFIG_CMD_ZIP
1501
1502 If this option is set, it would use zlib deflate method
1503 to compress the specified memory at its best effort.
1504
wdenkc29fdfc2003-08-29 20:57:53 +00001505- Compression support:
1506 CONFIG_BZIP2
1507
1508 If this option is set, support for bzip2 compressed
1509 images is included. If not, only uncompressed and gzip
1510 compressed images are supported.
1511
wdenk42d1f032003-10-15 23:53:47 +00001512 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001513 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001514 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001515
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001516 CONFIG_LZMA
1517
1518 If this option is set, support for lzma compressed
1519 images is included.
1520
1521 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1522 requires an amount of dynamic memory that is given by the
1523 formula:
1524
1525 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1526
1527 Where lc and lp stand for, respectively, Literal context bits
1528 and Literal pos bits.
1529
1530 This value is upper-bounded by 14MB in the worst case. Anyway,
1531 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1532 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1533 a very small buffer.
1534
1535 Use the lzmainfo tool to determinate the lc and lp values and
1536 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001537 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001538
wdenk17ea1172004-06-06 21:51:03 +00001539- MII/PHY support:
1540 CONFIG_PHY_ADDR
1541
1542 The address of PHY on MII bus.
1543
1544 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1545
1546 The clock frequency of the MII bus
1547
1548 CONFIG_PHY_GIGE
1549
1550 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001551 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001552
1553 CONFIG_PHY_RESET_DELAY
1554
1555 Some PHY like Intel LXT971A need extra delay after
1556 reset before any MII register access is possible.
1557 For such PHY, set this option to the usec delay
1558 required. (minimum 300usec for LXT971A)
1559
1560 CONFIG_PHY_CMD_DELAY (ppc4xx)
1561
1562 Some PHY like Intel LXT971A need extra delay after
1563 command issued before MII status register can be read
1564
wdenkc6097192002-11-03 00:24:07 +00001565- Ethernet address:
1566 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001567 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001568 CONFIG_ETH2ADDR
1569 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001570 CONFIG_ETH4ADDR
1571 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001572
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001573 Define a default value for Ethernet address to use
1574 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001575 is not determined automatically.
1576
1577- IP address:
1578 CONFIG_IPADDR
1579
1580 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001581 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001582 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001583 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001584
1585- Server IP address:
1586 CONFIG_SERVERIP
1587
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001588 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001589 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001590 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001591
Robin Getz97cfe862009-07-21 12:15:28 -04001592 CONFIG_KEEP_SERVERADDR
1593
1594 Keeps the server's MAC address, in the env 'serveraddr'
1595 for passing to bootargs (like Linux's netconsole option)
1596
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001597- Gateway IP address:
1598 CONFIG_GATEWAYIP
1599
1600 Defines a default value for the IP address of the
1601 default router where packets to other networks are
1602 sent to.
1603 (Environment variable "gatewayip")
1604
1605- Subnet mask:
1606 CONFIG_NETMASK
1607
1608 Defines a default value for the subnet mask (or
1609 routing prefix) which is used to determine if an IP
1610 address belongs to the local subnet or needs to be
1611 forwarded through a router.
1612 (Environment variable "netmask")
1613
David Updegraff53a5c422007-06-11 10:41:07 -05001614- Multicast TFTP Mode:
1615 CONFIG_MCAST_TFTP
1616
1617 Defines whether you want to support multicast TFTP as per
1618 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001619 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001620 driver in use must provide a function: mcast() to join/leave a
1621 multicast group.
1622
wdenkc6097192002-11-03 00:24:07 +00001623- BOOTP Recovery Mode:
1624 CONFIG_BOOTP_RANDOM_DELAY
1625
1626 If you have many targets in a network that try to
1627 boot using BOOTP, you may want to avoid that all
1628 systems send out BOOTP requests at precisely the same
1629 moment (which would happen for instance at recovery
1630 from a power failure, when all systems will try to
1631 boot, thus flooding the BOOTP server. Defining
1632 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1633 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001634 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001635
1636 1st BOOTP request: delay 0 ... 1 sec
1637 2nd BOOTP request: delay 0 ... 2 sec
1638 3rd BOOTP request: delay 0 ... 4 sec
1639 4th and following
1640 BOOTP requests: delay 0 ... 8 sec
1641
stroesefe389a82003-08-28 14:17:32 +00001642- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001643 You can fine tune the DHCP functionality by defining
1644 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001645
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001646 CONFIG_BOOTP_SUBNETMASK
1647 CONFIG_BOOTP_GATEWAY
1648 CONFIG_BOOTP_HOSTNAME
1649 CONFIG_BOOTP_NISDOMAIN
1650 CONFIG_BOOTP_BOOTPATH
1651 CONFIG_BOOTP_BOOTFILESIZE
1652 CONFIG_BOOTP_DNS
1653 CONFIG_BOOTP_DNS2
1654 CONFIG_BOOTP_SEND_HOSTNAME
1655 CONFIG_BOOTP_NTPSERVER
1656 CONFIG_BOOTP_TIMEOFFSET
1657 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001658 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001659
Wilson Callan5d110f02007-07-28 10:56:13 -04001660 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1661 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001662
Joe Hershberger2c00e092012-05-23 07:59:19 +00001663 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1664 after the configured retry count, the call will fail
1665 instead of starting over. This can be used to fail over
1666 to Link-local IP address configuration if the DHCP server
1667 is not available.
1668
stroesefe389a82003-08-28 14:17:32 +00001669 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1670 serverip from a DHCP server, it is possible that more
1671 than one DNS serverip is offered to the client.
1672 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1673 serverip will be stored in the additional environment
1674 variable "dnsip2". The first DNS serverip is always
1675 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001676 is defined.
stroesefe389a82003-08-28 14:17:32 +00001677
1678 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1679 to do a dynamic update of a DNS server. To do this, they
1680 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001681 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001682 of the "hostname" environment variable is passed as
1683 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001684
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001685 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1686
1687 A 32bit value in microseconds for a delay between
1688 receiving a "DHCP Offer" and sending the "DHCP Request".
1689 This fixes a problem with certain DHCP servers that don't
1690 respond 100% of the time to a "DHCP request". E.g. On an
1691 AT91RM9200 processor running at 180MHz, this delay needed
1692 to be *at least* 15,000 usec before a Windows Server 2003
1693 DHCP server would reply 100% of the time. I recommend at
1694 least 50,000 usec to be safe. The alternative is to hope
1695 that one of the retries will be successful but note that
1696 the DHCP timeout and retry process takes a longer than
1697 this delay.
1698
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001699 - Link-local IP address negotiation:
1700 Negotiate with other link-local clients on the local network
1701 for an address that doesn't require explicit configuration.
1702 This is especially useful if a DHCP server cannot be guaranteed
1703 to exist in all environments that the device must operate.
1704
1705 See doc/README.link-local for more information.
1706
wdenka3d991b2004-04-15 21:48:45 +00001707 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001708 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001709
1710 The device id used in CDP trigger frames.
1711
1712 CONFIG_CDP_DEVICE_ID_PREFIX
1713
1714 A two character string which is prefixed to the MAC address
1715 of the device.
1716
1717 CONFIG_CDP_PORT_ID
1718
1719 A printf format string which contains the ascii name of
1720 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001721 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001722
1723 CONFIG_CDP_CAPABILITIES
1724
1725 A 32bit integer which indicates the device capabilities;
1726 0x00000010 for a normal host which does not forwards.
1727
1728 CONFIG_CDP_VERSION
1729
1730 An ascii string containing the version of the software.
1731
1732 CONFIG_CDP_PLATFORM
1733
1734 An ascii string containing the name of the platform.
1735
1736 CONFIG_CDP_TRIGGER
1737
1738 A 32bit integer sent on the trigger.
1739
1740 CONFIG_CDP_POWER_CONSUMPTION
1741
1742 A 16bit integer containing the power consumption of the
1743 device in .1 of milliwatts.
1744
1745 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1746
1747 A byte containing the id of the VLAN.
1748
wdenkc6097192002-11-03 00:24:07 +00001749- Status LED: CONFIG_STATUS_LED
1750
1751 Several configurations allow to display the current
1752 status using a LED. For instance, the LED will blink
1753 fast while running U-Boot code, stop blinking as
1754 soon as a reply to a BOOTP request was received, and
1755 start blinking slow once the Linux kernel is running
1756 (supported by a status LED driver in the Linux
1757 kernel). Defining CONFIG_STATUS_LED enables this
1758 feature in U-Boot.
1759
1760- CAN Support: CONFIG_CAN_DRIVER
1761
1762 Defining CONFIG_CAN_DRIVER enables CAN driver support
1763 on those systems that support this (optional)
1764 feature, like the TQM8xxL modules.
1765
1766- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1767
wdenkb37c7e52003-06-30 16:24:52 +00001768 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001769 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001770 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001771
wdenk945af8d2003-07-16 21:53:01 +00001772 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001773 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001774 CONFIG_COMMANDS) and communicate with i2c based realtime
1775 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001776 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001777
Ben Warrenbb99ad62006-09-07 16:50:54 -04001778 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001779
wdenk945af8d2003-07-16 21:53:01 +00001780 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001781 bit-banging) driver instead of CPM or similar hardware
1782 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001783
wdenk945af8d2003-07-16 21:53:01 +00001784 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001785 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001787 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001788 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001789 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001790 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001791
Peter Tyser8d321b82010-04-12 22:28:21 -05001792 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001793 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001794 and so its address should therefore be cleared to 0 (See,
1795 eg, MPC823e User's Manual p.16-473). So, set
1796 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001797
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001798 CONFIG_SYS_I2C_INIT_MPC5XXX
1799
1800 When a board is reset during an i2c bus transfer
1801 chips might think that the current transfer is still
1802 in progress. Reset the slave devices by sending start
1803 commands until the slave device responds.
1804
wdenk945af8d2003-07-16 21:53:01 +00001805 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001806
1807 If you use the software i2c interface (CONFIG_SOFT_I2C)
1808 then the following macros need to be defined (examples are
1809 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001810
1811 I2C_INIT
1812
wdenkb37c7e52003-06-30 16:24:52 +00001813 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001814 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001815
wdenkba56f622004-02-06 23:19:44 +00001816 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001817
wdenkc6097192002-11-03 00:24:07 +00001818 I2C_PORT
1819
wdenk43d96162003-03-06 00:02:04 +00001820 (Only for MPC8260 CPU). The I/O port to use (the code
1821 assumes both bits are on the same port). Valid values
1822 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001823
1824 I2C_ACTIVE
1825
1826 The code necessary to make the I2C data line active
1827 (driven). If the data line is open collector, this
1828 define can be null.
1829
wdenkb37c7e52003-06-30 16:24:52 +00001830 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1831
wdenkc6097192002-11-03 00:24:07 +00001832 I2C_TRISTATE
1833
1834 The code necessary to make the I2C data line tri-stated
1835 (inactive). If the data line is open collector, this
1836 define can be null.
1837
wdenkb37c7e52003-06-30 16:24:52 +00001838 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1839
wdenkc6097192002-11-03 00:24:07 +00001840 I2C_READ
1841
1842 Code that returns TRUE if the I2C data line is high,
1843 FALSE if it is low.
1844
wdenkb37c7e52003-06-30 16:24:52 +00001845 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1846
wdenkc6097192002-11-03 00:24:07 +00001847 I2C_SDA(bit)
1848
1849 If <bit> is TRUE, sets the I2C data line high. If it
1850 is FALSE, it clears it (low).
1851
wdenkb37c7e52003-06-30 16:24:52 +00001852 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001853 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001854 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001855
wdenkc6097192002-11-03 00:24:07 +00001856 I2C_SCL(bit)
1857
1858 If <bit> is TRUE, sets the I2C clock line high. If it
1859 is FALSE, it clears it (low).
1860
wdenkb37c7e52003-06-30 16:24:52 +00001861 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001862 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001863 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001864
wdenkc6097192002-11-03 00:24:07 +00001865 I2C_DELAY
1866
1867 This delay is invoked four times per clock cycle so this
1868 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001869 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001870 like:
1871
wdenkb37c7e52003-06-30 16:24:52 +00001872 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001873
Mike Frysinger793b5722010-07-21 13:38:02 -04001874 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1875
1876 If your arch supports the generic GPIO framework (asm/gpio.h),
1877 then you may alternatively define the two GPIOs that are to be
1878 used as SCL / SDA. Any of the previous I2C_xxx macros will
1879 have GPIO-based defaults assigned to them as appropriate.
1880
1881 You should define these to the GPIO value as given directly to
1882 the generic GPIO functions.
1883
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001884 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001885
wdenk8bde7f72003-06-27 21:31:46 +00001886 When a board is reset during an i2c bus transfer
1887 chips might think that the current transfer is still
1888 in progress. On some boards it is possible to access
1889 the i2c SCLK line directly, either by using the
1890 processor pin as a GPIO or by having a second pin
1891 connected to the bus. If this option is defined a
1892 custom i2c_init_board() routine in boards/xxx/board.c
1893 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001894
Richard Retanubun26a33502010-04-12 15:08:17 -04001895 CONFIG_SYS_I2C_BOARD_LATE_INIT
1896
1897 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1898 defined a custom i2c_board_late_init() routine in
1899 boards/xxx/board.c is run AFTER the operations in i2c_init()
1900 is completed. This callpoint can be used to unreset i2c bus
1901 using CPU i2c controller register accesses for CPUs whose i2c
1902 controller provide such a method. It is called at the end of
1903 i2c_init() to allow i2c_init operations to setup the i2c bus
1904 controller on the CPU (e.g. setting bus speed & slave address).
1905
wdenk17ea1172004-06-06 21:51:03 +00001906 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1907
1908 This option enables configuration of bi_iic_fast[] flags
1909 in u-boot bd_info structure based on u-boot environment
1910 variable "i2cfast". (see also i2cfast)
1911
Ben Warrenbb99ad62006-09-07 16:50:54 -04001912 CONFIG_I2C_MULTI_BUS
1913
1914 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001915 must have a controller. At any point in time, only one bus is
1916 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001917 Note that bus numbering is zero-based.
1918
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001919 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001920
1921 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001922 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001923 is set, specify a list of bus-device pairs. Otherwise, specify
1924 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001925
1926 e.g.
1927 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001928 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001929
1930 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1931
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001932 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001933 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001934
1935 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1936
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001937 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001938
1939 If defined, then this indicates the I2C bus number for DDR SPD.
1940 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1941
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001942 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001943
1944 If defined, then this indicates the I2C bus number for the RTC.
1945 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1946
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001947 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001948
1949 If defined, then this indicates the I2C bus number for the DTT.
1950 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1951
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001952 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001953
1954 If defined, specifies the I2C address of the DTT device.
1955 If not defined, then U-Boot uses predefined value for
1956 specified DTT device.
1957
Timur Tabibe5e6182006-11-03 19:15:00 -06001958 CONFIG_FSL_I2C
1959
1960 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001961 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001962
Heiko Schocher67b23a32008-10-15 09:39:47 +02001963 CONFIG_I2C_MUX
1964
1965 Define this option if you have I2C devices reached over 1 .. n
1966 I2C Muxes like the pca9544a. This option addes a new I2C
1967 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1968 new I2C Bus to the existing I2C Busses. If you select the
1969 new Bus with "i2c dev", u-bbot sends first the commandos for
1970 the muxes to activate this new "bus".
1971
1972 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1973 feature!
1974
1975 Example:
1976 Adding a new I2C Bus reached over 2 pca9544a muxes
1977 The First mux with address 70 and channel 6
1978 The Second mux with address 71 and channel 4
1979
1980 => i2c bus pca9544a:70:6:pca9544a:71:4
1981
1982 Use the "i2c bus" command without parameter, to get a list
1983 of I2C Busses with muxes:
1984
1985 => i2c bus
1986 Busses reached over muxes:
1987 Bus ID: 2
1988 reached over Mux(es):
1989 pca9544a@70 ch: 4
1990 Bus ID: 3
1991 reached over Mux(es):
1992 pca9544a@70 ch: 6
1993 pca9544a@71 ch: 4
1994 =>
1995
1996 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001997 u-boot first sends the command to the mux@70 to enable
1998 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001999 the channel 4.
2000
2001 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00002002 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02002003 the 2 muxes.
2004
2005 This option is actually implemented for the bitbanging
2006 algorithm in common/soft_i2c.c and for the Hardware I2C
2007 Bus on the MPC8260. But it should be not so difficult
2008 to add this option to other architectures.
2009
Andrew Dyer2ac69852008-12-29 17:36:01 -06002010 CONFIG_SOFT_I2C_READ_REPEATED_START
2011
2012 defining this will force the i2c_read() function in
2013 the soft_i2c driver to perform an I2C repeated start
2014 between writing the address pointer and reading the
2015 data. If this define is omitted the default behaviour
2016 of doing a stop-start sequence will be used. Most I2C
2017 devices can use either method, but some require one or
2018 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002019
wdenkc6097192002-11-03 00:24:07 +00002020- SPI Support: CONFIG_SPI
2021
2022 Enables SPI driver (so far only tested with
2023 SPI EEPROM, also an instance works with Crystal A/D and
2024 D/As on the SACSng board)
2025
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002026 CONFIG_SH_SPI
2027
2028 Enables the driver for SPI controller on SuperH. Currently
2029 only SH7757 is supported.
2030
wdenkc6097192002-11-03 00:24:07 +00002031 CONFIG_SPI_X
2032
2033 Enables extended (16-bit) SPI EEPROM addressing.
2034 (symmetrical to CONFIG_I2C_X)
2035
2036 CONFIG_SOFT_SPI
2037
wdenk43d96162003-03-06 00:02:04 +00002038 Enables a software (bit-bang) SPI driver rather than
2039 using hardware support. This is a general purpose
2040 driver that only requires three general I/O port pins
2041 (two outputs, one input) to function. If this is
2042 defined, the board configuration must define several
2043 SPI configuration items (port pins to use, etc). For
2044 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002045
Ben Warren04a9e112008-01-16 22:37:35 -05002046 CONFIG_HARD_SPI
2047
2048 Enables a hardware SPI driver for general-purpose reads
2049 and writes. As with CONFIG_SOFT_SPI, the board configuration
2050 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002051 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002052 example, see include/configs/mpc8349emds.h.
2053
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002054 CONFIG_MXC_SPI
2055
2056 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002057 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002058
Matthias Fuchs01335022007-12-27 17:12:34 +01002059- FPGA Support: CONFIG_FPGA
2060
2061 Enables FPGA subsystem.
2062
2063 CONFIG_FPGA_<vendor>
2064
2065 Enables support for specific chip vendors.
2066 (ALTERA, XILINX)
2067
2068 CONFIG_FPGA_<family>
2069
2070 Enables support for FPGA family.
2071 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2072
2073 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002074
wdenk43d96162003-03-06 00:02:04 +00002075 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002076
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002077 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002078
wdenk8bde7f72003-06-27 21:31:46 +00002079 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002081 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002082
wdenk43d96162003-03-06 00:02:04 +00002083 Enable checks on FPGA configuration interface busy
2084 status by the configuration function. This option
2085 will require a board or device specific function to
2086 be written.
wdenkc6097192002-11-03 00:24:07 +00002087
2088 CONFIG_FPGA_DELAY
2089
2090 If defined, a function that provides delays in the FPGA
2091 configuration driver.
2092
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002093 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002094 Allow Control-C to interrupt FPGA configuration
2095
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002096 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002097
wdenk43d96162003-03-06 00:02:04 +00002098 Check for configuration errors during FPGA bitfile
2099 loading. For example, abort during Virtex II
2100 configuration if the INIT_B line goes low (which
2101 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002102
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002103 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002104
wdenk43d96162003-03-06 00:02:04 +00002105 Maximum time to wait for the INIT_B line to deassert
2106 after PROB_B has been deasserted during a Virtex II
2107 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002108 ms.
wdenkc6097192002-11-03 00:24:07 +00002109
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002110 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002111
wdenk43d96162003-03-06 00:02:04 +00002112 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002113 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002115 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002116
wdenk43d96162003-03-06 00:02:04 +00002117 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002118 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002119
2120- Configuration Management:
2121 CONFIG_IDENT_STRING
2122
wdenk43d96162003-03-06 00:02:04 +00002123 If defined, this string will be added to the U-Boot
2124 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002125
2126- Vendor Parameter Protection:
2127
wdenk43d96162003-03-06 00:02:04 +00002128 U-Boot considers the values of the environment
2129 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002130 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002131 are set once by the board vendor / manufacturer, and
2132 protects these variables from casual modification by
2133 the user. Once set, these variables are read-only,
2134 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002135 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002136
2137 If CONFIG_ENV_OVERWRITE is #defined in your config
2138 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002139 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002140 these parameters.
2141
2142 Alternatively, if you #define _both_ CONFIG_ETHADDR
2143 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002144 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002145 which can be changed exactly ONCE by the user. [The
2146 serial# is unaffected by this, i. e. it remains
2147 read-only.]
2148
2149- Protected RAM:
2150 CONFIG_PRAM
2151
2152 Define this variable to enable the reservation of
2153 "protected RAM", i. e. RAM which is not overwritten
2154 by U-Boot. Define CONFIG_PRAM to hold the number of
2155 kB you want to reserve for pRAM. You can overwrite
2156 this default value by defining an environment
2157 variable "pram" to the number of kB you want to
2158 reserve. Note that the board info structure will
2159 still show the full amount of RAM. If pRAM is
2160 reserved, a new environment variable "mem" will
2161 automatically be defined to hold the amount of
2162 remaining RAM in a form that can be passed as boot
2163 argument to Linux, for instance like that:
2164
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002165 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002166 saveenv
2167
2168 This way you can tell Linux not to use this memory,
2169 either, which results in a memory region that will
2170 not be affected by reboots.
2171
2172 *WARNING* If your board configuration uses automatic
2173 detection of the RAM size, you must make sure that
2174 this memory test is non-destructive. So far, the
2175 following board configurations are known to be
2176 "pRAM-clean":
2177
2178 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2179 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002180 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002181
2182- Error Recovery:
2183 CONFIG_PANIC_HANG
2184
2185 Define this variable to stop the system in case of a
2186 fatal error, so that you have to reset it manually.
2187 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002188 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002189 automatically as fast as possible, but it may be
2190 useful during development since you can try to debug
2191 the conditions that lead to the situation.
2192
2193 CONFIG_NET_RETRY_COUNT
2194
wdenk43d96162003-03-06 00:02:04 +00002195 This variable defines the number of retries for
2196 network operations like ARP, RARP, TFTP, or BOOTP
2197 before giving up the operation. If not defined, a
2198 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002199
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002200 CONFIG_ARP_TIMEOUT
2201
2202 Timeout waiting for an ARP reply in milliseconds.
2203
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002204 CONFIG_NFS_TIMEOUT
2205
2206 Timeout in milliseconds used in NFS protocol.
2207 If you encounter "ERROR: Cannot umount" in nfs command,
2208 try longer timeout such as
2209 #define CONFIG_NFS_TIMEOUT 10000UL
2210
wdenkc6097192002-11-03 00:24:07 +00002211- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002212 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002213
2214 Enable auto completion of commands using TAB.
2215
Wolfgang Denka9398e02006-11-27 15:32:42 +01002216 Note that this feature has NOT been implemented yet
2217 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002218
2219
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002220 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002221
2222 Define this variable to enable the "hush" shell (from
2223 Busybox) as command line interpreter, thus enabling
2224 powerful command line syntax like
2225 if...then...else...fi conditionals or `&&' and '||'
2226 constructs ("shell scripts").
2227
2228 If undefined, you get the old, much simpler behaviour
2229 with a somewhat smaller memory footprint.
2230
2231
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002232 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002233
2234 This defines the secondary prompt string, which is
2235 printed when the command interpreter needs more input
2236 to complete a command. Usually "> ".
2237
2238 Note:
2239
wdenk8bde7f72003-06-27 21:31:46 +00002240 In the current implementation, the local variables
2241 space and global environment variables space are
2242 separated. Local variables are those you define by
2243 simply typing `name=value'. To access a local
2244 variable later on, you have write `$name' or
2245 `${name}'; to execute the contents of a variable
2246 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002247
wdenk43d96162003-03-06 00:02:04 +00002248 Global environment variables are those you use
2249 setenv/printenv to work with. To run a command stored
2250 in such a variable, you need to use the run command,
2251 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002252
2253 To store commands and special characters in a
2254 variable, please use double quotation marks
2255 surrounding the whole text of the variable, instead
2256 of the backslashes before semicolons and special
2257 symbols.
2258
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002259- Commandline Editing and History:
2260 CONFIG_CMDLINE_EDITING
2261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002262 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002263 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002264
wdenka8c7c702003-12-06 19:49:23 +00002265- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002266 CONFIG_EXTRA_ENV_SETTINGS
2267
wdenk43d96162003-03-06 00:02:04 +00002268 Define this to contain any number of null terminated
2269 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002270 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002271
wdenk43d96162003-03-06 00:02:04 +00002272 For example, place something like this in your
2273 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002274
2275 #define CONFIG_EXTRA_ENV_SETTINGS \
2276 "myvar1=value1\0" \
2277 "myvar2=value2\0"
2278
wdenk43d96162003-03-06 00:02:04 +00002279 Warning: This method is based on knowledge about the
2280 internal format how the environment is stored by the
2281 U-Boot code. This is NOT an official, exported
2282 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002283 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002284 You better know what you are doing here.
2285
wdenk43d96162003-03-06 00:02:04 +00002286 Note: overly (ab)use of the default environment is
2287 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002288 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002289 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002290
Stephen Warren5e724ca2012-05-22 09:21:54 +00002291 CONFIG_ENV_VARS_UBOOT_CONFIG
2292
2293 Define this in order to add variables describing the
2294 U-Boot build configuration to the default environment.
2295 These will be named arch, cpu, board, vendor, and soc.
2296
2297 Enabling this option will cause the following to be defined:
2298
2299 - CONFIG_SYS_ARCH
2300 - CONFIG_SYS_CPU
2301 - CONFIG_SYS_BOARD
2302 - CONFIG_SYS_VENDOR
2303 - CONFIG_SYS_SOC
2304
wdenka8c7c702003-12-06 19:49:23 +00002305- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002306 CONFIG_HAS_DATAFLASH
2307
wdenk8bde7f72003-06-27 21:31:46 +00002308 Defining this option enables DataFlash features and
2309 allows to read/write in Dataflash via the standard
2310 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002311
Eric Nelsonf61ec452012-01-31 10:52:08 -07002312- Serial Flash support
2313 CONFIG_CMD_SF
2314
2315 Defining this option enables SPI flash commands
2316 'sf probe/read/write/erase/update'.
2317
2318 Usage requires an initial 'probe' to define the serial
2319 flash parameters, followed by read/write/erase/update
2320 commands.
2321
2322 The following defaults may be provided by the platform
2323 to handle the common case when only a single serial
2324 flash is present on the system.
2325
2326 CONFIG_SF_DEFAULT_BUS Bus identifier
2327 CONFIG_SF_DEFAULT_CS Chip-select
2328 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2329 CONFIG_SF_DEFAULT_SPEED in Hz
2330
wdenk3f85ce22004-02-23 16:11:30 +00002331- SystemACE Support:
2332 CONFIG_SYSTEMACE
2333
2334 Adding this option adds support for Xilinx SystemACE
2335 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002336 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002337 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002338
2339 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002340 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002341
2342 When SystemACE support is added, the "ace" device type
2343 becomes available to the fat commands, i.e. fatls.
2344
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002345- TFTP Fixed UDP Port:
2346 CONFIG_TFTP_PORT
2347
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002348 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002349 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002350 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002351 number generator is used.
2352
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002353 Also, the environment variable tftpdstp is used to supply
2354 the TFTP UDP destination port value. If tftpdstp isn't
2355 defined, the normal port 69 is used.
2356
2357 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002358 blindly start the TFTP transfer using the pre-configured
2359 target IP address and UDP port. This has the effect of
2360 "punching through" the (Windows XP) firewall, allowing
2361 the remainder of the TFTP transfer to proceed normally.
2362 A better solution is to properly configure the firewall,
2363 but sometimes that is not allowed.
2364
wdenka8c7c702003-12-06 19:49:23 +00002365- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002366 CONFIG_SHOW_BOOT_PROGRESS
2367
wdenk43d96162003-03-06 00:02:04 +00002368 Defining this option allows to add some board-
2369 specific code (calling a user-provided function
2370 "show_boot_progress(int)") that enables you to show
2371 the system's boot progress on some display (for
2372 example, some LED's) on your board. At the moment,
2373 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002374
Simon Glass3a608ca2012-02-13 13:51:19 +00002375- Detailed boot stage timing
2376 CONFIG_BOOTSTAGE
2377 Define this option to get detailed timing of each stage
2378 of the boot process.
2379
2380 CONFIG_BOOTSTAGE_USER_COUNT
2381 This is the number of available user bootstage records.
2382 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2383 a new ID will be allocated from this stash. If you exceed
2384 the limit, recording will stop.
2385
2386 CONFIG_BOOTSTAGE_REPORT
2387 Define this to print a report before boot, similar to this:
2388
2389 Timer summary in microseconds:
2390 Mark Elapsed Stage
2391 0 0 reset
2392 3,575,678 3,575,678 board_init_f start
2393 3,575,695 17 arch_cpu_init A9
2394 3,575,777 82 arch_cpu_init done
2395 3,659,598 83,821 board_init_r start
2396 3,910,375 250,777 main_loop
2397 29,916,167 26,005,792 bootm_start
2398 30,361,327 445,160 start_kernel
2399
Simon Glass2eba38c2012-09-28 08:56:39 +00002400 CONFIG_CMD_BOOTSTAGE
2401 Add a 'bootstage' command which supports printing a report
2402 and un/stashing of bootstage data.
2403
Simon Glass94fd1312012-09-28 08:56:37 +00002404 CONFIG_BOOTSTAGE_FDT
2405 Stash the bootstage information in the FDT. A root 'bootstage'
2406 node is created with each bootstage id as a child. Each child
2407 has a 'name' property and either 'mark' containing the
2408 mark time in microsecond, or 'accum' containing the
2409 accumulated time for that bootstage id in microseconds.
2410 For example:
2411
2412 bootstage {
2413 154 {
2414 name = "board_init_f";
2415 mark = <3575678>;
2416 };
2417 170 {
2418 name = "lcd";
2419 accum = <33482>;
2420 };
2421 };
2422
2423 Code in the Linux kernel can find this in /proc/devicetree.
2424
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002425Legacy uImage format:
2426
wdenkc6097192002-11-03 00:24:07 +00002427 Arg Where When
2428 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002429 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002430 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002431 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002432 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002433 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002434 4 common/cmd_bootm.c Image data has correct checksum
2435 -4 common/cmd_bootm.c Image is for unsupported architecture
2436 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002437 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002438 6 common/cmd_bootm.c Image Type check OK
2439 -6 common/cmd_bootm.c gunzip uncompression error
2440 -7 common/cmd_bootm.c Unimplemented compression type
2441 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002442 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002443 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002444
2445 9 common/image.c Start initial ramdisk verification
2446 -10 common/image.c Ramdisk header has bad magic number
2447 -11 common/image.c Ramdisk header has bad checksum
2448 10 common/image.c Ramdisk header is OK
2449 -12 common/image.c Ramdisk data has bad checksum
2450 11 common/image.c Ramdisk data has correct checksum
2451 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002452 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002453 13 common/image.c Start multifile image verification
2454 14 common/image.c No initial ramdisk, no multifile, continue.
2455
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002456 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002457
Stefan Roesea47a12b2010-04-15 16:07:28 +02002458 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002459 -31 post/post.c POST test failed, detected by post_output_backlog()
2460 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002461
Heiko Schocher566a4942007-06-22 19:11:54 +02002462 34 common/cmd_doc.c before loading a Image from a DOC device
2463 -35 common/cmd_doc.c Bad usage of "doc" command
2464 35 common/cmd_doc.c correct usage of "doc" command
2465 -36 common/cmd_doc.c No boot device
2466 36 common/cmd_doc.c correct boot device
2467 -37 common/cmd_doc.c Unknown Chip ID on boot device
2468 37 common/cmd_doc.c correct chip ID found, device available
2469 -38 common/cmd_doc.c Read Error on boot device
2470 38 common/cmd_doc.c reading Image header from DOC device OK
2471 -39 common/cmd_doc.c Image header has bad magic number
2472 39 common/cmd_doc.c Image header has correct magic number
2473 -40 common/cmd_doc.c Error reading Image from DOC device
2474 40 common/cmd_doc.c Image header has correct magic number
2475 41 common/cmd_ide.c before loading a Image from a IDE device
2476 -42 common/cmd_ide.c Bad usage of "ide" command
2477 42 common/cmd_ide.c correct usage of "ide" command
2478 -43 common/cmd_ide.c No boot device
2479 43 common/cmd_ide.c boot device found
2480 -44 common/cmd_ide.c Device not available
2481 44 common/cmd_ide.c Device available
2482 -45 common/cmd_ide.c wrong partition selected
2483 45 common/cmd_ide.c partition selected
2484 -46 common/cmd_ide.c Unknown partition table
2485 46 common/cmd_ide.c valid partition table found
2486 -47 common/cmd_ide.c Invalid partition type
2487 47 common/cmd_ide.c correct partition type
2488 -48 common/cmd_ide.c Error reading Image Header on boot device
2489 48 common/cmd_ide.c reading Image Header from IDE device OK
2490 -49 common/cmd_ide.c Image header has bad magic number
2491 49 common/cmd_ide.c Image header has correct magic number
2492 -50 common/cmd_ide.c Image header has bad checksum
2493 50 common/cmd_ide.c Image header has correct checksum
2494 -51 common/cmd_ide.c Error reading Image from IDE device
2495 51 common/cmd_ide.c reading Image from IDE device OK
2496 52 common/cmd_nand.c before loading a Image from a NAND device
2497 -53 common/cmd_nand.c Bad usage of "nand" command
2498 53 common/cmd_nand.c correct usage of "nand" command
2499 -54 common/cmd_nand.c No boot device
2500 54 common/cmd_nand.c boot device found
2501 -55 common/cmd_nand.c Unknown Chip ID on boot device
2502 55 common/cmd_nand.c correct chip ID found, device available
2503 -56 common/cmd_nand.c Error reading Image Header on boot device
2504 56 common/cmd_nand.c reading Image Header from NAND device OK
2505 -57 common/cmd_nand.c Image header has bad magic number
2506 57 common/cmd_nand.c Image header has correct magic number
2507 -58 common/cmd_nand.c Error reading Image from NAND device
2508 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002509
Heiko Schocher566a4942007-06-22 19:11:54 +02002510 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002511
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002512 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002513 -64 net/eth.c no Ethernet found.
2514 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002515
Heiko Schocher566a4942007-06-22 19:11:54 +02002516 -80 common/cmd_net.c usage wrong
2517 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002518 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002519 81 common/cmd_net.c NetLoop() back without error
2520 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2521 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002522 83 common/cmd_net.c running "source" command
2523 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002524 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002525
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002526FIT uImage format:
2527
2528 Arg Where When
2529 100 common/cmd_bootm.c Kernel FIT Image has correct format
2530 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2531 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2532 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2533 102 common/cmd_bootm.c Kernel unit name specified
2534 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002535 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002536 104 common/cmd_bootm.c Got kernel subimage node offset
2537 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2538 105 common/cmd_bootm.c Kernel subimage hash verification OK
2539 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2540 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002541 -106 common/cmd_bootm.c Kernel subimage has wrong type
2542 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002543 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2544 108 common/cmd_bootm.c Got kernel subimage data/size
2545 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2546 -109 common/cmd_bootm.c Can't get kernel subimage type
2547 -110 common/cmd_bootm.c Can't get kernel subimage comp
2548 -111 common/cmd_bootm.c Can't get kernel subimage os
2549 -112 common/cmd_bootm.c Can't get kernel subimage load address
2550 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2551
2552 120 common/image.c Start initial ramdisk verification
2553 -120 common/image.c Ramdisk FIT image has incorrect format
2554 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002555 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002556 -122 common/image.c Can't get configuration for ramdisk subimage
2557 123 common/image.c Ramdisk unit name specified
2558 -124 common/image.c Can't get ramdisk subimage node offset
2559 125 common/image.c Got ramdisk subimage node offset
2560 -125 common/image.c Ramdisk subimage hash verification failed
2561 126 common/image.c Ramdisk subimage hash verification OK
2562 -126 common/image.c Ramdisk subimage for unsupported architecture
2563 127 common/image.c Architecture check OK
2564 -127 common/image.c Can't get ramdisk subimage data/size
2565 128 common/image.c Got ramdisk subimage data/size
2566 129 common/image.c Can't get ramdisk load address
2567 -129 common/image.c Got ramdisk load address
2568
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002569 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002570 131 common/cmd_doc.c FIT image format OK
2571
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002572 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002573 141 common/cmd_ide.c FIT image format OK
2574
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002575 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002576 151 common/cmd_nand.c FIT image format OK
2577
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002578- Standalone program support:
2579 CONFIG_STANDALONE_LOAD_ADDR
2580
Wolfgang Denk6feff892011-10-09 21:06:34 +02002581 This option defines a board specific value for the
2582 address where standalone program gets loaded, thus
2583 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002584 settings.
2585
2586- Frame Buffer Address:
2587 CONFIG_FB_ADDR
2588
2589 Define CONFIG_FB_ADDR if you want to use specific
2590 address for frame buffer.
2591 Then system will reserve the frame buffer address to
2592 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002593 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002594
2595 Please see board_init_f function.
2596
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002597- Automatic software updates via TFTP server
2598 CONFIG_UPDATE_TFTP
2599 CONFIG_UPDATE_TFTP_CNT_MAX
2600 CONFIG_UPDATE_TFTP_MSEC_MAX
2601
2602 These options enable and control the auto-update feature;
2603 for a more detailed description refer to doc/README.update.
2604
2605- MTD Support (mtdparts command, UBI support)
2606 CONFIG_MTD_DEVICE
2607
2608 Adds the MTD device infrastructure from the Linux kernel.
2609 Needed for mtdparts command support.
2610
2611 CONFIG_MTD_PARTITIONS
2612
2613 Adds the MTD partitioning infrastructure from the Linux
2614 kernel. Needed for UBI support.
2615
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002616- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002617 CONFIG_SPL
2618 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002619
Tom Rini95579792012-02-14 07:29:40 +00002620 CONFIG_SPL_LDSCRIPT
2621 LDSCRIPT for linking the SPL binary.
2622
2623 CONFIG_SPL_MAX_SIZE
2624 Maximum binary size (text, data and rodata) of the SPL binary.
2625
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002626 CONFIG_SPL_TEXT_BASE
2627 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002628
Tom Rini95579792012-02-14 07:29:40 +00002629 CONFIG_SPL_BSS_START_ADDR
2630 Link address for the BSS within the SPL binary.
2631
2632 CONFIG_SPL_BSS_MAX_SIZE
2633 Maximum binary size of the BSS section of the SPL binary.
2634
2635 CONFIG_SPL_STACK
2636 Adress of the start of the stack SPL will use
2637
2638 CONFIG_SYS_SPL_MALLOC_START
2639 Starting address of the malloc pool used in SPL.
2640
2641 CONFIG_SYS_SPL_MALLOC_SIZE
2642 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002643
Tom Rini47f7bca2012-08-13 12:03:19 -07002644 CONFIG_SPL_FRAMEWORK
2645 Enable the SPL framework under common/. This framework
2646 supports MMC, NAND and YMODEM loading of U-Boot and NAND
2647 NAND loading of the Linux Kernel.
2648
Tom Rini861a86f2012-08-13 11:37:56 -07002649 CONFIG_SPL_DISPLAY_PRINT
2650 For ARM, enable an optional function to print more information
2651 about the running system.
2652
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002653 CONFIG_SPL_LIBCOMMON_SUPPORT
2654 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002655
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002656 CONFIG_SPL_LIBDISK_SUPPORT
2657 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002658
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002659 CONFIG_SPL_I2C_SUPPORT
2660 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002661
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002662 CONFIG_SPL_GPIO_SUPPORT
2663 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002664
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002665 CONFIG_SPL_MMC_SUPPORT
2666 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002667
Tom Rini95579792012-02-14 07:29:40 +00002668 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2669 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2670 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2671 Address, size and partition on the MMC to load U-Boot from
2672 when the MMC is being used in raw mode.
2673
2674 CONFIG_SPL_FAT_SUPPORT
2675 Support for fs/fat/libfat.o in SPL binary
2676
2677 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2678 Filename to read to load U-Boot when reading from FAT
2679
2680 CONFIG_SPL_NAND_SIMPLE
2681 Support for drivers/mtd/nand/libnand.o in SPL binary
2682
2683 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2684 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2685 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2686 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2687 CONFIG_SYS_NAND_ECCBYTES
2688 Defines the size and behavior of the NAND that SPL uses
2689 to read U-Boot with CONFIG_SPL_NAND_SIMPLE
2690
2691 CONFIG_SYS_NAND_U_BOOT_OFFS
2692 Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
2693 from.
2694
2695 CONFIG_SYS_NAND_U_BOOT_START
2696 Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
2697 to.
2698
2699 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2700 Define this if you need to first read the OOB and then the
2701 data. This is used for example on davinci plattforms.
2702
2703 CONFIG_SPL_OMAP3_ID_NAND
2704 Support for an OMAP3-specific set of functions to return the
2705 ID and MFR of the first attached NAND chip, if present.
2706
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002707 CONFIG_SPL_SERIAL_SUPPORT
2708 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002709
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002710 CONFIG_SPL_SPI_FLASH_SUPPORT
2711 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002712
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002713 CONFIG_SPL_SPI_SUPPORT
2714 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002715
Pavel Machekc57b9532012-08-30 22:42:11 +02002716 CONFIG_SPL_RAM_DEVICE
2717 Support for running image already present in ram, in SPL binary
2718
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002719 CONFIG_SPL_LIBGENERIC_SUPPORT
2720 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002721
wdenkc6097192002-11-03 00:24:07 +00002722Modem Support:
2723--------------
2724
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002725[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002726
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002727- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002728 CONFIG_MODEM_SUPPORT
2729
2730- RTS/CTS Flow control enable:
2731 CONFIG_HWFLOW
2732
2733- Modem debug support:
2734 CONFIG_MODEM_SUPPORT_DEBUG
2735
wdenk43d96162003-03-06 00:02:04 +00002736 Enables debugging stuff (char screen[1024], dbg())
2737 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002738
wdenka8c7c702003-12-06 19:49:23 +00002739- Interrupt support (PPC):
2740
wdenkd4ca31c2004-01-02 14:00:00 +00002741 There are common interrupt_init() and timer_interrupt()
2742 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002743 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002744 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002745 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002746 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002747 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002748 specific handling. If board has watchdog / status_led
2749 / other_activity_monitor it works automatically from
2750 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002751
wdenkc6097192002-11-03 00:24:07 +00002752- General:
2753
wdenk43d96162003-03-06 00:02:04 +00002754 In the target system modem support is enabled when a
2755 specific key (key combination) is pressed during
2756 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002757 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002758 board_init(). Currently key_pressed() is a dummy
2759 function, returning 1 and thus enabling modem
2760 initialization.
wdenkc6097192002-11-03 00:24:07 +00002761
wdenk43d96162003-03-06 00:02:04 +00002762 If there are no modem init strings in the
2763 environment, U-Boot proceed to autoboot; the
2764 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002765 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002766
2767 See also: doc/README.Modem
2768
Helmut Raiger9660e442011-10-20 04:19:47 +00002769Board initialization settings:
2770------------------------------
2771
2772During Initialization u-boot calls a number of board specific functions
2773to allow the preparation of board specific prerequisites, e.g. pin setup
2774before drivers are initialized. To enable these callbacks the
2775following configuration macros have to be defined. Currently this is
2776architecture specific, so please check arch/your_architecture/lib/board.c
2777typically in board_init_f() and board_init_r().
2778
2779- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2780- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2781- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2782- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002783
wdenkc6097192002-11-03 00:24:07 +00002784Configuration Settings:
2785-----------------------
2786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002787- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002788 undefine this when you're short of memory.
2789
Peter Tyser2fb26042009-01-27 18:03:12 -06002790- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2791 width of the commands listed in the 'help' command output.
2792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002793- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002794 prompt for user input.
2795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002796- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002797
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002798- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002799
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002800- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002801
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002802- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002803 the application (usually a Linux kernel) when it is
2804 booted
2805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002806- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002807 List of legal baudrate settings for this board.
2808
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002809- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002810 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002811
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002812- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002813 If the board specific function
2814 extern int overwrite_console (void);
2815 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002816 serial port, else the settings in the environment are used.
2817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002818- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002819 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002820
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002821- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002822 Enable overwrite of previous console environment settings.
2823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002824- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002825 Begin and End addresses of the area used by the
2826 simple memory test.
2827
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002828- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002829 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002830
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002831- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002832 Scratch address used by the alternate memory test
2833 You only need to set this if address zero isn't writeable
2834
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002835- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2836 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002837 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002838 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002839 fixing up gd->ram_size the Linux kernel should gets passed
2840 the now "corrected" memory size and won't touch it either.
2841 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002842 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002843 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002844 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002845
2846 This option can be used as a workaround for the 440EPx/GRx
2847 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2848 be touched.
2849
2850 WARNING: Please make sure that this value is a multiple of
2851 the Linux page size (normally 4k). If this is not the case,
2852 then the end address of the Linux memory will be located at a
2853 non page size aligned address and this could cause major
2854 problems.
2855
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002856- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002857 Default load address for network file downloads
2858
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002859- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002860 Enable temporary baudrate change while serial download
2861
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002862- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002863 Physical start address of SDRAM. _Must_ be 0 here.
2864
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002865- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002866 Physical start address of Motherboard I/O (if using a
2867 Cogent motherboard)
2868
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002869- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002870 Physical start address of Flash memory.
2871
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002872- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002873 Physical start address of boot monitor code (set by
2874 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002875 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002876 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002877
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002878- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002879 Size of memory reserved for monitor code, used to
2880 determine _at_compile_time_ (!) if the environment is
2881 embedded within the U-Boot image, or in a separate
2882 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002883
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002884- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002885 Size of DRAM reserved for malloc() use.
2886
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002887- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002888 Normally compressed uImages are limited to an
2889 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002890 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002891 to adjust this setting to your needs.
2892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002893- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002894 Maximum size of memory mapped by the startup code of
2895 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002896 the Linux kernel (bd_info, boot arguments, FDT blob if
2897 used) must be put below this limit, unless "bootm_low"
2898 enviroment variable is defined and non-zero. In such case
2899 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002900 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002901 variable "bootm_mapsize" will override the value of
2902 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2903 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002904
John Rigbyfca43cc2010-10-13 13:57:35 -06002905- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2906 Enable initrd_high functionality. If defined then the
2907 initrd_high feature is enabled and the bootm ramdisk subcommand
2908 is enabled.
2909
2910- CONFIG_SYS_BOOT_GET_CMDLINE:
2911 Enables allocating and saving kernel cmdline in space between
2912 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2913
2914- CONFIG_SYS_BOOT_GET_KBD:
2915 Enables allocating and saving a kernel copy of the bd_info in
2916 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002918- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002919 Max number of Flash memory banks
2920
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002921- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002922 Max number of sectors on a Flash chip
2923
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002924- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002925 Timeout for Flash erase operations (in ms)
2926
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002927- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002928 Timeout for Flash write operations (in ms)
2929
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002930- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002931 Timeout for Flash set sector lock bit operation (in ms)
2932
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002933- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002934 Timeout for Flash clear lock bits operation (in ms)
2935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002936- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002937 If defined, hardware flash sectors protection is used
2938 instead of U-Boot software protection.
2939
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002940- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002941
2942 Enable TFTP transfers directly to flash memory;
2943 without this option such a download has to be
2944 performed in two steps: (1) download to RAM, and (2)
2945 copy from RAM to flash.
2946
2947 The two-step approach is usually more reliable, since
2948 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002949 the flash, but in some situations (when system RAM is
2950 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002951 downloaded image) this option may be very useful.
2952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002953- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002954 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002955 common flash structure for storing flash geometry.
2956
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002957- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002958 This option also enables the building of the cfi_flash driver
2959 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002960
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002961- CONFIG_FLASH_CFI_MTD
2962 This option enables the building of the cfi_mtd driver
2963 in the drivers directory. The driver exports CFI flash
2964 to the MTD layer.
2965
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002966- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002967 Use buffered writes to flash.
2968
2969- CONFIG_FLASH_SPANSION_S29WS_N
2970 s29ws-n MirrorBit flash has non-standard addresses for buffered
2971 write commands.
2972
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002973- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002974 If this option is defined, the common CFI flash doesn't
2975 print it's warning upon not recognized FLASH banks. This
2976 is useful, if some of the configured banks are only
2977 optionally available.
2978
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002979- CONFIG_FLASH_SHOW_PROGRESS
2980 If defined (must be an integer), print out countdown
2981 digits and dots. Recommended value: 45 (9..1) for 80
2982 column displays, 15 (3..1) for 40 column displays.
2983
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002984- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002985 Defines the number of Ethernet receive buffers. On some
2986 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002987 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2988 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002989 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002990 Defaults to 4 if not defined.
2991
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002992- CONFIG_ENV_MAX_ENTRIES
2993
Wolfgang Denk071bc922010-10-27 22:48:30 +02002994 Maximum number of entries in the hash table that is used
2995 internally to store the environment settings. The default
2996 setting is supposed to be generous and should work in most
2997 cases. This setting can be used to tune behaviour; see
2998 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002999
wdenkc6097192002-11-03 00:24:07 +00003000The following definitions that deal with the placement and management
3001of environment data (variable area); in general, we support the
3002following configurations:
3003
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00003004- CONFIG_BUILD_ENVCRC:
3005
3006 Builds up envcrc with the target environment so that external utils
3007 may easily extract it and embed it in final U-Boot images.
3008
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003009- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003010
3011 Define this if the environment is in flash memory.
3012
3013 a) The environment occupies one whole flash sector, which is
3014 "embedded" in the text segment with the U-Boot code. This
3015 happens usually with "bottom boot sector" or "top boot
3016 sector" type flash chips, which have several smaller
3017 sectors at the start or the end. For instance, such a
3018 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3019 such a case you would place the environment in one of the
3020 4 kB sectors - with U-Boot code before and after it. With
3021 "top boot sector" type flash chips, you would put the
3022 environment in one of the last sectors, leaving a gap
3023 between U-Boot and the environment.
3024
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003025 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003026
3027 Offset of environment data (variable area) to the
3028 beginning of flash memory; for instance, with bottom boot
3029 type flash chips the second sector can be used: the offset
3030 for this sector is given here.
3031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003032 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003033
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003034 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003035
3036 This is just another way to specify the start address of
3037 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003038 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003039
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003040 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003041
3042 Size of the sector containing the environment.
3043
3044
3045 b) Sometimes flash chips have few, equal sized, BIG sectors.
3046 In such a case you don't want to spend a whole sector for
3047 the environment.
3048
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003049 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003050
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02003051 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003052 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003053 of this flash sector for the environment. This saves
3054 memory for the RAM copy of the environment.
3055
3056 It may also save flash memory if you decide to use this
3057 when your environment is "embedded" within U-Boot code,
3058 since then the remainder of the flash sector could be used
3059 for U-Boot code. It should be pointed out that this is
3060 STRONGLY DISCOURAGED from a robustness point of view:
3061 updating the environment in flash makes it always
3062 necessary to erase the WHOLE sector. If something goes
3063 wrong before the contents has been restored from a copy in
3064 RAM, your target system will be dead.
3065
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003066 - CONFIG_ENV_ADDR_REDUND
3067 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003068
wdenk43d96162003-03-06 00:02:04 +00003069 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003070 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00003071 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00003072 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003073
3074BE CAREFUL! Any changes to the flash layout, and some changes to the
3075source code will make it necessary to adapt <board>/u-boot.lds*
3076accordingly!
3077
3078
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02003079- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003080
3081 Define this if you have some non-volatile memory device
3082 (NVRAM, battery buffered SRAM) which you want to use for the
3083 environment.
3084
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003085 - CONFIG_ENV_ADDR:
3086 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003087
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003088 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003089 want to use for environment. It is assumed that this memory
3090 can just be read and written to, without any special
3091 provision.
3092
3093BE CAREFUL! The first access to the environment happens quite early
3094in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003095console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003096U-Boot will hang.
3097
3098Please note that even with NVRAM we still use a copy of the
3099environment in RAM: we could work on NVRAM directly, but we want to
3100keep settings there always unmodified except somebody uses "saveenv"
3101to save the current settings.
3102
3103
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02003104- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003105
3106 Use this if you have an EEPROM or similar serial access
3107 device and a driver for it.
3108
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003109 - CONFIG_ENV_OFFSET:
3110 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003111
3112 These two #defines specify the offset and size of the
3113 environment area within the total memory of your EEPROM.
3114
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003115 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003116 If defined, specified the chip address of the EEPROM device.
3117 The default address is zero.
3118
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003119 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003120 If defined, the number of bits used to address bytes in a
3121 single page in the EEPROM device. A 64 byte page, for example
3122 would require six bits.
3123
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003124 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003125 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003126 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003127
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003128 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003129 The length in bytes of the EEPROM memory array address. Note
3130 that this is NOT the chip address length!
3131
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003132 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003133 EEPROM chips that implement "address overflow" are ones
3134 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3135 address and the extra bits end up in the "chip address" bit
3136 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3137 byte chips.
3138
3139 Note that we consider the length of the address field to
3140 still be one byte because the extra address bits are hidden
3141 in the chip address.
3142
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003143 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003144 The size in bytes of the EEPROM device.
3145
Heiko Schocher548738b2010-01-07 08:55:40 +01003146 - CONFIG_ENV_EEPROM_IS_ON_I2C
3147 define this, if you have I2C and SPI activated, and your
3148 EEPROM, which holds the environment, is on the I2C bus.
3149
3150 - CONFIG_I2C_ENV_EEPROM_BUS
3151 if you have an Environment on an EEPROM reached over
3152 I2C muxes, you can define here, how to reach this
3153 EEPROM. For example:
3154
Wolfgang Denka9046b92010-06-13 17:48:15 +02003155 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003156
3157 EEPROM which holds the environment, is reached over
3158 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003159
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003160- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003161
wdenkd4ca31c2004-01-02 14:00:00 +00003162 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003163 want to use for the environment.
3164
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003165 - CONFIG_ENV_OFFSET:
3166 - CONFIG_ENV_ADDR:
3167 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003168
3169 These three #defines specify the offset and size of the
3170 environment area within the total memory of your DataFlash placed
3171 at the specified address.
3172
Liu Gang0a85a9e2012-03-08 00:33:20 +00003173- CONFIG_ENV_IS_IN_REMOTE:
3174
3175 Define this if you have a remote memory space which you
3176 want to use for the local device's environment.
3177
3178 - CONFIG_ENV_ADDR:
3179 - CONFIG_ENV_SIZE:
3180
3181 These two #defines specify the address and size of the
3182 environment area within the remote memory space. The
3183 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00003184 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003185
3186BE CAREFUL! For some special cases, the local device can not use
3187"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00003188environment stored in a remote NOR flash by SRIO or PCIE link,
3189but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00003190
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003191- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003192
3193 Define this if you have a NAND device which you want to use
3194 for the environment.
3195
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003196 - CONFIG_ENV_OFFSET:
3197 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003198
3199 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003200 area within the first NAND device. CONFIG_ENV_OFFSET must be
3201 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003202
Scott Woodfdd813d2010-09-17 14:38:37 -05003203 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003204
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003205 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003206 size used to hold a redundant copy of the environment data, so
3207 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003208 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003209 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003210
Scott Woodfdd813d2010-09-17 14:38:37 -05003211 - CONFIG_ENV_RANGE (optional):
3212
3213 Specifies the length of the region in which the environment
3214 can be written. This should be a multiple of the NAND device's
3215 block size. Specifying a range with more erase blocks than
3216 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3217 the range to be avoided.
3218
3219 - CONFIG_ENV_OFFSET_OOB (optional):
3220
3221 Enables support for dynamically retrieving the offset of the
3222 environment from block zero's out-of-band data. The
3223 "nand env.oob" command can be used to record this offset.
3224 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3225 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003226
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003227- CONFIG_NAND_ENV_DST
3228
3229 Defines address in RAM to which the nand_spl code should copy the
3230 environment. If redundant environment is used, it will be copied to
3231 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3232
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003233- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003234
3235 Defines offset to the initial SPI buffer area in DPRAM. The
3236 area is used at an early stage (ROM part) if the environment
3237 is configured to reside in the SPI EEPROM: We need a 520 byte
3238 scratch DPRAM area. It is used between the two initialization
3239 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3240 to be a good choice since it makes it far enough from the
3241 start of the data area as well as from the stack pointer.
3242
Bruce Adlere881cb52007-11-02 13:15:42 -07003243Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003244has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003245created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003246until then to read environment variables.
3247
wdenk85ec0bc2003-03-31 16:34:49 +00003248The environment is protected by a CRC32 checksum. Before the monitor
3249is relocated into RAM, as a result of a bad CRC you will be working
3250with the compiled-in default environment - *silently*!!! [This is
3251necessary, because the first environment variable we need is the
3252"baudrate" setting for the console - if we have a bad CRC, we don't
3253have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003254
3255Note: once the monitor has been relocated, then it will complain if
3256the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003257use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003258
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003259- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003260 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003261
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003262 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003263 also needs to be defined.
3264
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003265- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003266 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003267
Ron Madridf5675aa2009-02-18 14:30:44 -08003268- CONFIG_NS16550_MIN_FUNCTIONS:
3269 Define this if you desire to only have use of the NS16550_init
3270 and NS16550_putc functions for the serial driver located at
3271 drivers/serial/ns16550.c. This option is useful for saving
3272 space for already greatly restricted images, including but not
3273 limited to NAND_SPL configurations.
3274
wdenkc6097192002-11-03 00:24:07 +00003275Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003276---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003278- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003279 Cache Line Size of the CPU.
3280
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003281- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003282 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003283
wdenk42d1f032003-10-15 23:53:47 +00003284 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3285 and RPXsuper) to be able to adjust the position of
3286 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003287
Timur Tabie46fedf2011-08-04 18:03:41 -05003288- CONFIG_SYS_CCSRBAR_DEFAULT:
3289 Default (power-on reset) physical address of CCSR on Freescale
3290 PowerPC SOCs.
3291
3292- CONFIG_SYS_CCSRBAR:
3293 Virtual address of CCSR. On a 32-bit build, this is typically
3294 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3295
3296 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3297 for cross-platform code that uses that macro instead.
3298
3299- CONFIG_SYS_CCSRBAR_PHYS:
3300 Physical address of CCSR. CCSR can be relocated to a new
3301 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003302 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003303 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3304 is typically relocated on 36-bit builds. It is recommended
3305 that this macro be defined via the _HIGH and _LOW macros:
3306
3307 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3308 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3309
3310- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003311 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3312 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003313 used in assembly code, so it must not contain typecasts or
3314 integer size suffixes (e.g. "ULL").
3315
3316- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3317 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3318 used in assembly code, so it must not contain typecasts or
3319 integer size suffixes (e.g. "ULL").
3320
3321- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3322 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3323 forced to a value that ensures that CCSR is not relocated.
3324
wdenk7f6c2cb2002-11-10 22:06:23 +00003325- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003326 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003327
3328 the default drive number (default value 0)
3329
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003330 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003331
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003332 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003333 (default value 1)
3334
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003335 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003336
wdenk43d96162003-03-06 00:02:04 +00003337 defines the offset of register from address. It
3338 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003339 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003340
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003341 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3342 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003343 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003345 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003346 fdc_hw_init() is called at the beginning of the FDC
3347 setup. fdc_hw_init() must be provided by the board
3348 source code. It is used to make hardware dependant
3349 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003350
Macpaul Lin0abddf82011-04-11 20:45:32 +00003351- CONFIG_IDE_AHB:
3352 Most IDE controllers were designed to be connected with PCI
3353 interface. Only few of them were designed for AHB interface.
3354 When software is doing ATA command and data transfer to
3355 IDE devices through IDE-AHB controller, some additional
3356 registers accessing to these kind of IDE-AHB controller
3357 is requierd.
3358
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003359- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003360 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003361 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003362
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003363- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003364
wdenk7152b1d2003-09-05 23:19:14 +00003365 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003366 initial data and stack; please note that this must be
3367 writable memory that is working WITHOUT special
3368 initialization, i. e. you CANNOT use normal RAM which
3369 will become available only after programming the
3370 memory controller and running certain initialization
3371 sequences.
3372
3373 U-Boot uses the following memory types:
3374 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3375 - MPC824X: data cache
3376 - PPC4xx: data cache
3377
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003378- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003379
3380 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003381 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3382 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003383 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003384 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003385 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3386 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3387 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003388
3389 Note:
3390 On the MPC824X (or other systems that use the data
3391 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003392 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003393 point to an otherwise UNUSED address space between
3394 the top of RAM and the start of the PCI space.
3395
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003396- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003397
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003398- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003399
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003400- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003401
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003402- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003404- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003405
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003406- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003407
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003408- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003409 SDRAM timing
3410
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003411- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003412 periodic timer for refresh
3413
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003414- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003415
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003416- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3417 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3418 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3419 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003420 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3421
3422- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003423 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3424 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003425 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3426
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003427- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3428 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003429 Machine Mode Register and Memory Periodic Timer
3430 Prescaler definitions (SDRAM timing)
3431
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003432- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003433 enable I2C microcode relocation patch (MPC8xx);
3434 define relocation offset in DPRAM [DSP2]
3435
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003436- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003437 enable SMC microcode relocation patch (MPC8xx);
3438 define relocation offset in DPRAM [SMC1]
3439
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003440- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003441 enable SPI microcode relocation patch (MPC8xx);
3442 define relocation offset in DPRAM [SCC4]
3443
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003444- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003445 Use OSCM clock mode on MBX8xx board. Be careful,
3446 wrong setting might damage your board. Read
3447 doc/README.MBX before setting this variable!
3448
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003449- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003450 Offset of the bootmode word in DPRAM used by post
3451 (Power On Self Tests). This definition overrides
3452 #define'd default value in commproc.h resp.
3453 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003454
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003455- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3456 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3457 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3458 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3459 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3460 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3461 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3462 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003463 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003464
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003465- CONFIG_PCI_DISABLE_PCIE:
3466 Disable PCI-Express on systems where it is supported but not
3467 required.
3468
Andrew Sharp69fd2d32012-08-29 14:16:32 +00003469- CONFIG_PCI_ENUM_ONLY
3470 Only scan through and get the devices on the busses.
3471 Don't do any setup work, presumably because someone or
3472 something has already done it, and we don't need to do it
3473 a second time. Useful for platforms that are pre-booted
3474 by coreboot or similar.
3475
Kumar Galaa09b9b62010-12-30 12:09:53 -06003476- CONFIG_SYS_SRIO:
3477 Chip has SRIO or not
3478
3479- CONFIG_SRIO1:
3480 Board has SRIO 1 port available
3481
3482- CONFIG_SRIO2:
3483 Board has SRIO 2 port available
3484
3485- CONFIG_SYS_SRIOn_MEM_VIRT:
3486 Virtual Address of SRIO port 'n' memory region
3487
3488- CONFIG_SYS_SRIOn_MEM_PHYS:
3489 Physical Address of SRIO port 'n' memory region
3490
3491- CONFIG_SYS_SRIOn_MEM_SIZE:
3492 Size of SRIO port 'n' memory region
3493
Alex Watermaneced4622011-05-19 15:08:36 -04003494- CONFIG_SYS_NDFC_16
3495 Defined to tell the NDFC that the NAND chip is using a
3496 16 bit bus.
3497
3498- CONFIG_SYS_NDFC_EBC0_CFG
3499 Sets the EBC0_CFG register for the NDFC. If not defined
3500 a default value will be used.
3501
Ben Warrenbb99ad62006-09-07 16:50:54 -04003502- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003503 Get DDR timing information from an I2C EEPROM. Common
3504 with pluggable memory modules such as SODIMMs
3505
Ben Warrenbb99ad62006-09-07 16:50:54 -04003506 SPD_EEPROM_ADDRESS
3507 I2C address of the SPD EEPROM
3508
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003509- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003510 If SPD EEPROM is on an I2C bus other than the first
3511 one, specify here. Note that the value must resolve
3512 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003513
York Sun1b3e3c42011-06-07 09:42:16 +08003514- CONFIG_SYS_DDR_RAW_TIMING
3515 Get DDR timing information from other than SPD. Common with
3516 soldered DDR chips onboard without SPD. DDR raw timing
3517 parameters are extracted from datasheet and hard-coded into
3518 header files or board specific files.
3519
York Sun6f5e1dc2011-09-16 13:21:35 -07003520- CONFIG_FSL_DDR_INTERACTIVE
3521 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3522
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003523- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003524 Only for 83xx systems. If specified, then DDR should
3525 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003526
wdenkc26e4542004-04-18 10:13:26 +00003527- CONFIG_ETHER_ON_FEC[12]
3528 Define to enable FEC[12] on a 8xx series processor.
3529
3530- CONFIG_FEC[12]_PHY
3531 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003532 to the given FEC; i. e.
3533 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003534 means that the PHY with address 4 is connected to FEC1
3535
3536 When set to -1, means to probe for first available.
3537
3538- CONFIG_FEC[12]_PHY_NORXERR
3539 The PHY does not have a RXERR line (RMII only).
3540 (so program the FEC to ignore it).
3541
3542- CONFIG_RMII
3543 Enable RMII mode for all FECs.
3544 Note that this is a global option, we can't
3545 have one FEC in standard MII mode and another in RMII mode.
3546
wdenk5cf91d62004-04-23 20:32:05 +00003547- CONFIG_CRC32_VERIFY
3548 Add a verify option to the crc32 command.
3549 The syntax is:
3550
3551 => crc32 -v <address> <count> <crc32>
3552
3553 Where address/count indicate a memory area
3554 and crc32 is the correct crc32 which the
3555 area should have.
3556
wdenk56523f12004-07-11 17:40:54 +00003557- CONFIG_LOOPW
3558 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003559 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003560
stroese7b466642004-12-16 18:46:55 +00003561- CONFIG_MX_CYCLIC
3562 Add the "mdc" and "mwc" memory commands. These are cyclic
3563 "md/mw" commands.
3564 Examples:
3565
wdenkefe2a4d2004-12-16 21:44:03 +00003566 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003567 This command will print 4 bytes (10,11,12,13) each 500 ms.
3568
wdenkefe2a4d2004-12-16 21:44:03 +00003569 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003570 This command will write 12345678 to address 100 all 10 ms.
3571
wdenkefe2a4d2004-12-16 21:44:03 +00003572 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003573 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003574
wdenk8aa1a2d2005-04-04 12:44:11 +00003575- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003576 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003577 low level initializations (like setting up the memory
3578 controller) are omitted and/or U-Boot does not
3579 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003580
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003581 Normally this variable MUST NOT be defined. The only
3582 exception is when U-Boot is loaded (to RAM) by some
3583 other boot loader or by a debugger which performs
3584 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003585
Aneesh V401bb302011-07-13 05:11:07 +00003586- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003587 Modifies the behaviour of start.S when compiling a loader
3588 that is executed before the actual U-Boot. E.g. when
3589 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003590
Matthias Weisserd8834a12011-03-10 21:36:32 +00003591- CONFIG_USE_ARCH_MEMCPY
3592 CONFIG_USE_ARCH_MEMSET
3593 If these options are used a optimized version of memcpy/memset will
3594 be used if available. These functions may be faster under some
3595 conditions but may increase the binary size.
3596
Timur Tabif2717b42011-11-22 09:21:25 -06003597Freescale QE/FMAN Firmware Support:
3598-----------------------------------
3599
3600The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3601loading of "firmware", which is encoded in the QE firmware binary format.
3602This firmware often needs to be loaded during U-Boot booting, so macros
3603are used to identify the storage device (NOR flash, SPI, etc) and the address
3604within that device.
3605
3606- CONFIG_SYS_QE_FMAN_FW_ADDR
3607 The address in the storage device where the firmware is located. The
3608 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3609 is also specified.
3610
3611- CONFIG_SYS_QE_FMAN_FW_LENGTH
3612 The maximum possible size of the firmware. The firmware binary format
3613 has a field that specifies the actual size of the firmware, but it
3614 might not be possible to read any part of the firmware unless some
3615 local storage is allocated to hold the entire firmware first.
3616
3617- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3618 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3619 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3620 virtual address in NOR flash.
3621
3622- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3623 Specifies that QE/FMAN firmware is located in NAND flash.
3624 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3625
3626- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3627 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3628 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3629
3630- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3631 Specifies that QE/FMAN firmware is located on the primary SPI
3632 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3633
Liu Gang292dc6c2012-03-08 00:33:18 +00003634- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3635 Specifies that QE/FMAN firmware is located in the remote (master)
3636 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00003637 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3638 window->master inbound window->master LAW->the ucode address in
3639 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06003640
wdenkc6097192002-11-03 00:24:07 +00003641Building the Software:
3642======================
3643
Wolfgang Denk218ca722008-03-26 10:40:12 +01003644Building U-Boot has been tested in several native build environments
3645and in many different cross environments. Of course we cannot support
3646all possibly existing versions of cross development tools in all
3647(potentially obsolete) versions. In case of tool chain problems we
3648recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3649which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003650
Wolfgang Denk218ca722008-03-26 10:40:12 +01003651If you are not using a native environment, it is assumed that you
3652have GNU cross compiling tools available in your path. In this case,
3653you must set the environment variable CROSS_COMPILE in your shell.
3654Note that no changes to the Makefile or any other source files are
3655necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003656
Wolfgang Denk218ca722008-03-26 10:40:12 +01003657 $ CROSS_COMPILE=ppc_4xx-
3658 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003659
Peter Tyser2f8d3962009-03-13 18:54:51 -05003660Note: If you wish to generate Windows versions of the utilities in
3661 the tools directory you can use the MinGW toolchain
3662 (http://www.mingw.org). Set your HOST tools to the MinGW
3663 toolchain and execute 'make tools'. For example:
3664
3665 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3666
3667 Binaries such as tools/mkimage.exe will be created which can
3668 be executed on computers running Windows.
3669
Wolfgang Denk218ca722008-03-26 10:40:12 +01003670U-Boot is intended to be simple to build. After installing the
3671sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003672is done by typing:
3673
3674 make NAME_config
3675
Wolfgang Denk218ca722008-03-26 10:40:12 +01003676where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003677rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003678
wdenk2729af92004-05-03 20:45:30 +00003679Note: for some board special configuration names may exist; check if
3680 additional information is available from the board vendor; for
3681 instance, the TQM823L systems are available without (standard)
3682 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003683 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003684
wdenk2729af92004-05-03 20:45:30 +00003685 make TQM823L_config
3686 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003687
wdenk2729af92004-05-03 20:45:30 +00003688 make TQM823L_LCD_config
3689 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003690
wdenk2729af92004-05-03 20:45:30 +00003691 etc.
wdenkc6097192002-11-03 00:24:07 +00003692
wdenkc6097192002-11-03 00:24:07 +00003693
wdenk2729af92004-05-03 20:45:30 +00003694Finally, type "make all", and you should get some working U-Boot
3695images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697- "u-boot.bin" is a raw binary image
3698- "u-boot" is an image in ELF binary format
3699- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003700
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003701By default the build is performed locally and the objects are saved
3702in the source directory. One of the two methods can be used to change
3703this behavior and build U-Boot to some external directory:
3704
37051. Add O= to the make command line invocations:
3706
3707 make O=/tmp/build distclean
3708 make O=/tmp/build NAME_config
3709 make O=/tmp/build all
3710
37112. Set environment variable BUILD_DIR to point to the desired location:
3712
3713 export BUILD_DIR=/tmp/build
3714 make distclean
3715 make NAME_config
3716 make all
3717
3718Note that the command line "O=" setting overrides the BUILD_DIR environment
3719variable.
3720
wdenkc6097192002-11-03 00:24:07 +00003721
wdenk2729af92004-05-03 20:45:30 +00003722Please be aware that the Makefiles assume you are using GNU make, so
3723for instance on NetBSD you might need to use "gmake" instead of
3724native "make".
wdenkc6097192002-11-03 00:24:07 +00003725
wdenkc6097192002-11-03 00:24:07 +00003726
wdenk2729af92004-05-03 20:45:30 +00003727If the system board that you have is not listed, then you will need
3728to port U-Boot to your hardware platform. To do this, follow these
3729steps:
wdenkc6097192002-11-03 00:24:07 +00003730
wdenk2729af92004-05-03 20:45:30 +000037311. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00003732 "boards.cfg" file, using the existing entries as examples.
3733 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000037342. Create a new directory to hold your board specific code. Add any
3735 files you need. In your board directory, you will need at least
3736 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
37373. Create a new configuration file "include/configs/<board>.h" for
3738 your board
37393. If you're porting U-Boot to a new CPU, then also create a new
3740 directory to hold your CPU specific code. Add any files you need.
37414. Run "make <board>_config" with your new name.
37425. Type "make", and you should get a working "u-boot.srec" file
3743 to be installed on your target system.
37446. Debug and solve any problems that might arise.
3745 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003746
wdenkc6097192002-11-03 00:24:07 +00003747
wdenk2729af92004-05-03 20:45:30 +00003748Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3749==============================================================
wdenkc6097192002-11-03 00:24:07 +00003750
Wolfgang Denk218ca722008-03-26 10:40:12 +01003751If you have modified U-Boot sources (for instance added a new board
3752or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003753provide feedback to the other developers. The feedback normally takes
3754the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003755official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003756
Wolfgang Denk218ca722008-03-26 10:40:12 +01003757But before you submit such a patch, please verify that your modifi-
3758cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003759the supported boards compile WITHOUT ANY compiler warnings. To do so,
3760just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003761for ALL supported system. Be warned, this will take a while. You can
3762select which (cross) compiler to use by passing a `CROSS_COMPILE'
3763environment variable to the script, i. e. to use the ELDK cross tools
3764you can type
wdenkc6097192002-11-03 00:24:07 +00003765
wdenk2729af92004-05-03 20:45:30 +00003766 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003767
wdenk2729af92004-05-03 20:45:30 +00003768or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003771
Wolfgang Denk218ca722008-03-26 10:40:12 +01003772When using the MAKEALL script, the default behaviour is to build
3773U-Boot in the source directory. This location can be changed by
3774setting the BUILD_DIR environment variable. Also, for each target
3775built, the MAKEALL script saves two log files (<target>.ERR and
3776<target>.MAKEALL) in the <source dir>/LOG directory. This default
3777location can be changed by setting the MAKEALL_LOGDIR environment
3778variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003779
3780 export BUILD_DIR=/tmp/build
3781 export MAKEALL_LOGDIR=/tmp/log
3782 CROSS_COMPILE=ppc_8xx- MAKEALL
3783
Wolfgang Denk218ca722008-03-26 10:40:12 +01003784With the above settings build objects are saved in the /tmp/build,
3785log files are saved in the /tmp/log and the source tree remains clean
3786during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003787
3788
wdenk2729af92004-05-03 20:45:30 +00003789See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003790
wdenkc6097192002-11-03 00:24:07 +00003791
wdenk2729af92004-05-03 20:45:30 +00003792Monitor Commands - Overview:
3793============================
wdenkc6097192002-11-03 00:24:07 +00003794
wdenk2729af92004-05-03 20:45:30 +00003795go - start application at address 'addr'
3796run - run commands in an environment variable
3797bootm - boot application image from memory
3798bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003799bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003800tftpboot- boot image via network using TFTP protocol
3801 and env variables "ipaddr" and "serverip"
3802 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003803tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003804rarpboot- boot image via network using RARP/TFTP protocol
3805diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3806loads - load S-Record file over serial line
3807loadb - load binary file over serial line (kermit mode)
3808md - memory display
3809mm - memory modify (auto-incrementing)
3810nm - memory modify (constant address)
3811mw - memory write (fill)
3812cp - memory copy
3813cmp - memory compare
3814crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003815i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003816sspi - SPI utility commands
3817base - print or set address offset
3818printenv- print environment variables
3819setenv - set environment variables
3820saveenv - save environment variables to persistent storage
3821protect - enable or disable FLASH write protection
3822erase - erase FLASH memory
3823flinfo - print FLASH memory information
3824bdinfo - print Board Info structure
3825iminfo - print header information for application image
3826coninfo - print console devices and informations
3827ide - IDE sub-system
3828loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003829loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003830mtest - simple RAM test
3831icache - enable or disable instruction cache
3832dcache - enable or disable data cache
3833reset - Perform RESET of the CPU
3834echo - echo args to console
3835version - print monitor version
3836help - print online help
3837? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003838
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840Monitor Commands - Detailed Description:
3841========================================
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk2729af92004-05-03 20:45:30 +00003843TODO.
wdenkc6097192002-11-03 00:24:07 +00003844
wdenk2729af92004-05-03 20:45:30 +00003845For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003846
3847
wdenk2729af92004-05-03 20:45:30 +00003848Environment Variables:
3849======================
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851U-Boot supports user configuration using Environment Variables which
3852can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003853
wdenk2729af92004-05-03 20:45:30 +00003854Environment Variables are set using "setenv", printed using
3855"printenv", and saved to Flash using "saveenv". Using "setenv"
3856without a value can be used to delete a variable from the
3857environment. As long as you don't save the environment you are
3858working with an in-memory copy. In case the Flash area containing the
3859environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003860
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003861Some configuration options can be set using Environment Variables.
3862
3863List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003864
wdenk2729af92004-05-03 20:45:30 +00003865 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003866
wdenk2729af92004-05-03 20:45:30 +00003867 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003868
wdenk2729af92004-05-03 20:45:30 +00003869 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003870
wdenk2729af92004-05-03 20:45:30 +00003871 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003872
wdenk2729af92004-05-03 20:45:30 +00003873 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003874
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003875 bootm_low - Memory range available for image processing in the bootm
3876 command can be restricted. This variable is given as
3877 a hexadecimal number and defines lowest address allowed
3878 for use by the bootm command. See also "bootm_size"
3879 environment variable. Address defined by "bootm_low" is
3880 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003881 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3882 bootm_mapsize.
3883
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003884 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003885 This variable is given as a hexadecimal number and it
3886 defines the size of the memory region starting at base
3887 address bootm_low that is accessible by the Linux kernel
3888 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3889 as the default value if it is defined, and bootm_size is
3890 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003891
3892 bootm_size - Memory range available for image processing in the bootm
3893 command can be restricted. This variable is given as
3894 a hexadecimal number and defines the size of the region
3895 allowed for use by the bootm command. See also "bootm_low"
3896 environment variable.
3897
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003898 updatefile - Location of the software update file on a TFTP server, used
3899 by the automatic software update feature. Please refer to
3900 documentation in doc/README.update for more details.
3901
wdenk2729af92004-05-03 20:45:30 +00003902 autoload - if set to "no" (any string beginning with 'n'),
3903 "bootp" will just load perform a lookup of the
3904 configuration from the BOOTP server, but not try to
3905 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003906
wdenk2729af92004-05-03 20:45:30 +00003907 autostart - if set to "yes", an image loaded using the "bootp",
3908 "rarpboot", "tftpboot" or "diskboot" commands will
3909 be automatically started (by internally calling
3910 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003911
wdenk2729af92004-05-03 20:45:30 +00003912 If set to "no", a standalone image passed to the
3913 "bootm" command will be copied to the load address
3914 (and eventually uncompressed), but NOT be started.
3915 This can be used to load and uncompress arbitrary
3916 data.
wdenkc6097192002-11-03 00:24:07 +00003917
David A. Longa28afca2011-07-09 16:40:19 -04003918 fdt_high - if set this restricts the maximum address that the
3919 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003920 For example, if you have a system with 1 GB memory
3921 at physical address 0x10000000, while Linux kernel
3922 only recognizes the first 704 MB as low memory, you
3923 may need to set fdt_high as 0x3C000000 to have the
3924 device tree blob be copied to the maximum address
3925 of the 704 MB low memory, so that Linux kernel can
3926 access it during the boot procedure.
3927
David A. Longa28afca2011-07-09 16:40:19 -04003928 If this is set to the special value 0xFFFFFFFF then
3929 the fdt will not be copied at all on boot. For this
3930 to work it must reside in writable memory, have
3931 sufficient padding on the end of it for u-boot to
3932 add the information it needs into it, and the memory
3933 must be accessible by the kernel.
3934
Simon Glasseea63e02011-10-24 19:15:34 +00003935 fdtcontroladdr- if set this is the address of the control flattened
3936 device tree used by U-Boot when CONFIG_OF_CONTROL is
3937 defined.
3938
wdenk17ea1172004-06-06 21:51:03 +00003939 i2cfast - (PPC405GP|PPC405EP only)
3940 if set to 'y' configures Linux I2C driver for fast
3941 mode (400kHZ). This environment variable is used in
3942 initialization code. So, for changes to be effective
3943 it must be saved and board must be reset.
3944
wdenk2729af92004-05-03 20:45:30 +00003945 initrd_high - restrict positioning of initrd images:
3946 If this variable is not set, initrd images will be
3947 copied to the highest possible address in RAM; this
3948 is usually what you want since it allows for
3949 maximum initrd size. If for some reason you want to
3950 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003951 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003952 variable to a value of "no" or "off" or "0".
3953 Alternatively, you can set it to a maximum upper
3954 address to use (U-Boot will still check that it
3955 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003956
wdenk2729af92004-05-03 20:45:30 +00003957 For instance, when you have a system with 16 MB
3958 RAM, and want to reserve 4 MB from use by Linux,
3959 you can do this by adding "mem=12M" to the value of
3960 the "bootargs" variable. However, now you must make
3961 sure that the initrd image is placed in the first
3962 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003963
wdenk2729af92004-05-03 20:45:30 +00003964 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003965
wdenk2729af92004-05-03 20:45:30 +00003966 If you set initrd_high to 0xFFFFFFFF, this is an
3967 indication to U-Boot that all addresses are legal
3968 for the Linux kernel, including addresses in flash
3969 memory. In this case U-Boot will NOT COPY the
3970 ramdisk at all. This may be useful to reduce the
3971 boot time on your system, but requires that this
3972 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003973
wdenk2729af92004-05-03 20:45:30 +00003974 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk2729af92004-05-03 20:45:30 +00003976 loadaddr - Default load address for commands like "bootp",
3977 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003978
wdenk2729af92004-05-03 20:45:30 +00003979 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003980
wdenk2729af92004-05-03 20:45:30 +00003981 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003982
wdenk2729af92004-05-03 20:45:30 +00003983 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003984
wdenk2729af92004-05-03 20:45:30 +00003985 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003986
wdenk2729af92004-05-03 20:45:30 +00003987 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003988
Mike Frysingere2a53452011-10-02 10:01:27 +00003989 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003990
Mike Frysingere2a53452011-10-02 10:01:27 +00003991 ethact - controls which interface is currently active.
3992 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003993
Heiko Schocher48690d82010-07-20 17:45:02 +02003994 => setenv ethact FEC
3995 => ping 192.168.0.1 # traffic sent on FEC
3996 => setenv ethact SCC
3997 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003998
Matthias Fuchse1692572008-01-17 07:45:05 +01003999 ethrotate - When set to "no" U-Boot does not go through all
4000 available network interfaces.
4001 It just stays at the currently selected interface.
4002
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004003 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00004004 either succeed or fail without retrying.
4005 When set to "once" the network operation will
4006 fail when all the available network interfaces
4007 are tried once without success.
4008 Useful on scripts which control the retry operation
4009 themselves.
wdenkc6097192002-11-03 00:24:07 +00004010
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01004011 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01004012
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004013 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02004014 UDP source port.
4015
Wolfgang Denk28cb9372005-09-24 23:25:46 +02004016 tftpdstport - If this is set, the value is used for TFTP's UDP
4017 destination port instead of the Well Know Port 69.
4018
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01004019 tftpblocksize - Block size to use for TFTP transfers; if not set,
4020 we use the TFTP server's default block size
4021
4022 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4023 seconds, minimum value is 1000 = 1 second). Defines
4024 when a packet is considered to be lost so it has to
4025 be retransmitted. The default is 5000 = 5 seconds.
4026 Lowering this value may make downloads succeed
4027 faster in networks with high packet loss rates or
4028 with unreliable TFTP servers.
4029
4030 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004031 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00004032 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00004033
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004034The following image location variables contain the location of images
4035used in booting. The "Image" column gives the role of the image and is
4036not an environment variable name. The other columns are environment
4037variable names. "File Name" gives the name of the file on a TFTP
4038server, "RAM Address" gives the location in RAM the image will be
4039loaded to, and "Flash Location" gives the image's address in NOR
4040flash or offset in NAND flash.
4041
4042*Note* - these variables don't have to be defined for all boards, some
4043boards currenlty use other variables for these purposes, and some
4044boards use these variables for other purposes.
4045
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004046Image File Name RAM Address Flash Location
4047----- --------- ----------- --------------
4048u-boot u-boot u-boot_addr_r u-boot_addr
4049Linux kernel bootfile kernel_addr_r kernel_addr
4050device tree blob fdtfile fdt_addr_r fdt_addr
4051ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00004052
wdenk2729af92004-05-03 20:45:30 +00004053The following environment variables may be used and automatically
4054updated by the network boot commands ("bootp" and "rarpboot"),
4055depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00004056
wdenk2729af92004-05-03 20:45:30 +00004057 bootfile - see above
4058 dnsip - IP address of your Domain Name Server
4059 dnsip2 - IP address of your secondary Domain Name Server
4060 gatewayip - IP address of the Gateway (Router) to use
4061 hostname - Target hostname
4062 ipaddr - see above
4063 netmask - Subnet Mask
4064 rootpath - Pathname of the root filesystem on the NFS server
4065 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00004066
wdenka3d991b2004-04-15 21:48:45 +00004067
wdenk2729af92004-05-03 20:45:30 +00004068There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004069
wdenk2729af92004-05-03 20:45:30 +00004070 serial# - contains hardware identification information such
4071 as type string and/or serial number
4072 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004073
wdenk2729af92004-05-03 20:45:30 +00004074These variables can be set only once (usually during manufacturing of
4075the board). U-Boot refuses to delete or overwrite these variables
4076once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004077
4078
wdenk2729af92004-05-03 20:45:30 +00004079Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004080
wdenk2729af92004-05-03 20:45:30 +00004081 ver - Contains the U-Boot version string as printed
4082 with the "version" command. This variable is
4083 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004084
wdenkc6097192002-11-03 00:24:07 +00004085
wdenk2729af92004-05-03 20:45:30 +00004086Please note that changes to some configuration parameters may take
4087only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00004088
stroesec1551ea2003-04-04 15:53:41 +00004089
wdenk2729af92004-05-03 20:45:30 +00004090Command Line Parsing:
4091=====================
stroesec1551ea2003-04-04 15:53:41 +00004092
wdenk2729af92004-05-03 20:45:30 +00004093There are two different command line parsers available with U-Boot:
4094the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00004095
wdenk2729af92004-05-03 20:45:30 +00004096Old, simple command line parser:
4097--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004098
wdenk2729af92004-05-03 20:45:30 +00004099- supports environment variables (through setenv / saveenv commands)
4100- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004101- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00004102- special characters ('$', ';') can be escaped by prefixing with '\',
4103 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01004104 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00004105- You can also escape text by enclosing in single apostrophes, for example:
4106 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108Hush shell:
4109-----------
wdenkf07771c2003-05-28 08:06:31 +00004110
wdenk2729af92004-05-03 20:45:30 +00004111- similar to Bourne shell, with control structures like
4112 if...then...else...fi, for...do...done; while...do...done,
4113 until...do...done, ...
4114- supports environment ("global") variables (through setenv / saveenv
4115 commands) and local shell variables (through standard shell syntax
4116 "name=value"); only environment variables can be used with "run"
4117 command
wdenkf07771c2003-05-28 08:06:31 +00004118
wdenk2729af92004-05-03 20:45:30 +00004119General rules:
4120--------------
wdenkf07771c2003-05-28 08:06:31 +00004121
wdenk2729af92004-05-03 20:45:30 +00004122(1) If a command line (or an environment variable executed by a "run"
4123 command) contains several commands separated by semicolon, and
4124 one of these commands fails, then the remaining commands will be
4125 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004126
wdenk2729af92004-05-03 20:45:30 +00004127(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004128 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004129 command will cause "run" to terminate, i. e. the remaining
4130 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004131
wdenk2729af92004-05-03 20:45:30 +00004132Note for Redundant Ethernet Interfaces:
4133=======================================
wdenkf07771c2003-05-28 08:06:31 +00004134
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004135Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004136such configurations and is capable of automatic selection of a
4137"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004138
wdenk2729af92004-05-03 20:45:30 +00004139Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4140MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4141"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004142
wdenk2729af92004-05-03 20:45:30 +00004143If the network interface stores some valid MAC address (for instance
4144in SROM), this is used as default address if there is NO correspon-
4145ding setting in the environment; if the corresponding environment
4146variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004147
wdenk2729af92004-05-03 20:45:30 +00004148o If the SROM has a valid MAC address, and there is no address in the
4149 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004150
wdenk2729af92004-05-03 20:45:30 +00004151o If there is no valid address in the SROM, and a definition in the
4152 environment exists, then the value from the environment variable is
4153 used.
wdenkc6097192002-11-03 00:24:07 +00004154
wdenk2729af92004-05-03 20:45:30 +00004155o If both the SROM and the environment contain a MAC address, and
4156 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004157
wdenk2729af92004-05-03 20:45:30 +00004158o If both the SROM and the environment contain a MAC address, and the
4159 addresses differ, the value from the environment is used and a
4160 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162o If neither SROM nor the environment contain a MAC address, an error
4163 is raised.
wdenkc6097192002-11-03 00:24:07 +00004164
Ben Warrenecee9322010-04-26 11:11:46 -07004165If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004166will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004167may be skipped by setting the appropriate 'ethmacskip' environment variable.
4168The naming convention is as follows:
4169"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004170
wdenk2729af92004-05-03 20:45:30 +00004171Image Formats:
4172==============
wdenkc6097192002-11-03 00:24:07 +00004173
Marian Balakowicz3310c542008-03-12 12:13:13 +01004174U-Boot is capable of booting (and performing other auxiliary operations on)
4175images in two formats:
4176
4177New uImage format (FIT)
4178-----------------------
4179
4180Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4181to Flattened Device Tree). It allows the use of images with multiple
4182components (several kernels, ramdisks, etc.), with contents protected by
4183SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4184
4185
4186Old uImage format
4187-----------------
4188
4189Old image format is based on binary files which can be basically anything,
4190preceded by a special header; see the definitions in include/image.h for
4191details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004192
wdenk2729af92004-05-03 20:45:30 +00004193* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4194 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004195 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4196 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4197 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004198* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004199 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4200 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004201* Compression Type (uncompressed, gzip, bzip2)
4202* Load Address
4203* Entry Point
4204* Image Name
4205* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004206
wdenk2729af92004-05-03 20:45:30 +00004207The header is marked by a special Magic Number, and both the header
4208and the data portions of the image are secured against corruption by
4209CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004210
wdenkc6097192002-11-03 00:24:07 +00004211
wdenk2729af92004-05-03 20:45:30 +00004212Linux Support:
4213==============
wdenkc6097192002-11-03 00:24:07 +00004214
wdenk2729af92004-05-03 20:45:30 +00004215Although U-Boot should support any OS or standalone application
4216easily, the main focus has always been on Linux during the design of
4217U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004218
wdenk2729af92004-05-03 20:45:30 +00004219U-Boot includes many features that so far have been part of some
4220special "boot loader" code within the Linux kernel. Also, any
4221"initrd" images to be used are no longer part of one big Linux image;
4222instead, kernel and "initrd" are separate images. This implementation
4223serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004224
wdenk2729af92004-05-03 20:45:30 +00004225- the same features can be used for other OS or standalone
4226 applications (for instance: using compressed images to reduce the
4227 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004228
wdenk2729af92004-05-03 20:45:30 +00004229- it becomes much easier to port new Linux kernel versions because
4230 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004231
wdenk2729af92004-05-03 20:45:30 +00004232- the same Linux kernel image can now be used with different "initrd"
4233 images; of course this also means that different kernel images can
4234 be run with the same "initrd". This makes testing easier (you don't
4235 have to build a new "zImage.initrd" Linux image when you just
4236 change a file in your "initrd"). Also, a field-upgrade of the
4237 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004238
wdenkc6097192002-11-03 00:24:07 +00004239
wdenk2729af92004-05-03 20:45:30 +00004240Linux HOWTO:
4241============
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243Porting Linux to U-Boot based systems:
4244---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004245
wdenk2729af92004-05-03 20:45:30 +00004246U-Boot cannot save you from doing all the necessary modifications to
4247configure the Linux device drivers for use with your target hardware
4248(no, we don't intend to provide a full virtual machine interface to
4249Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004250
Stefan Roesea47a12b2010-04-15 16:07:28 +02004251But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253Just make sure your machine specific header file (for instance
4254include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004255Information structure as we define in include/asm-<arch>/u-boot.h,
4256and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004257as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004258
wdenkc6097192002-11-03 00:24:07 +00004259
wdenk2729af92004-05-03 20:45:30 +00004260Configuring the Linux kernel:
4261-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004262
wdenk2729af92004-05-03 20:45:30 +00004263No specific requirements for U-Boot. Make sure you have some root
4264device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004265
wdenkc6097192002-11-03 00:24:07 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267Building a Linux Image:
4268-----------------------
wdenkc6097192002-11-03 00:24:07 +00004269
wdenk2729af92004-05-03 20:45:30 +00004270With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4271not used. If you use recent kernel source, a new build target
4272"uImage" will exist which automatically builds an image usable by
4273U-Boot. Most older kernels also have support for a "pImage" target,
4274which was introduced for our predecessor project PPCBoot and uses a
4275100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004276
wdenk2729af92004-05-03 20:45:30 +00004277Example:
wdenkc6097192002-11-03 00:24:07 +00004278
wdenk2729af92004-05-03 20:45:30 +00004279 make TQM850L_config
4280 make oldconfig
4281 make dep
4282 make uImage
wdenkc6097192002-11-03 00:24:07 +00004283
wdenk2729af92004-05-03 20:45:30 +00004284The "uImage" build target uses a special tool (in 'tools/mkimage') to
4285encapsulate a compressed Linux kernel image with header information,
4286CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004287
wdenk2729af92004-05-03 20:45:30 +00004288* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004289
wdenk2729af92004-05-03 20:45:30 +00004290* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004291
wdenk2729af92004-05-03 20:45:30 +00004292 ${CROSS_COMPILE}-objcopy -O binary \
4293 -R .note -R .comment \
4294 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004295
wdenk2729af92004-05-03 20:45:30 +00004296* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004297
wdenk2729af92004-05-03 20:45:30 +00004298 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004299
wdenk2729af92004-05-03 20:45:30 +00004300* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004301
wdenk2729af92004-05-03 20:45:30 +00004302 mkimage -A ppc -O linux -T kernel -C gzip \
4303 -a 0 -e 0 -n "Linux Kernel Image" \
4304 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004305
wdenk24ee89b2002-11-03 17:56:27 +00004306
wdenk2729af92004-05-03 20:45:30 +00004307The "mkimage" tool can also be used to create ramdisk images for use
4308with U-Boot, either separated from the Linux kernel image, or
4309combined into one file. "mkimage" encapsulates the images with a 64
4310byte header containing information about target architecture,
4311operating system, image type, compression method, entry points, time
4312stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004313
wdenk2729af92004-05-03 20:45:30 +00004314"mkimage" can be called in two ways: to verify existing images and
4315print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004316
wdenk2729af92004-05-03 20:45:30 +00004317In the first form (with "-l" option) mkimage lists the information
4318contained in the header of an existing U-Boot image; this includes
4319checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004320
wdenk2729af92004-05-03 20:45:30 +00004321 tools/mkimage -l image
4322 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004323
wdenk2729af92004-05-03 20:45:30 +00004324The second form (with "-d" option) is used to build a U-Boot image
4325from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4328 -n name -d data_file image
4329 -A ==> set architecture to 'arch'
4330 -O ==> set operating system to 'os'
4331 -T ==> set image type to 'type'
4332 -C ==> set compression type 'comp'
4333 -a ==> set load address to 'addr' (hex)
4334 -e ==> set entry point to 'ep' (hex)
4335 -n ==> set image name to 'name'
4336 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004337
wdenk69459792004-05-29 16:53:29 +00004338Right now, all Linux kernels for PowerPC systems use the same load
4339address (0x00000000), but the entry point address depends on the
4340kernel version:
wdenkc6097192002-11-03 00:24:07 +00004341
wdenk2729af92004-05-03 20:45:30 +00004342- 2.2.x kernels have the entry point at 0x0000000C,
4343- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004344
wdenk2729af92004-05-03 20:45:30 +00004345So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004346
wdenk2729af92004-05-03 20:45:30 +00004347 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4348 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004349 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004350 > examples/uImage.TQM850L
4351 Image Name: 2.4.4 kernel for TQM850L
4352 Created: Wed Jul 19 02:34:59 2000
4353 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4354 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4355 Load Address: 0x00000000
4356 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004357
wdenk2729af92004-05-03 20:45:30 +00004358To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004359
wdenk2729af92004-05-03 20:45:30 +00004360 -> tools/mkimage -l examples/uImage.TQM850L
4361 Image Name: 2.4.4 kernel for TQM850L
4362 Created: Wed Jul 19 02:34:59 2000
4363 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4364 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4365 Load Address: 0x00000000
4366 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004367
wdenk2729af92004-05-03 20:45:30 +00004368NOTE: for embedded systems where boot time is critical you can trade
4369speed for memory and install an UNCOMPRESSED image instead: this
4370needs more space in Flash, but boots much faster since it does not
4371need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004372
Stefan Roesea47a12b2010-04-15 16:07:28 +02004373 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004374 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4375 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004376 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004377 > examples/uImage.TQM850L-uncompressed
4378 Image Name: 2.4.4 kernel for TQM850L
4379 Created: Wed Jul 19 02:34:59 2000
4380 Image Type: PowerPC Linux Kernel Image (uncompressed)
4381 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4382 Load Address: 0x00000000
4383 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004384
wdenkc6097192002-11-03 00:24:07 +00004385
wdenk2729af92004-05-03 20:45:30 +00004386Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4387when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004388
wdenk2729af92004-05-03 20:45:30 +00004389 -> tools/mkimage -n 'Simple Ramdisk Image' \
4390 > -A ppc -O linux -T ramdisk -C gzip \
4391 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4392 Image Name: Simple Ramdisk Image
4393 Created: Wed Jan 12 14:01:50 2000
4394 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4395 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4396 Load Address: 0x00000000
4397 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004398
wdenkdb01a2e2004-04-15 23:14:49 +00004399
wdenk2729af92004-05-03 20:45:30 +00004400Installing a Linux Image:
4401-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004402
wdenk2729af92004-05-03 20:45:30 +00004403To downloading a U-Boot image over the serial (console) interface,
4404you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004405
wdenk2729af92004-05-03 20:45:30 +00004406 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004407
wdenk2729af92004-05-03 20:45:30 +00004408The 'objcopy' does not understand the information in the U-Boot
4409image header, so the resulting S-Record file will be relative to
4410address 0x00000000. To load it to a given address, you need to
4411specify the target address as 'offset' parameter with the 'loads'
4412command.
wdenkc6097192002-11-03 00:24:07 +00004413
wdenk2729af92004-05-03 20:45:30 +00004414Example: install the image to address 0x40100000 (which on the
4415TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004416
wdenk2729af92004-05-03 20:45:30 +00004417 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004418
wdenk2729af92004-05-03 20:45:30 +00004419 .......... done
4420 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004421
wdenk2729af92004-05-03 20:45:30 +00004422 => loads 40100000
4423 ## Ready for S-Record download ...
4424 ~>examples/image.srec
4425 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4426 ...
4427 15989 15990 15991 15992
4428 [file transfer complete]
4429 [connected]
4430 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004431
4432
wdenk2729af92004-05-03 20:45:30 +00004433You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004434this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004435corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004436
wdenk2729af92004-05-03 20:45:30 +00004437 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004438
wdenk2729af92004-05-03 20:45:30 +00004439 ## Checking Image at 40100000 ...
4440 Image Name: 2.2.13 for initrd on TQM850L
4441 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4442 Data Size: 335725 Bytes = 327 kB = 0 MB
4443 Load Address: 00000000
4444 Entry Point: 0000000c
4445 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004446
4447
wdenk2729af92004-05-03 20:45:30 +00004448Boot Linux:
4449-----------
wdenkc6097192002-11-03 00:24:07 +00004450
wdenk2729af92004-05-03 20:45:30 +00004451The "bootm" command is used to boot an application that is stored in
4452memory (RAM or Flash). In case of a Linux kernel image, the contents
4453of the "bootargs" environment variable is passed to the kernel as
4454parameters. You can check and modify this variable using the
4455"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004456
4457
wdenk2729af92004-05-03 20:45:30 +00004458 => printenv bootargs
4459 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004460
wdenk2729af92004-05-03 20:45:30 +00004461 => 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 +00004462
wdenk2729af92004-05-03 20:45:30 +00004463 => printenv bootargs
4464 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 +00004465
wdenk2729af92004-05-03 20:45:30 +00004466 => bootm 40020000
4467 ## Booting Linux kernel at 40020000 ...
4468 Image Name: 2.2.13 for NFS on TQM850L
4469 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4470 Data Size: 381681 Bytes = 372 kB = 0 MB
4471 Load Address: 00000000
4472 Entry Point: 0000000c
4473 Verifying Checksum ... OK
4474 Uncompressing Kernel Image ... OK
4475 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
4476 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4477 time_init: decrementer frequency = 187500000/60
4478 Calibrating delay loop... 49.77 BogoMIPS
4479 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4480 ...
wdenkc6097192002-11-03 00:24:07 +00004481
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004482If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004483the memory addresses of both the kernel and the initrd image (PPBCOOT
4484format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004485
wdenk2729af92004-05-03 20:45:30 +00004486 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004487
wdenk2729af92004-05-03 20:45:30 +00004488 ## Checking Image at 40100000 ...
4489 Image Name: 2.2.13 for initrd on TQM850L
4490 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4491 Data Size: 335725 Bytes = 327 kB = 0 MB
4492 Load Address: 00000000
4493 Entry Point: 0000000c
4494 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004495
wdenk2729af92004-05-03 20:45:30 +00004496 ## Checking Image at 40200000 ...
4497 Image Name: Simple Ramdisk Image
4498 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4499 Data Size: 566530 Bytes = 553 kB = 0 MB
4500 Load Address: 00000000
4501 Entry Point: 00000000
4502 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004503
wdenk2729af92004-05-03 20:45:30 +00004504 => bootm 40100000 40200000
4505 ## Booting Linux kernel at 40100000 ...
4506 Image Name: 2.2.13 for initrd on TQM850L
4507 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4508 Data Size: 335725 Bytes = 327 kB = 0 MB
4509 Load Address: 00000000
4510 Entry Point: 0000000c
4511 Verifying Checksum ... OK
4512 Uncompressing Kernel Image ... OK
4513 ## Loading RAMDisk Image at 40200000 ...
4514 Image Name: Simple Ramdisk Image
4515 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4516 Data Size: 566530 Bytes = 553 kB = 0 MB
4517 Load Address: 00000000
4518 Entry Point: 00000000
4519 Verifying Checksum ... OK
4520 Loading Ramdisk ... OK
4521 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
4522 Boot arguments: root=/dev/ram
4523 time_init: decrementer frequency = 187500000/60
4524 Calibrating delay loop... 49.77 BogoMIPS
4525 ...
4526 RAMDISK: Compressed image found at block 0
4527 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004528
wdenk2729af92004-05-03 20:45:30 +00004529 bash#
wdenkc6097192002-11-03 00:24:07 +00004530
Matthew McClintock02677682006-06-28 10:41:37 -05004531Boot Linux and pass a flat device tree:
4532-----------
4533
4534First, U-Boot must be compiled with the appropriate defines. See the section
4535titled "Linux Kernel Interface" above for a more in depth explanation. The
4536following is an example of how to start a kernel and pass an updated
4537flat device tree:
4538
4539=> print oftaddr
4540oftaddr=0x300000
4541=> print oft
4542oft=oftrees/mpc8540ads.dtb
4543=> tftp $oftaddr $oft
4544Speed: 1000, full duplex
4545Using TSEC0 device
4546TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4547Filename 'oftrees/mpc8540ads.dtb'.
4548Load address: 0x300000
4549Loading: #
4550done
4551Bytes transferred = 4106 (100a hex)
4552=> tftp $loadaddr $bootfile
4553Speed: 1000, full duplex
4554Using TSEC0 device
4555TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4556Filename 'uImage'.
4557Load address: 0x200000
4558Loading:############
4559done
4560Bytes transferred = 1029407 (fb51f hex)
4561=> print loadaddr
4562loadaddr=200000
4563=> print oftaddr
4564oftaddr=0x300000
4565=> bootm $loadaddr - $oftaddr
4566## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004567 Image Name: Linux-2.6.17-dirty
4568 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4569 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004570 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004571 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004572 Verifying Checksum ... OK
4573 Uncompressing Kernel Image ... OK
4574Booting using flat device tree at 0x300000
4575Using MPC85xx ADS machine description
4576Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4577[snip]
4578
4579
wdenk2729af92004-05-03 20:45:30 +00004580More About U-Boot Image Types:
4581------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004584
wdenk2729af92004-05-03 20:45:30 +00004585 "Standalone Programs" are directly runnable in the environment
4586 provided by U-Boot; it is expected that (if they behave
4587 well) you can continue to work in U-Boot after return from
4588 the Standalone Program.
4589 "OS Kernel Images" are usually images of some Embedded OS which
4590 will take over control completely. Usually these programs
4591 will install their own set of exception handlers, device
4592 drivers, set up the MMU, etc. - this means, that you cannot
4593 expect to re-enter U-Boot except by resetting the CPU.
4594 "RAMDisk Images" are more or less just data blocks, and their
4595 parameters (address, size) are passed to an OS kernel that is
4596 being started.
4597 "Multi-File Images" contain several images, typically an OS
4598 (Linux) kernel image and one or more data images like
4599 RAMDisks. This construct is useful for instance when you want
4600 to boot over the network using BOOTP etc., where the boot
4601 server provides just a single image file, but you want to get
4602 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004603
wdenk2729af92004-05-03 20:45:30 +00004604 "Multi-File Images" start with a list of image sizes, each
4605 image size (in bytes) specified by an "uint32_t" in network
4606 byte order. This list is terminated by an "(uint32_t)0".
4607 Immediately after the terminating 0 follow the images, one by
4608 one, all aligned on "uint32_t" boundaries (size rounded up to
4609 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004610
wdenk2729af92004-05-03 20:45:30 +00004611 "Firmware Images" are binary images containing firmware (like
4612 U-Boot or FPGA images) which usually will be programmed to
4613 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004614
wdenk2729af92004-05-03 20:45:30 +00004615 "Script files" are command sequences that will be executed by
4616 U-Boot's command interpreter; this feature is especially
4617 useful when you configure U-Boot to use a real shell (hush)
4618 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004619
Marek Vasut44f074c2012-03-14 21:52:45 +00004620Booting the Linux zImage:
4621-------------------------
4622
4623On some platforms, it's possible to boot Linux zImage. This is done
4624using the "bootz" command. The syntax of "bootz" command is the same
4625as the syntax of "bootm" command.
4626
Marek Vasut017e1f32012-03-18 11:47:58 +00004627Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4628kernel with raw initrd images. The syntax is slightly different, the
4629address of the initrd must be augmented by it's size, in the following
4630format: "<initrd addres>:<initrd size>".
4631
wdenkc6097192002-11-03 00:24:07 +00004632
wdenk2729af92004-05-03 20:45:30 +00004633Standalone HOWTO:
4634=================
wdenkc6097192002-11-03 00:24:07 +00004635
wdenk2729af92004-05-03 20:45:30 +00004636One of the features of U-Boot is that you can dynamically load and
4637run "standalone" applications, which can use some resources of
4638U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk2729af92004-05-03 20:45:30 +00004640Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004641
wdenk2729af92004-05-03 20:45:30 +00004642"Hello World" Demo:
4643-------------------
wdenkc6097192002-11-03 00:24:07 +00004644
wdenk2729af92004-05-03 20:45:30 +00004645'examples/hello_world.c' contains a small "Hello World" Demo
4646application; it is automatically compiled when you build U-Boot.
4647It's configured to run at address 0x00040004, so you can play with it
4648like that:
wdenkc6097192002-11-03 00:24:07 +00004649
wdenk2729af92004-05-03 20:45:30 +00004650 => loads
4651 ## Ready for S-Record download ...
4652 ~>examples/hello_world.srec
4653 1 2 3 4 5 6 7 8 9 10 11 ...
4654 [file transfer complete]
4655 [connected]
4656 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004657
wdenk2729af92004-05-03 20:45:30 +00004658 => go 40004 Hello World! This is a test.
4659 ## Starting application at 0x00040004 ...
4660 Hello World
4661 argc = 7
4662 argv[0] = "40004"
4663 argv[1] = "Hello"
4664 argv[2] = "World!"
4665 argv[3] = "This"
4666 argv[4] = "is"
4667 argv[5] = "a"
4668 argv[6] = "test."
4669 argv[7] = "<NULL>"
4670 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk2729af92004-05-03 20:45:30 +00004672 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk2729af92004-05-03 20:45:30 +00004674Another example, which demonstrates how to register a CPM interrupt
4675handler with the U-Boot code, can be found in 'examples/timer.c'.
4676Here, a CPM timer is set up to generate an interrupt every second.
4677The interrupt service routine is trivial, just printing a '.'
4678character, but this is just a demo program. The application can be
4679controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004680
wdenk2729af92004-05-03 20:45:30 +00004681 ? - print current values og the CPM Timer registers
4682 b - enable interrupts and start timer
4683 e - stop timer and disable interrupts
4684 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004685
wdenk2729af92004-05-03 20:45:30 +00004686 => loads
4687 ## Ready for S-Record download ...
4688 ~>examples/timer.srec
4689 1 2 3 4 5 6 7 8 9 10 11 ...
4690 [file transfer complete]
4691 [connected]
4692 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004693
wdenk2729af92004-05-03 20:45:30 +00004694 => go 40004
4695 ## Starting application at 0x00040004 ...
4696 TIMERS=0xfff00980
4697 Using timer 1
4698 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004699
wdenk2729af92004-05-03 20:45:30 +00004700Hit 'b':
4701 [q, b, e, ?] Set interval 1000000 us
4702 Enabling timer
4703Hit '?':
4704 [q, b, e, ?] ........
4705 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4706Hit '?':
4707 [q, b, e, ?] .
4708 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4709Hit '?':
4710 [q, b, e, ?] .
4711 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4712Hit '?':
4713 [q, b, e, ?] .
4714 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4715Hit 'e':
4716 [q, b, e, ?] ...Stopping timer
4717Hit 'q':
4718 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004719
4720
wdenk2729af92004-05-03 20:45:30 +00004721Minicom warning:
4722================
wdenk85ec0bc2003-03-31 16:34:49 +00004723
wdenk2729af92004-05-03 20:45:30 +00004724Over time, many people have reported problems when trying to use the
4725"minicom" terminal emulation program for serial download. I (wd)
4726consider minicom to be broken, and recommend not to use it. Under
4727Unix, I recommend to use C-Kermit for general purpose use (and
4728especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00004729use "cu" for S-Record download ("loads" command). See
4730http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4731for help with kermit.
4732
wdenk85ec0bc2003-03-31 16:34:49 +00004733
wdenk2729af92004-05-03 20:45:30 +00004734Nevertheless, if you absolutely want to use it try adding this
4735configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004736
wdenk2729af92004-05-03 20:45:30 +00004737 Name Program Name U/D FullScr IO-Red. Multi
4738 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4739 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004740
4741
wdenk2729af92004-05-03 20:45:30 +00004742NetBSD Notes:
4743=============
wdenkc6097192002-11-03 00:24:07 +00004744
wdenk2729af92004-05-03 20:45:30 +00004745Starting at version 0.9.2, U-Boot supports NetBSD both as host
4746(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004747
wdenk2729af92004-05-03 20:45:30 +00004748Building requires a cross environment; it is known to work on
4749NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4750need gmake since the Makefiles are not compatible with BSD make).
4751Note that the cross-powerpc package does not install include files;
4752attempting to build U-Boot will fail because <machine/ansi.h> is
4753missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004754
wdenk2729af92004-05-03 20:45:30 +00004755 # cd /usr/pkg/cross/powerpc-netbsd/include
4756 # mkdir powerpc
4757 # ln -s powerpc machine
4758 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4759 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk2729af92004-05-03 20:45:30 +00004761Native builds *don't* work due to incompatibilities between native
4762and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004763
wdenk2729af92004-05-03 20:45:30 +00004764Booting assumes that (the first part of) the image booted is a
4765stage-2 loader which in turn loads and then invokes the kernel
4766proper. Loader sources will eventually appear in the NetBSD source
4767tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004768meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004769
4770
wdenk2729af92004-05-03 20:45:30 +00004771Implementation Internals:
4772=========================
wdenkc6097192002-11-03 00:24:07 +00004773
wdenk2729af92004-05-03 20:45:30 +00004774The following is not intended to be a complete description of every
4775implementation detail. However, it should help to understand the
4776inner workings of U-Boot and make it easier to port it to custom
4777hardware.
wdenkc6097192002-11-03 00:24:07 +00004778
4779
wdenk2729af92004-05-03 20:45:30 +00004780Initial Stack, Global Data:
4781---------------------------
wdenkc6097192002-11-03 00:24:07 +00004782
wdenk2729af92004-05-03 20:45:30 +00004783The implementation of U-Boot is complicated by the fact that U-Boot
4784starts running out of ROM (flash memory), usually without access to
4785system RAM (because the memory controller is not initialized yet).
4786This means that we don't have writable Data or BSS segments, and BSS
4787is not initialized as zero. To be able to get a C environment working
4788at all, we have to allocate at least a minimal stack. Implementation
4789options for this are defined and restricted by the CPU used: Some CPU
4790models provide on-chip memory (like the IMMR area on MPC8xx and
4791MPC826x processors), on others (parts of) the data cache can be
4792locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004793
Wolfgang Denk218ca722008-03-26 10:40:12 +01004794 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004795 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004796
wdenk2729af92004-05-03 20:45:30 +00004797 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4798 From: "Chris Hallinan" <clh@net1plus.com>
4799 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4800 ...
wdenk43d96162003-03-06 00:02:04 +00004801
wdenk2729af92004-05-03 20:45:30 +00004802 Correct me if I'm wrong, folks, but the way I understand it
4803 is this: Using DCACHE as initial RAM for Stack, etc, does not
4804 require any physical RAM backing up the cache. The cleverness
4805 is that the cache is being used as a temporary supply of
4806 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004807 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004808 can see how this works by studying the cache architecture and
4809 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004810
wdenk2729af92004-05-03 20:45:30 +00004811 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4812 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004813 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004814 option should work for you. Using CS 4 should be fine if your
4815 board designers haven't used it for something that would
4816 cause you grief during the initial boot! It is frequently not
4817 used.
wdenk43d96162003-03-06 00:02:04 +00004818
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004819 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004820 with your processor/board/system design. The default value
4821 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004822 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004823 than your SDRAM module. If you have a 64MB SDRAM module, set
4824 it above 400_0000. Just make sure your board has no resources
4825 that are supposed to respond to that address! That code in
4826 start.S has been around a while and should work as is when
4827 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004828
wdenk2729af92004-05-03 20:45:30 +00004829 -Chris Hallinan
4830 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004831
wdenk2729af92004-05-03 20:45:30 +00004832It is essential to remember this, since it has some impact on the C
4833code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004834
wdenk2729af92004-05-03 20:45:30 +00004835* Initialized global data (data segment) is read-only. Do not attempt
4836 to write it.
wdenkc6097192002-11-03 00:24:07 +00004837
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004838* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004839 as zero data - BSS segment) at all - this is undefined, initiali-
4840 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004841
wdenk2729af92004-05-03 20:45:30 +00004842* Stack space is very limited. Avoid big data buffers or things like
4843 that.
wdenkc6097192002-11-03 00:24:07 +00004844
wdenk2729af92004-05-03 20:45:30 +00004845Having only the stack as writable memory limits means we cannot use
4846normal global data to share information beween the code. But it
4847turned out that the implementation of U-Boot can be greatly
4848simplified by making a global data structure (gd_t) available to all
4849functions. We could pass a pointer to this data as argument to _all_
4850functions, but this would bloat the code. Instead we use a feature of
4851the GCC compiler (Global Register Variables) to share the data: we
4852place a pointer (gd) to the global data into a register which we
4853reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004854
wdenk2729af92004-05-03 20:45:30 +00004855When choosing a register for such a purpose we are restricted by the
4856relevant (E)ABI specifications for the current architecture, and by
4857GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004858
wdenk2729af92004-05-03 20:45:30 +00004859For PowerPC, the following registers have specific use:
4860 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004861 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004862 R3-R4: parameter passing and return values
4863 R5-R10: parameter passing
4864 R13: small data area pointer
4865 R30: GOT pointer
4866 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004867
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004868 (U-Boot also uses R12 as internal GOT pointer. r12
4869 is a volatile register so r12 needs to be reset when
4870 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004871
Wolfgang Denke7670f62008-02-14 22:43:22 +01004872 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004873
wdenk2729af92004-05-03 20:45:30 +00004874 Note: on PPC, we could use a static initializer (since the
4875 address of the global data structure is known at compile time),
4876 but it turned out that reserving a register results in somewhat
4877 smaller code - although the code savings are not that big (on
4878 average for all boards 752 bytes for the whole U-Boot image,
4879 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004880
Robin Getzc4db3352009-08-17 15:23:02 +00004881On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004882 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4883
Robin Getzc4db3352009-08-17 15:23:02 +00004884 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004885
wdenk2729af92004-05-03 20:45:30 +00004886On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004887
wdenk2729af92004-05-03 20:45:30 +00004888 R0: function argument word/integer result
4889 R1-R3: function argument word
4890 R9: GOT pointer
4891 R10: stack limit (used only if stack checking if enabled)
4892 R11: argument (frame) pointer
4893 R12: temporary workspace
4894 R13: stack pointer
4895 R14: link register
4896 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004897
wdenk2729af92004-05-03 20:45:30 +00004898 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004899
Thomas Chou0df01fd2010-05-21 11:08:03 +08004900On Nios II, the ABI is documented here:
4901 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4902
4903 ==> U-Boot will use gp to hold a pointer to the global data
4904
4905 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4906 to access small data sections, so gp is free.
4907
Macpaul Linafc1ce82011-10-19 20:41:11 +00004908On NDS32, the following registers are used:
4909
4910 R0-R1: argument/return
4911 R2-R5: argument
4912 R15: temporary register for assembler
4913 R16: trampoline register
4914 R28: frame pointer (FP)
4915 R29: global pointer (GP)
4916 R30: link register (LP)
4917 R31: stack pointer (SP)
4918 PC: program counter (PC)
4919
4920 ==> U-Boot will use R10 to hold a pointer to the global data
4921
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004922NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4923or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004924
wdenk2729af92004-05-03 20:45:30 +00004925Memory Management:
4926------------------
wdenkc6097192002-11-03 00:24:07 +00004927
wdenk2729af92004-05-03 20:45:30 +00004928U-Boot runs in system state and uses physical addresses, i.e. the
4929MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004930
wdenk2729af92004-05-03 20:45:30 +00004931The available memory is mapped to fixed addresses using the memory
4932controller. In this process, a contiguous block is formed for each
4933memory type (Flash, SDRAM, SRAM), even when it consists of several
4934physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004935
wdenk2729af92004-05-03 20:45:30 +00004936U-Boot is installed in the first 128 kB of the first Flash bank (on
4937TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4938booting and sizing and initializing DRAM, the code relocates itself
4939to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004940memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004941configuration setting]. Below that, a structure with global Board
4942Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004943
wdenk2729af92004-05-03 20:45:30 +00004944Additionally, some exception handler code is copied to the low 8 kB
4945of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004946
wdenk2729af92004-05-03 20:45:30 +00004947So a typical memory configuration with 16 MB of DRAM could look like
4948this:
wdenkc6097192002-11-03 00:24:07 +00004949
wdenk2729af92004-05-03 20:45:30 +00004950 0x0000 0000 Exception Vector code
4951 :
4952 0x0000 1FFF
4953 0x0000 2000 Free for Application Use
4954 :
4955 :
wdenkc6097192002-11-03 00:24:07 +00004956
wdenk2729af92004-05-03 20:45:30 +00004957 :
4958 :
4959 0x00FB FF20 Monitor Stack (Growing downward)
4960 0x00FB FFAC Board Info Data and permanent copy of global data
4961 0x00FC 0000 Malloc Arena
4962 :
4963 0x00FD FFFF
4964 0x00FE 0000 RAM Copy of Monitor Code
4965 ... eventually: LCD or video framebuffer
4966 ... eventually: pRAM (Protected RAM - unchanged by reset)
4967 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004968
4969
wdenk2729af92004-05-03 20:45:30 +00004970System Initialization:
4971----------------------
wdenkc6097192002-11-03 00:24:07 +00004972
wdenk2729af92004-05-03 20:45:30 +00004973In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004974(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004975configuration for CS0# this is a mirror of the onboard Flash memory.
4976To be able to re-map memory U-Boot then jumps to its link address.
4977To be able to implement the initialization code in C, a (small!)
4978initial stack is set up in the internal Dual Ported RAM (in case CPUs
4979which provide such a feature like MPC8xx or MPC8260), or in a locked
4980part of the data cache. After that, U-Boot initializes the CPU core,
4981the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004982
wdenk2729af92004-05-03 20:45:30 +00004983Next, all (potentially) available memory banks are mapped using a
4984preliminary mapping. For example, we put them on 512 MB boundaries
4985(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4986on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4987programmed for SDRAM access. Using the temporary configuration, a
4988simple memory test is run that determines the size of the SDRAM
4989banks.
wdenkc6097192002-11-03 00:24:07 +00004990
wdenk2729af92004-05-03 20:45:30 +00004991When there is more than one SDRAM bank, and the banks are of
4992different size, the largest is mapped first. For equal size, the first
4993bank (CS2#) is mapped first. The first mapping is always for address
49940x00000000, with any additional banks following immediately to create
4995contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk2729af92004-05-03 20:45:30 +00004997Then, the monitor installs itself at the upper end of the SDRAM area
4998and allocates memory for use by malloc() and for the global Board
4999Info data; also, the exception vector code is copied to the low RAM
5000pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005001
wdenk2729af92004-05-03 20:45:30 +00005002Only after this relocation will you have a "normal" C environment;
5003until that you are restricted in several ways, mostly because you are
5004running from ROM, and because the code will have to be relocated to a
5005new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005006
5007
wdenk2729af92004-05-03 20:45:30 +00005008U-Boot Porting Guide:
5009----------------------
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5012list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005013
5014
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005015int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00005016{
5017 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005018
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005019 signal(SIGALRM, no_more_time);
5020 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005021
wdenk2729af92004-05-03 20:45:30 +00005022 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005023 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00005024 return 0;
5025 }
5026
wdenk2729af92004-05-03 20:45:30 +00005027 Download latest U-Boot source;
5028
Wolfgang Denk06682362008-12-30 22:56:11 +01005029 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00005030
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005031 if (clueless)
5032 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk2729af92004-05-03 20:45:30 +00005034 while (learning) {
5035 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005036 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5037 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00005038 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005039 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00005040 }
wdenkc6097192002-11-03 00:24:07 +00005041
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005042 if (available_money > toLocalCurrency ($2500))
5043 Buy a BDI3000;
5044 else
wdenk2729af92004-05-03 20:45:30 +00005045 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005046
5047 if (a similar board exists) { /* hopefully... */
5048 cp -a board/<similar> board/<myboard>
5049 cp include/configs/<similar>.h include/configs/<myboard>.h
5050 } else {
5051 Create your own board support subdirectory;
5052 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00005053 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005054 Edit new board/<myboard> files
5055 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005056
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04005057 while (!accepted) {
5058 while (!running) {
5059 do {
5060 Add / modify source code;
5061 } until (compiles);
5062 Debug;
5063 if (clueless)
5064 email("Hi, I am having problems...");
5065 }
5066 Send patch file to the U-Boot email list;
5067 if (reasonable critiques)
5068 Incorporate improvements from email list code review;
5069 else
5070 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00005071 }
wdenkc6097192002-11-03 00:24:07 +00005072
wdenk2729af92004-05-03 20:45:30 +00005073 return 0;
5074}
5075
5076void no_more_time (int sig)
5077{
5078 hire_a_guru();
5079}
wdenkc6097192002-11-03 00:24:07 +00005080
5081
wdenk2729af92004-05-03 20:45:30 +00005082Coding Standards:
5083-----------------
wdenkc6097192002-11-03 00:24:07 +00005084
wdenk2729af92004-05-03 20:45:30 +00005085All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02005086coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005087"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00005088
Detlev Zundel2c051652006-09-01 15:39:02 +02005089Source files originating from a different project (for example the
5090MTD subsystem) are generally exempt from these guidelines and are not
5091reformated to ease subsequent migration to newer versions of those
5092sources.
5093
5094Please note that U-Boot is implemented in C (and to some small parts in
5095Assembler); no C++ is used, so please do not use C++ style comments (//)
5096in your code.
wdenk2729af92004-05-03 20:45:30 +00005097
5098Please also stick to the following formatting rules:
5099- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005100- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00005101- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005102- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00005103- do not add trailing empty lines to source files
5104
5105Submissions which do not conform to the standards may be returned
5106with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005107
5108
wdenk2729af92004-05-03 20:45:30 +00005109Submitting Patches:
5110-------------------
wdenkc6097192002-11-03 00:24:07 +00005111
wdenk2729af92004-05-03 20:45:30 +00005112Since the number of patches for U-Boot is growing, we need to
5113establish some rules. Submissions which do not conform to these rules
5114may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005115
Magnus Lilja0d28f342008-08-06 19:32:33 +02005116Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01005117
Wolfgang Denk06682362008-12-30 22:56:11 +01005118Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5119see http://lists.denx.de/mailman/listinfo/u-boot
5120
wdenk2729af92004-05-03 20:45:30 +00005121When you send a patch, please include the following information with
5122it:
wdenkc6097192002-11-03 00:24:07 +00005123
wdenk2729af92004-05-03 20:45:30 +00005124* For bug fixes: a description of the bug and how your patch fixes
5125 this bug. Please try to include a way of demonstrating that the
5126 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk2729af92004-05-03 20:45:30 +00005128* For new features: a description of the feature and your
5129 implementation.
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk2729af92004-05-03 20:45:30 +00005131* A CHANGELOG entry as plaintext (separate from the patch)
5132
5133* For major contributions, your entry to the CREDITS file
5134
5135* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005136 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005137
5138* If your patch adds new configuration options, don't forget to
5139 document these in the README file.
5140
Wolfgang Denk218ca722008-03-26 10:40:12 +01005141* The patch itself. If you are using git (which is *strongly*
5142 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005143 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005144 the U-Boot mailing list, you will avoid most of the common problems
5145 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005146
Wolfgang Denk218ca722008-03-26 10:40:12 +01005147 If you cannot use git, use "diff -purN OLD NEW". If your version of
5148 diff does not support these options, then get the latest version of
5149 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005150
Wolfgang Denk218ca722008-03-26 10:40:12 +01005151 The current directory when running this command shall be the parent
5152 directory of the U-Boot source tree (i. e. please make sure that
5153 your patch includes sufficient directory information for the
5154 affected files).
5155
5156 We prefer patches as plain text. MIME attachments are discouraged,
5157 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005158
5159* If one logical set of modifications affects or creates several
5160 files, all these changes shall be submitted in a SINGLE patch file.
5161
5162* Changesets that contain different, unrelated modifications shall be
5163 submitted as SEPARATE patches, one patch per changeset.
5164
5165
5166Notes:
5167
5168* Before sending the patch, run the MAKEALL script on your patched
5169 source tree and make sure that no errors or warnings are reported
5170 for any of the boards.
5171
5172* Keep your modifications to the necessary minimum: A patch
5173 containing several unrelated changes or arbitrary reformats will be
5174 returned with a request to re-formatting / split it.
5175
5176* If you modify existing code, make sure that your new code does not
5177 add to the memory footprint of the code ;-) Small is beautiful!
5178 When adding new features, these should compile conditionally only
5179 (using #ifdef), and the resulting code with the new feature
5180 disabled must not need more memory than the old code without your
5181 modification.
wdenk90dc6702005-05-03 14:12:25 +00005182
Wolfgang Denk06682362008-12-30 22:56:11 +01005183* Remember that there is a size limit of 100 kB per message on the
5184 u-boot mailing list. Bigger patches will be moderated. If they are
5185 reasonable and not too big, they will be acknowledged. But patches
5186 bigger than the size limit should be avoided.