blob: 6e313ad935474723f460e8d5ddeeaf426e8bd9b0 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000137 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800184 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000186 /nds32 Files generic to NDS32 architecture
187 /cpu CPU specific files
188 /n1213 Files specific to Andes Technology N1213 CPUs
189 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /nios2 Files generic to Altera NIOS2 architecture
191 /cpu CPU specific files
192 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200193 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500194 /cpu CPU specific files
195 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
196 /mpc5xx Files specific to Freescale MPC5xx CPUs
197 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
198 /mpc8xx Files specific to Freescale MPC8xx CPUs
199 /mpc8220 Files specific to Freescale MPC8220 CPUs
200 /mpc824x Files specific to Freescale MPC824x CPUs
201 /mpc8260 Files specific to Freescale MPC8260 CPUs
202 /mpc85xx Files specific to Freescale MPC85xx CPUs
203 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
204 /lib Architecture specific library files
205 /sh Files generic to SH architecture
206 /cpu CPU specific files
207 /sh2 Files specific to sh2 CPUs
208 /sh3 Files specific to sh3 CPUs
209 /sh4 Files specific to sh4 CPUs
210 /lib Architecture specific library files
211 /sparc Files generic to SPARC architecture
212 /cpu CPU specific files
213 /leon2 Files specific to Gaisler LEON2 SPARC CPU
214 /leon3 Files specific to Gaisler LEON3 SPARC CPU
215 /lib Architecture specific library files
216/api Machine/arch independent API for external apps
217/board Board dependent files
218/common Misc architecture independent functions
219/disk Code for disk drive partition handling
220/doc Documentation (don't expect too much)
221/drivers Commonly used device drivers
222/examples Example code for standalone applications, etc.
223/fs Filesystem code (cramfs, ext2, jffs2, etc.)
224/include Header Files
225/lib Files generic to all architectures
226 /libfdt Library files to support flattened device trees
227 /lzma Library files to support LZMA decompression
228 /lzo Library files to support LZO decompression
229/net Networking code
230/post Power On Self Test
231/rtc Real Time Clock drivers
232/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000233
wdenkc6097192002-11-03 00:24:07 +0000234Software Configuration:
235=======================
236
237Configuration is usually done using C preprocessor defines; the
238rationale behind that is to avoid dead code whenever possible.
239
240There are two classes of configuration variables:
241
242* Configuration _OPTIONS_:
243 These are selectable by the user and have names beginning with
244 "CONFIG_".
245
246* Configuration _SETTINGS_:
247 These depend on the hardware etc. and should not be meddled with if
248 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200249 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000250
251Later we will add a configuration tool - probably similar to or even
252identical to what's used for the Linux kernel. Right now, we have to
253do the configuration by hand, which means creating some symbolic
254links and editing some configuration files. We use the TQM8xxL boards
255as an example here.
256
257
258Selection of Processor Architecture and Board Type:
259---------------------------------------------------
260
261For all supported boards there are ready-to-use default
262configurations available; just type "make <board_name>_config".
263
264Example: For a TQM823L module type:
265
266 cd u-boot
267 make TQM823L_config
268
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200269For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000270e.g. "make cogent_mpc8xx_config". And also configure the cogent
271directory according to the instructions in cogent/README.
272
273
274Configuration Options:
275----------------------
276
277Configuration depends on the combination of board and CPU type; all
278such information is kept in a configuration file
279"include/configs/<board_name>.h".
280
281Example: For a TQM823L module, all configuration settings are in
282"include/configs/TQM823L.h".
283
284
wdenk7f6c2cb2002-11-10 22:06:23 +0000285Many of the options are named exactly as the corresponding Linux
286kernel configuration options. The intention is to make it easier to
287build a config tool - later.
288
289
wdenkc6097192002-11-03 00:24:07 +0000290The following options need to be configured:
291
Kim Phillips26281142007-08-10 13:28:25 -0500292- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000293
Kim Phillips26281142007-08-10 13:28:25 -0500294- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200295
296- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100297 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000298
299- CPU Module Type: (if CONFIG_COGENT is defined)
300 Define exactly one of
301 CONFIG_CMA286_60_OLD
302--- FIXME --- not tested yet:
303 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304 CONFIG_CMA287_23, CONFIG_CMA287_50
305
306- Motherboard Type: (if CONFIG_COGENT is defined)
307 Define exactly one of
308 CONFIG_CMA101, CONFIG_CMA102
309
310- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311 Define one or more of
312 CONFIG_CMA302
313
314- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315 Define one or more of
316 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200317 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000318 a "rotator" |\-/|\-/
319
wdenk2535d602003-07-17 23:16:40 +0000320- Board flavour: (if CONFIG_MPC8260ADS is defined)
321 CONFIG_ADSTYPE
322 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200323 CONFIG_SYS_8260ADS - original MPC8260ADS
324 CONFIG_SYS_8266ADS - MPC8266ADS
325 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
326 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000327
Lei Wencf946c62011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
wdenkc6097192002-11-03 00:24:07 +0000333- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000334 Define exactly one of
335 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000336
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200337- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
339 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000340 e.g. if there is no 32KHz
341 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
343 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000344
wdenk66ca92a2004-09-28 17:59:53 +0000345- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_8xx_CPUCLK_MIN
347 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000348 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000349 See doc/README.MPC866
350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000352
wdenkba56f622004-02-06 23:19:44 +0000353 Define this to measure the actual CPU clock instead
354 of relying on the correctness of the configured
355 values. Mostly useful for board bringup to make sure
356 the PLL is locked at the intended frequency. Note
357 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200358 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000359
Heiko Schocher506f3912009-03-12 07:37:15 +0100360 CONFIG_SYS_DELAYED_ICACHE
361
362 Define this option if you want to enable the
363 ICache only when Code runs from RAM.
364
Kumar Gala66412c62011-02-18 05:40:54 -0600365- 85xx CPU Options:
366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala8f290842011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000377- Generic CPU options:
378 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
379
380 Defines the endianess of the CPU. Implementation of those
381 values is arch specific.
382
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100383- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200384 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100385
386 Defines the Monahans run mode to oscillator
387 ratio. Valid values are 8, 16, 24, 31. The core
388 frequency is this value multiplied by 13 MHz.
389
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200390 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200391
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100392 Defines the Monahans turbo mode to oscillator
393 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200394 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100395 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200396
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200397- MIPS CPU options:
398 CONFIG_SYS_INIT_SP_OFFSET
399
400 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
401 pointer. This is needed for the temporary stack before
402 relocation.
403
404 CONFIG_SYS_MIPS_CACHE_MODE
405
406 Cache operation mode for the MIPS CPU.
407 See also arch/mips/include/asm/mipsregs.h.
408 Possible values are:
409 CONF_CM_CACHABLE_NO_WA
410 CONF_CM_CACHABLE_WA
411 CONF_CM_UNCACHED
412 CONF_CM_CACHABLE_NONCOHERENT
413 CONF_CM_CACHABLE_CE
414 CONF_CM_CACHABLE_COW
415 CONF_CM_CACHABLE_CUW
416 CONF_CM_CACHABLE_ACCELERATED
417
418 CONFIG_SYS_XWAY_EBU_BOOTCFG
419
420 Special option for Lantiq XWAY SoCs for booting from NOR flash.
421 See also arch/mips/cpu/mips32/start.S.
422
423 CONFIG_XWAY_SWAP_BYTES
424
425 Enable compilation of tools/xway-swap-bytes needed for Lantiq
426 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
427 be swapped if a flash programmer is used.
428
Christian Rieschb67d8812012-02-02 00:44:39 +0000429- ARM options:
430 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
431
432 Select high exception vectors of the ARM core, e.g., do not
433 clear the V bit of the c1 register of CP15.
434
Aneesh V5356f542012-03-08 07:20:19 +0000435 CONFIG_SYS_THUMB_BUILD
436
437 Use this flag to build U-Boot using the Thumb instruction
438 set for ARM architectures. Thumb instruction set provides
439 better code density. For ARM architectures that support
440 Thumb2 this flag will result in Thumb2 code generated by
441 GCC.
442
wdenk5da627a2003-10-09 20:09:04 +0000443- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000444 CONFIG_CLOCKS_IN_MHZ
445
446 U-Boot stores all clock information in Hz
447 internally. For binary compatibility with older Linux
448 kernels (which expect the clocks passed in the
449 bd_info data to be in MHz) the environment variable
450 "clocks_in_mhz" can be defined so that U-Boot
451 converts clock data to MHZ before passing it to the
452 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000453 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100454 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000455 default environment.
456
wdenk5da627a2003-10-09 20:09:04 +0000457 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
458
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200459 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000460 expect it to be in bytes, others in MB.
461 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
462
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400463 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200464
465 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400466 passed using flattened device trees (based on open firmware
467 concepts).
468
469 CONFIG_OF_LIBFDT
470 * New libfdt-based support
471 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500472 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400473
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200474 OF_CPU - The proper name of the cpus node (only required for
475 MPC512X and MPC5xxx based boards).
476 OF_SOC - The proper name of the soc node (only required for
477 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200478 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600479 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200480
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200481 boards with QUICC Engines require OF_QE to set UCC MAC
482 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500483
Kumar Gala4e253132006-01-11 13:54:17 -0600484 CONFIG_OF_BOARD_SETUP
485
486 Board code has addition modification that it wants to make
487 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000488
Matthew McClintock02677682006-06-28 10:41:37 -0500489 CONFIG_OF_BOOT_CPU
490
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200491 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500492 param header, the default value is zero if undefined.
493
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200494 CONFIG_OF_IDE_FIXUP
495
496 U-Boot can detect if an IDE device is present or not.
497 If not, and this new config option is activated, U-Boot
498 removes the ATA node from the DTS before booting Linux,
499 so the Linux IDE driver does not probe the device and
500 crash. This is needed for buggy hardware (uc101) where
501 no pull down resistor is connected to the signal IDE5V_DD7.
502
Igor Grinberg7eb29392011-07-14 05:45:07 +0000503 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
504
505 This setting is mandatory for all boards that have only one
506 machine type and must be used to specify the machine type
507 number as it appears in the ARM machine registry
508 (see http://www.arm.linux.org.uk/developer/machines/).
509 Only boards that have multiple machine types supported
510 in a single configuration file and the machine type is
511 runtime discoverable, do not have to use this setting.
512
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100513- vxWorks boot parameters:
514
515 bootvx constructs a valid bootline using the following
516 environments variables: bootfile, ipaddr, serverip, hostname.
517 It loads the vxWorks image pointed bootfile.
518
519 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
520 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
521 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
522 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
523
524 CONFIG_SYS_VXWORKS_ADD_PARAMS
525
526 Add it at the end of the bootline. E.g "u=username pw=secret"
527
528 Note: If a "bootargs" environment is defined, it will overwride
529 the defaults discussed just above.
530
Aneesh V2c451f72011-06-16 23:30:47 +0000531- Cache Configuration:
532 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
533 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
534 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
535
Aneesh V93bc2192011-06-16 23:30:51 +0000536- Cache Configuration for ARM:
537 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
538 controller
539 CONFIG_SYS_PL310_BASE - Physical base address of PL310
540 controller register space
541
wdenk6705d812004-08-02 23:22:59 +0000542- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200543 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000544
545 Define this if you want support for Amba PrimeCell PL010 UARTs.
546
Andreas Engel48d01922008-09-08 14:30:53 +0200547 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000548
549 Define this if you want support for Amba PrimeCell PL011 UARTs.
550
551 CONFIG_PL011_CLOCK
552
553 If you have Amba PrimeCell PL011 UARTs, set this variable to
554 the clock speed of the UARTs.
555
556 CONFIG_PL01x_PORTS
557
558 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
559 define this to a list of base addresses for each (supported)
560 port. See e.g. include/configs/versatile.h
561
John Rigby910f1ae2011-04-19 10:42:39 +0000562 CONFIG_PL011_SERIAL_RLCR
563
564 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
565 have separate receive and transmit line control registers. Set
566 this variable to initialize the extra register.
567
568 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
569
570 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
571 boot loader that has already initialized the UART. Define this
572 variable to flush the UART at init time.
573
wdenk6705d812004-08-02 23:22:59 +0000574
wdenkc6097192002-11-03 00:24:07 +0000575- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000576 Depending on board, define exactly one serial port
577 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
578 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
579 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000580
581 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
582 port routines must be defined elsewhere
583 (i.e. serial_init(), serial_getc(), ...)
584
585 CONFIG_CFB_CONSOLE
586 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000587 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000588 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
589 (default big endian)
590 VIDEO_HW_RECTFILL graphic chip supports
591 rectangle fill
592 (cf. smiLynxEM)
593 VIDEO_HW_BITBLT graphic chip supports
594 bit-blit (cf. smiLynxEM)
595 VIDEO_VISIBLE_COLS visible pixel columns
596 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000597 VIDEO_VISIBLE_ROWS visible pixel rows
598 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000599 VIDEO_DATA_FORMAT graphic data format
600 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000601 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000602 VIDEO_KBD_INIT_FCT keyboard int fct
603 (i.e. i8042_kbd_init())
604 VIDEO_TSTC_FCT test char fct
605 (i.e. i8042_tstc)
606 VIDEO_GETC_FCT get char fct
607 (i.e. i8042_getc)
608 CONFIG_CONSOLE_CURSOR cursor drawing on/off
609 (requires blink timer
610 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200611 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000612 CONFIG_CONSOLE_TIME display time/date info in
613 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500614 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000615 CONFIG_VIDEO_LOGO display Linux logo in
616 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000617 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
618 linux_logo.h for logo.
619 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000620 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200621 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000622 the logo
623
wdenk43d96162003-03-06 00:02:04 +0000624 When CONFIG_CFB_CONSOLE is defined, video console is
625 default i/o. Serial console can be forced with
626 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000627
wdenkd4ca31c2004-01-02 14:00:00 +0000628 When CONFIG_SILENT_CONSOLE is defined, all console
629 messages (by U-Boot and Linux!) can be silenced with
630 the "silent" environment variable. See
631 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000632
wdenkc6097192002-11-03 00:24:07 +0000633- Console Baudrate:
634 CONFIG_BAUDRATE - in bps
635 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200636 CONFIG_SYS_BAUDRATE_TABLE, see below.
637 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000638
Heiko Schocherc92fac92009-01-30 12:55:38 +0100639- Console Rx buffer length
640 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
641 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100642 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100643 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
644 must be defined, to setup the maximum idle timeout for
645 the SMC.
646
Graeme Russ9558b482011-09-01 00:48:27 +0000647- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200648 Prior to the console being initialised (i.e. serial UART
649 initialised etc) all console output is silently discarded.
650 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
651 buffer any console messages prior to the console being
652 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
653 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
654 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200655 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200656 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000657
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200658 'Sane' compilers will generate smaller code if
659 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000660
Sonny Rao046a37b2011-11-02 09:52:08 +0000661- Safe printf() functions
662 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
663 the printf() functions. These are defined in
664 include/vsprintf.h and include snprintf(), vsnprintf() and
665 so on. Code size increase is approximately 300-500 bytes.
666 If this option is not given then these functions will
667 silently discard their buffer size argument - this means
668 you are not getting any overflow checking in this case.
669
wdenkc6097192002-11-03 00:24:07 +0000670- Boot Delay: CONFIG_BOOTDELAY - in seconds
671 Delay before automatically booting the default image;
672 set to -1 to disable autoboot.
673
674 See doc/README.autoboot for these options that
675 work with CONFIG_BOOTDELAY. None are required.
676 CONFIG_BOOT_RETRY_TIME
677 CONFIG_BOOT_RETRY_MIN
678 CONFIG_AUTOBOOT_KEYED
679 CONFIG_AUTOBOOT_PROMPT
680 CONFIG_AUTOBOOT_DELAY_STR
681 CONFIG_AUTOBOOT_STOP_STR
682 CONFIG_AUTOBOOT_DELAY_STR2
683 CONFIG_AUTOBOOT_STOP_STR2
684 CONFIG_ZERO_BOOTDELAY_CHECK
685 CONFIG_RESET_TO_RETRY
686
687- Autoboot Command:
688 CONFIG_BOOTCOMMAND
689 Only needed when CONFIG_BOOTDELAY is enabled;
690 define a command string that is automatically executed
691 when no character is read on the console interface
692 within "Boot Delay" after reset.
693
694 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000695 This can be used to pass arguments to the bootm
696 command. The value of CONFIG_BOOTARGS goes into the
697 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000698
699 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000700 The value of these goes into the environment as
701 "ramboot" and "nfsboot" respectively, and can be used
702 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200703 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000704
705- Pre-Boot Commands:
706 CONFIG_PREBOOT
707
708 When this option is #defined, the existence of the
709 environment variable "preboot" will be checked
710 immediately before starting the CONFIG_BOOTDELAY
711 countdown and/or running the auto-boot command resp.
712 entering interactive mode.
713
714 This feature is especially useful when "preboot" is
715 automatically generated or modified. For an example
716 see the LWMON board specific code: here "preboot" is
717 modified when the user holds down a certain
718 combination of keys on the (special) keyboard when
719 booting the systems
720
721- Serial Download Echo Mode:
722 CONFIG_LOADS_ECHO
723 If defined to 1, all characters received during a
724 serial download (using the "loads" command) are
725 echoed back. This might be needed by some terminal
726 emulations (like "cu"), but may as well just take
727 time on others. This setting #define's the initial
728 value of the "loads_echo" environment variable.
729
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500730- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000731 CONFIG_KGDB_BAUDRATE
732 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200733 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000734
735- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500736 Monitor commands can be included or excluded
737 from the build by using the #include files
738 "config_cmd_all.h" and #undef'ing unwanted
739 commands, or using "config_cmd_default.h"
740 and augmenting with additional #define's
741 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000742
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500743 The default command configuration includes all commands
744 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000745
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500746 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500747 CONFIG_CMD_BDI bdinfo
748 CONFIG_CMD_BEDBUG * Include BedBug Debugger
749 CONFIG_CMD_BMP * BMP support
750 CONFIG_CMD_BSP * Board specific commands
751 CONFIG_CMD_BOOTD bootd
752 CONFIG_CMD_CACHE * icache, dcache
753 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500754 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500755 CONFIG_CMD_DATE * support for RTC, date/time...
756 CONFIG_CMD_DHCP * DHCP support
757 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600758 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
759 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
760 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
761 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500762 CONFIG_CMD_DTT * Digital Therm and Thermostat
763 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500764 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500765 CONFIG_CMD_EEPROM * EEPROM read/write support
766 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500767 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500768 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500769 CONFIG_CMD_FDC * Floppy Disk Support
770 CONFIG_CMD_FAT * FAT partition support
771 CONFIG_CMD_FDOS * Dos diskette Support
772 CONFIG_CMD_FLASH flinfo, erase, protect
773 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500774 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000775 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500776 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
777 CONFIG_CMD_I2C * I2C serial bus support
778 CONFIG_CMD_IDE * IDE harddisk support
779 CONFIG_CMD_IMI iminfo
780 CONFIG_CMD_IMLS List all found images
781 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500782 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500783 CONFIG_CMD_IRQ * irqinfo
784 CONFIG_CMD_ITEST Integer/string test of 2 values
785 CONFIG_CMD_JFFS2 * JFFS2 Support
786 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500787 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500788 CONFIG_CMD_LOADB loadb
789 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400790 CONFIG_CMD_MD5SUM print md5 message digest
791 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500792 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
793 loop, loopw, mtest
794 CONFIG_CMD_MISC Misc functions like sleep etc
795 CONFIG_CMD_MMC * MMC memory mapped support
796 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100797 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500798 CONFIG_CMD_NAND * NAND support
799 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600800 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000801 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500802 CONFIG_CMD_PCI * pciinfo
803 CONFIG_CMD_PCMCIA * PCMCIA support
804 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
805 host
806 CONFIG_CMD_PORTIO * Port I/O
807 CONFIG_CMD_REGINFO * Register dump
808 CONFIG_CMD_RUN run command in env variable
809 CONFIG_CMD_SAVES * save S record dump
810 CONFIG_CMD_SCSI * SCSI Support
811 CONFIG_CMD_SDRAM * print SDRAM configuration information
812 (requires CONFIG_CMD_I2C)
813 CONFIG_CMD_SETGETDCR Support for DCR Register access
814 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700815 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100816 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400817 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200818 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500819 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000820 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000821 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000822 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500823 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500824 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000825 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000826
wdenkc6097192002-11-03 00:24:07 +0000827
828 EXAMPLE: If you want all functions except of network
829 support you can write:
830
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500831 #include "config_cmd_all.h"
832 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000833
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400834 Other Commands:
835 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000836
837 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500838 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000839 what you (and your U-Boot users) are doing. Data
840 cache cannot be enabled on systems like the 8xx or
841 8260 (where accesses to the IMMR region must be
842 uncached), and it cannot be disabled on all other
843 systems where we (mis-) use the data cache to hold an
844 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000845
846
847 XXX - this list needs to get updated!
848
Simon Glass45ba8072011-10-15 05:48:20 +0000849- Device tree:
850 CONFIG_OF_CONTROL
851 If this variable is defined, U-Boot will use a device tree
852 to configure its devices, instead of relying on statically
853 compiled #defines in the board file. This option is
854 experimental and only available on a few boards. The device
855 tree is available in the global data as gd->fdt_blob.
856
Simon Glass2c0f79e2011-10-24 19:15:31 +0000857 U-Boot needs to get its device tree from somewhere. This can
858 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000859
860 CONFIG_OF_EMBED
861 If this variable is defined, U-Boot will embed a device tree
862 binary in its image. This device tree file should be in the
863 board directory and called <soc>-<board>.dts. The binary file
864 is then picked up in board_init_f() and made available through
865 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000866
Simon Glass2c0f79e2011-10-24 19:15:31 +0000867 CONFIG_OF_SEPARATE
868 If this variable is defined, U-Boot will build a device tree
869 binary. It will be called u-boot.dtb. Architecture-specific
870 code will locate it at run-time. Generally this works by:
871
872 cat u-boot.bin u-boot.dtb >image.bin
873
874 and in fact, U-Boot does this for you, creating a file called
875 u-boot-dtb.bin which is useful in the common case. You can
876 still use the individual files if you need something more
877 exotic.
878
wdenkc6097192002-11-03 00:24:07 +0000879- Watchdog:
880 CONFIG_WATCHDOG
881 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000882 support for the SoC. There must be support in the SoC
883 specific code for a watchdog. For the 8xx and 8260
884 CPUs, the SIU Watchdog feature is enabled in the SYPCR
885 register. When supported for a specific SoC is
886 available, then no further board specific code should
887 be needed to use it.
888
889 CONFIG_HW_WATCHDOG
890 When using a watchdog circuitry external to the used
891 SoC, then define this variable and provide board
892 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000893
stroesec1551ea2003-04-04 15:53:41 +0000894- U-Boot Version:
895 CONFIG_VERSION_VARIABLE
896 If this variable is defined, an environment variable
897 named "ver" is created by U-Boot showing the U-Boot
898 version as printed by the "version" command.
899 This variable is readonly.
900
wdenkc6097192002-11-03 00:24:07 +0000901- Real-Time Clock:
902
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500903 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000904 has to be selected, too. Define exactly one of the
905 following options:
906
907 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
908 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000909 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000910 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000911 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000912 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000913 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000914 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100915 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000916 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200917 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200918 CONFIG_SYS_RV3029_TCR - enable trickle charger on
919 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000920
wdenkb37c7e52003-06-30 16:24:52 +0000921 Note that if the RTC uses I2C, then the I2C interface
922 must also be configured. See I2C Support, below.
923
Peter Tysere92739d2008-12-17 16:36:21 -0600924- GPIO Support:
925 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
926 CONFIG_PCA953X_INFO - enable pca953x info command
927
Chris Packham5dec49c2010-12-19 10:12:13 +0000928 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
929 chip-ngpio pairs that tell the PCA953X driver the number of
930 pins supported by a particular chip.
931
Peter Tysere92739d2008-12-17 16:36:21 -0600932 Note that if the GPIO device uses I2C, then the I2C interface
933 must also be configured. See I2C Support, below.
934
wdenkc6097192002-11-03 00:24:07 +0000935- Timestamp Support:
936
wdenk43d96162003-03-06 00:02:04 +0000937 When CONFIG_TIMESTAMP is selected, the timestamp
938 (date and time) of an image is printed by image
939 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500940 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000941
942- Partition Support:
943 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400944 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000945
Wolfgang Denk218ca722008-03-26 10:40:12 +0100946 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
947 CONFIG_CMD_SCSI) you must configure support for at
948 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000949
950- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000951 CONFIG_IDE_RESET_ROUTINE - this is defined in several
952 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000953
wdenk4d13cba2004-03-14 14:09:05 +0000954 CONFIG_IDE_RESET - is this is defined, IDE Reset will
955 be performed by calling the function
956 ide_set_reset(int reset)
957 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000958
959- ATAPI Support:
960 CONFIG_ATAPI
961
962 Set this to enable ATAPI support.
963
wdenkc40b2952004-03-13 23:29:43 +0000964- LBA48 Support
965 CONFIG_LBA48
966
967 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100968 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000969 Whithout these , LBA48 support uses 32bit variables and will 'only'
970 support disks up to 2.1TB.
971
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200972 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000973 When enabled, makes the IDE subsystem use 64bit sector addresses.
974 Default is 32bit.
975
wdenkc6097192002-11-03 00:24:07 +0000976- SCSI Support:
977 At the moment only there is only support for the
978 SYM53C8XX SCSI controller; define
979 CONFIG_SCSI_SYM53C8XX to enable it.
980
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200981 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
982 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
983 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000984 maximum numbers of LUNs, SCSI ID's and target
985 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200986 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000987
988- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000989 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000990 Support for Intel 8254x/8257x gigabit chips.
991
992 CONFIG_E1000_SPI
993 Utility code for direct access to the SPI bus on Intel 8257x.
994 This does not do anything useful unless you set at least one
995 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
996
997 CONFIG_E1000_SPI_GENERIC
998 Allow generic access to the SPI bus on the Intel 8257x, for
999 example with the "sspi" command.
1000
1001 CONFIG_CMD_E1000
1002 Management command for E1000 devices. When used on devices
1003 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001004
Andre Schwarzac3315c2008-03-06 16:45:44 +01001005 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001006 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001007
wdenkc6097192002-11-03 00:24:07 +00001008 CONFIG_EEPRO100
1009 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001010 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001011 write routine for first time initialisation.
1012
1013 CONFIG_TULIP
1014 Support for Digital 2114x chips.
1015 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1016 modem chip initialisation (KS8761/QS6611).
1017
1018 CONFIG_NATSEMI
1019 Support for National dp83815 chips.
1020
1021 CONFIG_NS8382X
1022 Support for National dp8382[01] gigabit chips.
1023
wdenk45219c42003-05-12 21:50:16 +00001024- NETWORK Support (other):
1025
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001026 CONFIG_DRIVER_AT91EMAC
1027 Support for AT91RM9200 EMAC.
1028
1029 CONFIG_RMII
1030 Define this to use reduced MII inteface
1031
1032 CONFIG_DRIVER_AT91EMAC_QUIET
1033 If this defined, the driver is quiet.
1034 The driver doen't show link status messages.
1035
Rob Herringefdd7312011-12-15 11:15:49 +00001036 CONFIG_CALXEDA_XGMAC
1037 Support for the Calxeda XGMAC device
1038
wdenk45219c42003-05-12 21:50:16 +00001039 CONFIG_DRIVER_LAN91C96
1040 Support for SMSC's LAN91C96 chips.
1041
1042 CONFIG_LAN91C96_BASE
1043 Define this to hold the physical address
1044 of the LAN91C96's I/O space
1045
1046 CONFIG_LAN91C96_USE_32_BIT
1047 Define this to enable 32 bit addressing
1048
wdenkf39748a2004-06-09 13:37:52 +00001049 CONFIG_DRIVER_SMC91111
1050 Support for SMSC's LAN91C111 chip
1051
1052 CONFIG_SMC91111_BASE
1053 Define this to hold the physical address
1054 of the device (I/O space)
1055
1056 CONFIG_SMC_USE_32_BIT
1057 Define this if data bus is 32 bits
1058
1059 CONFIG_SMC_USE_IOFUNCS
1060 Define this to use i/o functions instead of macros
1061 (some hardware wont work with macros)
1062
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001063 CONFIG_DRIVER_TI_EMAC
1064 Support for davinci emac
1065
1066 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1067 Define this if you have more then 3 PHYs.
1068
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001069 CONFIG_FTGMAC100
1070 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1071
1072 CONFIG_FTGMAC100_EGIGA
1073 Define this to use GE link update with gigabit PHY.
1074 Define this if FTGMAC100 is connected to gigabit PHY.
1075 If your system has 10/100 PHY only, it might not occur
1076 wrong behavior. Because PHY usually return timeout or
1077 useless data when polling gigabit status and gigabit
1078 control registers. This behavior won't affect the
1079 correctnessof 10/100 link speed update.
1080
Mike Rapoportc2fff332009-11-11 10:03:03 +02001081 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001082 Support for SMSC's LAN911x and LAN921x chips
1083
Mike Rapoportc2fff332009-11-11 10:03:03 +02001084 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001085 Define this to hold the physical address
1086 of the device (I/O space)
1087
Mike Rapoportc2fff332009-11-11 10:03:03 +02001088 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001089 Define this if data bus is 32 bits
1090
Mike Rapoportc2fff332009-11-11 10:03:03 +02001091 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001092 Define this if data bus is 16 bits. If your processor
1093 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001094 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001095
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001096 CONFIG_SH_ETHER
1097 Support for Renesas on-chip Ethernet controller
1098
1099 CONFIG_SH_ETHER_USE_PORT
1100 Define the number of ports to be used
1101
1102 CONFIG_SH_ETHER_PHY_ADDR
1103 Define the ETH PHY's address
1104
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001105 CONFIG_SH_ETHER_CACHE_WRITEBACK
1106 If this option is set, the driver enables cache flush.
1107
Vadim Bendebury5e124722011-10-17 08:36:14 +00001108- TPM Support:
1109 CONFIG_GENERIC_LPC_TPM
1110 Support for generic parallel port TPM devices. Only one device
1111 per system is supported at this time.
1112
1113 CONFIG_TPM_TIS_BASE_ADDRESS
1114 Base address where the generic TPM device is mapped
1115 to. Contemporary x86 systems usually map it at
1116 0xfed40000.
1117
wdenkc6097192002-11-03 00:24:07 +00001118- USB Support:
1119 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001120 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001121 CONFIG_USB_UHCI to enable it.
1122 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001123 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001124 storage devices.
1125 Note:
1126 Supported are USB Keyboards and USB Floppy drives
1127 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001128 MPC5200 USB requires additional defines:
1129 CONFIG_USB_CLOCK
1130 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001131 CONFIG_PSC3_USB
1132 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001133 CONFIG_USB_CONFIG
1134 for differential drivers: 0x00001000
1135 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001136 for differential drivers on PSC3: 0x00000100
1137 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001138 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001139 May be defined to allow interrupt polling
1140 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001141
Simon Glass9ab4ce22012-02-27 10:52:47 +00001142 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1143 txfilltuning field in the EHCI controller on reset.
1144
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001145- USB Device:
1146 Define the below if you wish to use the USB console.
1147 Once firmware is rebuilt from a serial console issue the
1148 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001149 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001150 it has found a new device. The environment variable usbtty
1151 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001152 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001153 Common Device Class Abstract Control Model serial device.
1154 If you select usbtty = gserial you should be able to enumerate
1155 a Linux host by
1156 # modprobe usbserial vendor=0xVendorID product=0xProductID
1157 else if using cdc_acm, simply setting the environment
1158 variable usbtty to be cdc_acm should suffice. The following
1159 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001160
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001161 CONFIG_USB_DEVICE
1162 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001163
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001164 CONFIG_USB_TTY
1165 Define this to have a tty type of device available to
1166 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001167
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301168 CONFIG_USBD_HS
1169 Define this to enable the high speed support for usb
1170 device and usbtty. If this feature is enabled, a routine
1171 int is_usbd_high_speed(void)
1172 also needs to be defined by the driver to dynamically poll
1173 whether the enumeration has succeded at high speed or full
1174 speed.
1175
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001176 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001177 Define this if you want stdin, stdout &/or stderr to
1178 be set to usbtty.
1179
1180 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001181 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001182 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001183 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001184
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001185 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001186 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001187 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001188
Wolfgang Denk386eda02006-06-14 18:14:56 +02001189 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001190 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001191 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001192 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1193 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1194 should pretend to be a Linux device to it's target host.
1195
1196 CONFIG_USBD_MANUFACTURER
1197 Define this string as the name of your company for
1198 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001199
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001200 CONFIG_USBD_PRODUCT_NAME
1201 Define this string as the name of your product
1202 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1203
1204 CONFIG_USBD_VENDORID
1205 Define this as your assigned Vendor ID from the USB
1206 Implementors Forum. This *must* be a genuine Vendor ID
1207 to avoid polluting the USB namespace.
1208 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001209
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001210 CONFIG_USBD_PRODUCTID
1211 Define this as the unique Product ID
1212 for your device
1213 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001214
Igor Grinbergd70a5602011-12-12 12:08:35 +02001215- ULPI Layer Support:
1216 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1217 the generic ULPI layer. The generic layer accesses the ULPI PHY
1218 via the platform viewport, so you need both the genric layer and
1219 the viewport enabled. Currently only Chipidea/ARC based
1220 viewport is supported.
1221 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1222 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
wdenkc6097192002-11-03 00:24:07 +00001223
1224- MMC Support:
1225 The MMC controller on the Intel PXA is supported. To
1226 enable this define CONFIG_MMC. The MMC can be
1227 accessed from the boot prompt by mapping the device
1228 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001229 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1230 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001231
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001232 CONFIG_SH_MMCIF
1233 Support for Renesas on-chip MMCIF controller
1234
1235 CONFIG_SH_MMCIF_ADDR
1236 Define the base address of MMCIF registers
1237
1238 CONFIG_SH_MMCIF_CLK
1239 Define the clock frequency for MMCIF
1240
wdenk6705d812004-08-02 23:22:59 +00001241- Journaling Flash filesystem support:
1242 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1243 CONFIG_JFFS2_NAND_DEV
1244 Define these for a default partition on a NAND device
1245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001246 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1247 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001248 Define these for a default partition on a NOR device
1249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001250 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001251 Define this to create an own partition. You have to provide a
1252 function struct part_info* jffs2_part_info(int part_num)
1253
1254 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001255 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001256 to disable the command chpart. This is the default when you
1257 have not defined a custom partition
1258
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001259- FAT(File Allocation Table) filesystem write function support:
1260 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001261
1262 Define this to enable support for saving memory data as a
1263 file in FAT formatted partition.
1264
1265 This will also enable the command "fatwrite" enabling the
1266 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001267
wdenkc6097192002-11-03 00:24:07 +00001268- Keyboard Support:
1269 CONFIG_ISA_KEYBOARD
1270
1271 Define this to enable standard (PC-Style) keyboard
1272 support
1273
1274 CONFIG_I8042_KBD
1275 Standard PC keyboard driver with US (is default) and
1276 GERMAN key layout (switch via environment 'keymap=de') support.
1277 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1278 for cfb_console. Supports cursor blinking.
1279
1280- Video support:
1281 CONFIG_VIDEO
1282
1283 Define this to enable video support (for output to
1284 video).
1285
1286 CONFIG_VIDEO_CT69000
1287
1288 Enable Chips & Technologies 69000 Video chip
1289
1290 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001291 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001292 video output is selected via environment 'videoout'
1293 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1294 assumed.
wdenkc6097192002-11-03 00:24:07 +00001295
wdenkb79a11c2004-03-25 15:14:43 +00001296 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001297 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001298 are possible:
1299 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001300 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001301
1302 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1303 -------------+---------------------------------------------
1304 8 bits | 0x301* 0x303 0x305 0x161 0x307
1305 15 bits | 0x310 0x313 0x316 0x162 0x319
1306 16 bits | 0x311 0x314 0x317 0x163 0x31A
1307 24 bits | 0x312 0x315 0x318 ? 0x31B
1308 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001309 (i.e. setenv videomode 317; saveenv; reset;)
1310
wdenkb79a11c2004-03-25 15:14:43 +00001311 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001312 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001313
1314
stroesec1551ea2003-04-04 15:53:41 +00001315 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001316 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001317 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1318 or CONFIG_VIDEO_SED13806_16BPP
1319
Timur Tabi7d3053f2011-02-15 17:09:19 -06001320 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001321 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001322 SOCs that have a DIU should define this macro to enable DIU
1323 support, and should also define these other macros:
1324
1325 CONFIG_SYS_DIU_ADDR
1326 CONFIG_VIDEO
1327 CONFIG_CMD_BMP
1328 CONFIG_CFB_CONSOLE
1329 CONFIG_VIDEO_SW_CURSOR
1330 CONFIG_VGA_AS_SINGLE_DEVICE
1331 CONFIG_VIDEO_LOGO
1332 CONFIG_VIDEO_BMP_LOGO
1333
Timur Tabiba8e76b2011-04-11 14:18:22 -05001334 The DIU driver will look for the 'video-mode' environment
1335 variable, and if defined, enable the DIU as a console during
1336 boot. See the documentation file README.video for a
1337 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001338
wdenk682011f2003-06-03 23:54:09 +00001339- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001340 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001341
wdenk8bde7f72003-06-27 21:31:46 +00001342 Define this to enable a custom keyboard support.
1343 This simply calls drv_keyboard_init() which must be
1344 defined in your board-specific files.
1345 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001346
wdenkc6097192002-11-03 00:24:07 +00001347- LCD Support: CONFIG_LCD
1348
1349 Define this to enable LCD support (for output to LCD
1350 display); also select one of the supported displays
1351 by defining one of these:
1352
Stelian Pop39cf4802008-05-09 21:57:18 +02001353 CONFIG_ATMEL_LCD:
1354
1355 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1356
wdenkfd3103b2003-11-25 16:55:19 +00001357 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001358
wdenkfd3103b2003-11-25 16:55:19 +00001359 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001360
wdenkfd3103b2003-11-25 16:55:19 +00001361 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001362
wdenkfd3103b2003-11-25 16:55:19 +00001363 NEC NL6448BC20-08. 6.5", 640x480.
1364 Active, color, single scan.
1365
1366 CONFIG_NEC_NL6448BC33_54
1367
1368 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001369 Active, color, single scan.
1370
1371 CONFIG_SHARP_16x9
1372
1373 Sharp 320x240. Active, color, single scan.
1374 It isn't 16x9, and I am not sure what it is.
1375
1376 CONFIG_SHARP_LQ64D341
1377
1378 Sharp LQ64D341 display, 640x480.
1379 Active, color, single scan.
1380
1381 CONFIG_HLD1045
1382
1383 HLD1045 display, 640x480.
1384 Active, color, single scan.
1385
1386 CONFIG_OPTREX_BW
1387
1388 Optrex CBL50840-2 NF-FW 99 22 M5
1389 or
1390 Hitachi LMG6912RPFC-00T
1391 or
1392 Hitachi SP14Q002
1393
1394 320x240. Black & white.
1395
1396 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001397 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001398
wdenk7152b1d2003-09-05 23:19:14 +00001399- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001400
wdenk8bde7f72003-06-27 21:31:46 +00001401 If this option is set, the environment is checked for
1402 a variable "splashimage". If found, the usual display
1403 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001404 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001405 specified in "splashimage" is loaded instead. The
1406 console is redirected to the "nulldev", too. This
1407 allows for a "silent" boot where a splash screen is
1408 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001409
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001410 CONFIG_SPLASH_SCREEN_ALIGN
1411
1412 If this option is set the splash image can be freely positioned
1413 on the screen. Environment variable "splashpos" specifies the
1414 position as "x,y". If a positive number is given it is used as
1415 number of pixel from left/top. If a negative number is given it
1416 is used as number of pixel from right/bottom. You can also
1417 specify 'm' for centering the image.
1418
1419 Example:
1420 setenv splashpos m,m
1421 => image at center of screen
1422
1423 setenv splashpos 30,20
1424 => image at x = 30 and y = 20
1425
1426 setenv splashpos -10,m
1427 => vertically centered image
1428 at x = dspWidth - bmpWidth - 9
1429
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001430- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1431
1432 If this option is set, additionally to standard BMP
1433 images, gzipped BMP images can be displayed via the
1434 splashscreen support or the bmp command.
1435
Anatolij Gustschind5011762010-03-15 14:50:25 +01001436- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1437
1438 If this option is set, 8-bit RLE compressed BMP images
1439 can be displayed via the splashscreen support or the
1440 bmp command.
1441
wdenkc29fdfc2003-08-29 20:57:53 +00001442- Compression support:
1443 CONFIG_BZIP2
1444
1445 If this option is set, support for bzip2 compressed
1446 images is included. If not, only uncompressed and gzip
1447 compressed images are supported.
1448
wdenk42d1f032003-10-15 23:53:47 +00001449 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001450 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001451 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001452
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001453 CONFIG_LZMA
1454
1455 If this option is set, support for lzma compressed
1456 images is included.
1457
1458 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1459 requires an amount of dynamic memory that is given by the
1460 formula:
1461
1462 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1463
1464 Where lc and lp stand for, respectively, Literal context bits
1465 and Literal pos bits.
1466
1467 This value is upper-bounded by 14MB in the worst case. Anyway,
1468 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1469 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1470 a very small buffer.
1471
1472 Use the lzmainfo tool to determinate the lc and lp values and
1473 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001474 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001475
wdenk17ea1172004-06-06 21:51:03 +00001476- MII/PHY support:
1477 CONFIG_PHY_ADDR
1478
1479 The address of PHY on MII bus.
1480
1481 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1482
1483 The clock frequency of the MII bus
1484
1485 CONFIG_PHY_GIGE
1486
1487 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001488 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001489
1490 CONFIG_PHY_RESET_DELAY
1491
1492 Some PHY like Intel LXT971A need extra delay after
1493 reset before any MII register access is possible.
1494 For such PHY, set this option to the usec delay
1495 required. (minimum 300usec for LXT971A)
1496
1497 CONFIG_PHY_CMD_DELAY (ppc4xx)
1498
1499 Some PHY like Intel LXT971A need extra delay after
1500 command issued before MII status register can be read
1501
wdenkc6097192002-11-03 00:24:07 +00001502- Ethernet address:
1503 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001504 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001505 CONFIG_ETH2ADDR
1506 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001507 CONFIG_ETH4ADDR
1508 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001509
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001510 Define a default value for Ethernet address to use
1511 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001512 is not determined automatically.
1513
1514- IP address:
1515 CONFIG_IPADDR
1516
1517 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001518 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001519 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001520 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001521
1522- Server IP address:
1523 CONFIG_SERVERIP
1524
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001525 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001526 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001527 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001528
Robin Getz97cfe862009-07-21 12:15:28 -04001529 CONFIG_KEEP_SERVERADDR
1530
1531 Keeps the server's MAC address, in the env 'serveraddr'
1532 for passing to bootargs (like Linux's netconsole option)
1533
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001534- Gateway IP address:
1535 CONFIG_GATEWAYIP
1536
1537 Defines a default value for the IP address of the
1538 default router where packets to other networks are
1539 sent to.
1540 (Environment variable "gatewayip")
1541
1542- Subnet mask:
1543 CONFIG_NETMASK
1544
1545 Defines a default value for the subnet mask (or
1546 routing prefix) which is used to determine if an IP
1547 address belongs to the local subnet or needs to be
1548 forwarded through a router.
1549 (Environment variable "netmask")
1550
David Updegraff53a5c422007-06-11 10:41:07 -05001551- Multicast TFTP Mode:
1552 CONFIG_MCAST_TFTP
1553
1554 Defines whether you want to support multicast TFTP as per
1555 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001556 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001557 driver in use must provide a function: mcast() to join/leave a
1558 multicast group.
1559
wdenkc6097192002-11-03 00:24:07 +00001560- BOOTP Recovery Mode:
1561 CONFIG_BOOTP_RANDOM_DELAY
1562
1563 If you have many targets in a network that try to
1564 boot using BOOTP, you may want to avoid that all
1565 systems send out BOOTP requests at precisely the same
1566 moment (which would happen for instance at recovery
1567 from a power failure, when all systems will try to
1568 boot, thus flooding the BOOTP server. Defining
1569 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1570 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001571 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001572
1573 1st BOOTP request: delay 0 ... 1 sec
1574 2nd BOOTP request: delay 0 ... 2 sec
1575 3rd BOOTP request: delay 0 ... 4 sec
1576 4th and following
1577 BOOTP requests: delay 0 ... 8 sec
1578
stroesefe389a82003-08-28 14:17:32 +00001579- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001580 You can fine tune the DHCP functionality by defining
1581 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001582
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001583 CONFIG_BOOTP_SUBNETMASK
1584 CONFIG_BOOTP_GATEWAY
1585 CONFIG_BOOTP_HOSTNAME
1586 CONFIG_BOOTP_NISDOMAIN
1587 CONFIG_BOOTP_BOOTPATH
1588 CONFIG_BOOTP_BOOTFILESIZE
1589 CONFIG_BOOTP_DNS
1590 CONFIG_BOOTP_DNS2
1591 CONFIG_BOOTP_SEND_HOSTNAME
1592 CONFIG_BOOTP_NTPSERVER
1593 CONFIG_BOOTP_TIMEOFFSET
1594 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001595 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001596
Wilson Callan5d110f02007-07-28 10:56:13 -04001597 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1598 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001599
Joe Hershberger2c00e092012-05-23 07:59:19 +00001600 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1601 after the configured retry count, the call will fail
1602 instead of starting over. This can be used to fail over
1603 to Link-local IP address configuration if the DHCP server
1604 is not available.
1605
stroesefe389a82003-08-28 14:17:32 +00001606 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1607 serverip from a DHCP server, it is possible that more
1608 than one DNS serverip is offered to the client.
1609 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1610 serverip will be stored in the additional environment
1611 variable "dnsip2". The first DNS serverip is always
1612 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001613 is defined.
stroesefe389a82003-08-28 14:17:32 +00001614
1615 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1616 to do a dynamic update of a DNS server. To do this, they
1617 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001618 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001619 of the "hostname" environment variable is passed as
1620 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001621
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001622 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1623
1624 A 32bit value in microseconds for a delay between
1625 receiving a "DHCP Offer" and sending the "DHCP Request".
1626 This fixes a problem with certain DHCP servers that don't
1627 respond 100% of the time to a "DHCP request". E.g. On an
1628 AT91RM9200 processor running at 180MHz, this delay needed
1629 to be *at least* 15,000 usec before a Windows Server 2003
1630 DHCP server would reply 100% of the time. I recommend at
1631 least 50,000 usec to be safe. The alternative is to hope
1632 that one of the retries will be successful but note that
1633 the DHCP timeout and retry process takes a longer than
1634 this delay.
1635
wdenka3d991b2004-04-15 21:48:45 +00001636 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001637 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001638
1639 The device id used in CDP trigger frames.
1640
1641 CONFIG_CDP_DEVICE_ID_PREFIX
1642
1643 A two character string which is prefixed to the MAC address
1644 of the device.
1645
1646 CONFIG_CDP_PORT_ID
1647
1648 A printf format string which contains the ascii name of
1649 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001650 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001651
1652 CONFIG_CDP_CAPABILITIES
1653
1654 A 32bit integer which indicates the device capabilities;
1655 0x00000010 for a normal host which does not forwards.
1656
1657 CONFIG_CDP_VERSION
1658
1659 An ascii string containing the version of the software.
1660
1661 CONFIG_CDP_PLATFORM
1662
1663 An ascii string containing the name of the platform.
1664
1665 CONFIG_CDP_TRIGGER
1666
1667 A 32bit integer sent on the trigger.
1668
1669 CONFIG_CDP_POWER_CONSUMPTION
1670
1671 A 16bit integer containing the power consumption of the
1672 device in .1 of milliwatts.
1673
1674 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1675
1676 A byte containing the id of the VLAN.
1677
wdenkc6097192002-11-03 00:24:07 +00001678- Status LED: CONFIG_STATUS_LED
1679
1680 Several configurations allow to display the current
1681 status using a LED. For instance, the LED will blink
1682 fast while running U-Boot code, stop blinking as
1683 soon as a reply to a BOOTP request was received, and
1684 start blinking slow once the Linux kernel is running
1685 (supported by a status LED driver in the Linux
1686 kernel). Defining CONFIG_STATUS_LED enables this
1687 feature in U-Boot.
1688
1689- CAN Support: CONFIG_CAN_DRIVER
1690
1691 Defining CONFIG_CAN_DRIVER enables CAN driver support
1692 on those systems that support this (optional)
1693 feature, like the TQM8xxL modules.
1694
1695- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1696
wdenkb37c7e52003-06-30 16:24:52 +00001697 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001698 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001699 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001700
wdenk945af8d2003-07-16 21:53:01 +00001701 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001702 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001703 CONFIG_COMMANDS) and communicate with i2c based realtime
1704 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001705 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001706
Ben Warrenbb99ad62006-09-07 16:50:54 -04001707 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001708
wdenk945af8d2003-07-16 21:53:01 +00001709 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001710 bit-banging) driver instead of CPM or similar hardware
1711 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001712
wdenk945af8d2003-07-16 21:53:01 +00001713 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001714 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001715
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001716 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001717 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001718 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001719 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001720
Peter Tyser8d321b82010-04-12 22:28:21 -05001721 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001722 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001723 and so its address should therefore be cleared to 0 (See,
1724 eg, MPC823e User's Manual p.16-473). So, set
1725 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001726
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001727 CONFIG_SYS_I2C_INIT_MPC5XXX
1728
1729 When a board is reset during an i2c bus transfer
1730 chips might think that the current transfer is still
1731 in progress. Reset the slave devices by sending start
1732 commands until the slave device responds.
1733
wdenk945af8d2003-07-16 21:53:01 +00001734 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001735
1736 If you use the software i2c interface (CONFIG_SOFT_I2C)
1737 then the following macros need to be defined (examples are
1738 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001739
1740 I2C_INIT
1741
wdenkb37c7e52003-06-30 16:24:52 +00001742 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001743 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001744
wdenkba56f622004-02-06 23:19:44 +00001745 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001746
wdenkc6097192002-11-03 00:24:07 +00001747 I2C_PORT
1748
wdenk43d96162003-03-06 00:02:04 +00001749 (Only for MPC8260 CPU). The I/O port to use (the code
1750 assumes both bits are on the same port). Valid values
1751 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001752
1753 I2C_ACTIVE
1754
1755 The code necessary to make the I2C data line active
1756 (driven). If the data line is open collector, this
1757 define can be null.
1758
wdenkb37c7e52003-06-30 16:24:52 +00001759 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1760
wdenkc6097192002-11-03 00:24:07 +00001761 I2C_TRISTATE
1762
1763 The code necessary to make the I2C data line tri-stated
1764 (inactive). If the data line is open collector, this
1765 define can be null.
1766
wdenkb37c7e52003-06-30 16:24:52 +00001767 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1768
wdenkc6097192002-11-03 00:24:07 +00001769 I2C_READ
1770
1771 Code that returns TRUE if the I2C data line is high,
1772 FALSE if it is low.
1773
wdenkb37c7e52003-06-30 16:24:52 +00001774 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1775
wdenkc6097192002-11-03 00:24:07 +00001776 I2C_SDA(bit)
1777
1778 If <bit> is TRUE, sets the I2C data line high. If it
1779 is FALSE, it clears it (low).
1780
wdenkb37c7e52003-06-30 16:24:52 +00001781 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001782 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001783 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001784
wdenkc6097192002-11-03 00:24:07 +00001785 I2C_SCL(bit)
1786
1787 If <bit> is TRUE, sets the I2C clock line high. If it
1788 is FALSE, it clears it (low).
1789
wdenkb37c7e52003-06-30 16:24:52 +00001790 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001791 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001792 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001793
wdenkc6097192002-11-03 00:24:07 +00001794 I2C_DELAY
1795
1796 This delay is invoked four times per clock cycle so this
1797 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001798 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001799 like:
1800
wdenkb37c7e52003-06-30 16:24:52 +00001801 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001802
Mike Frysinger793b5722010-07-21 13:38:02 -04001803 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1804
1805 If your arch supports the generic GPIO framework (asm/gpio.h),
1806 then you may alternatively define the two GPIOs that are to be
1807 used as SCL / SDA. Any of the previous I2C_xxx macros will
1808 have GPIO-based defaults assigned to them as appropriate.
1809
1810 You should define these to the GPIO value as given directly to
1811 the generic GPIO functions.
1812
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001813 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001814
wdenk8bde7f72003-06-27 21:31:46 +00001815 When a board is reset during an i2c bus transfer
1816 chips might think that the current transfer is still
1817 in progress. On some boards it is possible to access
1818 the i2c SCLK line directly, either by using the
1819 processor pin as a GPIO or by having a second pin
1820 connected to the bus. If this option is defined a
1821 custom i2c_init_board() routine in boards/xxx/board.c
1822 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001823
Richard Retanubun26a33502010-04-12 15:08:17 -04001824 CONFIG_SYS_I2C_BOARD_LATE_INIT
1825
1826 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1827 defined a custom i2c_board_late_init() routine in
1828 boards/xxx/board.c is run AFTER the operations in i2c_init()
1829 is completed. This callpoint can be used to unreset i2c bus
1830 using CPU i2c controller register accesses for CPUs whose i2c
1831 controller provide such a method. It is called at the end of
1832 i2c_init() to allow i2c_init operations to setup the i2c bus
1833 controller on the CPU (e.g. setting bus speed & slave address).
1834
wdenk17ea1172004-06-06 21:51:03 +00001835 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1836
1837 This option enables configuration of bi_iic_fast[] flags
1838 in u-boot bd_info structure based on u-boot environment
1839 variable "i2cfast". (see also i2cfast)
1840
Ben Warrenbb99ad62006-09-07 16:50:54 -04001841 CONFIG_I2C_MULTI_BUS
1842
1843 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001844 must have a controller. At any point in time, only one bus is
1845 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001846 Note that bus numbering is zero-based.
1847
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001848 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001849
1850 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001851 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001852 is set, specify a list of bus-device pairs. Otherwise, specify
1853 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001854
1855 e.g.
1856 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001857 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001858
1859 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1860
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001861 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001862 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001863
1864 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1865
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001866 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001867
1868 If defined, then this indicates the I2C bus number for DDR SPD.
1869 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1870
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001871 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001872
1873 If defined, then this indicates the I2C bus number for the RTC.
1874 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1875
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001876 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001877
1878 If defined, then this indicates the I2C bus number for the DTT.
1879 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1880
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001881 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001882
1883 If defined, specifies the I2C address of the DTT device.
1884 If not defined, then U-Boot uses predefined value for
1885 specified DTT device.
1886
Timur Tabibe5e6182006-11-03 19:15:00 -06001887 CONFIG_FSL_I2C
1888
1889 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001890 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001891
Heiko Schocher67b23a32008-10-15 09:39:47 +02001892 CONFIG_I2C_MUX
1893
1894 Define this option if you have I2C devices reached over 1 .. n
1895 I2C Muxes like the pca9544a. This option addes a new I2C
1896 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1897 new I2C Bus to the existing I2C Busses. If you select the
1898 new Bus with "i2c dev", u-bbot sends first the commandos for
1899 the muxes to activate this new "bus".
1900
1901 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1902 feature!
1903
1904 Example:
1905 Adding a new I2C Bus reached over 2 pca9544a muxes
1906 The First mux with address 70 and channel 6
1907 The Second mux with address 71 and channel 4
1908
1909 => i2c bus pca9544a:70:6:pca9544a:71:4
1910
1911 Use the "i2c bus" command without parameter, to get a list
1912 of I2C Busses with muxes:
1913
1914 => i2c bus
1915 Busses reached over muxes:
1916 Bus ID: 2
1917 reached over Mux(es):
1918 pca9544a@70 ch: 4
1919 Bus ID: 3
1920 reached over Mux(es):
1921 pca9544a@70 ch: 6
1922 pca9544a@71 ch: 4
1923 =>
1924
1925 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001926 u-boot first sends the command to the mux@70 to enable
1927 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001928 the channel 4.
1929
1930 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001931 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001932 the 2 muxes.
1933
1934 This option is actually implemented for the bitbanging
1935 algorithm in common/soft_i2c.c and for the Hardware I2C
1936 Bus on the MPC8260. But it should be not so difficult
1937 to add this option to other architectures.
1938
Andrew Dyer2ac69852008-12-29 17:36:01 -06001939 CONFIG_SOFT_I2C_READ_REPEATED_START
1940
1941 defining this will force the i2c_read() function in
1942 the soft_i2c driver to perform an I2C repeated start
1943 between writing the address pointer and reading the
1944 data. If this define is omitted the default behaviour
1945 of doing a stop-start sequence will be used. Most I2C
1946 devices can use either method, but some require one or
1947 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001948
wdenkc6097192002-11-03 00:24:07 +00001949- SPI Support: CONFIG_SPI
1950
1951 Enables SPI driver (so far only tested with
1952 SPI EEPROM, also an instance works with Crystal A/D and
1953 D/As on the SACSng board)
1954
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001955 CONFIG_SH_SPI
1956
1957 Enables the driver for SPI controller on SuperH. Currently
1958 only SH7757 is supported.
1959
wdenkc6097192002-11-03 00:24:07 +00001960 CONFIG_SPI_X
1961
1962 Enables extended (16-bit) SPI EEPROM addressing.
1963 (symmetrical to CONFIG_I2C_X)
1964
1965 CONFIG_SOFT_SPI
1966
wdenk43d96162003-03-06 00:02:04 +00001967 Enables a software (bit-bang) SPI driver rather than
1968 using hardware support. This is a general purpose
1969 driver that only requires three general I/O port pins
1970 (two outputs, one input) to function. If this is
1971 defined, the board configuration must define several
1972 SPI configuration items (port pins to use, etc). For
1973 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001974
Ben Warren04a9e112008-01-16 22:37:35 -05001975 CONFIG_HARD_SPI
1976
1977 Enables a hardware SPI driver for general-purpose reads
1978 and writes. As with CONFIG_SOFT_SPI, the board configuration
1979 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001980 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05001981 example, see include/configs/mpc8349emds.h.
1982
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001983 CONFIG_MXC_SPI
1984
1985 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00001986 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001987
Matthias Fuchs01335022007-12-27 17:12:34 +01001988- FPGA Support: CONFIG_FPGA
1989
1990 Enables FPGA subsystem.
1991
1992 CONFIG_FPGA_<vendor>
1993
1994 Enables support for specific chip vendors.
1995 (ALTERA, XILINX)
1996
1997 CONFIG_FPGA_<family>
1998
1999 Enables support for FPGA family.
2000 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2001
2002 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002003
wdenk43d96162003-03-06 00:02:04 +00002004 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002005
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002006 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002007
wdenk8bde7f72003-06-27 21:31:46 +00002008 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002009
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002010 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002011
wdenk43d96162003-03-06 00:02:04 +00002012 Enable checks on FPGA configuration interface busy
2013 status by the configuration function. This option
2014 will require a board or device specific function to
2015 be written.
wdenkc6097192002-11-03 00:24:07 +00002016
2017 CONFIG_FPGA_DELAY
2018
2019 If defined, a function that provides delays in the FPGA
2020 configuration driver.
2021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002022 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002023 Allow Control-C to interrupt FPGA configuration
2024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002025 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002026
wdenk43d96162003-03-06 00:02:04 +00002027 Check for configuration errors during FPGA bitfile
2028 loading. For example, abort during Virtex II
2029 configuration if the INIT_B line goes low (which
2030 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002032 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002033
wdenk43d96162003-03-06 00:02:04 +00002034 Maximum time to wait for the INIT_B line to deassert
2035 after PROB_B has been deasserted during a Virtex II
2036 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002037 ms.
wdenkc6097192002-11-03 00:24:07 +00002038
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002039 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002040
wdenk43d96162003-03-06 00:02:04 +00002041 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002042 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002043
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002044 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002045
wdenk43d96162003-03-06 00:02:04 +00002046 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002047 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002048
2049- Configuration Management:
2050 CONFIG_IDENT_STRING
2051
wdenk43d96162003-03-06 00:02:04 +00002052 If defined, this string will be added to the U-Boot
2053 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002054
2055- Vendor Parameter Protection:
2056
wdenk43d96162003-03-06 00:02:04 +00002057 U-Boot considers the values of the environment
2058 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002059 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002060 are set once by the board vendor / manufacturer, and
2061 protects these variables from casual modification by
2062 the user. Once set, these variables are read-only,
2063 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002064 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002065
2066 If CONFIG_ENV_OVERWRITE is #defined in your config
2067 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002068 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002069 these parameters.
2070
2071 Alternatively, if you #define _both_ CONFIG_ETHADDR
2072 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002073 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002074 which can be changed exactly ONCE by the user. [The
2075 serial# is unaffected by this, i. e. it remains
2076 read-only.]
2077
2078- Protected RAM:
2079 CONFIG_PRAM
2080
2081 Define this variable to enable the reservation of
2082 "protected RAM", i. e. RAM which is not overwritten
2083 by U-Boot. Define CONFIG_PRAM to hold the number of
2084 kB you want to reserve for pRAM. You can overwrite
2085 this default value by defining an environment
2086 variable "pram" to the number of kB you want to
2087 reserve. Note that the board info structure will
2088 still show the full amount of RAM. If pRAM is
2089 reserved, a new environment variable "mem" will
2090 automatically be defined to hold the amount of
2091 remaining RAM in a form that can be passed as boot
2092 argument to Linux, for instance like that:
2093
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002094 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002095 saveenv
2096
2097 This way you can tell Linux not to use this memory,
2098 either, which results in a memory region that will
2099 not be affected by reboots.
2100
2101 *WARNING* If your board configuration uses automatic
2102 detection of the RAM size, you must make sure that
2103 this memory test is non-destructive. So far, the
2104 following board configurations are known to be
2105 "pRAM-clean":
2106
2107 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2108 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002109 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002110
2111- Error Recovery:
2112 CONFIG_PANIC_HANG
2113
2114 Define this variable to stop the system in case of a
2115 fatal error, so that you have to reset it manually.
2116 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002117 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002118 automatically as fast as possible, but it may be
2119 useful during development since you can try to debug
2120 the conditions that lead to the situation.
2121
2122 CONFIG_NET_RETRY_COUNT
2123
wdenk43d96162003-03-06 00:02:04 +00002124 This variable defines the number of retries for
2125 network operations like ARP, RARP, TFTP, or BOOTP
2126 before giving up the operation. If not defined, a
2127 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002128
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002129 CONFIG_ARP_TIMEOUT
2130
2131 Timeout waiting for an ARP reply in milliseconds.
2132
wdenkc6097192002-11-03 00:24:07 +00002133- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002134 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002135
2136 Enable auto completion of commands using TAB.
2137
Wolfgang Denka9398e02006-11-27 15:32:42 +01002138 Note that this feature has NOT been implemented yet
2139 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002140
2141
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002142 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002143
2144 Define this variable to enable the "hush" shell (from
2145 Busybox) as command line interpreter, thus enabling
2146 powerful command line syntax like
2147 if...then...else...fi conditionals or `&&' and '||'
2148 constructs ("shell scripts").
2149
2150 If undefined, you get the old, much simpler behaviour
2151 with a somewhat smaller memory footprint.
2152
2153
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002154 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002155
2156 This defines the secondary prompt string, which is
2157 printed when the command interpreter needs more input
2158 to complete a command. Usually "> ".
2159
2160 Note:
2161
wdenk8bde7f72003-06-27 21:31:46 +00002162 In the current implementation, the local variables
2163 space and global environment variables space are
2164 separated. Local variables are those you define by
2165 simply typing `name=value'. To access a local
2166 variable later on, you have write `$name' or
2167 `${name}'; to execute the contents of a variable
2168 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002169
wdenk43d96162003-03-06 00:02:04 +00002170 Global environment variables are those you use
2171 setenv/printenv to work with. To run a command stored
2172 in such a variable, you need to use the run command,
2173 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002174
2175 To store commands and special characters in a
2176 variable, please use double quotation marks
2177 surrounding the whole text of the variable, instead
2178 of the backslashes before semicolons and special
2179 symbols.
2180
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002181- Commandline Editing and History:
2182 CONFIG_CMDLINE_EDITING
2183
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002184 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002185 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002186
wdenka8c7c702003-12-06 19:49:23 +00002187- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002188 CONFIG_EXTRA_ENV_SETTINGS
2189
wdenk43d96162003-03-06 00:02:04 +00002190 Define this to contain any number of null terminated
2191 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002192 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002193
wdenk43d96162003-03-06 00:02:04 +00002194 For example, place something like this in your
2195 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002196
2197 #define CONFIG_EXTRA_ENV_SETTINGS \
2198 "myvar1=value1\0" \
2199 "myvar2=value2\0"
2200
wdenk43d96162003-03-06 00:02:04 +00002201 Warning: This method is based on knowledge about the
2202 internal format how the environment is stored by the
2203 U-Boot code. This is NOT an official, exported
2204 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002205 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002206 You better know what you are doing here.
2207
wdenk43d96162003-03-06 00:02:04 +00002208 Note: overly (ab)use of the default environment is
2209 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002210 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002211 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002212
wdenka8c7c702003-12-06 19:49:23 +00002213- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002214 CONFIG_HAS_DATAFLASH
2215
wdenk8bde7f72003-06-27 21:31:46 +00002216 Defining this option enables DataFlash features and
2217 allows to read/write in Dataflash via the standard
2218 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002219
Eric Nelsonf61ec452012-01-31 10:52:08 -07002220- Serial Flash support
2221 CONFIG_CMD_SF
2222
2223 Defining this option enables SPI flash commands
2224 'sf probe/read/write/erase/update'.
2225
2226 Usage requires an initial 'probe' to define the serial
2227 flash parameters, followed by read/write/erase/update
2228 commands.
2229
2230 The following defaults may be provided by the platform
2231 to handle the common case when only a single serial
2232 flash is present on the system.
2233
2234 CONFIG_SF_DEFAULT_BUS Bus identifier
2235 CONFIG_SF_DEFAULT_CS Chip-select
2236 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2237 CONFIG_SF_DEFAULT_SPEED in Hz
2238
wdenk3f85ce22004-02-23 16:11:30 +00002239- SystemACE Support:
2240 CONFIG_SYSTEMACE
2241
2242 Adding this option adds support for Xilinx SystemACE
2243 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002244 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002245 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002246
2247 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002248 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002249
2250 When SystemACE support is added, the "ace" device type
2251 becomes available to the fat commands, i.e. fatls.
2252
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002253- TFTP Fixed UDP Port:
2254 CONFIG_TFTP_PORT
2255
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002256 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002257 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002258 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002259 number generator is used.
2260
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002261 Also, the environment variable tftpdstp is used to supply
2262 the TFTP UDP destination port value. If tftpdstp isn't
2263 defined, the normal port 69 is used.
2264
2265 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002266 blindly start the TFTP transfer using the pre-configured
2267 target IP address and UDP port. This has the effect of
2268 "punching through" the (Windows XP) firewall, allowing
2269 the remainder of the TFTP transfer to proceed normally.
2270 A better solution is to properly configure the firewall,
2271 but sometimes that is not allowed.
2272
wdenka8c7c702003-12-06 19:49:23 +00002273- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002274 CONFIG_SHOW_BOOT_PROGRESS
2275
wdenk43d96162003-03-06 00:02:04 +00002276 Defining this option allows to add some board-
2277 specific code (calling a user-provided function
2278 "show_boot_progress(int)") that enables you to show
2279 the system's boot progress on some display (for
2280 example, some LED's) on your board. At the moment,
2281 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002282
Simon Glass3a608ca2012-02-13 13:51:19 +00002283- Detailed boot stage timing
2284 CONFIG_BOOTSTAGE
2285 Define this option to get detailed timing of each stage
2286 of the boot process.
2287
2288 CONFIG_BOOTSTAGE_USER_COUNT
2289 This is the number of available user bootstage records.
2290 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2291 a new ID will be allocated from this stash. If you exceed
2292 the limit, recording will stop.
2293
2294 CONFIG_BOOTSTAGE_REPORT
2295 Define this to print a report before boot, similar to this:
2296
2297 Timer summary in microseconds:
2298 Mark Elapsed Stage
2299 0 0 reset
2300 3,575,678 3,575,678 board_init_f start
2301 3,575,695 17 arch_cpu_init A9
2302 3,575,777 82 arch_cpu_init done
2303 3,659,598 83,821 board_init_r start
2304 3,910,375 250,777 main_loop
2305 29,916,167 26,005,792 bootm_start
2306 30,361,327 445,160 start_kernel
2307
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002308Legacy uImage format:
2309
wdenkc6097192002-11-03 00:24:07 +00002310 Arg Where When
2311 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002312 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002313 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002314 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002315 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002316 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002317 4 common/cmd_bootm.c Image data has correct checksum
2318 -4 common/cmd_bootm.c Image is for unsupported architecture
2319 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002320 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002321 6 common/cmd_bootm.c Image Type check OK
2322 -6 common/cmd_bootm.c gunzip uncompression error
2323 -7 common/cmd_bootm.c Unimplemented compression type
2324 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002325 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002326 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002327
2328 9 common/image.c Start initial ramdisk verification
2329 -10 common/image.c Ramdisk header has bad magic number
2330 -11 common/image.c Ramdisk header has bad checksum
2331 10 common/image.c Ramdisk header is OK
2332 -12 common/image.c Ramdisk data has bad checksum
2333 11 common/image.c Ramdisk data has correct checksum
2334 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002335 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002336 13 common/image.c Start multifile image verification
2337 14 common/image.c No initial ramdisk, no multifile, continue.
2338
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002339 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002340
Stefan Roesea47a12b2010-04-15 16:07:28 +02002341 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002342 -31 post/post.c POST test failed, detected by post_output_backlog()
2343 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002344
Heiko Schocher566a4942007-06-22 19:11:54 +02002345 34 common/cmd_doc.c before loading a Image from a DOC device
2346 -35 common/cmd_doc.c Bad usage of "doc" command
2347 35 common/cmd_doc.c correct usage of "doc" command
2348 -36 common/cmd_doc.c No boot device
2349 36 common/cmd_doc.c correct boot device
2350 -37 common/cmd_doc.c Unknown Chip ID on boot device
2351 37 common/cmd_doc.c correct chip ID found, device available
2352 -38 common/cmd_doc.c Read Error on boot device
2353 38 common/cmd_doc.c reading Image header from DOC device OK
2354 -39 common/cmd_doc.c Image header has bad magic number
2355 39 common/cmd_doc.c Image header has correct magic number
2356 -40 common/cmd_doc.c Error reading Image from DOC device
2357 40 common/cmd_doc.c Image header has correct magic number
2358 41 common/cmd_ide.c before loading a Image from a IDE device
2359 -42 common/cmd_ide.c Bad usage of "ide" command
2360 42 common/cmd_ide.c correct usage of "ide" command
2361 -43 common/cmd_ide.c No boot device
2362 43 common/cmd_ide.c boot device found
2363 -44 common/cmd_ide.c Device not available
2364 44 common/cmd_ide.c Device available
2365 -45 common/cmd_ide.c wrong partition selected
2366 45 common/cmd_ide.c partition selected
2367 -46 common/cmd_ide.c Unknown partition table
2368 46 common/cmd_ide.c valid partition table found
2369 -47 common/cmd_ide.c Invalid partition type
2370 47 common/cmd_ide.c correct partition type
2371 -48 common/cmd_ide.c Error reading Image Header on boot device
2372 48 common/cmd_ide.c reading Image Header from IDE device OK
2373 -49 common/cmd_ide.c Image header has bad magic number
2374 49 common/cmd_ide.c Image header has correct magic number
2375 -50 common/cmd_ide.c Image header has bad checksum
2376 50 common/cmd_ide.c Image header has correct checksum
2377 -51 common/cmd_ide.c Error reading Image from IDE device
2378 51 common/cmd_ide.c reading Image from IDE device OK
2379 52 common/cmd_nand.c before loading a Image from a NAND device
2380 -53 common/cmd_nand.c Bad usage of "nand" command
2381 53 common/cmd_nand.c correct usage of "nand" command
2382 -54 common/cmd_nand.c No boot device
2383 54 common/cmd_nand.c boot device found
2384 -55 common/cmd_nand.c Unknown Chip ID on boot device
2385 55 common/cmd_nand.c correct chip ID found, device available
2386 -56 common/cmd_nand.c Error reading Image Header on boot device
2387 56 common/cmd_nand.c reading Image Header from NAND device OK
2388 -57 common/cmd_nand.c Image header has bad magic number
2389 57 common/cmd_nand.c Image header has correct magic number
2390 -58 common/cmd_nand.c Error reading Image from NAND device
2391 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002392
Heiko Schocher566a4942007-06-22 19:11:54 +02002393 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002394
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002395 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002396 -64 net/eth.c no Ethernet found.
2397 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002398
Heiko Schocher566a4942007-06-22 19:11:54 +02002399 -80 common/cmd_net.c usage wrong
2400 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002401 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002402 81 common/cmd_net.c NetLoop() back without error
2403 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2404 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002405 83 common/cmd_net.c running "source" command
2406 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002407 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002408
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002409FIT uImage format:
2410
2411 Arg Where When
2412 100 common/cmd_bootm.c Kernel FIT Image has correct format
2413 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2414 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2415 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2416 102 common/cmd_bootm.c Kernel unit name specified
2417 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002418 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002419 104 common/cmd_bootm.c Got kernel subimage node offset
2420 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2421 105 common/cmd_bootm.c Kernel subimage hash verification OK
2422 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2423 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002424 -106 common/cmd_bootm.c Kernel subimage has wrong type
2425 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002426 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2427 108 common/cmd_bootm.c Got kernel subimage data/size
2428 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2429 -109 common/cmd_bootm.c Can't get kernel subimage type
2430 -110 common/cmd_bootm.c Can't get kernel subimage comp
2431 -111 common/cmd_bootm.c Can't get kernel subimage os
2432 -112 common/cmd_bootm.c Can't get kernel subimage load address
2433 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2434
2435 120 common/image.c Start initial ramdisk verification
2436 -120 common/image.c Ramdisk FIT image has incorrect format
2437 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002438 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002439 -122 common/image.c Can't get configuration for ramdisk subimage
2440 123 common/image.c Ramdisk unit name specified
2441 -124 common/image.c Can't get ramdisk subimage node offset
2442 125 common/image.c Got ramdisk subimage node offset
2443 -125 common/image.c Ramdisk subimage hash verification failed
2444 126 common/image.c Ramdisk subimage hash verification OK
2445 -126 common/image.c Ramdisk subimage for unsupported architecture
2446 127 common/image.c Architecture check OK
2447 -127 common/image.c Can't get ramdisk subimage data/size
2448 128 common/image.c Got ramdisk subimage data/size
2449 129 common/image.c Can't get ramdisk load address
2450 -129 common/image.c Got ramdisk load address
2451
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002452 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002453 131 common/cmd_doc.c FIT image format OK
2454
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002455 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002456 141 common/cmd_ide.c FIT image format OK
2457
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002458 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002459 151 common/cmd_nand.c FIT image format OK
2460
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002461- Standalone program support:
2462 CONFIG_STANDALONE_LOAD_ADDR
2463
Wolfgang Denk6feff892011-10-09 21:06:34 +02002464 This option defines a board specific value for the
2465 address where standalone program gets loaded, thus
2466 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002467 settings.
2468
2469- Frame Buffer Address:
2470 CONFIG_FB_ADDR
2471
2472 Define CONFIG_FB_ADDR if you want to use specific
2473 address for frame buffer.
2474 Then system will reserve the frame buffer address to
2475 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002476 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002477
2478 Please see board_init_f function.
2479
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002480- Automatic software updates via TFTP server
2481 CONFIG_UPDATE_TFTP
2482 CONFIG_UPDATE_TFTP_CNT_MAX
2483 CONFIG_UPDATE_TFTP_MSEC_MAX
2484
2485 These options enable and control the auto-update feature;
2486 for a more detailed description refer to doc/README.update.
2487
2488- MTD Support (mtdparts command, UBI support)
2489 CONFIG_MTD_DEVICE
2490
2491 Adds the MTD device infrastructure from the Linux kernel.
2492 Needed for mtdparts command support.
2493
2494 CONFIG_MTD_PARTITIONS
2495
2496 Adds the MTD partitioning infrastructure from the Linux
2497 kernel. Needed for UBI support.
2498
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002499- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002500 CONFIG_SPL
2501 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002502
Tom Rini95579792012-02-14 07:29:40 +00002503 CONFIG_SPL_LDSCRIPT
2504 LDSCRIPT for linking the SPL binary.
2505
2506 CONFIG_SPL_MAX_SIZE
2507 Maximum binary size (text, data and rodata) of the SPL binary.
2508
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002509 CONFIG_SPL_TEXT_BASE
2510 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002511
Tom Rini95579792012-02-14 07:29:40 +00002512 CONFIG_SPL_BSS_START_ADDR
2513 Link address for the BSS within the SPL binary.
2514
2515 CONFIG_SPL_BSS_MAX_SIZE
2516 Maximum binary size of the BSS section of the SPL binary.
2517
2518 CONFIG_SPL_STACK
2519 Adress of the start of the stack SPL will use
2520
2521 CONFIG_SYS_SPL_MALLOC_START
2522 Starting address of the malloc pool used in SPL.
2523
2524 CONFIG_SYS_SPL_MALLOC_SIZE
2525 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002526
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002527 CONFIG_SPL_LIBCOMMON_SUPPORT
2528 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002529
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002530 CONFIG_SPL_LIBDISK_SUPPORT
2531 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002532
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002533 CONFIG_SPL_I2C_SUPPORT
2534 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002535
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002536 CONFIG_SPL_GPIO_SUPPORT
2537 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002538
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002539 CONFIG_SPL_MMC_SUPPORT
2540 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002541
Tom Rini95579792012-02-14 07:29:40 +00002542 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2543 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2544 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2545 Address, size and partition on the MMC to load U-Boot from
2546 when the MMC is being used in raw mode.
2547
2548 CONFIG_SPL_FAT_SUPPORT
2549 Support for fs/fat/libfat.o in SPL binary
2550
2551 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2552 Filename to read to load U-Boot when reading from FAT
2553
2554 CONFIG_SPL_NAND_SIMPLE
2555 Support for drivers/mtd/nand/libnand.o in SPL binary
2556
2557 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2558 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2559 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2560 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2561 CONFIG_SYS_NAND_ECCBYTES
2562 Defines the size and behavior of the NAND that SPL uses
2563 to read U-Boot with CONFIG_SPL_NAND_SIMPLE
2564
2565 CONFIG_SYS_NAND_U_BOOT_OFFS
2566 Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
2567 from.
2568
2569 CONFIG_SYS_NAND_U_BOOT_START
2570 Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
2571 to.
2572
2573 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2574 Define this if you need to first read the OOB and then the
2575 data. This is used for example on davinci plattforms.
2576
2577 CONFIG_SPL_OMAP3_ID_NAND
2578 Support for an OMAP3-specific set of functions to return the
2579 ID and MFR of the first attached NAND chip, if present.
2580
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002581 CONFIG_SPL_SERIAL_SUPPORT
2582 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002583
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002584 CONFIG_SPL_SPI_FLASH_SUPPORT
2585 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002586
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002587 CONFIG_SPL_SPI_SUPPORT
2588 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002589
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002590 CONFIG_SPL_LIBGENERIC_SUPPORT
2591 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002592
wdenkc6097192002-11-03 00:24:07 +00002593Modem Support:
2594--------------
2595
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002596[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002597
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002598- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002599 CONFIG_MODEM_SUPPORT
2600
2601- RTS/CTS Flow control enable:
2602 CONFIG_HWFLOW
2603
2604- Modem debug support:
2605 CONFIG_MODEM_SUPPORT_DEBUG
2606
wdenk43d96162003-03-06 00:02:04 +00002607 Enables debugging stuff (char screen[1024], dbg())
2608 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002609
wdenka8c7c702003-12-06 19:49:23 +00002610- Interrupt support (PPC):
2611
wdenkd4ca31c2004-01-02 14:00:00 +00002612 There are common interrupt_init() and timer_interrupt()
2613 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002614 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002615 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002616 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002617 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002618 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002619 specific handling. If board has watchdog / status_led
2620 / other_activity_monitor it works automatically from
2621 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002622
wdenkc6097192002-11-03 00:24:07 +00002623- General:
2624
wdenk43d96162003-03-06 00:02:04 +00002625 In the target system modem support is enabled when a
2626 specific key (key combination) is pressed during
2627 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002628 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002629 board_init(). Currently key_pressed() is a dummy
2630 function, returning 1 and thus enabling modem
2631 initialization.
wdenkc6097192002-11-03 00:24:07 +00002632
wdenk43d96162003-03-06 00:02:04 +00002633 If there are no modem init strings in the
2634 environment, U-Boot proceed to autoboot; the
2635 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002636 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002637
2638 See also: doc/README.Modem
2639
Helmut Raiger9660e442011-10-20 04:19:47 +00002640Board initialization settings:
2641------------------------------
2642
2643During Initialization u-boot calls a number of board specific functions
2644to allow the preparation of board specific prerequisites, e.g. pin setup
2645before drivers are initialized. To enable these callbacks the
2646following configuration macros have to be defined. Currently this is
2647architecture specific, so please check arch/your_architecture/lib/board.c
2648typically in board_init_f() and board_init_r().
2649
2650- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2651- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2652- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2653- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002654
wdenkc6097192002-11-03 00:24:07 +00002655Configuration Settings:
2656-----------------------
2657
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002658- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002659 undefine this when you're short of memory.
2660
Peter Tyser2fb26042009-01-27 18:03:12 -06002661- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2662 width of the commands listed in the 'help' command output.
2663
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002664- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002665 prompt for user input.
2666
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002667- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002668
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002669- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002670
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002671- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002672
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002673- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002674 the application (usually a Linux kernel) when it is
2675 booted
2676
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002677- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002678 List of legal baudrate settings for this board.
2679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002680- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002681 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002683- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002684 If the board specific function
2685 extern int overwrite_console (void);
2686 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002687 serial port, else the settings in the environment are used.
2688
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002689- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002690 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002691
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002692- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002693 Enable overwrite of previous console environment settings.
2694
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002695- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002696 Begin and End addresses of the area used by the
2697 simple memory test.
2698
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002699- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002700 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002701
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002702- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002703 Scratch address used by the alternate memory test
2704 You only need to set this if address zero isn't writeable
2705
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002706- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2707 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002708 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002709 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002710 fixing up gd->ram_size the Linux kernel should gets passed
2711 the now "corrected" memory size and won't touch it either.
2712 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002713 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002714 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002715 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002716
2717 This option can be used as a workaround for the 440EPx/GRx
2718 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2719 be touched.
2720
2721 WARNING: Please make sure that this value is a multiple of
2722 the Linux page size (normally 4k). If this is not the case,
2723 then the end address of the Linux memory will be located at a
2724 non page size aligned address and this could cause major
2725 problems.
2726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002727- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002728 Default load address for network file downloads
2729
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002730- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002731 Enable temporary baudrate change while serial download
2732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002733- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002734 Physical start address of SDRAM. _Must_ be 0 here.
2735
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002736- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002737 Physical start address of Motherboard I/O (if using a
2738 Cogent motherboard)
2739
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002740- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002741 Physical start address of Flash memory.
2742
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002743- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002744 Physical start address of boot monitor code (set by
2745 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002746 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002747 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002748
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002749- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002750 Size of memory reserved for monitor code, used to
2751 determine _at_compile_time_ (!) if the environment is
2752 embedded within the U-Boot image, or in a separate
2753 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002754
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002755- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002756 Size of DRAM reserved for malloc() use.
2757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002758- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002759 Normally compressed uImages are limited to an
2760 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002761 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002762 to adjust this setting to your needs.
2763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002764- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002765 Maximum size of memory mapped by the startup code of
2766 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002767 the Linux kernel (bd_info, boot arguments, FDT blob if
2768 used) must be put below this limit, unless "bootm_low"
2769 enviroment variable is defined and non-zero. In such case
2770 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002771 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002772 variable "bootm_mapsize" will override the value of
2773 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2774 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002775
John Rigbyfca43cc2010-10-13 13:57:35 -06002776- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2777 Enable initrd_high functionality. If defined then the
2778 initrd_high feature is enabled and the bootm ramdisk subcommand
2779 is enabled.
2780
2781- CONFIG_SYS_BOOT_GET_CMDLINE:
2782 Enables allocating and saving kernel cmdline in space between
2783 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2784
2785- CONFIG_SYS_BOOT_GET_KBD:
2786 Enables allocating and saving a kernel copy of the bd_info in
2787 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2788
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002789- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002790 Max number of Flash memory banks
2791
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002792- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002793 Max number of sectors on a Flash chip
2794
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002795- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002796 Timeout for Flash erase operations (in ms)
2797
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002798- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002799 Timeout for Flash write operations (in ms)
2800
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002801- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002802 Timeout for Flash set sector lock bit operation (in ms)
2803
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002804- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002805 Timeout for Flash clear lock bits operation (in ms)
2806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002807- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002808 If defined, hardware flash sectors protection is used
2809 instead of U-Boot software protection.
2810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002811- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002812
2813 Enable TFTP transfers directly to flash memory;
2814 without this option such a download has to be
2815 performed in two steps: (1) download to RAM, and (2)
2816 copy from RAM to flash.
2817
2818 The two-step approach is usually more reliable, since
2819 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002820 the flash, but in some situations (when system RAM is
2821 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002822 downloaded image) this option may be very useful.
2823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002824- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002825 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002826 common flash structure for storing flash geometry.
2827
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002828- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002829 This option also enables the building of the cfi_flash driver
2830 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002831
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002832- CONFIG_FLASH_CFI_MTD
2833 This option enables the building of the cfi_mtd driver
2834 in the drivers directory. The driver exports CFI flash
2835 to the MTD layer.
2836
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002837- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002838 Use buffered writes to flash.
2839
2840- CONFIG_FLASH_SPANSION_S29WS_N
2841 s29ws-n MirrorBit flash has non-standard addresses for buffered
2842 write commands.
2843
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002844- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002845 If this option is defined, the common CFI flash doesn't
2846 print it's warning upon not recognized FLASH banks. This
2847 is useful, if some of the configured banks are only
2848 optionally available.
2849
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002850- CONFIG_FLASH_SHOW_PROGRESS
2851 If defined (must be an integer), print out countdown
2852 digits and dots. Recommended value: 45 (9..1) for 80
2853 column displays, 15 (3..1) for 40 column displays.
2854
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002855- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002856 Defines the number of Ethernet receive buffers. On some
2857 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002858 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2859 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002860 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002861 Defaults to 4 if not defined.
2862
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002863- CONFIG_ENV_MAX_ENTRIES
2864
Wolfgang Denk071bc922010-10-27 22:48:30 +02002865 Maximum number of entries in the hash table that is used
2866 internally to store the environment settings. The default
2867 setting is supposed to be generous and should work in most
2868 cases. This setting can be used to tune behaviour; see
2869 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002870
wdenkc6097192002-11-03 00:24:07 +00002871The following definitions that deal with the placement and management
2872of environment data (variable area); in general, we support the
2873following configurations:
2874
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002875- CONFIG_BUILD_ENVCRC:
2876
2877 Builds up envcrc with the target environment so that external utils
2878 may easily extract it and embed it in final U-Boot images.
2879
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002880- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002881
2882 Define this if the environment is in flash memory.
2883
2884 a) The environment occupies one whole flash sector, which is
2885 "embedded" in the text segment with the U-Boot code. This
2886 happens usually with "bottom boot sector" or "top boot
2887 sector" type flash chips, which have several smaller
2888 sectors at the start or the end. For instance, such a
2889 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2890 such a case you would place the environment in one of the
2891 4 kB sectors - with U-Boot code before and after it. With
2892 "top boot sector" type flash chips, you would put the
2893 environment in one of the last sectors, leaving a gap
2894 between U-Boot and the environment.
2895
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002896 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002897
2898 Offset of environment data (variable area) to the
2899 beginning of flash memory; for instance, with bottom boot
2900 type flash chips the second sector can be used: the offset
2901 for this sector is given here.
2902
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002903 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002904
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002905 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002906
2907 This is just another way to specify the start address of
2908 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002909 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002910
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002911 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002912
2913 Size of the sector containing the environment.
2914
2915
2916 b) Sometimes flash chips have few, equal sized, BIG sectors.
2917 In such a case you don't want to spend a whole sector for
2918 the environment.
2919
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002920 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002921
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002922 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002923 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002924 of this flash sector for the environment. This saves
2925 memory for the RAM copy of the environment.
2926
2927 It may also save flash memory if you decide to use this
2928 when your environment is "embedded" within U-Boot code,
2929 since then the remainder of the flash sector could be used
2930 for U-Boot code. It should be pointed out that this is
2931 STRONGLY DISCOURAGED from a robustness point of view:
2932 updating the environment in flash makes it always
2933 necessary to erase the WHOLE sector. If something goes
2934 wrong before the contents has been restored from a copy in
2935 RAM, your target system will be dead.
2936
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002937 - CONFIG_ENV_ADDR_REDUND
2938 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002939
wdenk43d96162003-03-06 00:02:04 +00002940 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002941 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002942 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002943 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002944
2945BE CAREFUL! Any changes to the flash layout, and some changes to the
2946source code will make it necessary to adapt <board>/u-boot.lds*
2947accordingly!
2948
2949
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002950- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002951
2952 Define this if you have some non-volatile memory device
2953 (NVRAM, battery buffered SRAM) which you want to use for the
2954 environment.
2955
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002956 - CONFIG_ENV_ADDR:
2957 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002958
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002959 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002960 want to use for environment. It is assumed that this memory
2961 can just be read and written to, without any special
2962 provision.
2963
2964BE CAREFUL! The first access to the environment happens quite early
2965in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002966console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002967U-Boot will hang.
2968
2969Please note that even with NVRAM we still use a copy of the
2970environment in RAM: we could work on NVRAM directly, but we want to
2971keep settings there always unmodified except somebody uses "saveenv"
2972to save the current settings.
2973
2974
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002975- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002976
2977 Use this if you have an EEPROM or similar serial access
2978 device and a driver for it.
2979
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002980 - CONFIG_ENV_OFFSET:
2981 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002982
2983 These two #defines specify the offset and size of the
2984 environment area within the total memory of your EEPROM.
2985
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002986 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002987 If defined, specified the chip address of the EEPROM device.
2988 The default address is zero.
2989
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002990 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002991 If defined, the number of bits used to address bytes in a
2992 single page in the EEPROM device. A 64 byte page, for example
2993 would require six bits.
2994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002995 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002996 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002997 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002998
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002999 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003000 The length in bytes of the EEPROM memory array address. Note
3001 that this is NOT the chip address length!
3002
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003003 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003004 EEPROM chips that implement "address overflow" are ones
3005 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3006 address and the extra bits end up in the "chip address" bit
3007 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3008 byte chips.
3009
3010 Note that we consider the length of the address field to
3011 still be one byte because the extra address bits are hidden
3012 in the chip address.
3013
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003014 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003015 The size in bytes of the EEPROM device.
3016
Heiko Schocher548738b2010-01-07 08:55:40 +01003017 - CONFIG_ENV_EEPROM_IS_ON_I2C
3018 define this, if you have I2C and SPI activated, and your
3019 EEPROM, which holds the environment, is on the I2C bus.
3020
3021 - CONFIG_I2C_ENV_EEPROM_BUS
3022 if you have an Environment on an EEPROM reached over
3023 I2C muxes, you can define here, how to reach this
3024 EEPROM. For example:
3025
Wolfgang Denka9046b92010-06-13 17:48:15 +02003026 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003027
3028 EEPROM which holds the environment, is reached over
3029 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003030
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003031- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003032
wdenkd4ca31c2004-01-02 14:00:00 +00003033 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003034 want to use for the environment.
3035
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003036 - CONFIG_ENV_OFFSET:
3037 - CONFIG_ENV_ADDR:
3038 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003039
3040 These three #defines specify the offset and size of the
3041 environment area within the total memory of your DataFlash placed
3042 at the specified address.
3043
Liu Gang0a85a9e2012-03-08 00:33:20 +00003044- CONFIG_ENV_IS_IN_REMOTE:
3045
3046 Define this if you have a remote memory space which you
3047 want to use for the local device's environment.
3048
3049 - CONFIG_ENV_ADDR:
3050 - CONFIG_ENV_SIZE:
3051
3052 These two #defines specify the address and size of the
3053 environment area within the remote memory space. The
3054 local device can get the environment from remote memory
3055 space by SRIO or other links.
3056
3057BE CAREFUL! For some special cases, the local device can not use
3058"saveenv" command. For example, the local device will get the
3059environment stored in a remote NOR flash by SRIO link, but it can
3060not erase, write this NOR flash by SRIO interface.
3061
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003062- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003063
3064 Define this if you have a NAND device which you want to use
3065 for the environment.
3066
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003067 - CONFIG_ENV_OFFSET:
3068 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003069
3070 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003071 area within the first NAND device. CONFIG_ENV_OFFSET must be
3072 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003073
Scott Woodfdd813d2010-09-17 14:38:37 -05003074 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003075
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003076 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003077 size used to hold a redundant copy of the environment data, so
3078 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003079 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003080 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003081
Scott Woodfdd813d2010-09-17 14:38:37 -05003082 - CONFIG_ENV_RANGE (optional):
3083
3084 Specifies the length of the region in which the environment
3085 can be written. This should be a multiple of the NAND device's
3086 block size. Specifying a range with more erase blocks than
3087 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3088 the range to be avoided.
3089
3090 - CONFIG_ENV_OFFSET_OOB (optional):
3091
3092 Enables support for dynamically retrieving the offset of the
3093 environment from block zero's out-of-band data. The
3094 "nand env.oob" command can be used to record this offset.
3095 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3096 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003097
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003098- CONFIG_NAND_ENV_DST
3099
3100 Defines address in RAM to which the nand_spl code should copy the
3101 environment. If redundant environment is used, it will be copied to
3102 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3103
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003104- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003105
3106 Defines offset to the initial SPI buffer area in DPRAM. The
3107 area is used at an early stage (ROM part) if the environment
3108 is configured to reside in the SPI EEPROM: We need a 520 byte
3109 scratch DPRAM area. It is used between the two initialization
3110 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3111 to be a good choice since it makes it far enough from the
3112 start of the data area as well as from the stack pointer.
3113
Bruce Adlere881cb52007-11-02 13:15:42 -07003114Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003115has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003116created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003117until then to read environment variables.
3118
wdenk85ec0bc2003-03-31 16:34:49 +00003119The environment is protected by a CRC32 checksum. Before the monitor
3120is relocated into RAM, as a result of a bad CRC you will be working
3121with the compiled-in default environment - *silently*!!! [This is
3122necessary, because the first environment variable we need is the
3123"baudrate" setting for the console - if we have a bad CRC, we don't
3124have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003125
3126Note: once the monitor has been relocated, then it will complain if
3127the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003128use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003130- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003131 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003132
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003133 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003134 also needs to be defined.
3135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003136- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003137 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003138
Ron Madridf5675aa2009-02-18 14:30:44 -08003139- CONFIG_NS16550_MIN_FUNCTIONS:
3140 Define this if you desire to only have use of the NS16550_init
3141 and NS16550_putc functions for the serial driver located at
3142 drivers/serial/ns16550.c. This option is useful for saving
3143 space for already greatly restricted images, including but not
3144 limited to NAND_SPL configurations.
3145
wdenkc6097192002-11-03 00:24:07 +00003146Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003147---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003148
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003149- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003150 Cache Line Size of the CPU.
3151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003152- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003153 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003154
wdenk42d1f032003-10-15 23:53:47 +00003155 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3156 and RPXsuper) to be able to adjust the position of
3157 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003158
Timur Tabie46fedf2011-08-04 18:03:41 -05003159- CONFIG_SYS_CCSRBAR_DEFAULT:
3160 Default (power-on reset) physical address of CCSR on Freescale
3161 PowerPC SOCs.
3162
3163- CONFIG_SYS_CCSRBAR:
3164 Virtual address of CCSR. On a 32-bit build, this is typically
3165 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3166
3167 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3168 for cross-platform code that uses that macro instead.
3169
3170- CONFIG_SYS_CCSRBAR_PHYS:
3171 Physical address of CCSR. CCSR can be relocated to a new
3172 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003173 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003174 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3175 is typically relocated on 36-bit builds. It is recommended
3176 that this macro be defined via the _HIGH and _LOW macros:
3177
3178 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3179 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3180
3181- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003182 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3183 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003184 used in assembly code, so it must not contain typecasts or
3185 integer size suffixes (e.g. "ULL").
3186
3187- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3188 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3189 used in assembly code, so it must not contain typecasts or
3190 integer size suffixes (e.g. "ULL").
3191
3192- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3193 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3194 forced to a value that ensures that CCSR is not relocated.
3195
wdenk7f6c2cb2002-11-10 22:06:23 +00003196- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003197 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003198
3199 the default drive number (default value 0)
3200
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003201 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003202
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003203 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003204 (default value 1)
3205
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003206 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003207
wdenk43d96162003-03-06 00:02:04 +00003208 defines the offset of register from address. It
3209 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003210 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003212 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3213 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003214 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003216 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003217 fdc_hw_init() is called at the beginning of the FDC
3218 setup. fdc_hw_init() must be provided by the board
3219 source code. It is used to make hardware dependant
3220 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003221
Macpaul Lin0abddf82011-04-11 20:45:32 +00003222- CONFIG_IDE_AHB:
3223 Most IDE controllers were designed to be connected with PCI
3224 interface. Only few of them were designed for AHB interface.
3225 When software is doing ATA command and data transfer to
3226 IDE devices through IDE-AHB controller, some additional
3227 registers accessing to these kind of IDE-AHB controller
3228 is requierd.
3229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003230- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003231 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003232 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003233
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003234- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003235
wdenk7152b1d2003-09-05 23:19:14 +00003236 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003237 initial data and stack; please note that this must be
3238 writable memory that is working WITHOUT special
3239 initialization, i. e. you CANNOT use normal RAM which
3240 will become available only after programming the
3241 memory controller and running certain initialization
3242 sequences.
3243
3244 U-Boot uses the following memory types:
3245 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3246 - MPC824X: data cache
3247 - PPC4xx: data cache
3248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003249- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003250
3251 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003252 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3253 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003254 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003255 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003256 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3257 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3258 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003259
3260 Note:
3261 On the MPC824X (or other systems that use the data
3262 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003263 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003264 point to an otherwise UNUSED address space between
3265 the top of RAM and the start of the PCI space.
3266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003267- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003269- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003270
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003271- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003272
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003273- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003275- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003276
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003277- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003278
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003279- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003280 SDRAM timing
3281
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003282- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003283 periodic timer for refresh
3284
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003285- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003286
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003287- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3288 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3289 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3290 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003291 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3292
3293- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003294 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3295 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003296 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003298- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3299 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003300 Machine Mode Register and Memory Periodic Timer
3301 Prescaler definitions (SDRAM timing)
3302
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003303- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003304 enable I2C microcode relocation patch (MPC8xx);
3305 define relocation offset in DPRAM [DSP2]
3306
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003307- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003308 enable SMC microcode relocation patch (MPC8xx);
3309 define relocation offset in DPRAM [SMC1]
3310
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003311- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003312 enable SPI microcode relocation patch (MPC8xx);
3313 define relocation offset in DPRAM [SCC4]
3314
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003315- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003316 Use OSCM clock mode on MBX8xx board. Be careful,
3317 wrong setting might damage your board. Read
3318 doc/README.MBX before setting this variable!
3319
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003320- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003321 Offset of the bootmode word in DPRAM used by post
3322 (Power On Self Tests). This definition overrides
3323 #define'd default value in commproc.h resp.
3324 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003325
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003326- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3327 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3328 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3329 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3330 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3331 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3332 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3333 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003334 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003335
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003336- CONFIG_PCI_DISABLE_PCIE:
3337 Disable PCI-Express on systems where it is supported but not
3338 required.
3339
Kumar Galaa09b9b62010-12-30 12:09:53 -06003340- CONFIG_SYS_SRIO:
3341 Chip has SRIO or not
3342
3343- CONFIG_SRIO1:
3344 Board has SRIO 1 port available
3345
3346- CONFIG_SRIO2:
3347 Board has SRIO 2 port available
3348
3349- CONFIG_SYS_SRIOn_MEM_VIRT:
3350 Virtual Address of SRIO port 'n' memory region
3351
3352- CONFIG_SYS_SRIOn_MEM_PHYS:
3353 Physical Address of SRIO port 'n' memory region
3354
3355- CONFIG_SYS_SRIOn_MEM_SIZE:
3356 Size of SRIO port 'n' memory region
3357
Alex Watermaneced4622011-05-19 15:08:36 -04003358- CONFIG_SYS_NDFC_16
3359 Defined to tell the NDFC that the NAND chip is using a
3360 16 bit bus.
3361
3362- CONFIG_SYS_NDFC_EBC0_CFG
3363 Sets the EBC0_CFG register for the NDFC. If not defined
3364 a default value will be used.
3365
Ben Warrenbb99ad62006-09-07 16:50:54 -04003366- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003367 Get DDR timing information from an I2C EEPROM. Common
3368 with pluggable memory modules such as SODIMMs
3369
Ben Warrenbb99ad62006-09-07 16:50:54 -04003370 SPD_EEPROM_ADDRESS
3371 I2C address of the SPD EEPROM
3372
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003373- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003374 If SPD EEPROM is on an I2C bus other than the first
3375 one, specify here. Note that the value must resolve
3376 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003377
York Sun1b3e3c42011-06-07 09:42:16 +08003378- CONFIG_SYS_DDR_RAW_TIMING
3379 Get DDR timing information from other than SPD. Common with
3380 soldered DDR chips onboard without SPD. DDR raw timing
3381 parameters are extracted from datasheet and hard-coded into
3382 header files or board specific files.
3383
York Sun6f5e1dc2011-09-16 13:21:35 -07003384- CONFIG_FSL_DDR_INTERACTIVE
3385 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3386
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003387- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003388 Only for 83xx systems. If specified, then DDR should
3389 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003390
wdenkc26e4542004-04-18 10:13:26 +00003391- CONFIG_ETHER_ON_FEC[12]
3392 Define to enable FEC[12] on a 8xx series processor.
3393
3394- CONFIG_FEC[12]_PHY
3395 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003396 to the given FEC; i. e.
3397 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003398 means that the PHY with address 4 is connected to FEC1
3399
3400 When set to -1, means to probe for first available.
3401
3402- CONFIG_FEC[12]_PHY_NORXERR
3403 The PHY does not have a RXERR line (RMII only).
3404 (so program the FEC to ignore it).
3405
3406- CONFIG_RMII
3407 Enable RMII mode for all FECs.
3408 Note that this is a global option, we can't
3409 have one FEC in standard MII mode and another in RMII mode.
3410
wdenk5cf91d62004-04-23 20:32:05 +00003411- CONFIG_CRC32_VERIFY
3412 Add a verify option to the crc32 command.
3413 The syntax is:
3414
3415 => crc32 -v <address> <count> <crc32>
3416
3417 Where address/count indicate a memory area
3418 and crc32 is the correct crc32 which the
3419 area should have.
3420
wdenk56523f12004-07-11 17:40:54 +00003421- CONFIG_LOOPW
3422 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003423 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003424
stroese7b466642004-12-16 18:46:55 +00003425- CONFIG_MX_CYCLIC
3426 Add the "mdc" and "mwc" memory commands. These are cyclic
3427 "md/mw" commands.
3428 Examples:
3429
wdenkefe2a4d2004-12-16 21:44:03 +00003430 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003431 This command will print 4 bytes (10,11,12,13) each 500 ms.
3432
wdenkefe2a4d2004-12-16 21:44:03 +00003433 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003434 This command will write 12345678 to address 100 all 10 ms.
3435
wdenkefe2a4d2004-12-16 21:44:03 +00003436 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003437 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003438
wdenk8aa1a2d2005-04-04 12:44:11 +00003439- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003440 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003441 low level initializations (like setting up the memory
3442 controller) are omitted and/or U-Boot does not
3443 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003444
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003445 Normally this variable MUST NOT be defined. The only
3446 exception is when U-Boot is loaded (to RAM) by some
3447 other boot loader or by a debugger which performs
3448 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003449
Aneesh V401bb302011-07-13 05:11:07 +00003450- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003451 Modifies the behaviour of start.S when compiling a loader
3452 that is executed before the actual U-Boot. E.g. when
3453 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003454
Matthias Weisserd8834a12011-03-10 21:36:32 +00003455- CONFIG_USE_ARCH_MEMCPY
3456 CONFIG_USE_ARCH_MEMSET
3457 If these options are used a optimized version of memcpy/memset will
3458 be used if available. These functions may be faster under some
3459 conditions but may increase the binary size.
3460
Timur Tabif2717b42011-11-22 09:21:25 -06003461Freescale QE/FMAN Firmware Support:
3462-----------------------------------
3463
3464The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3465loading of "firmware", which is encoded in the QE firmware binary format.
3466This firmware often needs to be loaded during U-Boot booting, so macros
3467are used to identify the storage device (NOR flash, SPI, etc) and the address
3468within that device.
3469
3470- CONFIG_SYS_QE_FMAN_FW_ADDR
3471 The address in the storage device where the firmware is located. The
3472 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3473 is also specified.
3474
3475- CONFIG_SYS_QE_FMAN_FW_LENGTH
3476 The maximum possible size of the firmware. The firmware binary format
3477 has a field that specifies the actual size of the firmware, but it
3478 might not be possible to read any part of the firmware unless some
3479 local storage is allocated to hold the entire firmware first.
3480
3481- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3482 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3483 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3484 virtual address in NOR flash.
3485
3486- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3487 Specifies that QE/FMAN firmware is located in NAND flash.
3488 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3489
3490- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3491 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3492 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3493
3494- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3495 Specifies that QE/FMAN firmware is located on the primary SPI
3496 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3497
Liu Gang292dc6c2012-03-08 00:33:18 +00003498- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3499 Specifies that QE/FMAN firmware is located in the remote (master)
3500 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3501 can be mapped from slave TLB->slave LAW->slave SRIO outbound window
3502 ->master inbound window->master LAW->the ucode address in master's
3503 NOR flash.
Timur Tabif2717b42011-11-22 09:21:25 -06003504
wdenkc6097192002-11-03 00:24:07 +00003505Building the Software:
3506======================
3507
Wolfgang Denk218ca722008-03-26 10:40:12 +01003508Building U-Boot has been tested in several native build environments
3509and in many different cross environments. Of course we cannot support
3510all possibly existing versions of cross development tools in all
3511(potentially obsolete) versions. In case of tool chain problems we
3512recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3513which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003514
Wolfgang Denk218ca722008-03-26 10:40:12 +01003515If you are not using a native environment, it is assumed that you
3516have GNU cross compiling tools available in your path. In this case,
3517you must set the environment variable CROSS_COMPILE in your shell.
3518Note that no changes to the Makefile or any other source files are
3519necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003520
Wolfgang Denk218ca722008-03-26 10:40:12 +01003521 $ CROSS_COMPILE=ppc_4xx-
3522 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003523
Peter Tyser2f8d3962009-03-13 18:54:51 -05003524Note: If you wish to generate Windows versions of the utilities in
3525 the tools directory you can use the MinGW toolchain
3526 (http://www.mingw.org). Set your HOST tools to the MinGW
3527 toolchain and execute 'make tools'. For example:
3528
3529 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3530
3531 Binaries such as tools/mkimage.exe will be created which can
3532 be executed on computers running Windows.
3533
Wolfgang Denk218ca722008-03-26 10:40:12 +01003534U-Boot is intended to be simple to build. After installing the
3535sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003536is done by typing:
3537
3538 make NAME_config
3539
Wolfgang Denk218ca722008-03-26 10:40:12 +01003540where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003541rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543Note: for some board special configuration names may exist; check if
3544 additional information is available from the board vendor; for
3545 instance, the TQM823L systems are available without (standard)
3546 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003547 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003548
wdenk2729af92004-05-03 20:45:30 +00003549 make TQM823L_config
3550 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003551
wdenk2729af92004-05-03 20:45:30 +00003552 make TQM823L_LCD_config
3553 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003554
wdenk2729af92004-05-03 20:45:30 +00003555 etc.
wdenkc6097192002-11-03 00:24:07 +00003556
wdenkc6097192002-11-03 00:24:07 +00003557
wdenk2729af92004-05-03 20:45:30 +00003558Finally, type "make all", and you should get some working U-Boot
3559images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003560
wdenk2729af92004-05-03 20:45:30 +00003561- "u-boot.bin" is a raw binary image
3562- "u-boot" is an image in ELF binary format
3563- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003564
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003565By default the build is performed locally and the objects are saved
3566in the source directory. One of the two methods can be used to change
3567this behavior and build U-Boot to some external directory:
3568
35691. Add O= to the make command line invocations:
3570
3571 make O=/tmp/build distclean
3572 make O=/tmp/build NAME_config
3573 make O=/tmp/build all
3574
35752. Set environment variable BUILD_DIR to point to the desired location:
3576
3577 export BUILD_DIR=/tmp/build
3578 make distclean
3579 make NAME_config
3580 make all
3581
3582Note that the command line "O=" setting overrides the BUILD_DIR environment
3583variable.
3584
wdenkc6097192002-11-03 00:24:07 +00003585
wdenk2729af92004-05-03 20:45:30 +00003586Please be aware that the Makefiles assume you are using GNU make, so
3587for instance on NetBSD you might need to use "gmake" instead of
3588native "make".
wdenkc6097192002-11-03 00:24:07 +00003589
wdenkc6097192002-11-03 00:24:07 +00003590
wdenk2729af92004-05-03 20:45:30 +00003591If the system board that you have is not listed, then you will need
3592to port U-Boot to your hardware platform. To do this, follow these
3593steps:
wdenkc6097192002-11-03 00:24:07 +00003594
wdenk2729af92004-05-03 20:45:30 +000035951. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00003596 "boards.cfg" file, using the existing entries as examples.
3597 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000035982. Create a new directory to hold your board specific code. Add any
3599 files you need. In your board directory, you will need at least
3600 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
36013. Create a new configuration file "include/configs/<board>.h" for
3602 your board
36033. If you're porting U-Boot to a new CPU, then also create a new
3604 directory to hold your CPU specific code. Add any files you need.
36054. Run "make <board>_config" with your new name.
36065. Type "make", and you should get a working "u-boot.srec" file
3607 to be installed on your target system.
36086. Debug and solve any problems that might arise.
3609 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003610
wdenkc6097192002-11-03 00:24:07 +00003611
wdenk2729af92004-05-03 20:45:30 +00003612Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3613==============================================================
wdenkc6097192002-11-03 00:24:07 +00003614
Wolfgang Denk218ca722008-03-26 10:40:12 +01003615If you have modified U-Boot sources (for instance added a new board
3616or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003617provide feedback to the other developers. The feedback normally takes
3618the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003619official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003620
Wolfgang Denk218ca722008-03-26 10:40:12 +01003621But before you submit such a patch, please verify that your modifi-
3622cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003623the supported boards compile WITHOUT ANY compiler warnings. To do so,
3624just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003625for ALL supported system. Be warned, this will take a while. You can
3626select which (cross) compiler to use by passing a `CROSS_COMPILE'
3627environment variable to the script, i. e. to use the ELDK cross tools
3628you can type
wdenkc6097192002-11-03 00:24:07 +00003629
wdenk2729af92004-05-03 20:45:30 +00003630 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003631
wdenk2729af92004-05-03 20:45:30 +00003632or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003633
wdenk2729af92004-05-03 20:45:30 +00003634 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003635
Wolfgang Denk218ca722008-03-26 10:40:12 +01003636When using the MAKEALL script, the default behaviour is to build
3637U-Boot in the source directory. This location can be changed by
3638setting the BUILD_DIR environment variable. Also, for each target
3639built, the MAKEALL script saves two log files (<target>.ERR and
3640<target>.MAKEALL) in the <source dir>/LOG directory. This default
3641location can be changed by setting the MAKEALL_LOGDIR environment
3642variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003643
3644 export BUILD_DIR=/tmp/build
3645 export MAKEALL_LOGDIR=/tmp/log
3646 CROSS_COMPILE=ppc_8xx- MAKEALL
3647
Wolfgang Denk218ca722008-03-26 10:40:12 +01003648With the above settings build objects are saved in the /tmp/build,
3649log files are saved in the /tmp/log and the source tree remains clean
3650during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003651
3652
wdenk2729af92004-05-03 20:45:30 +00003653See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003654
wdenkc6097192002-11-03 00:24:07 +00003655
wdenk2729af92004-05-03 20:45:30 +00003656Monitor Commands - Overview:
3657============================
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk2729af92004-05-03 20:45:30 +00003659go - start application at address 'addr'
3660run - run commands in an environment variable
3661bootm - boot application image from memory
3662bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003663bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003664tftpboot- boot image via network using TFTP protocol
3665 and env variables "ipaddr" and "serverip"
3666 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003667tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003668rarpboot- boot image via network using RARP/TFTP protocol
3669diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3670loads - load S-Record file over serial line
3671loadb - load binary file over serial line (kermit mode)
3672md - memory display
3673mm - memory modify (auto-incrementing)
3674nm - memory modify (constant address)
3675mw - memory write (fill)
3676cp - memory copy
3677cmp - memory compare
3678crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003679i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003680sspi - SPI utility commands
3681base - print or set address offset
3682printenv- print environment variables
3683setenv - set environment variables
3684saveenv - save environment variables to persistent storage
3685protect - enable or disable FLASH write protection
3686erase - erase FLASH memory
3687flinfo - print FLASH memory information
3688bdinfo - print Board Info structure
3689iminfo - print header information for application image
3690coninfo - print console devices and informations
3691ide - IDE sub-system
3692loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003693loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003694mtest - simple RAM test
3695icache - enable or disable instruction cache
3696dcache - enable or disable data cache
3697reset - Perform RESET of the CPU
3698echo - echo args to console
3699version - print monitor version
3700help - print online help
3701? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003702
wdenkc6097192002-11-03 00:24:07 +00003703
wdenk2729af92004-05-03 20:45:30 +00003704Monitor Commands - Detailed Description:
3705========================================
wdenkc6097192002-11-03 00:24:07 +00003706
wdenk2729af92004-05-03 20:45:30 +00003707TODO.
wdenkc6097192002-11-03 00:24:07 +00003708
wdenk2729af92004-05-03 20:45:30 +00003709For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003710
3711
wdenk2729af92004-05-03 20:45:30 +00003712Environment Variables:
3713======================
wdenkc6097192002-11-03 00:24:07 +00003714
wdenk2729af92004-05-03 20:45:30 +00003715U-Boot supports user configuration using Environment Variables which
3716can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003717
wdenk2729af92004-05-03 20:45:30 +00003718Environment Variables are set using "setenv", printed using
3719"printenv", and saved to Flash using "saveenv". Using "setenv"
3720without a value can be used to delete a variable from the
3721environment. As long as you don't save the environment you are
3722working with an in-memory copy. In case the Flash area containing the
3723environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003724
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003725Some configuration options can be set using Environment Variables.
3726
3727List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003728
wdenk2729af92004-05-03 20:45:30 +00003729 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003730
wdenk2729af92004-05-03 20:45:30 +00003731 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003732
wdenk2729af92004-05-03 20:45:30 +00003733 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003734
wdenk2729af92004-05-03 20:45:30 +00003735 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003736
wdenk2729af92004-05-03 20:45:30 +00003737 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003738
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003739 bootm_low - Memory range available for image processing in the bootm
3740 command can be restricted. This variable is given as
3741 a hexadecimal number and defines lowest address allowed
3742 for use by the bootm command. See also "bootm_size"
3743 environment variable. Address defined by "bootm_low" is
3744 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003745 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3746 bootm_mapsize.
3747
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003748 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003749 This variable is given as a hexadecimal number and it
3750 defines the size of the memory region starting at base
3751 address bootm_low that is accessible by the Linux kernel
3752 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3753 as the default value if it is defined, and bootm_size is
3754 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003755
3756 bootm_size - Memory range available for image processing in the bootm
3757 command can be restricted. This variable is given as
3758 a hexadecimal number and defines the size of the region
3759 allowed for use by the bootm command. See also "bootm_low"
3760 environment variable.
3761
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003762 updatefile - Location of the software update file on a TFTP server, used
3763 by the automatic software update feature. Please refer to
3764 documentation in doc/README.update for more details.
3765
wdenk2729af92004-05-03 20:45:30 +00003766 autoload - if set to "no" (any string beginning with 'n'),
3767 "bootp" will just load perform a lookup of the
3768 configuration from the BOOTP server, but not try to
3769 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003770
wdenk2729af92004-05-03 20:45:30 +00003771 autostart - if set to "yes", an image loaded using the "bootp",
3772 "rarpboot", "tftpboot" or "diskboot" commands will
3773 be automatically started (by internally calling
3774 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003775
wdenk2729af92004-05-03 20:45:30 +00003776 If set to "no", a standalone image passed to the
3777 "bootm" command will be copied to the load address
3778 (and eventually uncompressed), but NOT be started.
3779 This can be used to load and uncompress arbitrary
3780 data.
wdenkc6097192002-11-03 00:24:07 +00003781
David A. Longa28afca2011-07-09 16:40:19 -04003782 fdt_high - if set this restricts the maximum address that the
3783 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003784 For example, if you have a system with 1 GB memory
3785 at physical address 0x10000000, while Linux kernel
3786 only recognizes the first 704 MB as low memory, you
3787 may need to set fdt_high as 0x3C000000 to have the
3788 device tree blob be copied to the maximum address
3789 of the 704 MB low memory, so that Linux kernel can
3790 access it during the boot procedure.
3791
David A. Longa28afca2011-07-09 16:40:19 -04003792 If this is set to the special value 0xFFFFFFFF then
3793 the fdt will not be copied at all on boot. For this
3794 to work it must reside in writable memory, have
3795 sufficient padding on the end of it for u-boot to
3796 add the information it needs into it, and the memory
3797 must be accessible by the kernel.
3798
Simon Glasseea63e02011-10-24 19:15:34 +00003799 fdtcontroladdr- if set this is the address of the control flattened
3800 device tree used by U-Boot when CONFIG_OF_CONTROL is
3801 defined.
3802
wdenk17ea1172004-06-06 21:51:03 +00003803 i2cfast - (PPC405GP|PPC405EP only)
3804 if set to 'y' configures Linux I2C driver for fast
3805 mode (400kHZ). This environment variable is used in
3806 initialization code. So, for changes to be effective
3807 it must be saved and board must be reset.
3808
wdenk2729af92004-05-03 20:45:30 +00003809 initrd_high - restrict positioning of initrd images:
3810 If this variable is not set, initrd images will be
3811 copied to the highest possible address in RAM; this
3812 is usually what you want since it allows for
3813 maximum initrd size. If for some reason you want to
3814 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003815 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003816 variable to a value of "no" or "off" or "0".
3817 Alternatively, you can set it to a maximum upper
3818 address to use (U-Boot will still check that it
3819 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003820
wdenk2729af92004-05-03 20:45:30 +00003821 For instance, when you have a system with 16 MB
3822 RAM, and want to reserve 4 MB from use by Linux,
3823 you can do this by adding "mem=12M" to the value of
3824 the "bootargs" variable. However, now you must make
3825 sure that the initrd image is placed in the first
3826 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003829
wdenk2729af92004-05-03 20:45:30 +00003830 If you set initrd_high to 0xFFFFFFFF, this is an
3831 indication to U-Boot that all addresses are legal
3832 for the Linux kernel, including addresses in flash
3833 memory. In this case U-Boot will NOT COPY the
3834 ramdisk at all. This may be useful to reduce the
3835 boot time on your system, but requires that this
3836 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003837
wdenk2729af92004-05-03 20:45:30 +00003838 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840 loadaddr - Default load address for commands like "bootp",
3841 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003842
wdenk2729af92004-05-03 20:45:30 +00003843 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003844
wdenk2729af92004-05-03 20:45:30 +00003845 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003846
wdenk2729af92004-05-03 20:45:30 +00003847 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk2729af92004-05-03 20:45:30 +00003849 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003850
wdenk2729af92004-05-03 20:45:30 +00003851 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003852
Mike Frysingere2a53452011-10-02 10:01:27 +00003853 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003854
Mike Frysingere2a53452011-10-02 10:01:27 +00003855 ethact - controls which interface is currently active.
3856 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003857
Heiko Schocher48690d82010-07-20 17:45:02 +02003858 => setenv ethact FEC
3859 => ping 192.168.0.1 # traffic sent on FEC
3860 => setenv ethact SCC
3861 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003862
Matthias Fuchse1692572008-01-17 07:45:05 +01003863 ethrotate - When set to "no" U-Boot does not go through all
3864 available network interfaces.
3865 It just stays at the currently selected interface.
3866
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003867 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003868 either succeed or fail without retrying.
3869 When set to "once" the network operation will
3870 fail when all the available network interfaces
3871 are tried once without success.
3872 Useful on scripts which control the retry operation
3873 themselves.
wdenkc6097192002-11-03 00:24:07 +00003874
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003875 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003876
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003877 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003878 UDP source port.
3879
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003880 tftpdstport - If this is set, the value is used for TFTP's UDP
3881 destination port instead of the Well Know Port 69.
3882
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003883 tftpblocksize - Block size to use for TFTP transfers; if not set,
3884 we use the TFTP server's default block size
3885
3886 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3887 seconds, minimum value is 1000 = 1 second). Defines
3888 when a packet is considered to be lost so it has to
3889 be retransmitted. The default is 5000 = 5 seconds.
3890 Lowering this value may make downloads succeed
3891 faster in networks with high packet loss rates or
3892 with unreliable TFTP servers.
3893
3894 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003895 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003896 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003897
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003898The following image location variables contain the location of images
3899used in booting. The "Image" column gives the role of the image and is
3900not an environment variable name. The other columns are environment
3901variable names. "File Name" gives the name of the file on a TFTP
3902server, "RAM Address" gives the location in RAM the image will be
3903loaded to, and "Flash Location" gives the image's address in NOR
3904flash or offset in NAND flash.
3905
3906*Note* - these variables don't have to be defined for all boards, some
3907boards currenlty use other variables for these purposes, and some
3908boards use these variables for other purposes.
3909
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003910Image File Name RAM Address Flash Location
3911----- --------- ----------- --------------
3912u-boot u-boot u-boot_addr_r u-boot_addr
3913Linux kernel bootfile kernel_addr_r kernel_addr
3914device tree blob fdtfile fdt_addr_r fdt_addr
3915ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003916
wdenk2729af92004-05-03 20:45:30 +00003917The following environment variables may be used and automatically
3918updated by the network boot commands ("bootp" and "rarpboot"),
3919depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003920
wdenk2729af92004-05-03 20:45:30 +00003921 bootfile - see above
3922 dnsip - IP address of your Domain Name Server
3923 dnsip2 - IP address of your secondary Domain Name Server
3924 gatewayip - IP address of the Gateway (Router) to use
3925 hostname - Target hostname
3926 ipaddr - see above
3927 netmask - Subnet Mask
3928 rootpath - Pathname of the root filesystem on the NFS server
3929 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003930
wdenka3d991b2004-04-15 21:48:45 +00003931
wdenk2729af92004-05-03 20:45:30 +00003932There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003933
wdenk2729af92004-05-03 20:45:30 +00003934 serial# - contains hardware identification information such
3935 as type string and/or serial number
3936 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003937
wdenk2729af92004-05-03 20:45:30 +00003938These variables can be set only once (usually during manufacturing of
3939the board). U-Boot refuses to delete or overwrite these variables
3940once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003941
3942
wdenk2729af92004-05-03 20:45:30 +00003943Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003944
wdenk2729af92004-05-03 20:45:30 +00003945 ver - Contains the U-Boot version string as printed
3946 with the "version" command. This variable is
3947 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003948
wdenkc6097192002-11-03 00:24:07 +00003949
wdenk2729af92004-05-03 20:45:30 +00003950Please note that changes to some configuration parameters may take
3951only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003952
stroesec1551ea2003-04-04 15:53:41 +00003953
wdenk2729af92004-05-03 20:45:30 +00003954Command Line Parsing:
3955=====================
stroesec1551ea2003-04-04 15:53:41 +00003956
wdenk2729af92004-05-03 20:45:30 +00003957There are two different command line parsers available with U-Boot:
3958the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003959
wdenk2729af92004-05-03 20:45:30 +00003960Old, simple command line parser:
3961--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003962
wdenk2729af92004-05-03 20:45:30 +00003963- supports environment variables (through setenv / saveenv commands)
3964- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003965- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003966- special characters ('$', ';') can be escaped by prefixing with '\',
3967 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003968 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003969- You can also escape text by enclosing in single apostrophes, for example:
3970 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003971
wdenk2729af92004-05-03 20:45:30 +00003972Hush shell:
3973-----------
wdenkf07771c2003-05-28 08:06:31 +00003974
wdenk2729af92004-05-03 20:45:30 +00003975- similar to Bourne shell, with control structures like
3976 if...then...else...fi, for...do...done; while...do...done,
3977 until...do...done, ...
3978- supports environment ("global") variables (through setenv / saveenv
3979 commands) and local shell variables (through standard shell syntax
3980 "name=value"); only environment variables can be used with "run"
3981 command
wdenkf07771c2003-05-28 08:06:31 +00003982
wdenk2729af92004-05-03 20:45:30 +00003983General rules:
3984--------------
wdenkf07771c2003-05-28 08:06:31 +00003985
wdenk2729af92004-05-03 20:45:30 +00003986(1) If a command line (or an environment variable executed by a "run"
3987 command) contains several commands separated by semicolon, and
3988 one of these commands fails, then the remaining commands will be
3989 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003990
wdenk2729af92004-05-03 20:45:30 +00003991(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003992 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003993 command will cause "run" to terminate, i. e. the remaining
3994 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003995
wdenk2729af92004-05-03 20:45:30 +00003996Note for Redundant Ethernet Interfaces:
3997=======================================
wdenkf07771c2003-05-28 08:06:31 +00003998
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003999Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004000such configurations and is capable of automatic selection of a
4001"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004002
wdenk2729af92004-05-03 20:45:30 +00004003Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4004MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4005"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004006
wdenk2729af92004-05-03 20:45:30 +00004007If the network interface stores some valid MAC address (for instance
4008in SROM), this is used as default address if there is NO correspon-
4009ding setting in the environment; if the corresponding environment
4010variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004011
wdenk2729af92004-05-03 20:45:30 +00004012o If the SROM has a valid MAC address, and there is no address in the
4013 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004014
wdenk2729af92004-05-03 20:45:30 +00004015o If there is no valid address in the SROM, and a definition in the
4016 environment exists, then the value from the environment variable is
4017 used.
wdenkc6097192002-11-03 00:24:07 +00004018
wdenk2729af92004-05-03 20:45:30 +00004019o If both the SROM and the environment contain a MAC address, and
4020 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022o If both the SROM and the environment contain a MAC address, and the
4023 addresses differ, the value from the environment is used and a
4024 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004025
wdenk2729af92004-05-03 20:45:30 +00004026o If neither SROM nor the environment contain a MAC address, an error
4027 is raised.
wdenkc6097192002-11-03 00:24:07 +00004028
Ben Warrenecee9322010-04-26 11:11:46 -07004029If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004030will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004031may be skipped by setting the appropriate 'ethmacskip' environment variable.
4032The naming convention is as follows:
4033"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004034
wdenk2729af92004-05-03 20:45:30 +00004035Image Formats:
4036==============
wdenkc6097192002-11-03 00:24:07 +00004037
Marian Balakowicz3310c542008-03-12 12:13:13 +01004038U-Boot is capable of booting (and performing other auxiliary operations on)
4039images in two formats:
4040
4041New uImage format (FIT)
4042-----------------------
4043
4044Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4045to Flattened Device Tree). It allows the use of images with multiple
4046components (several kernels, ramdisks, etc.), with contents protected by
4047SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4048
4049
4050Old uImage format
4051-----------------
4052
4053Old image format is based on binary files which can be basically anything,
4054preceded by a special header; see the definitions in include/image.h for
4055details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004056
wdenk2729af92004-05-03 20:45:30 +00004057* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4058 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004059 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4060 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4061 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004062* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004063 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4064 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004065* Compression Type (uncompressed, gzip, bzip2)
4066* Load Address
4067* Entry Point
4068* Image Name
4069* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004070
wdenk2729af92004-05-03 20:45:30 +00004071The header is marked by a special Magic Number, and both the header
4072and the data portions of the image are secured against corruption by
4073CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004074
wdenkc6097192002-11-03 00:24:07 +00004075
wdenk2729af92004-05-03 20:45:30 +00004076Linux Support:
4077==============
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk2729af92004-05-03 20:45:30 +00004079Although U-Boot should support any OS or standalone application
4080easily, the main focus has always been on Linux during the design of
4081U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004082
wdenk2729af92004-05-03 20:45:30 +00004083U-Boot includes many features that so far have been part of some
4084special "boot loader" code within the Linux kernel. Also, any
4085"initrd" images to be used are no longer part of one big Linux image;
4086instead, kernel and "initrd" are separate images. This implementation
4087serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004088
wdenk2729af92004-05-03 20:45:30 +00004089- the same features can be used for other OS or standalone
4090 applications (for instance: using compressed images to reduce the
4091 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004092
wdenk2729af92004-05-03 20:45:30 +00004093- it becomes much easier to port new Linux kernel versions because
4094 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004095
wdenk2729af92004-05-03 20:45:30 +00004096- the same Linux kernel image can now be used with different "initrd"
4097 images; of course this also means that different kernel images can
4098 be run with the same "initrd". This makes testing easier (you don't
4099 have to build a new "zImage.initrd" Linux image when you just
4100 change a file in your "initrd"). Also, a field-upgrade of the
4101 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004102
wdenkc6097192002-11-03 00:24:07 +00004103
wdenk2729af92004-05-03 20:45:30 +00004104Linux HOWTO:
4105============
wdenkc6097192002-11-03 00:24:07 +00004106
wdenk2729af92004-05-03 20:45:30 +00004107Porting Linux to U-Boot based systems:
4108---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004109
wdenk2729af92004-05-03 20:45:30 +00004110U-Boot cannot save you from doing all the necessary modifications to
4111configure the Linux device drivers for use with your target hardware
4112(no, we don't intend to provide a full virtual machine interface to
4113Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004114
Stefan Roesea47a12b2010-04-15 16:07:28 +02004115But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004116
wdenk2729af92004-05-03 20:45:30 +00004117Just make sure your machine specific header file (for instance
4118include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004119Information structure as we define in include/asm-<arch>/u-boot.h,
4120and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004121as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004122
wdenkc6097192002-11-03 00:24:07 +00004123
wdenk2729af92004-05-03 20:45:30 +00004124Configuring the Linux kernel:
4125-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004126
wdenk2729af92004-05-03 20:45:30 +00004127No specific requirements for U-Boot. Make sure you have some root
4128device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004129
wdenkc6097192002-11-03 00:24:07 +00004130
wdenk2729af92004-05-03 20:45:30 +00004131Building a Linux Image:
4132-----------------------
wdenkc6097192002-11-03 00:24:07 +00004133
wdenk2729af92004-05-03 20:45:30 +00004134With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4135not used. If you use recent kernel source, a new build target
4136"uImage" will exist which automatically builds an image usable by
4137U-Boot. Most older kernels also have support for a "pImage" target,
4138which was introduced for our predecessor project PPCBoot and uses a
4139100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004140
wdenk2729af92004-05-03 20:45:30 +00004141Example:
wdenkc6097192002-11-03 00:24:07 +00004142
wdenk2729af92004-05-03 20:45:30 +00004143 make TQM850L_config
4144 make oldconfig
4145 make dep
4146 make uImage
wdenkc6097192002-11-03 00:24:07 +00004147
wdenk2729af92004-05-03 20:45:30 +00004148The "uImage" build target uses a special tool (in 'tools/mkimage') to
4149encapsulate a compressed Linux kernel image with header information,
4150CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004151
wdenk2729af92004-05-03 20:45:30 +00004152* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004153
wdenk2729af92004-05-03 20:45:30 +00004154* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004155
wdenk2729af92004-05-03 20:45:30 +00004156 ${CROSS_COMPILE}-objcopy -O binary \
4157 -R .note -R .comment \
4158 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004159
wdenk2729af92004-05-03 20:45:30 +00004160* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004163
wdenk2729af92004-05-03 20:45:30 +00004164* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004165
wdenk2729af92004-05-03 20:45:30 +00004166 mkimage -A ppc -O linux -T kernel -C gzip \
4167 -a 0 -e 0 -n "Linux Kernel Image" \
4168 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004169
wdenk24ee89b2002-11-03 17:56:27 +00004170
wdenk2729af92004-05-03 20:45:30 +00004171The "mkimage" tool can also be used to create ramdisk images for use
4172with U-Boot, either separated from the Linux kernel image, or
4173combined into one file. "mkimage" encapsulates the images with a 64
4174byte header containing information about target architecture,
4175operating system, image type, compression method, entry points, time
4176stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004177
wdenk2729af92004-05-03 20:45:30 +00004178"mkimage" can be called in two ways: to verify existing images and
4179print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004180
wdenk2729af92004-05-03 20:45:30 +00004181In the first form (with "-l" option) mkimage lists the information
4182contained in the header of an existing U-Boot image; this includes
4183checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004184
wdenk2729af92004-05-03 20:45:30 +00004185 tools/mkimage -l image
4186 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004187
wdenk2729af92004-05-03 20:45:30 +00004188The second form (with "-d" option) is used to build a U-Boot image
4189from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004190
wdenk2729af92004-05-03 20:45:30 +00004191 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4192 -n name -d data_file image
4193 -A ==> set architecture to 'arch'
4194 -O ==> set operating system to 'os'
4195 -T ==> set image type to 'type'
4196 -C ==> set compression type 'comp'
4197 -a ==> set load address to 'addr' (hex)
4198 -e ==> set entry point to 'ep' (hex)
4199 -n ==> set image name to 'name'
4200 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004201
wdenk69459792004-05-29 16:53:29 +00004202Right now, all Linux kernels for PowerPC systems use the same load
4203address (0x00000000), but the entry point address depends on the
4204kernel version:
wdenkc6097192002-11-03 00:24:07 +00004205
wdenk2729af92004-05-03 20:45:30 +00004206- 2.2.x kernels have the entry point at 0x0000000C,
4207- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004208
wdenk2729af92004-05-03 20:45:30 +00004209So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004210
wdenk2729af92004-05-03 20:45:30 +00004211 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4212 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004213 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004214 > examples/uImage.TQM850L
4215 Image Name: 2.4.4 kernel for TQM850L
4216 Created: Wed Jul 19 02:34:59 2000
4217 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4218 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4219 Load Address: 0x00000000
4220 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004221
wdenk2729af92004-05-03 20:45:30 +00004222To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004223
wdenk2729af92004-05-03 20:45:30 +00004224 -> tools/mkimage -l examples/uImage.TQM850L
4225 Image Name: 2.4.4 kernel for TQM850L
4226 Created: Wed Jul 19 02:34:59 2000
4227 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4228 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4229 Load Address: 0x00000000
4230 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004231
wdenk2729af92004-05-03 20:45:30 +00004232NOTE: for embedded systems where boot time is critical you can trade
4233speed for memory and install an UNCOMPRESSED image instead: this
4234needs more space in Flash, but boots much faster since it does not
4235need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004236
Stefan Roesea47a12b2010-04-15 16:07:28 +02004237 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004238 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4239 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004240 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004241 > examples/uImage.TQM850L-uncompressed
4242 Image Name: 2.4.4 kernel for TQM850L
4243 Created: Wed Jul 19 02:34:59 2000
4244 Image Type: PowerPC Linux Kernel Image (uncompressed)
4245 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4246 Load Address: 0x00000000
4247 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004248
wdenkc6097192002-11-03 00:24:07 +00004249
wdenk2729af92004-05-03 20:45:30 +00004250Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4251when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004252
wdenk2729af92004-05-03 20:45:30 +00004253 -> tools/mkimage -n 'Simple Ramdisk Image' \
4254 > -A ppc -O linux -T ramdisk -C gzip \
4255 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4256 Image Name: Simple Ramdisk Image
4257 Created: Wed Jan 12 14:01:50 2000
4258 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4259 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4260 Load Address: 0x00000000
4261 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004262
wdenkdb01a2e2004-04-15 23:14:49 +00004263
wdenk2729af92004-05-03 20:45:30 +00004264Installing a Linux Image:
4265-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004266
wdenk2729af92004-05-03 20:45:30 +00004267To downloading a U-Boot image over the serial (console) interface,
4268you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004269
wdenk2729af92004-05-03 20:45:30 +00004270 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004271
wdenk2729af92004-05-03 20:45:30 +00004272The 'objcopy' does not understand the information in the U-Boot
4273image header, so the resulting S-Record file will be relative to
4274address 0x00000000. To load it to a given address, you need to
4275specify the target address as 'offset' parameter with the 'loads'
4276command.
wdenkc6097192002-11-03 00:24:07 +00004277
wdenk2729af92004-05-03 20:45:30 +00004278Example: install the image to address 0x40100000 (which on the
4279TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004280
wdenk2729af92004-05-03 20:45:30 +00004281 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004282
wdenk2729af92004-05-03 20:45:30 +00004283 .......... done
4284 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004285
wdenk2729af92004-05-03 20:45:30 +00004286 => loads 40100000
4287 ## Ready for S-Record download ...
4288 ~>examples/image.srec
4289 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4290 ...
4291 15989 15990 15991 15992
4292 [file transfer complete]
4293 [connected]
4294 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004295
4296
wdenk2729af92004-05-03 20:45:30 +00004297You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004298this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004299corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004300
wdenk2729af92004-05-03 20:45:30 +00004301 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004302
wdenk2729af92004-05-03 20:45:30 +00004303 ## Checking Image at 40100000 ...
4304 Image Name: 2.2.13 for initrd on TQM850L
4305 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4306 Data Size: 335725 Bytes = 327 kB = 0 MB
4307 Load Address: 00000000
4308 Entry Point: 0000000c
4309 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004310
4311
wdenk2729af92004-05-03 20:45:30 +00004312Boot Linux:
4313-----------
wdenkc6097192002-11-03 00:24:07 +00004314
wdenk2729af92004-05-03 20:45:30 +00004315The "bootm" command is used to boot an application that is stored in
4316memory (RAM or Flash). In case of a Linux kernel image, the contents
4317of the "bootargs" environment variable is passed to the kernel as
4318parameters. You can check and modify this variable using the
4319"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004320
4321
wdenk2729af92004-05-03 20:45:30 +00004322 => printenv bootargs
4323 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004324
wdenk2729af92004-05-03 20:45:30 +00004325 => 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 +00004326
wdenk2729af92004-05-03 20:45:30 +00004327 => printenv bootargs
4328 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 +00004329
wdenk2729af92004-05-03 20:45:30 +00004330 => bootm 40020000
4331 ## Booting Linux kernel at 40020000 ...
4332 Image Name: 2.2.13 for NFS on TQM850L
4333 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4334 Data Size: 381681 Bytes = 372 kB = 0 MB
4335 Load Address: 00000000
4336 Entry Point: 0000000c
4337 Verifying Checksum ... OK
4338 Uncompressing Kernel Image ... OK
4339 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
4340 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4341 time_init: decrementer frequency = 187500000/60
4342 Calibrating delay loop... 49.77 BogoMIPS
4343 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4344 ...
wdenkc6097192002-11-03 00:24:07 +00004345
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004346If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004347the memory addresses of both the kernel and the initrd image (PPBCOOT
4348format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004349
wdenk2729af92004-05-03 20:45:30 +00004350 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004351
wdenk2729af92004-05-03 20:45:30 +00004352 ## Checking Image at 40100000 ...
4353 Image Name: 2.2.13 for initrd on TQM850L
4354 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4355 Data Size: 335725 Bytes = 327 kB = 0 MB
4356 Load Address: 00000000
4357 Entry Point: 0000000c
4358 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004359
wdenk2729af92004-05-03 20:45:30 +00004360 ## Checking Image at 40200000 ...
4361 Image Name: Simple Ramdisk Image
4362 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4363 Data Size: 566530 Bytes = 553 kB = 0 MB
4364 Load Address: 00000000
4365 Entry Point: 00000000
4366 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004367
wdenk2729af92004-05-03 20:45:30 +00004368 => bootm 40100000 40200000
4369 ## Booting Linux kernel at 40100000 ...
4370 Image Name: 2.2.13 for initrd on TQM850L
4371 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4372 Data Size: 335725 Bytes = 327 kB = 0 MB
4373 Load Address: 00000000
4374 Entry Point: 0000000c
4375 Verifying Checksum ... OK
4376 Uncompressing Kernel Image ... OK
4377 ## Loading RAMDisk Image at 40200000 ...
4378 Image Name: Simple Ramdisk Image
4379 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4380 Data Size: 566530 Bytes = 553 kB = 0 MB
4381 Load Address: 00000000
4382 Entry Point: 00000000
4383 Verifying Checksum ... OK
4384 Loading Ramdisk ... OK
4385 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
4386 Boot arguments: root=/dev/ram
4387 time_init: decrementer frequency = 187500000/60
4388 Calibrating delay loop... 49.77 BogoMIPS
4389 ...
4390 RAMDISK: Compressed image found at block 0
4391 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004392
wdenk2729af92004-05-03 20:45:30 +00004393 bash#
wdenkc6097192002-11-03 00:24:07 +00004394
Matthew McClintock02677682006-06-28 10:41:37 -05004395Boot Linux and pass a flat device tree:
4396-----------
4397
4398First, U-Boot must be compiled with the appropriate defines. See the section
4399titled "Linux Kernel Interface" above for a more in depth explanation. The
4400following is an example of how to start a kernel and pass an updated
4401flat device tree:
4402
4403=> print oftaddr
4404oftaddr=0x300000
4405=> print oft
4406oft=oftrees/mpc8540ads.dtb
4407=> tftp $oftaddr $oft
4408Speed: 1000, full duplex
4409Using TSEC0 device
4410TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4411Filename 'oftrees/mpc8540ads.dtb'.
4412Load address: 0x300000
4413Loading: #
4414done
4415Bytes transferred = 4106 (100a hex)
4416=> tftp $loadaddr $bootfile
4417Speed: 1000, full duplex
4418Using TSEC0 device
4419TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4420Filename 'uImage'.
4421Load address: 0x200000
4422Loading:############
4423done
4424Bytes transferred = 1029407 (fb51f hex)
4425=> print loadaddr
4426loadaddr=200000
4427=> print oftaddr
4428oftaddr=0x300000
4429=> bootm $loadaddr - $oftaddr
4430## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004431 Image Name: Linux-2.6.17-dirty
4432 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4433 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004434 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004435 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004436 Verifying Checksum ... OK
4437 Uncompressing Kernel Image ... OK
4438Booting using flat device tree at 0x300000
4439Using MPC85xx ADS machine description
4440Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4441[snip]
4442
4443
wdenk2729af92004-05-03 20:45:30 +00004444More About U-Boot Image Types:
4445------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004446
wdenk2729af92004-05-03 20:45:30 +00004447U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004448
wdenk2729af92004-05-03 20:45:30 +00004449 "Standalone Programs" are directly runnable in the environment
4450 provided by U-Boot; it is expected that (if they behave
4451 well) you can continue to work in U-Boot after return from
4452 the Standalone Program.
4453 "OS Kernel Images" are usually images of some Embedded OS which
4454 will take over control completely. Usually these programs
4455 will install their own set of exception handlers, device
4456 drivers, set up the MMU, etc. - this means, that you cannot
4457 expect to re-enter U-Boot except by resetting the CPU.
4458 "RAMDisk Images" are more or less just data blocks, and their
4459 parameters (address, size) are passed to an OS kernel that is
4460 being started.
4461 "Multi-File Images" contain several images, typically an OS
4462 (Linux) kernel image and one or more data images like
4463 RAMDisks. This construct is useful for instance when you want
4464 to boot over the network using BOOTP etc., where the boot
4465 server provides just a single image file, but you want to get
4466 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004467
wdenk2729af92004-05-03 20:45:30 +00004468 "Multi-File Images" start with a list of image sizes, each
4469 image size (in bytes) specified by an "uint32_t" in network
4470 byte order. This list is terminated by an "(uint32_t)0".
4471 Immediately after the terminating 0 follow the images, one by
4472 one, all aligned on "uint32_t" boundaries (size rounded up to
4473 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004474
wdenk2729af92004-05-03 20:45:30 +00004475 "Firmware Images" are binary images containing firmware (like
4476 U-Boot or FPGA images) which usually will be programmed to
4477 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004478
wdenk2729af92004-05-03 20:45:30 +00004479 "Script files" are command sequences that will be executed by
4480 U-Boot's command interpreter; this feature is especially
4481 useful when you configure U-Boot to use a real shell (hush)
4482 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004483
Marek Vasut44f074c2012-03-14 21:52:45 +00004484Booting the Linux zImage:
4485-------------------------
4486
4487On some platforms, it's possible to boot Linux zImage. This is done
4488using the "bootz" command. The syntax of "bootz" command is the same
4489as the syntax of "bootm" command.
4490
Marek Vasut017e1f32012-03-18 11:47:58 +00004491Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4492kernel with raw initrd images. The syntax is slightly different, the
4493address of the initrd must be augmented by it's size, in the following
4494format: "<initrd addres>:<initrd size>".
4495
wdenkc6097192002-11-03 00:24:07 +00004496
wdenk2729af92004-05-03 20:45:30 +00004497Standalone HOWTO:
4498=================
wdenkc6097192002-11-03 00:24:07 +00004499
wdenk2729af92004-05-03 20:45:30 +00004500One of the features of U-Boot is that you can dynamically load and
4501run "standalone" applications, which can use some resources of
4502U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004503
wdenk2729af92004-05-03 20:45:30 +00004504Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004505
wdenk2729af92004-05-03 20:45:30 +00004506"Hello World" Demo:
4507-------------------
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk2729af92004-05-03 20:45:30 +00004509'examples/hello_world.c' contains a small "Hello World" Demo
4510application; it is automatically compiled when you build U-Boot.
4511It's configured to run at address 0x00040004, so you can play with it
4512like that:
wdenkc6097192002-11-03 00:24:07 +00004513
wdenk2729af92004-05-03 20:45:30 +00004514 => loads
4515 ## Ready for S-Record download ...
4516 ~>examples/hello_world.srec
4517 1 2 3 4 5 6 7 8 9 10 11 ...
4518 [file transfer complete]
4519 [connected]
4520 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004521
wdenk2729af92004-05-03 20:45:30 +00004522 => go 40004 Hello World! This is a test.
4523 ## Starting application at 0x00040004 ...
4524 Hello World
4525 argc = 7
4526 argv[0] = "40004"
4527 argv[1] = "Hello"
4528 argv[2] = "World!"
4529 argv[3] = "This"
4530 argv[4] = "is"
4531 argv[5] = "a"
4532 argv[6] = "test."
4533 argv[7] = "<NULL>"
4534 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004535
wdenk2729af92004-05-03 20:45:30 +00004536 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004537
wdenk2729af92004-05-03 20:45:30 +00004538Another example, which demonstrates how to register a CPM interrupt
4539handler with the U-Boot code, can be found in 'examples/timer.c'.
4540Here, a CPM timer is set up to generate an interrupt every second.
4541The interrupt service routine is trivial, just printing a '.'
4542character, but this is just a demo program. The application can be
4543controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004544
wdenk2729af92004-05-03 20:45:30 +00004545 ? - print current values og the CPM Timer registers
4546 b - enable interrupts and start timer
4547 e - stop timer and disable interrupts
4548 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk2729af92004-05-03 20:45:30 +00004550 => loads
4551 ## Ready for S-Record download ...
4552 ~>examples/timer.srec
4553 1 2 3 4 5 6 7 8 9 10 11 ...
4554 [file transfer complete]
4555 [connected]
4556 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004557
wdenk2729af92004-05-03 20:45:30 +00004558 => go 40004
4559 ## Starting application at 0x00040004 ...
4560 TIMERS=0xfff00980
4561 Using timer 1
4562 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004563
wdenk2729af92004-05-03 20:45:30 +00004564Hit 'b':
4565 [q, b, e, ?] Set interval 1000000 us
4566 Enabling timer
4567Hit '?':
4568 [q, b, e, ?] ........
4569 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4570Hit '?':
4571 [q, b, e, ?] .
4572 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4573Hit '?':
4574 [q, b, e, ?] .
4575 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4576Hit '?':
4577 [q, b, e, ?] .
4578 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4579Hit 'e':
4580 [q, b, e, ?] ...Stopping timer
4581Hit 'q':
4582 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004583
4584
wdenk2729af92004-05-03 20:45:30 +00004585Minicom warning:
4586================
wdenk85ec0bc2003-03-31 16:34:49 +00004587
wdenk2729af92004-05-03 20:45:30 +00004588Over time, many people have reported problems when trying to use the
4589"minicom" terminal emulation program for serial download. I (wd)
4590consider minicom to be broken, and recommend not to use it. Under
4591Unix, I recommend to use C-Kermit for general purpose use (and
4592especially for kermit binary protocol download ("loadb" command), and
4593use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004594
wdenk2729af92004-05-03 20:45:30 +00004595Nevertheless, if you absolutely want to use it try adding this
4596configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004597
wdenk2729af92004-05-03 20:45:30 +00004598 Name Program Name U/D FullScr IO-Red. Multi
4599 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4600 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004601
4602
wdenk2729af92004-05-03 20:45:30 +00004603NetBSD Notes:
4604=============
wdenkc6097192002-11-03 00:24:07 +00004605
wdenk2729af92004-05-03 20:45:30 +00004606Starting at version 0.9.2, U-Boot supports NetBSD both as host
4607(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004608
wdenk2729af92004-05-03 20:45:30 +00004609Building requires a cross environment; it is known to work on
4610NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4611need gmake since the Makefiles are not compatible with BSD make).
4612Note that the cross-powerpc package does not install include files;
4613attempting to build U-Boot will fail because <machine/ansi.h> is
4614missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004615
wdenk2729af92004-05-03 20:45:30 +00004616 # cd /usr/pkg/cross/powerpc-netbsd/include
4617 # mkdir powerpc
4618 # ln -s powerpc machine
4619 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4620 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004621
wdenk2729af92004-05-03 20:45:30 +00004622Native builds *don't* work due to incompatibilities between native
4623and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004624
wdenk2729af92004-05-03 20:45:30 +00004625Booting assumes that (the first part of) the image booted is a
4626stage-2 loader which in turn loads and then invokes the kernel
4627proper. Loader sources will eventually appear in the NetBSD source
4628tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004629meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004630
4631
wdenk2729af92004-05-03 20:45:30 +00004632Implementation Internals:
4633=========================
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk2729af92004-05-03 20:45:30 +00004635The following is not intended to be a complete description of every
4636implementation detail. However, it should help to understand the
4637inner workings of U-Boot and make it easier to port it to custom
4638hardware.
wdenkc6097192002-11-03 00:24:07 +00004639
4640
wdenk2729af92004-05-03 20:45:30 +00004641Initial Stack, Global Data:
4642---------------------------
wdenkc6097192002-11-03 00:24:07 +00004643
wdenk2729af92004-05-03 20:45:30 +00004644The implementation of U-Boot is complicated by the fact that U-Boot
4645starts running out of ROM (flash memory), usually without access to
4646system RAM (because the memory controller is not initialized yet).
4647This means that we don't have writable Data or BSS segments, and BSS
4648is not initialized as zero. To be able to get a C environment working
4649at all, we have to allocate at least a minimal stack. Implementation
4650options for this are defined and restricted by the CPU used: Some CPU
4651models provide on-chip memory (like the IMMR area on MPC8xx and
4652MPC826x processors), on others (parts of) the data cache can be
4653locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004654
Wolfgang Denk218ca722008-03-26 10:40:12 +01004655 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004656 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004657
wdenk2729af92004-05-03 20:45:30 +00004658 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4659 From: "Chris Hallinan" <clh@net1plus.com>
4660 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4661 ...
wdenk43d96162003-03-06 00:02:04 +00004662
wdenk2729af92004-05-03 20:45:30 +00004663 Correct me if I'm wrong, folks, but the way I understand it
4664 is this: Using DCACHE as initial RAM for Stack, etc, does not
4665 require any physical RAM backing up the cache. The cleverness
4666 is that the cache is being used as a temporary supply of
4667 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004668 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004669 can see how this works by studying the cache architecture and
4670 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004671
wdenk2729af92004-05-03 20:45:30 +00004672 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4673 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004674 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004675 option should work for you. Using CS 4 should be fine if your
4676 board designers haven't used it for something that would
4677 cause you grief during the initial boot! It is frequently not
4678 used.
wdenk43d96162003-03-06 00:02:04 +00004679
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004680 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004681 with your processor/board/system design. The default value
4682 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004683 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004684 than your SDRAM module. If you have a 64MB SDRAM module, set
4685 it above 400_0000. Just make sure your board has no resources
4686 that are supposed to respond to that address! That code in
4687 start.S has been around a while and should work as is when
4688 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004689
wdenk2729af92004-05-03 20:45:30 +00004690 -Chris Hallinan
4691 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004692
wdenk2729af92004-05-03 20:45:30 +00004693It is essential to remember this, since it has some impact on the C
4694code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk2729af92004-05-03 20:45:30 +00004696* Initialized global data (data segment) is read-only. Do not attempt
4697 to write it.
wdenkc6097192002-11-03 00:24:07 +00004698
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004699* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004700 as zero data - BSS segment) at all - this is undefined, initiali-
4701 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004702
wdenk2729af92004-05-03 20:45:30 +00004703* Stack space is very limited. Avoid big data buffers or things like
4704 that.
wdenkc6097192002-11-03 00:24:07 +00004705
wdenk2729af92004-05-03 20:45:30 +00004706Having only the stack as writable memory limits means we cannot use
4707normal global data to share information beween the code. But it
4708turned out that the implementation of U-Boot can be greatly
4709simplified by making a global data structure (gd_t) available to all
4710functions. We could pass a pointer to this data as argument to _all_
4711functions, but this would bloat the code. Instead we use a feature of
4712the GCC compiler (Global Register Variables) to share the data: we
4713place a pointer (gd) to the global data into a register which we
4714reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004715
wdenk2729af92004-05-03 20:45:30 +00004716When choosing a register for such a purpose we are restricted by the
4717relevant (E)ABI specifications for the current architecture, and by
4718GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004719
wdenk2729af92004-05-03 20:45:30 +00004720For PowerPC, the following registers have specific use:
4721 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004722 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004723 R3-R4: parameter passing and return values
4724 R5-R10: parameter passing
4725 R13: small data area pointer
4726 R30: GOT pointer
4727 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004728
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004729 (U-Boot also uses R12 as internal GOT pointer. r12
4730 is a volatile register so r12 needs to be reset when
4731 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004732
Wolfgang Denke7670f62008-02-14 22:43:22 +01004733 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk2729af92004-05-03 20:45:30 +00004735 Note: on PPC, we could use a static initializer (since the
4736 address of the global data structure is known at compile time),
4737 but it turned out that reserving a register results in somewhat
4738 smaller code - although the code savings are not that big (on
4739 average for all boards 752 bytes for the whole U-Boot image,
4740 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004741
Robin Getzc4db3352009-08-17 15:23:02 +00004742On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004743 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4744
Robin Getzc4db3352009-08-17 15:23:02 +00004745 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004746
wdenk2729af92004-05-03 20:45:30 +00004747On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004748
wdenk2729af92004-05-03 20:45:30 +00004749 R0: function argument word/integer result
4750 R1-R3: function argument word
4751 R9: GOT pointer
4752 R10: stack limit (used only if stack checking if enabled)
4753 R11: argument (frame) pointer
4754 R12: temporary workspace
4755 R13: stack pointer
4756 R14: link register
4757 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004758
wdenk2729af92004-05-03 20:45:30 +00004759 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004760
Thomas Chou0df01fd2010-05-21 11:08:03 +08004761On Nios II, the ABI is documented here:
4762 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4763
4764 ==> U-Boot will use gp to hold a pointer to the global data
4765
4766 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4767 to access small data sections, so gp is free.
4768
Macpaul Linafc1ce82011-10-19 20:41:11 +00004769On NDS32, the following registers are used:
4770
4771 R0-R1: argument/return
4772 R2-R5: argument
4773 R15: temporary register for assembler
4774 R16: trampoline register
4775 R28: frame pointer (FP)
4776 R29: global pointer (GP)
4777 R30: link register (LP)
4778 R31: stack pointer (SP)
4779 PC: program counter (PC)
4780
4781 ==> U-Boot will use R10 to hold a pointer to the global data
4782
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004783NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4784or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004785
wdenk2729af92004-05-03 20:45:30 +00004786Memory Management:
4787------------------
wdenkc6097192002-11-03 00:24:07 +00004788
wdenk2729af92004-05-03 20:45:30 +00004789U-Boot runs in system state and uses physical addresses, i.e. the
4790MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004791
wdenk2729af92004-05-03 20:45:30 +00004792The available memory is mapped to fixed addresses using the memory
4793controller. In this process, a contiguous block is formed for each
4794memory type (Flash, SDRAM, SRAM), even when it consists of several
4795physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004796
wdenk2729af92004-05-03 20:45:30 +00004797U-Boot is installed in the first 128 kB of the first Flash bank (on
4798TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4799booting and sizing and initializing DRAM, the code relocates itself
4800to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004801memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004802configuration setting]. Below that, a structure with global Board
4803Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004804
wdenk2729af92004-05-03 20:45:30 +00004805Additionally, some exception handler code is copied to the low 8 kB
4806of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk2729af92004-05-03 20:45:30 +00004808So a typical memory configuration with 16 MB of DRAM could look like
4809this:
wdenkc6097192002-11-03 00:24:07 +00004810
wdenk2729af92004-05-03 20:45:30 +00004811 0x0000 0000 Exception Vector code
4812 :
4813 0x0000 1FFF
4814 0x0000 2000 Free for Application Use
4815 :
4816 :
wdenkc6097192002-11-03 00:24:07 +00004817
wdenk2729af92004-05-03 20:45:30 +00004818 :
4819 :
4820 0x00FB FF20 Monitor Stack (Growing downward)
4821 0x00FB FFAC Board Info Data and permanent copy of global data
4822 0x00FC 0000 Malloc Arena
4823 :
4824 0x00FD FFFF
4825 0x00FE 0000 RAM Copy of Monitor Code
4826 ... eventually: LCD or video framebuffer
4827 ... eventually: pRAM (Protected RAM - unchanged by reset)
4828 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004829
4830
wdenk2729af92004-05-03 20:45:30 +00004831System Initialization:
4832----------------------
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk2729af92004-05-03 20:45:30 +00004834In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004835(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004836configuration for CS0# this is a mirror of the onboard Flash memory.
4837To be able to re-map memory U-Boot then jumps to its link address.
4838To be able to implement the initialization code in C, a (small!)
4839initial stack is set up in the internal Dual Ported RAM (in case CPUs
4840which provide such a feature like MPC8xx or MPC8260), or in a locked
4841part of the data cache. After that, U-Boot initializes the CPU core,
4842the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk2729af92004-05-03 20:45:30 +00004844Next, all (potentially) available memory banks are mapped using a
4845preliminary mapping. For example, we put them on 512 MB boundaries
4846(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4847on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4848programmed for SDRAM access. Using the temporary configuration, a
4849simple memory test is run that determines the size of the SDRAM
4850banks.
wdenkc6097192002-11-03 00:24:07 +00004851
wdenk2729af92004-05-03 20:45:30 +00004852When there is more than one SDRAM bank, and the banks are of
4853different size, the largest is mapped first. For equal size, the first
4854bank (CS2#) is mapped first. The first mapping is always for address
48550x00000000, with any additional banks following immediately to create
4856contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004857
wdenk2729af92004-05-03 20:45:30 +00004858Then, the monitor installs itself at the upper end of the SDRAM area
4859and allocates memory for use by malloc() and for the global Board
4860Info data; also, the exception vector code is copied to the low RAM
4861pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004862
wdenk2729af92004-05-03 20:45:30 +00004863Only after this relocation will you have a "normal" C environment;
4864until that you are restricted in several ways, mostly because you are
4865running from ROM, and because the code will have to be relocated to a
4866new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004867
4868
wdenk2729af92004-05-03 20:45:30 +00004869U-Boot Porting Guide:
4870----------------------
wdenkc6097192002-11-03 00:24:07 +00004871
wdenk2729af92004-05-03 20:45:30 +00004872[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4873list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004874
4875
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004876int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004877{
4878 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004879
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004880 signal(SIGALRM, no_more_time);
4881 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004882
wdenk2729af92004-05-03 20:45:30 +00004883 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004884 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004885 return 0;
4886 }
4887
wdenk2729af92004-05-03 20:45:30 +00004888 Download latest U-Boot source;
4889
Wolfgang Denk06682362008-12-30 22:56:11 +01004890 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004891
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004892 if (clueless)
4893 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk2729af92004-05-03 20:45:30 +00004895 while (learning) {
4896 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004897 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4898 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004899 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004900 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004901 }
wdenkc6097192002-11-03 00:24:07 +00004902
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004903 if (available_money > toLocalCurrency ($2500))
4904 Buy a BDI3000;
4905 else
wdenk2729af92004-05-03 20:45:30 +00004906 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004907
4908 if (a similar board exists) { /* hopefully... */
4909 cp -a board/<similar> board/<myboard>
4910 cp include/configs/<similar>.h include/configs/<myboard>.h
4911 } else {
4912 Create your own board support subdirectory;
4913 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004914 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004915 Edit new board/<myboard> files
4916 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004917
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004918 while (!accepted) {
4919 while (!running) {
4920 do {
4921 Add / modify source code;
4922 } until (compiles);
4923 Debug;
4924 if (clueless)
4925 email("Hi, I am having problems...");
4926 }
4927 Send patch file to the U-Boot email list;
4928 if (reasonable critiques)
4929 Incorporate improvements from email list code review;
4930 else
4931 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004932 }
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk2729af92004-05-03 20:45:30 +00004934 return 0;
4935}
4936
4937void no_more_time (int sig)
4938{
4939 hire_a_guru();
4940}
wdenkc6097192002-11-03 00:24:07 +00004941
4942
wdenk2729af92004-05-03 20:45:30 +00004943Coding Standards:
4944-----------------
wdenkc6097192002-11-03 00:24:07 +00004945
wdenk2729af92004-05-03 20:45:30 +00004946All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004947coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004948"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004949
Detlev Zundel2c051652006-09-01 15:39:02 +02004950Source files originating from a different project (for example the
4951MTD subsystem) are generally exempt from these guidelines and are not
4952reformated to ease subsequent migration to newer versions of those
4953sources.
4954
4955Please note that U-Boot is implemented in C (and to some small parts in
4956Assembler); no C++ is used, so please do not use C++ style comments (//)
4957in your code.
wdenk2729af92004-05-03 20:45:30 +00004958
4959Please also stick to the following formatting rules:
4960- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004961- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004962- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004963- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004964- do not add trailing empty lines to source files
4965
4966Submissions which do not conform to the standards may be returned
4967with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004968
4969
wdenk2729af92004-05-03 20:45:30 +00004970Submitting Patches:
4971-------------------
wdenkc6097192002-11-03 00:24:07 +00004972
wdenk2729af92004-05-03 20:45:30 +00004973Since the number of patches for U-Boot is growing, we need to
4974establish some rules. Submissions which do not conform to these rules
4975may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004976
Magnus Lilja0d28f342008-08-06 19:32:33 +02004977Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004978
Wolfgang Denk06682362008-12-30 22:56:11 +01004979Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4980see http://lists.denx.de/mailman/listinfo/u-boot
4981
wdenk2729af92004-05-03 20:45:30 +00004982When you send a patch, please include the following information with
4983it:
wdenkc6097192002-11-03 00:24:07 +00004984
wdenk2729af92004-05-03 20:45:30 +00004985* For bug fixes: a description of the bug and how your patch fixes
4986 this bug. Please try to include a way of demonstrating that the
4987 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004988
wdenk2729af92004-05-03 20:45:30 +00004989* For new features: a description of the feature and your
4990 implementation.
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk2729af92004-05-03 20:45:30 +00004992* A CHANGELOG entry as plaintext (separate from the patch)
4993
4994* For major contributions, your entry to the CREDITS file
4995
4996* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004997 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00004998
4999* If your patch adds new configuration options, don't forget to
5000 document these in the README file.
5001
Wolfgang Denk218ca722008-03-26 10:40:12 +01005002* The patch itself. If you are using git (which is *strongly*
5003 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005004 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005005 the U-Boot mailing list, you will avoid most of the common problems
5006 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005007
Wolfgang Denk218ca722008-03-26 10:40:12 +01005008 If you cannot use git, use "diff -purN OLD NEW". If your version of
5009 diff does not support these options, then get the latest version of
5010 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005011
Wolfgang Denk218ca722008-03-26 10:40:12 +01005012 The current directory when running this command shall be the parent
5013 directory of the U-Boot source tree (i. e. please make sure that
5014 your patch includes sufficient directory information for the
5015 affected files).
5016
5017 We prefer patches as plain text. MIME attachments are discouraged,
5018 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005019
5020* If one logical set of modifications affects or creates several
5021 files, all these changes shall be submitted in a SINGLE patch file.
5022
5023* Changesets that contain different, unrelated modifications shall be
5024 submitted as SEPARATE patches, one patch per changeset.
5025
5026
5027Notes:
5028
5029* Before sending the patch, run the MAKEALL script on your patched
5030 source tree and make sure that no errors or warnings are reported
5031 for any of the boards.
5032
5033* Keep your modifications to the necessary minimum: A patch
5034 containing several unrelated changes or arbitrary reformats will be
5035 returned with a request to re-formatting / split it.
5036
5037* If you modify existing code, make sure that your new code does not
5038 add to the memory footprint of the code ;-) Small is beautiful!
5039 When adding new features, these should compile conditionally only
5040 (using #ifdef), and the resulting code with the new feature
5041 disabled must not need more memory than the old code without your
5042 modification.
wdenk90dc6702005-05-03 14:12:25 +00005043
Wolfgang Denk06682362008-12-30 22:56:11 +01005044* Remember that there is a size limit of 100 kB per message on the
5045 u-boot mailing list. Bigger patches will be moderated. If they are
5046 reasonable and not too big, they will be acknowledged. But patches
5047 bigger than the size limit should be avoided.