blob: bb1b725672a7dab8ad435aaa8ef5813514f282d5 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkb75190d2012-01-19 10:58:21 +01002# (C) Copyright 2000 - 2012
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
5# See file CREDITS for list of people who contributed to this
6# project.
7#
8# This program is free software; you can redistribute it and/or
9# modify it under the terms of the GNU General Public License as
10# published by the Free Software Foundation; either version 2 of
11# the License, or (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21# MA 02111-1307 USA
22#
23
24Summary:
25========
26
wdenk24ee89b2002-11-03 17:56:27 +000027This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000028Embedded boards based on PowerPC, ARM, MIPS and several other
29processors, which can be installed in a boot ROM and used to
30initialize and test the hardware or to download and run application
31code.
wdenkc6097192002-11-03 00:24:07 +000032
33The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000034the source code originate in the Linux source tree, we have some
35header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000036support booting of Linux images.
37
38Some attention has been paid to make this software easily
39configurable and extendable. For instance, all monitor commands are
40implemented with the same call interface, so that it's very easy to
41add new commands. Also, instead of permanently adding rarely used
42code (for instance hardware test utilities) to the monitor, you can
43load and run it dynamically.
44
45
46Status:
47=======
48
49In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000050Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000051"working". In fact, many of them are used in production systems.
52
wdenk24ee89b2002-11-03 17:56:27 +000053In case of problems see the CHANGELOG and CREDITS files to find out
Wolfgang Denk218ca722008-03-26 10:40:12 +010054who contributed the specific port. The MAINTAINERS file lists board
55maintainers.
wdenkc6097192002-11-03 00:24:07 +000056
wdenkc6097192002-11-03 00:24:07 +000057
58Where to get help:
59==================
60
wdenk24ee89b2002-11-03 17:56:27 +000061In case you have questions about, problems with or contributions for
62U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050063<u-boot@lists.denx.de>. There is also an archive of previous traffic
64on the mailing list - please search the archive before asking FAQ's.
65Please see http://lists.denx.de/pipermail/u-boot and
66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000067
68
Wolfgang Denk218ca722008-03-26 10:40:12 +010069Where to get source code:
70=========================
71
72The U-Boot source code is maintained in the git repository at
73git://www.denx.de/git/u-boot.git ; you can browse it online at
74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75
76The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020077any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010078available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79directory.
80
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010081Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010082ftp://ftp.denx.de/pub/u-boot/images/
83
84
wdenkc6097192002-11-03 00:24:07 +000085Where we come from:
86===================
87
88- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000089- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000090- clean up code
91- make it easier to add custom boards
92- make it possible to add other [PowerPC] CPUs
93- extend functions, especially:
94 * Provide extended interface to Linux boot loader
95 * S-Record download
96 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020097 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000098- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000099- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +0000100- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +0200101- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +0000102
103
104Names and Spelling:
105===================
106
107The "official" name of this project is "Das U-Boot". The spelling
108"U-Boot" shall be used in all written text (documentation, comments
109in source files etc.). Example:
110
111 This is the README file for the U-Boot project.
112
113File names etc. shall be based on the string "u-boot". Examples:
114
115 include/asm-ppc/u-boot.h
116
117 #include <asm/u-boot.h>
118
119Variable names, preprocessor constants etc. shall be either based on
120the string "u_boot" or on "U_BOOT". Example:
121
122 U_BOOT_VERSION u_boot_logo
123 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000124
125
wdenk93f19cc2002-12-17 17:55:09 +0000126Versioning:
127===========
128
Thomas Weber360d8832010-09-28 08:06:25 +0200129Starting with the release in October 2008, the names of the releases
130were changed from numerical release numbers without deeper meaning
131into a time stamp based numbering. Regular releases are identified by
132names consisting of the calendar year and month of the release date.
133Additional fields (if present) indicate release candidates or bug fix
134releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000135
Thomas Weber360d8832010-09-28 08:06:25 +0200136Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000137 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000140
141
wdenkc6097192002-11-03 00:24:07 +0000142Directory Hierarchy:
143====================
144
Peter Tyser8d321b82010-04-12 22:28:21 -0500145/arch Architecture specific files
146 /arm Files generic to ARM architecture
147 /cpu CPU specific files
148 /arm720t Files specific to ARM 720 CPUs
149 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000150 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200151 /imx Files specific to Freescale MC9328 i.MX CPUs
152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500153 /arm925t Files specific to ARM 925 CPUs
154 /arm926ejs Files specific to ARM 926 CPUs
155 /arm1136 Files specific to ARM 1136 CPUs
156 /ixp Files specific to Intel XScale IXP CPUs
157 /pxa Files specific to Intel XScale PXA CPUs
158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs
159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
160 /lib Architecture specific library files
161 /avr32 Files generic to AVR32 architecture
162 /cpu CPU specific files
163 /lib Architecture specific library files
164 /blackfin Files generic to Analog Devices Blackfin architecture
165 /cpu CPU specific files
166 /lib Architecture specific library files
Graeme Russfea25722011-04-13 19:43:28 +1000167 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500168 /cpu CPU specific files
169 /lib Architecture specific library files
170 /m68k Files generic to m68k architecture
171 /cpu CPU specific files
172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
177 /lib Architecture specific library files
178 /microblaze Files generic to microblaze architecture
179 /cpu CPU specific files
180 /lib Architecture specific library files
181 /mips Files generic to MIPS architecture
182 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200183 /mips32 Files specific to MIPS32 CPUs
Xiangfu Liu80421fc2011-10-12 12:24:06 +0800184 /xburst Files specific to Ingenic XBurst CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000186 /nds32 Files generic to NDS32 architecture
187 /cpu CPU specific files
188 /n1213 Files specific to Andes Technology N1213 CPUs
189 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500190 /nios2 Files generic to Altera NIOS2 architecture
191 /cpu CPU specific files
192 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200193 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500194 /cpu CPU specific files
195 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
196 /mpc5xx Files specific to Freescale MPC5xx CPUs
197 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
198 /mpc8xx Files specific to Freescale MPC8xx CPUs
199 /mpc8220 Files specific to Freescale MPC8220 CPUs
200 /mpc824x Files specific to Freescale MPC824x CPUs
201 /mpc8260 Files specific to Freescale MPC8260 CPUs
202 /mpc85xx Files specific to Freescale MPC85xx CPUs
203 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
204 /lib Architecture specific library files
205 /sh Files generic to SH architecture
206 /cpu CPU specific files
207 /sh2 Files specific to sh2 CPUs
208 /sh3 Files specific to sh3 CPUs
209 /sh4 Files specific to sh4 CPUs
210 /lib Architecture specific library files
211 /sparc Files generic to SPARC architecture
212 /cpu CPU specific files
213 /leon2 Files specific to Gaisler LEON2 SPARC CPU
214 /leon3 Files specific to Gaisler LEON3 SPARC CPU
215 /lib Architecture specific library files
216/api Machine/arch independent API for external apps
217/board Board dependent files
218/common Misc architecture independent functions
219/disk Code for disk drive partition handling
220/doc Documentation (don't expect too much)
221/drivers Commonly used device drivers
222/examples Example code for standalone applications, etc.
223/fs Filesystem code (cramfs, ext2, jffs2, etc.)
224/include Header Files
225/lib Files generic to all architectures
226 /libfdt Library files to support flattened device trees
227 /lzma Library files to support LZMA decompression
228 /lzo Library files to support LZO decompression
229/net Networking code
230/post Power On Self Test
231/rtc Real Time Clock drivers
232/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000233
wdenkc6097192002-11-03 00:24:07 +0000234Software Configuration:
235=======================
236
237Configuration is usually done using C preprocessor defines; the
238rationale behind that is to avoid dead code whenever possible.
239
240There are two classes of configuration variables:
241
242* Configuration _OPTIONS_:
243 These are selectable by the user and have names beginning with
244 "CONFIG_".
245
246* Configuration _SETTINGS_:
247 These depend on the hardware etc. and should not be meddled with if
248 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200249 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000250
251Later we will add a configuration tool - probably similar to or even
252identical to what's used for the Linux kernel. Right now, we have to
253do the configuration by hand, which means creating some symbolic
254links and editing some configuration files. We use the TQM8xxL boards
255as an example here.
256
257
258Selection of Processor Architecture and Board Type:
259---------------------------------------------------
260
261For all supported boards there are ready-to-use default
262configurations available; just type "make <board_name>_config".
263
264Example: For a TQM823L module type:
265
266 cd u-boot
267 make TQM823L_config
268
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200269For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000270e.g. "make cogent_mpc8xx_config". And also configure the cogent
271directory according to the instructions in cogent/README.
272
273
274Configuration Options:
275----------------------
276
277Configuration depends on the combination of board and CPU type; all
278such information is kept in a configuration file
279"include/configs/<board_name>.h".
280
281Example: For a TQM823L module, all configuration settings are in
282"include/configs/TQM823L.h".
283
284
wdenk7f6c2cb2002-11-10 22:06:23 +0000285Many of the options are named exactly as the corresponding Linux
286kernel configuration options. The intention is to make it easier to
287build a config tool - later.
288
289
wdenkc6097192002-11-03 00:24:07 +0000290The following options need to be configured:
291
Kim Phillips26281142007-08-10 13:28:25 -0500292- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000293
Kim Phillips26281142007-08-10 13:28:25 -0500294- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200295
296- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100297 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000298
299- CPU Module Type: (if CONFIG_COGENT is defined)
300 Define exactly one of
301 CONFIG_CMA286_60_OLD
302--- FIXME --- not tested yet:
303 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304 CONFIG_CMA287_23, CONFIG_CMA287_50
305
306- Motherboard Type: (if CONFIG_COGENT is defined)
307 Define exactly one of
308 CONFIG_CMA101, CONFIG_CMA102
309
310- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311 Define one or more of
312 CONFIG_CMA302
313
314- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315 Define one or more of
316 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200317 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000318 a "rotator" |\-/|\-/
319
wdenk2535d602003-07-17 23:16:40 +0000320- Board flavour: (if CONFIG_MPC8260ADS is defined)
321 CONFIG_ADSTYPE
322 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200323 CONFIG_SYS_8260ADS - original MPC8260ADS
324 CONFIG_SYS_8266ADS - MPC8266ADS
325 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
326 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000327
Lei Wencf946c62011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
wdenkc6097192002-11-03 00:24:07 +0000333- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000334 Define exactly one of
335 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000336
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200337- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
339 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000340 e.g. if there is no 32KHz
341 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000342 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
343 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000344
wdenk66ca92a2004-09-28 17:59:53 +0000345- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200346 CONFIG_SYS_8xx_CPUCLK_MIN
347 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000348 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000349 See doc/README.MPC866
350
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200351 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000352
wdenkba56f622004-02-06 23:19:44 +0000353 Define this to measure the actual CPU clock instead
354 of relying on the correctness of the configured
355 values. Mostly useful for board bringup to make sure
356 the PLL is locked at the intended frequency. Note
357 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200358 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000359
Heiko Schocher506f3912009-03-12 07:37:15 +0100360 CONFIG_SYS_DELAYED_ICACHE
361
362 Define this option if you want to enable the
363 ICache only when Code runs from RAM.
364
Kumar Gala66412c62011-02-18 05:40:54 -0600365- 85xx CPU Options:
366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala8f290842011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000377 CONFIG_SYS_PPC_E500_DEBUG_TLB
378
379 Enables a temporary TLB entry to be used during boot to work
380 around limitations in e500v1 and e500v2 external debugger
381 support. This reduces the portions of the boot code where
382 breakpoints and single stepping do not work. The value of this
383 symbol should be set to the TLB1 entry to be used for this
384 purpose.
385
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000386- Generic CPU options:
387 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
388
389 Defines the endianess of the CPU. Implementation of those
390 values is arch specific.
391
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100392- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200393 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100394
395 Defines the Monahans run mode to oscillator
396 ratio. Valid values are 8, 16, 24, 31. The core
397 frequency is this value multiplied by 13 MHz.
398
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200399 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200400
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100401 Defines the Monahans turbo mode to oscillator
402 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200403 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100404 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200405
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200406- MIPS CPU options:
407 CONFIG_SYS_INIT_SP_OFFSET
408
409 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
410 pointer. This is needed for the temporary stack before
411 relocation.
412
413 CONFIG_SYS_MIPS_CACHE_MODE
414
415 Cache operation mode for the MIPS CPU.
416 See also arch/mips/include/asm/mipsregs.h.
417 Possible values are:
418 CONF_CM_CACHABLE_NO_WA
419 CONF_CM_CACHABLE_WA
420 CONF_CM_UNCACHED
421 CONF_CM_CACHABLE_NONCOHERENT
422 CONF_CM_CACHABLE_CE
423 CONF_CM_CACHABLE_COW
424 CONF_CM_CACHABLE_CUW
425 CONF_CM_CACHABLE_ACCELERATED
426
427 CONFIG_SYS_XWAY_EBU_BOOTCFG
428
429 Special option for Lantiq XWAY SoCs for booting from NOR flash.
430 See also arch/mips/cpu/mips32/start.S.
431
432 CONFIG_XWAY_SWAP_BYTES
433
434 Enable compilation of tools/xway-swap-bytes needed for Lantiq
435 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
436 be swapped if a flash programmer is used.
437
Christian Rieschb67d8812012-02-02 00:44:39 +0000438- ARM options:
439 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
440
441 Select high exception vectors of the ARM core, e.g., do not
442 clear the V bit of the c1 register of CP15.
443
Aneesh V5356f542012-03-08 07:20:19 +0000444 CONFIG_SYS_THUMB_BUILD
445
446 Use this flag to build U-Boot using the Thumb instruction
447 set for ARM architectures. Thumb instruction set provides
448 better code density. For ARM architectures that support
449 Thumb2 this flag will result in Thumb2 code generated by
450 GCC.
451
wdenk5da627a2003-10-09 20:09:04 +0000452- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000453 CONFIG_CLOCKS_IN_MHZ
454
455 U-Boot stores all clock information in Hz
456 internally. For binary compatibility with older Linux
457 kernels (which expect the clocks passed in the
458 bd_info data to be in MHz) the environment variable
459 "clocks_in_mhz" can be defined so that U-Boot
460 converts clock data to MHZ before passing it to the
461 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000462 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100463 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000464 default environment.
465
wdenk5da627a2003-10-09 20:09:04 +0000466 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
467
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200468 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000469 expect it to be in bytes, others in MB.
470 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
471
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400472 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200473
474 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400475 passed using flattened device trees (based on open firmware
476 concepts).
477
478 CONFIG_OF_LIBFDT
479 * New libfdt-based support
480 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500481 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400482
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200483 OF_CPU - The proper name of the cpus node (only required for
484 MPC512X and MPC5xxx based boards).
485 OF_SOC - The proper name of the soc node (only required for
486 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200487 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600488 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200489
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200490 boards with QUICC Engines require OF_QE to set UCC MAC
491 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500492
Kumar Gala4e253132006-01-11 13:54:17 -0600493 CONFIG_OF_BOARD_SETUP
494
495 Board code has addition modification that it wants to make
496 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000497
Matthew McClintock02677682006-06-28 10:41:37 -0500498 CONFIG_OF_BOOT_CPU
499
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200500 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500501 param header, the default value is zero if undefined.
502
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200503 CONFIG_OF_IDE_FIXUP
504
505 U-Boot can detect if an IDE device is present or not.
506 If not, and this new config option is activated, U-Boot
507 removes the ATA node from the DTS before booting Linux,
508 so the Linux IDE driver does not probe the device and
509 crash. This is needed for buggy hardware (uc101) where
510 no pull down resistor is connected to the signal IDE5V_DD7.
511
Igor Grinberg7eb29392011-07-14 05:45:07 +0000512 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
513
514 This setting is mandatory for all boards that have only one
515 machine type and must be used to specify the machine type
516 number as it appears in the ARM machine registry
517 (see http://www.arm.linux.org.uk/developer/machines/).
518 Only boards that have multiple machine types supported
519 in a single configuration file and the machine type is
520 runtime discoverable, do not have to use this setting.
521
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100522- vxWorks boot parameters:
523
524 bootvx constructs a valid bootline using the following
525 environments variables: bootfile, ipaddr, serverip, hostname.
526 It loads the vxWorks image pointed bootfile.
527
528 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
529 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
530 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
531 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
532
533 CONFIG_SYS_VXWORKS_ADD_PARAMS
534
535 Add it at the end of the bootline. E.g "u=username pw=secret"
536
537 Note: If a "bootargs" environment is defined, it will overwride
538 the defaults discussed just above.
539
Aneesh V2c451f72011-06-16 23:30:47 +0000540- Cache Configuration:
541 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
542 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
543 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
544
Aneesh V93bc2192011-06-16 23:30:51 +0000545- Cache Configuration for ARM:
546 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
547 controller
548 CONFIG_SYS_PL310_BASE - Physical base address of PL310
549 controller register space
550
wdenk6705d812004-08-02 23:22:59 +0000551- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200552 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000553
554 Define this if you want support for Amba PrimeCell PL010 UARTs.
555
Andreas Engel48d01922008-09-08 14:30:53 +0200556 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000557
558 Define this if you want support for Amba PrimeCell PL011 UARTs.
559
560 CONFIG_PL011_CLOCK
561
562 If you have Amba PrimeCell PL011 UARTs, set this variable to
563 the clock speed of the UARTs.
564
565 CONFIG_PL01x_PORTS
566
567 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
568 define this to a list of base addresses for each (supported)
569 port. See e.g. include/configs/versatile.h
570
John Rigby910f1ae2011-04-19 10:42:39 +0000571 CONFIG_PL011_SERIAL_RLCR
572
573 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
574 have separate receive and transmit line control registers. Set
575 this variable to initialize the extra register.
576
577 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
578
579 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
580 boot loader that has already initialized the UART. Define this
581 variable to flush the UART at init time.
582
wdenk6705d812004-08-02 23:22:59 +0000583
wdenkc6097192002-11-03 00:24:07 +0000584- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000585 Depending on board, define exactly one serial port
586 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
587 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
588 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000589
590 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
591 port routines must be defined elsewhere
592 (i.e. serial_init(), serial_getc(), ...)
593
594 CONFIG_CFB_CONSOLE
595 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000596 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000597 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
598 (default big endian)
599 VIDEO_HW_RECTFILL graphic chip supports
600 rectangle fill
601 (cf. smiLynxEM)
602 VIDEO_HW_BITBLT graphic chip supports
603 bit-blit (cf. smiLynxEM)
604 VIDEO_VISIBLE_COLS visible pixel columns
605 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000606 VIDEO_VISIBLE_ROWS visible pixel rows
607 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000608 VIDEO_DATA_FORMAT graphic data format
609 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000610 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000611 VIDEO_KBD_INIT_FCT keyboard int fct
612 (i.e. i8042_kbd_init())
613 VIDEO_TSTC_FCT test char fct
614 (i.e. i8042_tstc)
615 VIDEO_GETC_FCT get char fct
616 (i.e. i8042_getc)
617 CONFIG_CONSOLE_CURSOR cursor drawing on/off
618 (requires blink timer
619 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200620 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000621 CONFIG_CONSOLE_TIME display time/date info in
622 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500623 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000624 CONFIG_VIDEO_LOGO display Linux logo in
625 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000626 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
627 linux_logo.h for logo.
628 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000629 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200630 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000631 the logo
632
wdenk43d96162003-03-06 00:02:04 +0000633 When CONFIG_CFB_CONSOLE is defined, video console is
634 default i/o. Serial console can be forced with
635 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000636
wdenkd4ca31c2004-01-02 14:00:00 +0000637 When CONFIG_SILENT_CONSOLE is defined, all console
638 messages (by U-Boot and Linux!) can be silenced with
639 the "silent" environment variable. See
640 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000641
wdenkc6097192002-11-03 00:24:07 +0000642- Console Baudrate:
643 CONFIG_BAUDRATE - in bps
644 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200645 CONFIG_SYS_BAUDRATE_TABLE, see below.
646 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000647
Heiko Schocherc92fac92009-01-30 12:55:38 +0100648- Console Rx buffer length
649 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
650 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100651 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100652 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
653 must be defined, to setup the maximum idle timeout for
654 the SMC.
655
Graeme Russ9558b482011-09-01 00:48:27 +0000656- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200657 Prior to the console being initialised (i.e. serial UART
658 initialised etc) all console output is silently discarded.
659 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
660 buffer any console messages prior to the console being
661 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
662 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
663 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200664 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200665 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000666
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200667 'Sane' compilers will generate smaller code if
668 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000669
Sonny Rao046a37b2011-11-02 09:52:08 +0000670- Safe printf() functions
671 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
672 the printf() functions. These are defined in
673 include/vsprintf.h and include snprintf(), vsnprintf() and
674 so on. Code size increase is approximately 300-500 bytes.
675 If this option is not given then these functions will
676 silently discard their buffer size argument - this means
677 you are not getting any overflow checking in this case.
678
wdenkc6097192002-11-03 00:24:07 +0000679- Boot Delay: CONFIG_BOOTDELAY - in seconds
680 Delay before automatically booting the default image;
681 set to -1 to disable autoboot.
682
683 See doc/README.autoboot for these options that
684 work with CONFIG_BOOTDELAY. None are required.
685 CONFIG_BOOT_RETRY_TIME
686 CONFIG_BOOT_RETRY_MIN
687 CONFIG_AUTOBOOT_KEYED
688 CONFIG_AUTOBOOT_PROMPT
689 CONFIG_AUTOBOOT_DELAY_STR
690 CONFIG_AUTOBOOT_STOP_STR
691 CONFIG_AUTOBOOT_DELAY_STR2
692 CONFIG_AUTOBOOT_STOP_STR2
693 CONFIG_ZERO_BOOTDELAY_CHECK
694 CONFIG_RESET_TO_RETRY
695
696- Autoboot Command:
697 CONFIG_BOOTCOMMAND
698 Only needed when CONFIG_BOOTDELAY is enabled;
699 define a command string that is automatically executed
700 when no character is read on the console interface
701 within "Boot Delay" after reset.
702
703 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000704 This can be used to pass arguments to the bootm
705 command. The value of CONFIG_BOOTARGS goes into the
706 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000707
708 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000709 The value of these goes into the environment as
710 "ramboot" and "nfsboot" respectively, and can be used
711 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200712 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000713
714- Pre-Boot Commands:
715 CONFIG_PREBOOT
716
717 When this option is #defined, the existence of the
718 environment variable "preboot" will be checked
719 immediately before starting the CONFIG_BOOTDELAY
720 countdown and/or running the auto-boot command resp.
721 entering interactive mode.
722
723 This feature is especially useful when "preboot" is
724 automatically generated or modified. For an example
725 see the LWMON board specific code: here "preboot" is
726 modified when the user holds down a certain
727 combination of keys on the (special) keyboard when
728 booting the systems
729
730- Serial Download Echo Mode:
731 CONFIG_LOADS_ECHO
732 If defined to 1, all characters received during a
733 serial download (using the "loads" command) are
734 echoed back. This might be needed by some terminal
735 emulations (like "cu"), but may as well just take
736 time on others. This setting #define's the initial
737 value of the "loads_echo" environment variable.
738
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500739- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000740 CONFIG_KGDB_BAUDRATE
741 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200742 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000743
744- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500745 Monitor commands can be included or excluded
746 from the build by using the #include files
747 "config_cmd_all.h" and #undef'ing unwanted
748 commands, or using "config_cmd_default.h"
749 and augmenting with additional #define's
750 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000751
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500752 The default command configuration includes all commands
753 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000754
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500755 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500756 CONFIG_CMD_BDI bdinfo
757 CONFIG_CMD_BEDBUG * Include BedBug Debugger
758 CONFIG_CMD_BMP * BMP support
759 CONFIG_CMD_BSP * Board specific commands
760 CONFIG_CMD_BOOTD bootd
761 CONFIG_CMD_CACHE * icache, dcache
762 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500763 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500764 CONFIG_CMD_DATE * support for RTC, date/time...
765 CONFIG_CMD_DHCP * DHCP support
766 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600767 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
768 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
769 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
770 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500771 CONFIG_CMD_DTT * Digital Therm and Thermostat
772 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500773 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500774 CONFIG_CMD_EEPROM * EEPROM read/write support
775 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500776 CONFIG_CMD_EXPORTENV * export the environment
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500777 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500778 CONFIG_CMD_FDC * Floppy Disk Support
779 CONFIG_CMD_FAT * FAT partition support
780 CONFIG_CMD_FDOS * Dos diskette Support
781 CONFIG_CMD_FLASH flinfo, erase, protect
782 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysingera641b972010-12-26 23:32:22 -0500783 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000784 CONFIG_CMD_GREPENV * search environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500785 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
786 CONFIG_CMD_I2C * I2C serial bus support
787 CONFIG_CMD_IDE * IDE harddisk support
788 CONFIG_CMD_IMI iminfo
789 CONFIG_CMD_IMLS List all found images
790 CONFIG_CMD_IMMAP * IMMR dump support
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500791 CONFIG_CMD_IMPORTENV * import an environment
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500792 CONFIG_CMD_IRQ * irqinfo
793 CONFIG_CMD_ITEST Integer/string test of 2 values
794 CONFIG_CMD_JFFS2 * JFFS2 Support
795 CONFIG_CMD_KGDB * kgdb
Mike Frysinger1ba7fd22010-12-26 12:34:49 -0500796 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +0000797 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
798 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500799 CONFIG_CMD_LOADB loadb
800 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400801 CONFIG_CMD_MD5SUM print md5 message digest
802 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500803 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
804 loop, loopw, mtest
805 CONFIG_CMD_MISC Misc functions like sleep etc
806 CONFIG_CMD_MMC * MMC memory mapped support
807 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100808 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500809 CONFIG_CMD_NAND * NAND support
810 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600811 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000812 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500813 CONFIG_CMD_PCI * pciinfo
814 CONFIG_CMD_PCMCIA * PCMCIA support
815 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
816 host
817 CONFIG_CMD_PORTIO * Port I/O
818 CONFIG_CMD_REGINFO * Register dump
819 CONFIG_CMD_RUN run command in env variable
820 CONFIG_CMD_SAVES * save S record dump
821 CONFIG_CMD_SCSI * SCSI Support
822 CONFIG_CMD_SDRAM * print SDRAM configuration information
823 (requires CONFIG_CMD_I2C)
824 CONFIG_CMD_SETGETDCR Support for DCR Register access
825 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -0700826 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Alexander Hollerc6b1ee62011-01-18 09:48:08 +0100827 CONFIG_CMD_SHA1SUM print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -0400828 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200829 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500830 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +0000831 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +0000832 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Che-liang Chiouca366d02011-10-06 23:40:48 +0000833 CONFIG_CMD_TIME * run command and report execution time
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500834 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500835 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +0000836 CONFIG_CMD_MFSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000837
wdenkc6097192002-11-03 00:24:07 +0000838
839 EXAMPLE: If you want all functions except of network
840 support you can write:
841
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500842 #include "config_cmd_all.h"
843 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000844
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400845 Other Commands:
846 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000847
848 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500849 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000850 what you (and your U-Boot users) are doing. Data
851 cache cannot be enabled on systems like the 8xx or
852 8260 (where accesses to the IMMR region must be
853 uncached), and it cannot be disabled on all other
854 systems where we (mis-) use the data cache to hold an
855 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000856
857
858 XXX - this list needs to get updated!
859
Simon Glass45ba8072011-10-15 05:48:20 +0000860- Device tree:
861 CONFIG_OF_CONTROL
862 If this variable is defined, U-Boot will use a device tree
863 to configure its devices, instead of relying on statically
864 compiled #defines in the board file. This option is
865 experimental and only available on a few boards. The device
866 tree is available in the global data as gd->fdt_blob.
867
Simon Glass2c0f79e2011-10-24 19:15:31 +0000868 U-Boot needs to get its device tree from somewhere. This can
869 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000870
871 CONFIG_OF_EMBED
872 If this variable is defined, U-Boot will embed a device tree
873 binary in its image. This device tree file should be in the
874 board directory and called <soc>-<board>.dts. The binary file
875 is then picked up in board_init_f() and made available through
876 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000877
Simon Glass2c0f79e2011-10-24 19:15:31 +0000878 CONFIG_OF_SEPARATE
879 If this variable is defined, U-Boot will build a device tree
880 binary. It will be called u-boot.dtb. Architecture-specific
881 code will locate it at run-time. Generally this works by:
882
883 cat u-boot.bin u-boot.dtb >image.bin
884
885 and in fact, U-Boot does this for you, creating a file called
886 u-boot-dtb.bin which is useful in the common case. You can
887 still use the individual files if you need something more
888 exotic.
889
wdenkc6097192002-11-03 00:24:07 +0000890- Watchdog:
891 CONFIG_WATCHDOG
892 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000893 support for the SoC. There must be support in the SoC
894 specific code for a watchdog. For the 8xx and 8260
895 CPUs, the SIU Watchdog feature is enabled in the SYPCR
896 register. When supported for a specific SoC is
897 available, then no further board specific code should
898 be needed to use it.
899
900 CONFIG_HW_WATCHDOG
901 When using a watchdog circuitry external to the used
902 SoC, then define this variable and provide board
903 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000904
stroesec1551ea2003-04-04 15:53:41 +0000905- U-Boot Version:
906 CONFIG_VERSION_VARIABLE
907 If this variable is defined, an environment variable
908 named "ver" is created by U-Boot showing the U-Boot
909 version as printed by the "version" command.
910 This variable is readonly.
911
wdenkc6097192002-11-03 00:24:07 +0000912- Real-Time Clock:
913
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500914 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000915 has to be selected, too. Define exactly one of the
916 following options:
917
918 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
919 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000920 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000921 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000922 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000923 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000924 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000925 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100926 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000927 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200928 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200929 CONFIG_SYS_RV3029_TCR - enable trickle charger on
930 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000931
wdenkb37c7e52003-06-30 16:24:52 +0000932 Note that if the RTC uses I2C, then the I2C interface
933 must also be configured. See I2C Support, below.
934
Peter Tysere92739d2008-12-17 16:36:21 -0600935- GPIO Support:
936 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
937 CONFIG_PCA953X_INFO - enable pca953x info command
938
Chris Packham5dec49c2010-12-19 10:12:13 +0000939 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
940 chip-ngpio pairs that tell the PCA953X driver the number of
941 pins supported by a particular chip.
942
Peter Tysere92739d2008-12-17 16:36:21 -0600943 Note that if the GPIO device uses I2C, then the I2C interface
944 must also be configured. See I2C Support, below.
945
wdenkc6097192002-11-03 00:24:07 +0000946- Timestamp Support:
947
wdenk43d96162003-03-06 00:02:04 +0000948 When CONFIG_TIMESTAMP is selected, the timestamp
949 (date and time) of an image is printed by image
950 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500951 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000952
953- Partition Support:
954 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400955 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000956
Wolfgang Denk218ca722008-03-26 10:40:12 +0100957 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
958 CONFIG_CMD_SCSI) you must configure support for at
959 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000960
961- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000962 CONFIG_IDE_RESET_ROUTINE - this is defined in several
963 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000964
wdenk4d13cba2004-03-14 14:09:05 +0000965 CONFIG_IDE_RESET - is this is defined, IDE Reset will
966 be performed by calling the function
967 ide_set_reset(int reset)
968 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000969
970- ATAPI Support:
971 CONFIG_ATAPI
972
973 Set this to enable ATAPI support.
974
wdenkc40b2952004-03-13 23:29:43 +0000975- LBA48 Support
976 CONFIG_LBA48
977
978 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100979 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000980 Whithout these , LBA48 support uses 32bit variables and will 'only'
981 support disks up to 2.1TB.
982
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200983 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000984 When enabled, makes the IDE subsystem use 64bit sector addresses.
985 Default is 32bit.
986
wdenkc6097192002-11-03 00:24:07 +0000987- SCSI Support:
988 At the moment only there is only support for the
989 SYM53C8XX SCSI controller; define
990 CONFIG_SCSI_SYM53C8XX to enable it.
991
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200992 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
993 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
994 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000995 maximum numbers of LUNs, SCSI ID's and target
996 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200997 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000998
999- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001000 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001001 Support for Intel 8254x/8257x gigabit chips.
1002
1003 CONFIG_E1000_SPI
1004 Utility code for direct access to the SPI bus on Intel 8257x.
1005 This does not do anything useful unless you set at least one
1006 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1007
1008 CONFIG_E1000_SPI_GENERIC
1009 Allow generic access to the SPI bus on the Intel 8257x, for
1010 example with the "sspi" command.
1011
1012 CONFIG_CMD_E1000
1013 Management command for E1000 devices. When used on devices
1014 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001015
Andre Schwarzac3315c2008-03-06 16:45:44 +01001016 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001017 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001018
wdenkc6097192002-11-03 00:24:07 +00001019 CONFIG_EEPRO100
1020 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001021 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001022 write routine for first time initialisation.
1023
1024 CONFIG_TULIP
1025 Support for Digital 2114x chips.
1026 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1027 modem chip initialisation (KS8761/QS6611).
1028
1029 CONFIG_NATSEMI
1030 Support for National dp83815 chips.
1031
1032 CONFIG_NS8382X
1033 Support for National dp8382[01] gigabit chips.
1034
wdenk45219c42003-05-12 21:50:16 +00001035- NETWORK Support (other):
1036
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001037 CONFIG_DRIVER_AT91EMAC
1038 Support for AT91RM9200 EMAC.
1039
1040 CONFIG_RMII
1041 Define this to use reduced MII inteface
1042
1043 CONFIG_DRIVER_AT91EMAC_QUIET
1044 If this defined, the driver is quiet.
1045 The driver doen't show link status messages.
1046
Rob Herringefdd7312011-12-15 11:15:49 +00001047 CONFIG_CALXEDA_XGMAC
1048 Support for the Calxeda XGMAC device
1049
wdenk45219c42003-05-12 21:50:16 +00001050 CONFIG_DRIVER_LAN91C96
1051 Support for SMSC's LAN91C96 chips.
1052
1053 CONFIG_LAN91C96_BASE
1054 Define this to hold the physical address
1055 of the LAN91C96's I/O space
1056
1057 CONFIG_LAN91C96_USE_32_BIT
1058 Define this to enable 32 bit addressing
1059
wdenkf39748a2004-06-09 13:37:52 +00001060 CONFIG_DRIVER_SMC91111
1061 Support for SMSC's LAN91C111 chip
1062
1063 CONFIG_SMC91111_BASE
1064 Define this to hold the physical address
1065 of the device (I/O space)
1066
1067 CONFIG_SMC_USE_32_BIT
1068 Define this if data bus is 32 bits
1069
1070 CONFIG_SMC_USE_IOFUNCS
1071 Define this to use i/o functions instead of macros
1072 (some hardware wont work with macros)
1073
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001074 CONFIG_DRIVER_TI_EMAC
1075 Support for davinci emac
1076
1077 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1078 Define this if you have more then 3 PHYs.
1079
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001080 CONFIG_FTGMAC100
1081 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1082
1083 CONFIG_FTGMAC100_EGIGA
1084 Define this to use GE link update with gigabit PHY.
1085 Define this if FTGMAC100 is connected to gigabit PHY.
1086 If your system has 10/100 PHY only, it might not occur
1087 wrong behavior. Because PHY usually return timeout or
1088 useless data when polling gigabit status and gigabit
1089 control registers. This behavior won't affect the
1090 correctnessof 10/100 link speed update.
1091
Mike Rapoportc2fff332009-11-11 10:03:03 +02001092 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001093 Support for SMSC's LAN911x and LAN921x chips
1094
Mike Rapoportc2fff332009-11-11 10:03:03 +02001095 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001096 Define this to hold the physical address
1097 of the device (I/O space)
1098
Mike Rapoportc2fff332009-11-11 10:03:03 +02001099 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001100 Define this if data bus is 32 bits
1101
Mike Rapoportc2fff332009-11-11 10:03:03 +02001102 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001103 Define this if data bus is 16 bits. If your processor
1104 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001105 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001106
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001107 CONFIG_SH_ETHER
1108 Support for Renesas on-chip Ethernet controller
1109
1110 CONFIG_SH_ETHER_USE_PORT
1111 Define the number of ports to be used
1112
1113 CONFIG_SH_ETHER_PHY_ADDR
1114 Define the ETH PHY's address
1115
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001116 CONFIG_SH_ETHER_CACHE_WRITEBACK
1117 If this option is set, the driver enables cache flush.
1118
Vadim Bendebury5e124722011-10-17 08:36:14 +00001119- TPM Support:
1120 CONFIG_GENERIC_LPC_TPM
1121 Support for generic parallel port TPM devices. Only one device
1122 per system is supported at this time.
1123
1124 CONFIG_TPM_TIS_BASE_ADDRESS
1125 Base address where the generic TPM device is mapped
1126 to. Contemporary x86 systems usually map it at
1127 0xfed40000.
1128
wdenkc6097192002-11-03 00:24:07 +00001129- USB Support:
1130 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001131 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001132 CONFIG_USB_UHCI to enable it.
1133 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001134 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001135 storage devices.
1136 Note:
1137 Supported are USB Keyboards and USB Floppy drives
1138 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001139 MPC5200 USB requires additional defines:
1140 CONFIG_USB_CLOCK
1141 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001142 CONFIG_PSC3_USB
1143 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001144 CONFIG_USB_CONFIG
1145 for differential drivers: 0x00001000
1146 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001147 for differential drivers on PSC3: 0x00000100
1148 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001149 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001150 May be defined to allow interrupt polling
1151 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001152
Simon Glass9ab4ce22012-02-27 10:52:47 +00001153 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1154 txfilltuning field in the EHCI controller on reset.
1155
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001156- USB Device:
1157 Define the below if you wish to use the USB console.
1158 Once firmware is rebuilt from a serial console issue the
1159 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001160 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001161 it has found a new device. The environment variable usbtty
1162 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001163 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001164 Common Device Class Abstract Control Model serial device.
1165 If you select usbtty = gserial you should be able to enumerate
1166 a Linux host by
1167 # modprobe usbserial vendor=0xVendorID product=0xProductID
1168 else if using cdc_acm, simply setting the environment
1169 variable usbtty to be cdc_acm should suffice. The following
1170 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001171
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001172 CONFIG_USB_DEVICE
1173 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001174
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001175 CONFIG_USB_TTY
1176 Define this to have a tty type of device available to
1177 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001178
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301179 CONFIG_USBD_HS
1180 Define this to enable the high speed support for usb
1181 device and usbtty. If this feature is enabled, a routine
1182 int is_usbd_high_speed(void)
1183 also needs to be defined by the driver to dynamically poll
1184 whether the enumeration has succeded at high speed or full
1185 speed.
1186
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001187 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001188 Define this if you want stdin, stdout &/or stderr to
1189 be set to usbtty.
1190
1191 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001192 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001193 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001194 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001195
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001196 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001197 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001198 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001199
Wolfgang Denk386eda02006-06-14 18:14:56 +02001200 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001201 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001202 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001203 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1204 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1205 should pretend to be a Linux device to it's target host.
1206
1207 CONFIG_USBD_MANUFACTURER
1208 Define this string as the name of your company for
1209 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001210
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001211 CONFIG_USBD_PRODUCT_NAME
1212 Define this string as the name of your product
1213 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1214
1215 CONFIG_USBD_VENDORID
1216 Define this as your assigned Vendor ID from the USB
1217 Implementors Forum. This *must* be a genuine Vendor ID
1218 to avoid polluting the USB namespace.
1219 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001220
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001221 CONFIG_USBD_PRODUCTID
1222 Define this as the unique Product ID
1223 for your device
1224 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001225
Igor Grinbergd70a5602011-12-12 12:08:35 +02001226- ULPI Layer Support:
1227 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1228 the generic ULPI layer. The generic layer accesses the ULPI PHY
1229 via the platform viewport, so you need both the genric layer and
1230 the viewport enabled. Currently only Chipidea/ARC based
1231 viewport is supported.
1232 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1233 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
wdenkc6097192002-11-03 00:24:07 +00001234
1235- MMC Support:
1236 The MMC controller on the Intel PXA is supported. To
1237 enable this define CONFIG_MMC. The MMC can be
1238 accessed from the boot prompt by mapping the device
1239 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001240 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1241 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001242
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001243 CONFIG_SH_MMCIF
1244 Support for Renesas on-chip MMCIF controller
1245
1246 CONFIG_SH_MMCIF_ADDR
1247 Define the base address of MMCIF registers
1248
1249 CONFIG_SH_MMCIF_CLK
1250 Define the clock frequency for MMCIF
1251
wdenk6705d812004-08-02 23:22:59 +00001252- Journaling Flash filesystem support:
1253 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1254 CONFIG_JFFS2_NAND_DEV
1255 Define these for a default partition on a NAND device
1256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001257 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1258 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001259 Define these for a default partition on a NOR device
1260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001261 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001262 Define this to create an own partition. You have to provide a
1263 function struct part_info* jffs2_part_info(int part_num)
1264
1265 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001266 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001267 to disable the command chpart. This is the default when you
1268 have not defined a custom partition
1269
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001270- FAT(File Allocation Table) filesystem write function support:
1271 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001272
1273 Define this to enable support for saving memory data as a
1274 file in FAT formatted partition.
1275
1276 This will also enable the command "fatwrite" enabling the
1277 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001278
wdenkc6097192002-11-03 00:24:07 +00001279- Keyboard Support:
1280 CONFIG_ISA_KEYBOARD
1281
1282 Define this to enable standard (PC-Style) keyboard
1283 support
1284
1285 CONFIG_I8042_KBD
1286 Standard PC keyboard driver with US (is default) and
1287 GERMAN key layout (switch via environment 'keymap=de') support.
1288 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1289 for cfb_console. Supports cursor blinking.
1290
1291- Video support:
1292 CONFIG_VIDEO
1293
1294 Define this to enable video support (for output to
1295 video).
1296
1297 CONFIG_VIDEO_CT69000
1298
1299 Enable Chips & Technologies 69000 Video chip
1300
1301 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001302 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001303 video output is selected via environment 'videoout'
1304 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1305 assumed.
wdenkc6097192002-11-03 00:24:07 +00001306
wdenkb79a11c2004-03-25 15:14:43 +00001307 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001308 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001309 are possible:
1310 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001311 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001312
1313 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1314 -------------+---------------------------------------------
1315 8 bits | 0x301* 0x303 0x305 0x161 0x307
1316 15 bits | 0x310 0x313 0x316 0x162 0x319
1317 16 bits | 0x311 0x314 0x317 0x163 0x31A
1318 24 bits | 0x312 0x315 0x318 ? 0x31B
1319 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001320 (i.e. setenv videomode 317; saveenv; reset;)
1321
wdenkb79a11c2004-03-25 15:14:43 +00001322 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001323 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001324
1325
stroesec1551ea2003-04-04 15:53:41 +00001326 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001327 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001328 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1329 or CONFIG_VIDEO_SED13806_16BPP
1330
Timur Tabi7d3053f2011-02-15 17:09:19 -06001331 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001332 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001333 SOCs that have a DIU should define this macro to enable DIU
1334 support, and should also define these other macros:
1335
1336 CONFIG_SYS_DIU_ADDR
1337 CONFIG_VIDEO
1338 CONFIG_CMD_BMP
1339 CONFIG_CFB_CONSOLE
1340 CONFIG_VIDEO_SW_CURSOR
1341 CONFIG_VGA_AS_SINGLE_DEVICE
1342 CONFIG_VIDEO_LOGO
1343 CONFIG_VIDEO_BMP_LOGO
1344
Timur Tabiba8e76b2011-04-11 14:18:22 -05001345 The DIU driver will look for the 'video-mode' environment
1346 variable, and if defined, enable the DIU as a console during
1347 boot. See the documentation file README.video for a
1348 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001349
wdenk682011f2003-06-03 23:54:09 +00001350- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001351 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001352
wdenk8bde7f72003-06-27 21:31:46 +00001353 Define this to enable a custom keyboard support.
1354 This simply calls drv_keyboard_init() which must be
1355 defined in your board-specific files.
1356 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001357
wdenkc6097192002-11-03 00:24:07 +00001358- LCD Support: CONFIG_LCD
1359
1360 Define this to enable LCD support (for output to LCD
1361 display); also select one of the supported displays
1362 by defining one of these:
1363
Stelian Pop39cf4802008-05-09 21:57:18 +02001364 CONFIG_ATMEL_LCD:
1365
1366 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1367
wdenkfd3103b2003-11-25 16:55:19 +00001368 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001369
wdenkfd3103b2003-11-25 16:55:19 +00001370 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001371
wdenkfd3103b2003-11-25 16:55:19 +00001372 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001373
wdenkfd3103b2003-11-25 16:55:19 +00001374 NEC NL6448BC20-08. 6.5", 640x480.
1375 Active, color, single scan.
1376
1377 CONFIG_NEC_NL6448BC33_54
1378
1379 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001380 Active, color, single scan.
1381
1382 CONFIG_SHARP_16x9
1383
1384 Sharp 320x240. Active, color, single scan.
1385 It isn't 16x9, and I am not sure what it is.
1386
1387 CONFIG_SHARP_LQ64D341
1388
1389 Sharp LQ64D341 display, 640x480.
1390 Active, color, single scan.
1391
1392 CONFIG_HLD1045
1393
1394 HLD1045 display, 640x480.
1395 Active, color, single scan.
1396
1397 CONFIG_OPTREX_BW
1398
1399 Optrex CBL50840-2 NF-FW 99 22 M5
1400 or
1401 Hitachi LMG6912RPFC-00T
1402 or
1403 Hitachi SP14Q002
1404
1405 320x240. Black & white.
1406
1407 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001408 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001409
wdenk7152b1d2003-09-05 23:19:14 +00001410- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001411
wdenk8bde7f72003-06-27 21:31:46 +00001412 If this option is set, the environment is checked for
1413 a variable "splashimage". If found, the usual display
1414 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001415 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001416 specified in "splashimage" is loaded instead. The
1417 console is redirected to the "nulldev", too. This
1418 allows for a "silent" boot where a splash screen is
1419 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001420
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001421 CONFIG_SPLASH_SCREEN_ALIGN
1422
1423 If this option is set the splash image can be freely positioned
1424 on the screen. Environment variable "splashpos" specifies the
1425 position as "x,y". If a positive number is given it is used as
1426 number of pixel from left/top. If a negative number is given it
1427 is used as number of pixel from right/bottom. You can also
1428 specify 'm' for centering the image.
1429
1430 Example:
1431 setenv splashpos m,m
1432 => image at center of screen
1433
1434 setenv splashpos 30,20
1435 => image at x = 30 and y = 20
1436
1437 setenv splashpos -10,m
1438 => vertically centered image
1439 at x = dspWidth - bmpWidth - 9
1440
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001441- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1442
1443 If this option is set, additionally to standard BMP
1444 images, gzipped BMP images can be displayed via the
1445 splashscreen support or the bmp command.
1446
Anatolij Gustschind5011762010-03-15 14:50:25 +01001447- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1448
1449 If this option is set, 8-bit RLE compressed BMP images
1450 can be displayed via the splashscreen support or the
1451 bmp command.
1452
wdenkc29fdfc2003-08-29 20:57:53 +00001453- Compression support:
1454 CONFIG_BZIP2
1455
1456 If this option is set, support for bzip2 compressed
1457 images is included. If not, only uncompressed and gzip
1458 compressed images are supported.
1459
wdenk42d1f032003-10-15 23:53:47 +00001460 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001461 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001462 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001463
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001464 CONFIG_LZMA
1465
1466 If this option is set, support for lzma compressed
1467 images is included.
1468
1469 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1470 requires an amount of dynamic memory that is given by the
1471 formula:
1472
1473 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1474
1475 Where lc and lp stand for, respectively, Literal context bits
1476 and Literal pos bits.
1477
1478 This value is upper-bounded by 14MB in the worst case. Anyway,
1479 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1480 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1481 a very small buffer.
1482
1483 Use the lzmainfo tool to determinate the lc and lp values and
1484 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001485 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001486
wdenk17ea1172004-06-06 21:51:03 +00001487- MII/PHY support:
1488 CONFIG_PHY_ADDR
1489
1490 The address of PHY on MII bus.
1491
1492 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1493
1494 The clock frequency of the MII bus
1495
1496 CONFIG_PHY_GIGE
1497
1498 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001499 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001500
1501 CONFIG_PHY_RESET_DELAY
1502
1503 Some PHY like Intel LXT971A need extra delay after
1504 reset before any MII register access is possible.
1505 For such PHY, set this option to the usec delay
1506 required. (minimum 300usec for LXT971A)
1507
1508 CONFIG_PHY_CMD_DELAY (ppc4xx)
1509
1510 Some PHY like Intel LXT971A need extra delay after
1511 command issued before MII status register can be read
1512
wdenkc6097192002-11-03 00:24:07 +00001513- Ethernet address:
1514 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001515 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001516 CONFIG_ETH2ADDR
1517 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001518 CONFIG_ETH4ADDR
1519 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001520
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001521 Define a default value for Ethernet address to use
1522 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001523 is not determined automatically.
1524
1525- IP address:
1526 CONFIG_IPADDR
1527
1528 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001529 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001530 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001531 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001532
1533- Server IP address:
1534 CONFIG_SERVERIP
1535
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001536 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001537 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001538 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001539
Robin Getz97cfe862009-07-21 12:15:28 -04001540 CONFIG_KEEP_SERVERADDR
1541
1542 Keeps the server's MAC address, in the env 'serveraddr'
1543 for passing to bootargs (like Linux's netconsole option)
1544
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001545- Gateway IP address:
1546 CONFIG_GATEWAYIP
1547
1548 Defines a default value for the IP address of the
1549 default router where packets to other networks are
1550 sent to.
1551 (Environment variable "gatewayip")
1552
1553- Subnet mask:
1554 CONFIG_NETMASK
1555
1556 Defines a default value for the subnet mask (or
1557 routing prefix) which is used to determine if an IP
1558 address belongs to the local subnet or needs to be
1559 forwarded through a router.
1560 (Environment variable "netmask")
1561
David Updegraff53a5c422007-06-11 10:41:07 -05001562- Multicast TFTP Mode:
1563 CONFIG_MCAST_TFTP
1564
1565 Defines whether you want to support multicast TFTP as per
1566 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001567 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001568 driver in use must provide a function: mcast() to join/leave a
1569 multicast group.
1570
wdenkc6097192002-11-03 00:24:07 +00001571- BOOTP Recovery Mode:
1572 CONFIG_BOOTP_RANDOM_DELAY
1573
1574 If you have many targets in a network that try to
1575 boot using BOOTP, you may want to avoid that all
1576 systems send out BOOTP requests at precisely the same
1577 moment (which would happen for instance at recovery
1578 from a power failure, when all systems will try to
1579 boot, thus flooding the BOOTP server. Defining
1580 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1581 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001582 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001583
1584 1st BOOTP request: delay 0 ... 1 sec
1585 2nd BOOTP request: delay 0 ... 2 sec
1586 3rd BOOTP request: delay 0 ... 4 sec
1587 4th and following
1588 BOOTP requests: delay 0 ... 8 sec
1589
stroesefe389a82003-08-28 14:17:32 +00001590- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001591 You can fine tune the DHCP functionality by defining
1592 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001593
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001594 CONFIG_BOOTP_SUBNETMASK
1595 CONFIG_BOOTP_GATEWAY
1596 CONFIG_BOOTP_HOSTNAME
1597 CONFIG_BOOTP_NISDOMAIN
1598 CONFIG_BOOTP_BOOTPATH
1599 CONFIG_BOOTP_BOOTFILESIZE
1600 CONFIG_BOOTP_DNS
1601 CONFIG_BOOTP_DNS2
1602 CONFIG_BOOTP_SEND_HOSTNAME
1603 CONFIG_BOOTP_NTPSERVER
1604 CONFIG_BOOTP_TIMEOFFSET
1605 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001606 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001607
Wilson Callan5d110f02007-07-28 10:56:13 -04001608 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1609 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001610
Joe Hershberger2c00e092012-05-23 07:59:19 +00001611 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1612 after the configured retry count, the call will fail
1613 instead of starting over. This can be used to fail over
1614 to Link-local IP address configuration if the DHCP server
1615 is not available.
1616
stroesefe389a82003-08-28 14:17:32 +00001617 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1618 serverip from a DHCP server, it is possible that more
1619 than one DNS serverip is offered to the client.
1620 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1621 serverip will be stored in the additional environment
1622 variable "dnsip2". The first DNS serverip is always
1623 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001624 is defined.
stroesefe389a82003-08-28 14:17:32 +00001625
1626 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1627 to do a dynamic update of a DNS server. To do this, they
1628 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001629 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001630 of the "hostname" environment variable is passed as
1631 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001632
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001633 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1634
1635 A 32bit value in microseconds for a delay between
1636 receiving a "DHCP Offer" and sending the "DHCP Request".
1637 This fixes a problem with certain DHCP servers that don't
1638 respond 100% of the time to a "DHCP request". E.g. On an
1639 AT91RM9200 processor running at 180MHz, this delay needed
1640 to be *at least* 15,000 usec before a Windows Server 2003
1641 DHCP server would reply 100% of the time. I recommend at
1642 least 50,000 usec to be safe. The alternative is to hope
1643 that one of the retries will be successful but note that
1644 the DHCP timeout and retry process takes a longer than
1645 this delay.
1646
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001647 - Link-local IP address negotiation:
1648 Negotiate with other link-local clients on the local network
1649 for an address that doesn't require explicit configuration.
1650 This is especially useful if a DHCP server cannot be guaranteed
1651 to exist in all environments that the device must operate.
1652
1653 See doc/README.link-local for more information.
1654
wdenka3d991b2004-04-15 21:48:45 +00001655 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001656 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001657
1658 The device id used in CDP trigger frames.
1659
1660 CONFIG_CDP_DEVICE_ID_PREFIX
1661
1662 A two character string which is prefixed to the MAC address
1663 of the device.
1664
1665 CONFIG_CDP_PORT_ID
1666
1667 A printf format string which contains the ascii name of
1668 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001669 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001670
1671 CONFIG_CDP_CAPABILITIES
1672
1673 A 32bit integer which indicates the device capabilities;
1674 0x00000010 for a normal host which does not forwards.
1675
1676 CONFIG_CDP_VERSION
1677
1678 An ascii string containing the version of the software.
1679
1680 CONFIG_CDP_PLATFORM
1681
1682 An ascii string containing the name of the platform.
1683
1684 CONFIG_CDP_TRIGGER
1685
1686 A 32bit integer sent on the trigger.
1687
1688 CONFIG_CDP_POWER_CONSUMPTION
1689
1690 A 16bit integer containing the power consumption of the
1691 device in .1 of milliwatts.
1692
1693 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1694
1695 A byte containing the id of the VLAN.
1696
wdenkc6097192002-11-03 00:24:07 +00001697- Status LED: CONFIG_STATUS_LED
1698
1699 Several configurations allow to display the current
1700 status using a LED. For instance, the LED will blink
1701 fast while running U-Boot code, stop blinking as
1702 soon as a reply to a BOOTP request was received, and
1703 start blinking slow once the Linux kernel is running
1704 (supported by a status LED driver in the Linux
1705 kernel). Defining CONFIG_STATUS_LED enables this
1706 feature in U-Boot.
1707
1708- CAN Support: CONFIG_CAN_DRIVER
1709
1710 Defining CONFIG_CAN_DRIVER enables CAN driver support
1711 on those systems that support this (optional)
1712 feature, like the TQM8xxL modules.
1713
1714- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1715
wdenkb37c7e52003-06-30 16:24:52 +00001716 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001717 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001718 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001719
wdenk945af8d2003-07-16 21:53:01 +00001720 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001721 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001722 CONFIG_COMMANDS) and communicate with i2c based realtime
1723 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001724 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001725
Ben Warrenbb99ad62006-09-07 16:50:54 -04001726 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001727
wdenk945af8d2003-07-16 21:53:01 +00001728 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001729 bit-banging) driver instead of CPM or similar hardware
1730 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001731
wdenk945af8d2003-07-16 21:53:01 +00001732 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001733 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001735 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001736 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001737 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001738 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001739
Peter Tyser8d321b82010-04-12 22:28:21 -05001740 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02001741 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05001742 and so its address should therefore be cleared to 0 (See,
1743 eg, MPC823e User's Manual p.16-473). So, set
1744 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001745
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001746 CONFIG_SYS_I2C_INIT_MPC5XXX
1747
1748 When a board is reset during an i2c bus transfer
1749 chips might think that the current transfer is still
1750 in progress. Reset the slave devices by sending start
1751 commands until the slave device responds.
1752
wdenk945af8d2003-07-16 21:53:01 +00001753 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001754
1755 If you use the software i2c interface (CONFIG_SOFT_I2C)
1756 then the following macros need to be defined (examples are
1757 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001758
1759 I2C_INIT
1760
wdenkb37c7e52003-06-30 16:24:52 +00001761 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001762 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001763
wdenkba56f622004-02-06 23:19:44 +00001764 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001765
wdenkc6097192002-11-03 00:24:07 +00001766 I2C_PORT
1767
wdenk43d96162003-03-06 00:02:04 +00001768 (Only for MPC8260 CPU). The I/O port to use (the code
1769 assumes both bits are on the same port). Valid values
1770 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001771
1772 I2C_ACTIVE
1773
1774 The code necessary to make the I2C data line active
1775 (driven). If the data line is open collector, this
1776 define can be null.
1777
wdenkb37c7e52003-06-30 16:24:52 +00001778 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1779
wdenkc6097192002-11-03 00:24:07 +00001780 I2C_TRISTATE
1781
1782 The code necessary to make the I2C data line tri-stated
1783 (inactive). If the data line is open collector, this
1784 define can be null.
1785
wdenkb37c7e52003-06-30 16:24:52 +00001786 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1787
wdenkc6097192002-11-03 00:24:07 +00001788 I2C_READ
1789
1790 Code that returns TRUE if the I2C data line is high,
1791 FALSE if it is low.
1792
wdenkb37c7e52003-06-30 16:24:52 +00001793 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1794
wdenkc6097192002-11-03 00:24:07 +00001795 I2C_SDA(bit)
1796
1797 If <bit> is TRUE, sets the I2C data line high. If it
1798 is FALSE, it clears it (low).
1799
wdenkb37c7e52003-06-30 16:24:52 +00001800 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001801 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001802 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001803
wdenkc6097192002-11-03 00:24:07 +00001804 I2C_SCL(bit)
1805
1806 If <bit> is TRUE, sets the I2C clock line high. If it
1807 is FALSE, it clears it (low).
1808
wdenkb37c7e52003-06-30 16:24:52 +00001809 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001810 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001811 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001812
wdenkc6097192002-11-03 00:24:07 +00001813 I2C_DELAY
1814
1815 This delay is invoked four times per clock cycle so this
1816 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001817 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001818 like:
1819
wdenkb37c7e52003-06-30 16:24:52 +00001820 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001821
Mike Frysinger793b5722010-07-21 13:38:02 -04001822 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1823
1824 If your arch supports the generic GPIO framework (asm/gpio.h),
1825 then you may alternatively define the two GPIOs that are to be
1826 used as SCL / SDA. Any of the previous I2C_xxx macros will
1827 have GPIO-based defaults assigned to them as appropriate.
1828
1829 You should define these to the GPIO value as given directly to
1830 the generic GPIO functions.
1831
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001832 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001833
wdenk8bde7f72003-06-27 21:31:46 +00001834 When a board is reset during an i2c bus transfer
1835 chips might think that the current transfer is still
1836 in progress. On some boards it is possible to access
1837 the i2c SCLK line directly, either by using the
1838 processor pin as a GPIO or by having a second pin
1839 connected to the bus. If this option is defined a
1840 custom i2c_init_board() routine in boards/xxx/board.c
1841 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001842
Richard Retanubun26a33502010-04-12 15:08:17 -04001843 CONFIG_SYS_I2C_BOARD_LATE_INIT
1844
1845 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
1846 defined a custom i2c_board_late_init() routine in
1847 boards/xxx/board.c is run AFTER the operations in i2c_init()
1848 is completed. This callpoint can be used to unreset i2c bus
1849 using CPU i2c controller register accesses for CPUs whose i2c
1850 controller provide such a method. It is called at the end of
1851 i2c_init() to allow i2c_init operations to setup the i2c bus
1852 controller on the CPU (e.g. setting bus speed & slave address).
1853
wdenk17ea1172004-06-06 21:51:03 +00001854 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1855
1856 This option enables configuration of bi_iic_fast[] flags
1857 in u-boot bd_info structure based on u-boot environment
1858 variable "i2cfast". (see also i2cfast)
1859
Ben Warrenbb99ad62006-09-07 16:50:54 -04001860 CONFIG_I2C_MULTI_BUS
1861
1862 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001863 must have a controller. At any point in time, only one bus is
1864 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001865 Note that bus numbering is zero-based.
1866
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001867 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001868
1869 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001870 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001871 is set, specify a list of bus-device pairs. Otherwise, specify
1872 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001873
1874 e.g.
1875 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001876 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001877
1878 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1879
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001880 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001881 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001882
1883 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1884
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001885 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001886
1887 If defined, then this indicates the I2C bus number for DDR SPD.
1888 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1889
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001890 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001891
1892 If defined, then this indicates the I2C bus number for the RTC.
1893 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1894
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001895 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001896
1897 If defined, then this indicates the I2C bus number for the DTT.
1898 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1899
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001900 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001901
1902 If defined, specifies the I2C address of the DTT device.
1903 If not defined, then U-Boot uses predefined value for
1904 specified DTT device.
1905
Timur Tabibe5e6182006-11-03 19:15:00 -06001906 CONFIG_FSL_I2C
1907
1908 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001909 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001910
Heiko Schocher67b23a32008-10-15 09:39:47 +02001911 CONFIG_I2C_MUX
1912
1913 Define this option if you have I2C devices reached over 1 .. n
1914 I2C Muxes like the pca9544a. This option addes a new I2C
1915 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1916 new I2C Bus to the existing I2C Busses. If you select the
1917 new Bus with "i2c dev", u-bbot sends first the commandos for
1918 the muxes to activate this new "bus".
1919
1920 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1921 feature!
1922
1923 Example:
1924 Adding a new I2C Bus reached over 2 pca9544a muxes
1925 The First mux with address 70 and channel 6
1926 The Second mux with address 71 and channel 4
1927
1928 => i2c bus pca9544a:70:6:pca9544a:71:4
1929
1930 Use the "i2c bus" command without parameter, to get a list
1931 of I2C Busses with muxes:
1932
1933 => i2c bus
1934 Busses reached over muxes:
1935 Bus ID: 2
1936 reached over Mux(es):
1937 pca9544a@70 ch: 4
1938 Bus ID: 3
1939 reached over Mux(es):
1940 pca9544a@70 ch: 6
1941 pca9544a@71 ch: 4
1942 =>
1943
1944 If you now switch to the new I2C Bus 3 with "i2c dev 3"
Michael Jonesf9a78b82011-07-14 22:09:28 +00001945 u-boot first sends the command to the mux@70 to enable
1946 channel 6, and then the command to the mux@71 to enable
Heiko Schocher67b23a32008-10-15 09:39:47 +02001947 the channel 4.
1948
1949 After that, you can use the "normal" i2c commands as
Michael Jonesf9a78b82011-07-14 22:09:28 +00001950 usual to communicate with your I2C devices behind
Heiko Schocher67b23a32008-10-15 09:39:47 +02001951 the 2 muxes.
1952
1953 This option is actually implemented for the bitbanging
1954 algorithm in common/soft_i2c.c and for the Hardware I2C
1955 Bus on the MPC8260. But it should be not so difficult
1956 to add this option to other architectures.
1957
Andrew Dyer2ac69852008-12-29 17:36:01 -06001958 CONFIG_SOFT_I2C_READ_REPEATED_START
1959
1960 defining this will force the i2c_read() function in
1961 the soft_i2c driver to perform an I2C repeated start
1962 between writing the address pointer and reading the
1963 data. If this define is omitted the default behaviour
1964 of doing a stop-start sequence will be used. Most I2C
1965 devices can use either method, but some require one or
1966 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001967
wdenkc6097192002-11-03 00:24:07 +00001968- SPI Support: CONFIG_SPI
1969
1970 Enables SPI driver (so far only tested with
1971 SPI EEPROM, also an instance works with Crystal A/D and
1972 D/As on the SACSng board)
1973
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09001974 CONFIG_SH_SPI
1975
1976 Enables the driver for SPI controller on SuperH. Currently
1977 only SH7757 is supported.
1978
wdenkc6097192002-11-03 00:24:07 +00001979 CONFIG_SPI_X
1980
1981 Enables extended (16-bit) SPI EEPROM addressing.
1982 (symmetrical to CONFIG_I2C_X)
1983
1984 CONFIG_SOFT_SPI
1985
wdenk43d96162003-03-06 00:02:04 +00001986 Enables a software (bit-bang) SPI driver rather than
1987 using hardware support. This is a general purpose
1988 driver that only requires three general I/O port pins
1989 (two outputs, one input) to function. If this is
1990 defined, the board configuration must define several
1991 SPI configuration items (port pins to use, etc). For
1992 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001993
Ben Warren04a9e112008-01-16 22:37:35 -05001994 CONFIG_HARD_SPI
1995
1996 Enables a hardware SPI driver for general-purpose reads
1997 and writes. As with CONFIG_SOFT_SPI, the board configuration
1998 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001999 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002000 example, see include/configs/mpc8349emds.h.
2001
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002002 CONFIG_MXC_SPI
2003
2004 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002005 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002006
Matthias Fuchs01335022007-12-27 17:12:34 +01002007- FPGA Support: CONFIG_FPGA
2008
2009 Enables FPGA subsystem.
2010
2011 CONFIG_FPGA_<vendor>
2012
2013 Enables support for specific chip vendors.
2014 (ALTERA, XILINX)
2015
2016 CONFIG_FPGA_<family>
2017
2018 Enables support for FPGA family.
2019 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2020
2021 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002022
wdenk43d96162003-03-06 00:02:04 +00002023 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002024
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002025 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002026
wdenk8bde7f72003-06-27 21:31:46 +00002027 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002028
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002029 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002030
wdenk43d96162003-03-06 00:02:04 +00002031 Enable checks on FPGA configuration interface busy
2032 status by the configuration function. This option
2033 will require a board or device specific function to
2034 be written.
wdenkc6097192002-11-03 00:24:07 +00002035
2036 CONFIG_FPGA_DELAY
2037
2038 If defined, a function that provides delays in the FPGA
2039 configuration driver.
2040
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002041 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002042 Allow Control-C to interrupt FPGA configuration
2043
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002044 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002045
wdenk43d96162003-03-06 00:02:04 +00002046 Check for configuration errors during FPGA bitfile
2047 loading. For example, abort during Virtex II
2048 configuration if the INIT_B line goes low (which
2049 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002050
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002051 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002052
wdenk43d96162003-03-06 00:02:04 +00002053 Maximum time to wait for the INIT_B line to deassert
2054 after PROB_B has been deasserted during a Virtex II
2055 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002056 ms.
wdenkc6097192002-11-03 00:24:07 +00002057
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002058 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002059
wdenk43d96162003-03-06 00:02:04 +00002060 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002061 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002062
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002063 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002064
wdenk43d96162003-03-06 00:02:04 +00002065 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002066 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002067
2068- Configuration Management:
2069 CONFIG_IDENT_STRING
2070
wdenk43d96162003-03-06 00:02:04 +00002071 If defined, this string will be added to the U-Boot
2072 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002073
2074- Vendor Parameter Protection:
2075
wdenk43d96162003-03-06 00:02:04 +00002076 U-Boot considers the values of the environment
2077 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002078 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002079 are set once by the board vendor / manufacturer, and
2080 protects these variables from casual modification by
2081 the user. Once set, these variables are read-only,
2082 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002083 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002084
2085 If CONFIG_ENV_OVERWRITE is #defined in your config
2086 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002087 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002088 these parameters.
2089
2090 Alternatively, if you #define _both_ CONFIG_ETHADDR
2091 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002092 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002093 which can be changed exactly ONCE by the user. [The
2094 serial# is unaffected by this, i. e. it remains
2095 read-only.]
2096
2097- Protected RAM:
2098 CONFIG_PRAM
2099
2100 Define this variable to enable the reservation of
2101 "protected RAM", i. e. RAM which is not overwritten
2102 by U-Boot. Define CONFIG_PRAM to hold the number of
2103 kB you want to reserve for pRAM. You can overwrite
2104 this default value by defining an environment
2105 variable "pram" to the number of kB you want to
2106 reserve. Note that the board info structure will
2107 still show the full amount of RAM. If pRAM is
2108 reserved, a new environment variable "mem" will
2109 automatically be defined to hold the amount of
2110 remaining RAM in a form that can be passed as boot
2111 argument to Linux, for instance like that:
2112
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002113 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002114 saveenv
2115
2116 This way you can tell Linux not to use this memory,
2117 either, which results in a memory region that will
2118 not be affected by reboots.
2119
2120 *WARNING* If your board configuration uses automatic
2121 detection of the RAM size, you must make sure that
2122 this memory test is non-destructive. So far, the
2123 following board configurations are known to be
2124 "pRAM-clean":
2125
2126 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2127 HERMES, IP860, RPXlite, LWMON, LANTEC,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002128 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002129
2130- Error Recovery:
2131 CONFIG_PANIC_HANG
2132
2133 Define this variable to stop the system in case of a
2134 fatal error, so that you have to reset it manually.
2135 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002136 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002137 automatically as fast as possible, but it may be
2138 useful during development since you can try to debug
2139 the conditions that lead to the situation.
2140
2141 CONFIG_NET_RETRY_COUNT
2142
wdenk43d96162003-03-06 00:02:04 +00002143 This variable defines the number of retries for
2144 network operations like ARP, RARP, TFTP, or BOOTP
2145 before giving up the operation. If not defined, a
2146 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002147
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002148 CONFIG_ARP_TIMEOUT
2149
2150 Timeout waiting for an ARP reply in milliseconds.
2151
wdenkc6097192002-11-03 00:24:07 +00002152- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002153 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002154
2155 Enable auto completion of commands using TAB.
2156
Wolfgang Denka9398e02006-11-27 15:32:42 +01002157 Note that this feature has NOT been implemented yet
2158 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002159
2160
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002161 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00002162
2163 Define this variable to enable the "hush" shell (from
2164 Busybox) as command line interpreter, thus enabling
2165 powerful command line syntax like
2166 if...then...else...fi conditionals or `&&' and '||'
2167 constructs ("shell scripts").
2168
2169 If undefined, you get the old, much simpler behaviour
2170 with a somewhat smaller memory footprint.
2171
2172
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002173 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002174
2175 This defines the secondary prompt string, which is
2176 printed when the command interpreter needs more input
2177 to complete a command. Usually "> ".
2178
2179 Note:
2180
wdenk8bde7f72003-06-27 21:31:46 +00002181 In the current implementation, the local variables
2182 space and global environment variables space are
2183 separated. Local variables are those you define by
2184 simply typing `name=value'. To access a local
2185 variable later on, you have write `$name' or
2186 `${name}'; to execute the contents of a variable
2187 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002188
wdenk43d96162003-03-06 00:02:04 +00002189 Global environment variables are those you use
2190 setenv/printenv to work with. To run a command stored
2191 in such a variable, you need to use the run command,
2192 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002193
2194 To store commands and special characters in a
2195 variable, please use double quotation marks
2196 surrounding the whole text of the variable, instead
2197 of the backslashes before semicolons and special
2198 symbols.
2199
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002200- Commandline Editing and History:
2201 CONFIG_CMDLINE_EDITING
2202
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002203 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02002204 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002205
wdenka8c7c702003-12-06 19:49:23 +00002206- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002207 CONFIG_EXTRA_ENV_SETTINGS
2208
wdenk43d96162003-03-06 00:02:04 +00002209 Define this to contain any number of null terminated
2210 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002211 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002212
wdenk43d96162003-03-06 00:02:04 +00002213 For example, place something like this in your
2214 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002215
2216 #define CONFIG_EXTRA_ENV_SETTINGS \
2217 "myvar1=value1\0" \
2218 "myvar2=value2\0"
2219
wdenk43d96162003-03-06 00:02:04 +00002220 Warning: This method is based on knowledge about the
2221 internal format how the environment is stored by the
2222 U-Boot code. This is NOT an official, exported
2223 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002224 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002225 You better know what you are doing here.
2226
wdenk43d96162003-03-06 00:02:04 +00002227 Note: overly (ab)use of the default environment is
2228 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002229 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002230 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002231
wdenka8c7c702003-12-06 19:49:23 +00002232- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002233 CONFIG_HAS_DATAFLASH
2234
wdenk8bde7f72003-06-27 21:31:46 +00002235 Defining this option enables DataFlash features and
2236 allows to read/write in Dataflash via the standard
2237 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002238
Eric Nelsonf61ec452012-01-31 10:52:08 -07002239- Serial Flash support
2240 CONFIG_CMD_SF
2241
2242 Defining this option enables SPI flash commands
2243 'sf probe/read/write/erase/update'.
2244
2245 Usage requires an initial 'probe' to define the serial
2246 flash parameters, followed by read/write/erase/update
2247 commands.
2248
2249 The following defaults may be provided by the platform
2250 to handle the common case when only a single serial
2251 flash is present on the system.
2252
2253 CONFIG_SF_DEFAULT_BUS Bus identifier
2254 CONFIG_SF_DEFAULT_CS Chip-select
2255 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2256 CONFIG_SF_DEFAULT_SPEED in Hz
2257
wdenk3f85ce22004-02-23 16:11:30 +00002258- SystemACE Support:
2259 CONFIG_SYSTEMACE
2260
2261 Adding this option adds support for Xilinx SystemACE
2262 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002263 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002264 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00002265
2266 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002267 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00002268
2269 When SystemACE support is added, the "ace" device type
2270 becomes available to the fat commands, i.e. fatls.
2271
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002272- TFTP Fixed UDP Port:
2273 CONFIG_TFTP_PORT
2274
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002275 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002276 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002277 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002278 number generator is used.
2279
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002280 Also, the environment variable tftpdstp is used to supply
2281 the TFTP UDP destination port value. If tftpdstp isn't
2282 defined, the normal port 69 is used.
2283
2284 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002285 blindly start the TFTP transfer using the pre-configured
2286 target IP address and UDP port. This has the effect of
2287 "punching through" the (Windows XP) firewall, allowing
2288 the remainder of the TFTP transfer to proceed normally.
2289 A better solution is to properly configure the firewall,
2290 but sometimes that is not allowed.
2291
wdenka8c7c702003-12-06 19:49:23 +00002292- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002293 CONFIG_SHOW_BOOT_PROGRESS
2294
wdenk43d96162003-03-06 00:02:04 +00002295 Defining this option allows to add some board-
2296 specific code (calling a user-provided function
2297 "show_boot_progress(int)") that enables you to show
2298 the system's boot progress on some display (for
2299 example, some LED's) on your board. At the moment,
2300 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002301
Simon Glass3a608ca2012-02-13 13:51:19 +00002302- Detailed boot stage timing
2303 CONFIG_BOOTSTAGE
2304 Define this option to get detailed timing of each stage
2305 of the boot process.
2306
2307 CONFIG_BOOTSTAGE_USER_COUNT
2308 This is the number of available user bootstage records.
2309 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2310 a new ID will be allocated from this stash. If you exceed
2311 the limit, recording will stop.
2312
2313 CONFIG_BOOTSTAGE_REPORT
2314 Define this to print a report before boot, similar to this:
2315
2316 Timer summary in microseconds:
2317 Mark Elapsed Stage
2318 0 0 reset
2319 3,575,678 3,575,678 board_init_f start
2320 3,575,695 17 arch_cpu_init A9
2321 3,575,777 82 arch_cpu_init done
2322 3,659,598 83,821 board_init_r start
2323 3,910,375 250,777 main_loop
2324 29,916,167 26,005,792 bootm_start
2325 30,361,327 445,160 start_kernel
2326
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002327Legacy uImage format:
2328
wdenkc6097192002-11-03 00:24:07 +00002329 Arg Where When
2330 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002331 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002332 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002333 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002334 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002335 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002336 4 common/cmd_bootm.c Image data has correct checksum
2337 -4 common/cmd_bootm.c Image is for unsupported architecture
2338 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002339 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002340 6 common/cmd_bootm.c Image Type check OK
2341 -6 common/cmd_bootm.c gunzip uncompression error
2342 -7 common/cmd_bootm.c Unimplemented compression type
2343 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002344 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002345 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002346
2347 9 common/image.c Start initial ramdisk verification
2348 -10 common/image.c Ramdisk header has bad magic number
2349 -11 common/image.c Ramdisk header has bad checksum
2350 10 common/image.c Ramdisk header is OK
2351 -12 common/image.c Ramdisk data has bad checksum
2352 11 common/image.c Ramdisk data has correct checksum
2353 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002354 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002355 13 common/image.c Start multifile image verification
2356 14 common/image.c No initial ramdisk, no multifile, continue.
2357
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002358 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002359
Stefan Roesea47a12b2010-04-15 16:07:28 +02002360 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002361 -31 post/post.c POST test failed, detected by post_output_backlog()
2362 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002363
Heiko Schocher566a4942007-06-22 19:11:54 +02002364 34 common/cmd_doc.c before loading a Image from a DOC device
2365 -35 common/cmd_doc.c Bad usage of "doc" command
2366 35 common/cmd_doc.c correct usage of "doc" command
2367 -36 common/cmd_doc.c No boot device
2368 36 common/cmd_doc.c correct boot device
2369 -37 common/cmd_doc.c Unknown Chip ID on boot device
2370 37 common/cmd_doc.c correct chip ID found, device available
2371 -38 common/cmd_doc.c Read Error on boot device
2372 38 common/cmd_doc.c reading Image header from DOC device OK
2373 -39 common/cmd_doc.c Image header has bad magic number
2374 39 common/cmd_doc.c Image header has correct magic number
2375 -40 common/cmd_doc.c Error reading Image from DOC device
2376 40 common/cmd_doc.c Image header has correct magic number
2377 41 common/cmd_ide.c before loading a Image from a IDE device
2378 -42 common/cmd_ide.c Bad usage of "ide" command
2379 42 common/cmd_ide.c correct usage of "ide" command
2380 -43 common/cmd_ide.c No boot device
2381 43 common/cmd_ide.c boot device found
2382 -44 common/cmd_ide.c Device not available
2383 44 common/cmd_ide.c Device available
2384 -45 common/cmd_ide.c wrong partition selected
2385 45 common/cmd_ide.c partition selected
2386 -46 common/cmd_ide.c Unknown partition table
2387 46 common/cmd_ide.c valid partition table found
2388 -47 common/cmd_ide.c Invalid partition type
2389 47 common/cmd_ide.c correct partition type
2390 -48 common/cmd_ide.c Error reading Image Header on boot device
2391 48 common/cmd_ide.c reading Image Header from IDE device OK
2392 -49 common/cmd_ide.c Image header has bad magic number
2393 49 common/cmd_ide.c Image header has correct magic number
2394 -50 common/cmd_ide.c Image header has bad checksum
2395 50 common/cmd_ide.c Image header has correct checksum
2396 -51 common/cmd_ide.c Error reading Image from IDE device
2397 51 common/cmd_ide.c reading Image from IDE device OK
2398 52 common/cmd_nand.c before loading a Image from a NAND device
2399 -53 common/cmd_nand.c Bad usage of "nand" command
2400 53 common/cmd_nand.c correct usage of "nand" command
2401 -54 common/cmd_nand.c No boot device
2402 54 common/cmd_nand.c boot device found
2403 -55 common/cmd_nand.c Unknown Chip ID on boot device
2404 55 common/cmd_nand.c correct chip ID found, device available
2405 -56 common/cmd_nand.c Error reading Image Header on boot device
2406 56 common/cmd_nand.c reading Image Header from NAND device OK
2407 -57 common/cmd_nand.c Image header has bad magic number
2408 57 common/cmd_nand.c Image header has correct magic number
2409 -58 common/cmd_nand.c Error reading Image from NAND device
2410 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002411
Heiko Schocher566a4942007-06-22 19:11:54 +02002412 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002413
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002414 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002415 -64 net/eth.c no Ethernet found.
2416 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002417
Heiko Schocher566a4942007-06-22 19:11:54 +02002418 -80 common/cmd_net.c usage wrong
2419 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002420 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002421 81 common/cmd_net.c NetLoop() back without error
2422 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2423 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002424 83 common/cmd_net.c running "source" command
2425 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002426 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002427
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002428FIT uImage format:
2429
2430 Arg Where When
2431 100 common/cmd_bootm.c Kernel FIT Image has correct format
2432 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2433 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2434 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2435 102 common/cmd_bootm.c Kernel unit name specified
2436 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002437 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002438 104 common/cmd_bootm.c Got kernel subimage node offset
2439 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2440 105 common/cmd_bootm.c Kernel subimage hash verification OK
2441 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2442 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002443 -106 common/cmd_bootm.c Kernel subimage has wrong type
2444 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002445 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2446 108 common/cmd_bootm.c Got kernel subimage data/size
2447 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2448 -109 common/cmd_bootm.c Can't get kernel subimage type
2449 -110 common/cmd_bootm.c Can't get kernel subimage comp
2450 -111 common/cmd_bootm.c Can't get kernel subimage os
2451 -112 common/cmd_bootm.c Can't get kernel subimage load address
2452 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2453
2454 120 common/image.c Start initial ramdisk verification
2455 -120 common/image.c Ramdisk FIT image has incorrect format
2456 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002457 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002458 -122 common/image.c Can't get configuration for ramdisk subimage
2459 123 common/image.c Ramdisk unit name specified
2460 -124 common/image.c Can't get ramdisk subimage node offset
2461 125 common/image.c Got ramdisk subimage node offset
2462 -125 common/image.c Ramdisk subimage hash verification failed
2463 126 common/image.c Ramdisk subimage hash verification OK
2464 -126 common/image.c Ramdisk subimage for unsupported architecture
2465 127 common/image.c Architecture check OK
2466 -127 common/image.c Can't get ramdisk subimage data/size
2467 128 common/image.c Got ramdisk subimage data/size
2468 129 common/image.c Can't get ramdisk load address
2469 -129 common/image.c Got ramdisk load address
2470
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002471 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002472 131 common/cmd_doc.c FIT image format OK
2473
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002474 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002475 141 common/cmd_ide.c FIT image format OK
2476
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002477 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002478 151 common/cmd_nand.c FIT image format OK
2479
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002480- Standalone program support:
2481 CONFIG_STANDALONE_LOAD_ADDR
2482
Wolfgang Denk6feff892011-10-09 21:06:34 +02002483 This option defines a board specific value for the
2484 address where standalone program gets loaded, thus
2485 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002486 settings.
2487
2488- Frame Buffer Address:
2489 CONFIG_FB_ADDR
2490
2491 Define CONFIG_FB_ADDR if you want to use specific
2492 address for frame buffer.
2493 Then system will reserve the frame buffer address to
2494 defined address instead of lcd_setmem (this function
Wolfgang Denk6feff892011-10-09 21:06:34 +02002495 grabs the memory for frame buffer by panel's size).
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002496
2497 Please see board_init_f function.
2498
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002499- Automatic software updates via TFTP server
2500 CONFIG_UPDATE_TFTP
2501 CONFIG_UPDATE_TFTP_CNT_MAX
2502 CONFIG_UPDATE_TFTP_MSEC_MAX
2503
2504 These options enable and control the auto-update feature;
2505 for a more detailed description refer to doc/README.update.
2506
2507- MTD Support (mtdparts command, UBI support)
2508 CONFIG_MTD_DEVICE
2509
2510 Adds the MTD device infrastructure from the Linux kernel.
2511 Needed for mtdparts command support.
2512
2513 CONFIG_MTD_PARTITIONS
2514
2515 Adds the MTD partitioning infrastructure from the Linux
2516 kernel. Needed for UBI support.
2517
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002518- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002519 CONFIG_SPL
2520 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002521
Tom Rini95579792012-02-14 07:29:40 +00002522 CONFIG_SPL_LDSCRIPT
2523 LDSCRIPT for linking the SPL binary.
2524
2525 CONFIG_SPL_MAX_SIZE
2526 Maximum binary size (text, data and rodata) of the SPL binary.
2527
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002528 CONFIG_SPL_TEXT_BASE
2529 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002530
Tom Rini95579792012-02-14 07:29:40 +00002531 CONFIG_SPL_BSS_START_ADDR
2532 Link address for the BSS within the SPL binary.
2533
2534 CONFIG_SPL_BSS_MAX_SIZE
2535 Maximum binary size of the BSS section of the SPL binary.
2536
2537 CONFIG_SPL_STACK
2538 Adress of the start of the stack SPL will use
2539
2540 CONFIG_SYS_SPL_MALLOC_START
2541 Starting address of the malloc pool used in SPL.
2542
2543 CONFIG_SYS_SPL_MALLOC_SIZE
2544 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002545
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002546 CONFIG_SPL_LIBCOMMON_SUPPORT
2547 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002548
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002549 CONFIG_SPL_LIBDISK_SUPPORT
2550 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002551
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002552 CONFIG_SPL_I2C_SUPPORT
2553 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002554
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002555 CONFIG_SPL_GPIO_SUPPORT
2556 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002557
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002558 CONFIG_SPL_MMC_SUPPORT
2559 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002560
Tom Rini95579792012-02-14 07:29:40 +00002561 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
2562 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
2563 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
2564 Address, size and partition on the MMC to load U-Boot from
2565 when the MMC is being used in raw mode.
2566
2567 CONFIG_SPL_FAT_SUPPORT
2568 Support for fs/fat/libfat.o in SPL binary
2569
2570 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
2571 Filename to read to load U-Boot when reading from FAT
2572
2573 CONFIG_SPL_NAND_SIMPLE
2574 Support for drivers/mtd/nand/libnand.o in SPL binary
2575
2576 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
2577 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
2578 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
2579 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
2580 CONFIG_SYS_NAND_ECCBYTES
2581 Defines the size and behavior of the NAND that SPL uses
2582 to read U-Boot with CONFIG_SPL_NAND_SIMPLE
2583
2584 CONFIG_SYS_NAND_U_BOOT_OFFS
2585 Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
2586 from.
2587
2588 CONFIG_SYS_NAND_U_BOOT_START
2589 Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
2590 to.
2591
2592 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
2593 Define this if you need to first read the OOB and then the
2594 data. This is used for example on davinci plattforms.
2595
2596 CONFIG_SPL_OMAP3_ID_NAND
2597 Support for an OMAP3-specific set of functions to return the
2598 ID and MFR of the first attached NAND chip, if present.
2599
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002600 CONFIG_SPL_SERIAL_SUPPORT
2601 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002602
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002603 CONFIG_SPL_SPI_FLASH_SUPPORT
2604 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002605
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002606 CONFIG_SPL_SPI_SUPPORT
2607 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00002608
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02002609 CONFIG_SPL_LIBGENERIC_SUPPORT
2610 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002611
wdenkc6097192002-11-03 00:24:07 +00002612Modem Support:
2613--------------
2614
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02002615[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00002616
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002617- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002618 CONFIG_MODEM_SUPPORT
2619
2620- RTS/CTS Flow control enable:
2621 CONFIG_HWFLOW
2622
2623- Modem debug support:
2624 CONFIG_MODEM_SUPPORT_DEBUG
2625
wdenk43d96162003-03-06 00:02:04 +00002626 Enables debugging stuff (char screen[1024], dbg())
2627 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002628
wdenka8c7c702003-12-06 19:49:23 +00002629- Interrupt support (PPC):
2630
wdenkd4ca31c2004-01-02 14:00:00 +00002631 There are common interrupt_init() and timer_interrupt()
2632 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002633 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002634 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002635 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002636 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002637 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002638 specific handling. If board has watchdog / status_led
2639 / other_activity_monitor it works automatically from
2640 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002641
wdenkc6097192002-11-03 00:24:07 +00002642- General:
2643
wdenk43d96162003-03-06 00:02:04 +00002644 In the target system modem support is enabled when a
2645 specific key (key combination) is pressed during
2646 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002647 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002648 board_init(). Currently key_pressed() is a dummy
2649 function, returning 1 and thus enabling modem
2650 initialization.
wdenkc6097192002-11-03 00:24:07 +00002651
wdenk43d96162003-03-06 00:02:04 +00002652 If there are no modem init strings in the
2653 environment, U-Boot proceed to autoboot; the
2654 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002655 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002656
2657 See also: doc/README.Modem
2658
Helmut Raiger9660e442011-10-20 04:19:47 +00002659Board initialization settings:
2660------------------------------
2661
2662During Initialization u-boot calls a number of board specific functions
2663to allow the preparation of board specific prerequisites, e.g. pin setup
2664before drivers are initialized. To enable these callbacks the
2665following configuration macros have to be defined. Currently this is
2666architecture specific, so please check arch/your_architecture/lib/board.c
2667typically in board_init_f() and board_init_r().
2668
2669- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
2670- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
2671- CONFIG_BOARD_LATE_INIT: Call board_late_init()
2672- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00002673
wdenkc6097192002-11-03 00:24:07 +00002674Configuration Settings:
2675-----------------------
2676
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002677- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002678 undefine this when you're short of memory.
2679
Peter Tyser2fb26042009-01-27 18:03:12 -06002680- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2681 width of the commands listed in the 'help' command output.
2682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002683- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002684 prompt for user input.
2685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002686- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002687
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002688- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002689
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002690- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002691
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002692- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002693 the application (usually a Linux kernel) when it is
2694 booted
2695
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002696- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002697 List of legal baudrate settings for this board.
2698
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002699- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002700 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002701
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002702- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002703 If the board specific function
2704 extern int overwrite_console (void);
2705 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002706 serial port, else the settings in the environment are used.
2707
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002708- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002709 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002710
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002711- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002712 Enable overwrite of previous console environment settings.
2713
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002714- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002715 Begin and End addresses of the area used by the
2716 simple memory test.
2717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002718- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002719 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002720
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002721- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002722 Scratch address used by the alternate memory test
2723 You only need to set this if address zero isn't writeable
2724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2726 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002727 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002728 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002729 fixing up gd->ram_size the Linux kernel should gets passed
2730 the now "corrected" memory size and won't touch it either.
2731 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002732 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002733 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002734 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002735
2736 This option can be used as a workaround for the 440EPx/GRx
2737 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2738 be touched.
2739
2740 WARNING: Please make sure that this value is a multiple of
2741 the Linux page size (normally 4k). If this is not the case,
2742 then the end address of the Linux memory will be located at a
2743 non page size aligned address and this could cause major
2744 problems.
2745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002746- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002747 Default load address for network file downloads
2748
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002749- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002750 Enable temporary baudrate change while serial download
2751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002752- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002753 Physical start address of SDRAM. _Must_ be 0 here.
2754
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002755- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002756 Physical start address of Motherboard I/O (if using a
2757 Cogent motherboard)
2758
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002759- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002760 Physical start address of Flash memory.
2761
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002762- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002763 Physical start address of boot monitor code (set by
2764 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02002765 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002766 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002767
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002768- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002769 Size of memory reserved for monitor code, used to
2770 determine _at_compile_time_ (!) if the environment is
2771 embedded within the U-Boot image, or in a separate
2772 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002773
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002774- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002775 Size of DRAM reserved for malloc() use.
2776
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002777- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002778 Normally compressed uImages are limited to an
2779 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002780 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002781 to adjust this setting to your needs.
2782
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002783- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002784 Maximum size of memory mapped by the startup code of
2785 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002786 the Linux kernel (bd_info, boot arguments, FDT blob if
2787 used) must be put below this limit, unless "bootm_low"
2788 enviroment variable is defined and non-zero. In such case
2789 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002790 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00002791 variable "bootm_mapsize" will override the value of
2792 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
2793 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00002794
John Rigbyfca43cc2010-10-13 13:57:35 -06002795- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2796 Enable initrd_high functionality. If defined then the
2797 initrd_high feature is enabled and the bootm ramdisk subcommand
2798 is enabled.
2799
2800- CONFIG_SYS_BOOT_GET_CMDLINE:
2801 Enables allocating and saving kernel cmdline in space between
2802 "bootm_low" and "bootm_low" + BOOTMAPSZ.
2803
2804- CONFIG_SYS_BOOT_GET_KBD:
2805 Enables allocating and saving a kernel copy of the bd_info in
2806 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002808- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002809 Max number of Flash memory banks
2810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002811- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002812 Max number of sectors on a Flash chip
2813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002814- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002815 Timeout for Flash erase operations (in ms)
2816
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002817- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002818 Timeout for Flash write operations (in ms)
2819
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002820- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002821 Timeout for Flash set sector lock bit operation (in ms)
2822
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002823- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002824 Timeout for Flash clear lock bits operation (in ms)
2825
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002826- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002827 If defined, hardware flash sectors protection is used
2828 instead of U-Boot software protection.
2829
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002830- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002831
2832 Enable TFTP transfers directly to flash memory;
2833 without this option such a download has to be
2834 performed in two steps: (1) download to RAM, and (2)
2835 copy from RAM to flash.
2836
2837 The two-step approach is usually more reliable, since
2838 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002839 the flash, but in some situations (when system RAM is
2840 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002841 downloaded image) this option may be very useful.
2842
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002843- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002844 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002845 common flash structure for storing flash geometry.
2846
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002847- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002848 This option also enables the building of the cfi_flash driver
2849 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002850
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002851- CONFIG_FLASH_CFI_MTD
2852 This option enables the building of the cfi_mtd driver
2853 in the drivers directory. The driver exports CFI flash
2854 to the MTD layer.
2855
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002856- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002857 Use buffered writes to flash.
2858
2859- CONFIG_FLASH_SPANSION_S29WS_N
2860 s29ws-n MirrorBit flash has non-standard addresses for buffered
2861 write commands.
2862
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002863- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002864 If this option is defined, the common CFI flash doesn't
2865 print it's warning upon not recognized FLASH banks. This
2866 is useful, if some of the configured banks are only
2867 optionally available.
2868
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002869- CONFIG_FLASH_SHOW_PROGRESS
2870 If defined (must be an integer), print out countdown
2871 digits and dots. Recommended value: 45 (9..1) for 80
2872 column displays, 15 (3..1) for 40 column displays.
2873
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002874- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002875 Defines the number of Ethernet receive buffers. On some
2876 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002877 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2878 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002879 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002880 Defaults to 4 if not defined.
2881
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002882- CONFIG_ENV_MAX_ENTRIES
2883
Wolfgang Denk071bc922010-10-27 22:48:30 +02002884 Maximum number of entries in the hash table that is used
2885 internally to store the environment settings. The default
2886 setting is supposed to be generous and should work in most
2887 cases. This setting can be used to tune behaviour; see
2888 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002889
wdenkc6097192002-11-03 00:24:07 +00002890The following definitions that deal with the placement and management
2891of environment data (variable area); in general, we support the
2892following configurations:
2893
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00002894- CONFIG_BUILD_ENVCRC:
2895
2896 Builds up envcrc with the target environment so that external utils
2897 may easily extract it and embed it in final U-Boot images.
2898
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002899- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002900
2901 Define this if the environment is in flash memory.
2902
2903 a) The environment occupies one whole flash sector, which is
2904 "embedded" in the text segment with the U-Boot code. This
2905 happens usually with "bottom boot sector" or "top boot
2906 sector" type flash chips, which have several smaller
2907 sectors at the start or the end. For instance, such a
2908 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2909 such a case you would place the environment in one of the
2910 4 kB sectors - with U-Boot code before and after it. With
2911 "top boot sector" type flash chips, you would put the
2912 environment in one of the last sectors, leaving a gap
2913 between U-Boot and the environment.
2914
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002915 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002916
2917 Offset of environment data (variable area) to the
2918 beginning of flash memory; for instance, with bottom boot
2919 type flash chips the second sector can be used: the offset
2920 for this sector is given here.
2921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002922 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002923
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002924 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002925
2926 This is just another way to specify the start address of
2927 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002928 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002929
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002930 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002931
2932 Size of the sector containing the environment.
2933
2934
2935 b) Sometimes flash chips have few, equal sized, BIG sectors.
2936 In such a case you don't want to spend a whole sector for
2937 the environment.
2938
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002939 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002940
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002941 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002942 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002943 of this flash sector for the environment. This saves
2944 memory for the RAM copy of the environment.
2945
2946 It may also save flash memory if you decide to use this
2947 when your environment is "embedded" within U-Boot code,
2948 since then the remainder of the flash sector could be used
2949 for U-Boot code. It should be pointed out that this is
2950 STRONGLY DISCOURAGED from a robustness point of view:
2951 updating the environment in flash makes it always
2952 necessary to erase the WHOLE sector. If something goes
2953 wrong before the contents has been restored from a copy in
2954 RAM, your target system will be dead.
2955
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002956 - CONFIG_ENV_ADDR_REDUND
2957 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002958
wdenk43d96162003-03-06 00:02:04 +00002959 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002960 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002961 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002962 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002963
2964BE CAREFUL! Any changes to the flash layout, and some changes to the
2965source code will make it necessary to adapt <board>/u-boot.lds*
2966accordingly!
2967
2968
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002969- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002970
2971 Define this if you have some non-volatile memory device
2972 (NVRAM, battery buffered SRAM) which you want to use for the
2973 environment.
2974
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002975 - CONFIG_ENV_ADDR:
2976 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002977
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002978 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002979 want to use for environment. It is assumed that this memory
2980 can just be read and written to, without any special
2981 provision.
2982
2983BE CAREFUL! The first access to the environment happens quite early
2984in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002985console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002986U-Boot will hang.
2987
2988Please note that even with NVRAM we still use a copy of the
2989environment in RAM: we could work on NVRAM directly, but we want to
2990keep settings there always unmodified except somebody uses "saveenv"
2991to save the current settings.
2992
2993
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002994- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002995
2996 Use this if you have an EEPROM or similar serial access
2997 device and a driver for it.
2998
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002999 - CONFIG_ENV_OFFSET:
3000 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003001
3002 These two #defines specify the offset and size of the
3003 environment area within the total memory of your EEPROM.
3004
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003005 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003006 If defined, specified the chip address of the EEPROM device.
3007 The default address is zero.
3008
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003009 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003010 If defined, the number of bits used to address bytes in a
3011 single page in the EEPROM device. A 64 byte page, for example
3012 would require six bits.
3013
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003014 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003015 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00003016 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003017
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003018 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003019 The length in bytes of the EEPROM memory array address. Note
3020 that this is NOT the chip address length!
3021
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003022 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00003023 EEPROM chips that implement "address overflow" are ones
3024 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3025 address and the extra bits end up in the "chip address" bit
3026 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3027 byte chips.
3028
3029 Note that we consider the length of the address field to
3030 still be one byte because the extra address bits are hidden
3031 in the chip address.
3032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003033 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003034 The size in bytes of the EEPROM device.
3035
Heiko Schocher548738b2010-01-07 08:55:40 +01003036 - CONFIG_ENV_EEPROM_IS_ON_I2C
3037 define this, if you have I2C and SPI activated, and your
3038 EEPROM, which holds the environment, is on the I2C bus.
3039
3040 - CONFIG_I2C_ENV_EEPROM_BUS
3041 if you have an Environment on an EEPROM reached over
3042 I2C muxes, you can define here, how to reach this
3043 EEPROM. For example:
3044
Wolfgang Denka9046b92010-06-13 17:48:15 +02003045 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
Heiko Schocher548738b2010-01-07 08:55:40 +01003046
3047 EEPROM which holds the environment, is reached over
3048 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003049
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02003050- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00003051
wdenkd4ca31c2004-01-02 14:00:00 +00003052 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00003053 want to use for the environment.
3054
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003055 - CONFIG_ENV_OFFSET:
3056 - CONFIG_ENV_ADDR:
3057 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00003058
3059 These three #defines specify the offset and size of the
3060 environment area within the total memory of your DataFlash placed
3061 at the specified address.
3062
Liu Gang0a85a9e2012-03-08 00:33:20 +00003063- CONFIG_ENV_IS_IN_REMOTE:
3064
3065 Define this if you have a remote memory space which you
3066 want to use for the local device's environment.
3067
3068 - CONFIG_ENV_ADDR:
3069 - CONFIG_ENV_SIZE:
3070
3071 These two #defines specify the address and size of the
3072 environment area within the remote memory space. The
3073 local device can get the environment from remote memory
3074 space by SRIO or other links.
3075
3076BE CAREFUL! For some special cases, the local device can not use
3077"saveenv" command. For example, the local device will get the
3078environment stored in a remote NOR flash by SRIO link, but it can
3079not erase, write this NOR flash by SRIO interface.
3080
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02003081- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00003082
3083 Define this if you have a NAND device which you want to use
3084 for the environment.
3085
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003086 - CONFIG_ENV_OFFSET:
3087 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00003088
3089 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05003090 area within the first NAND device. CONFIG_ENV_OFFSET must be
3091 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00003092
Scott Woodfdd813d2010-09-17 14:38:37 -05003093 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003094
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02003095 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05003096 size used to hold a redundant copy of the environment data, so
3097 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003098 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05003099 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003100
Scott Woodfdd813d2010-09-17 14:38:37 -05003101 - CONFIG_ENV_RANGE (optional):
3102
3103 Specifies the length of the region in which the environment
3104 can be written. This should be a multiple of the NAND device's
3105 block size. Specifying a range with more erase blocks than
3106 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3107 the range to be avoided.
3108
3109 - CONFIG_ENV_OFFSET_OOB (optional):
3110
3111 Enables support for dynamically retrieving the offset of the
3112 environment from block zero's out-of-band data. The
3113 "nand env.oob" command can be used to record this offset.
3114 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3115 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01003116
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02003117- CONFIG_NAND_ENV_DST
3118
3119 Defines address in RAM to which the nand_spl code should copy the
3120 environment. If redundant environment is used, it will be copied to
3121 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3122
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003123- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003124
3125 Defines offset to the initial SPI buffer area in DPRAM. The
3126 area is used at an early stage (ROM part) if the environment
3127 is configured to reside in the SPI EEPROM: We need a 520 byte
3128 scratch DPRAM area. It is used between the two initialization
3129 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3130 to be a good choice since it makes it far enough from the
3131 start of the data area as well as from the stack pointer.
3132
Bruce Adlere881cb52007-11-02 13:15:42 -07003133Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003134has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02003135created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003136until then to read environment variables.
3137
wdenk85ec0bc2003-03-31 16:34:49 +00003138The environment is protected by a CRC32 checksum. Before the monitor
3139is relocated into RAM, as a result of a bad CRC you will be working
3140with the compiled-in default environment - *silently*!!! [This is
3141necessary, because the first environment variable we need is the
3142"baudrate" setting for the console - if we have a bad CRC, we don't
3143have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003144
3145Note: once the monitor has been relocated, then it will complain if
3146the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00003147use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003148
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003149- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00003150 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00003151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003152 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00003153 also needs to be defined.
3154
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003155- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00003156 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003157
Ron Madridf5675aa2009-02-18 14:30:44 -08003158- CONFIG_NS16550_MIN_FUNCTIONS:
3159 Define this if you desire to only have use of the NS16550_init
3160 and NS16550_putc functions for the serial driver located at
3161 drivers/serial/ns16550.c. This option is useful for saving
3162 space for already greatly restricted images, including but not
3163 limited to NAND_SPL configurations.
3164
wdenkc6097192002-11-03 00:24:07 +00003165Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00003166---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003167
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003168- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003169 Cache Line Size of the CPU.
3170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003171- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003172 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00003173
wdenk42d1f032003-10-15 23:53:47 +00003174 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3175 and RPXsuper) to be able to adjust the position of
3176 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003177
Timur Tabie46fedf2011-08-04 18:03:41 -05003178- CONFIG_SYS_CCSRBAR_DEFAULT:
3179 Default (power-on reset) physical address of CCSR on Freescale
3180 PowerPC SOCs.
3181
3182- CONFIG_SYS_CCSRBAR:
3183 Virtual address of CCSR. On a 32-bit build, this is typically
3184 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3185
3186 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3187 for cross-platform code that uses that macro instead.
3188
3189- CONFIG_SYS_CCSRBAR_PHYS:
3190 Physical address of CCSR. CCSR can be relocated to a new
3191 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003192 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05003193 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3194 is typically relocated on 36-bit builds. It is recommended
3195 that this macro be defined via the _HIGH and _LOW macros:
3196
3197 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3198 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3199
3200- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003201 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
3202 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05003203 used in assembly code, so it must not contain typecasts or
3204 integer size suffixes (e.g. "ULL").
3205
3206- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3207 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
3208 used in assembly code, so it must not contain typecasts or
3209 integer size suffixes (e.g. "ULL").
3210
3211- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3212 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3213 forced to a value that ensures that CCSR is not relocated.
3214
wdenk7f6c2cb2002-11-10 22:06:23 +00003215- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003216 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00003217
3218 the default drive number (default value 0)
3219
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003220 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00003221
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003222 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00003223 (default value 1)
3224
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003225 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00003226
wdenk43d96162003-03-06 00:02:04 +00003227 defines the offset of register from address. It
3228 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003229 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00003230
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003231 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
3232 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00003233 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00003234
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003235 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00003236 fdc_hw_init() is called at the beginning of the FDC
3237 setup. fdc_hw_init() must be provided by the board
3238 source code. It is used to make hardware dependant
3239 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00003240
Macpaul Lin0abddf82011-04-11 20:45:32 +00003241- CONFIG_IDE_AHB:
3242 Most IDE controllers were designed to be connected with PCI
3243 interface. Only few of them were designed for AHB interface.
3244 When software is doing ATA command and data transfer to
3245 IDE devices through IDE-AHB controller, some additional
3246 registers accessing to these kind of IDE-AHB controller
3247 is requierd.
3248
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003249- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00003250 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00003251 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00003252
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003253- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003254
wdenk7152b1d2003-09-05 23:19:14 +00003255 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00003256 initial data and stack; please note that this must be
3257 writable memory that is working WITHOUT special
3258 initialization, i. e. you CANNOT use normal RAM which
3259 will become available only after programming the
3260 memory controller and running certain initialization
3261 sequences.
3262
3263 U-Boot uses the following memory types:
3264 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3265 - MPC824X: data cache
3266 - PPC4xx: data cache
3267
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003268- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003269
3270 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003271 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
3272 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00003273 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02003274 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003275 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
3276 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
3277 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00003278
3279 Note:
3280 On the MPC824X (or other systems that use the data
3281 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003282 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00003283 point to an otherwise UNUSED address space between
3284 the top of RAM and the start of the PCI space.
3285
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003286- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00003287
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003288- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00003289
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003290- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00003291
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003292- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00003293
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003294- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00003295
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003296- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00003297
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003298- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00003299 SDRAM timing
3300
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003301- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00003302 periodic timer for refresh
3303
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003304- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00003305
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003306- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
3307 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
3308 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
3309 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003310 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3311
3312- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003313 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
3314 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00003315 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3316
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003317- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
3318 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00003319 Machine Mode Register and Memory Periodic Timer
3320 Prescaler definitions (SDRAM timing)
3321
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003322- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003323 enable I2C microcode relocation patch (MPC8xx);
3324 define relocation offset in DPRAM [DSP2]
3325
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003326- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01003327 enable SMC microcode relocation patch (MPC8xx);
3328 define relocation offset in DPRAM [SMC1]
3329
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003330- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00003331 enable SPI microcode relocation patch (MPC8xx);
3332 define relocation offset in DPRAM [SCC4]
3333
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003334- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00003335 Use OSCM clock mode on MBX8xx board. Be careful,
3336 wrong setting might damage your board. Read
3337 doc/README.MBX before setting this variable!
3338
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003339- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00003340 Offset of the bootmode word in DPRAM used by post
3341 (Power On Self Tests). This definition overrides
3342 #define'd default value in commproc.h resp.
3343 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00003344
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003345- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
3346 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
3347 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
3348 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
3349 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
3350 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
3351 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
3352 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02003353 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00003354
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01003355- CONFIG_PCI_DISABLE_PCIE:
3356 Disable PCI-Express on systems where it is supported but not
3357 required.
3358
Kumar Galaa09b9b62010-12-30 12:09:53 -06003359- CONFIG_SYS_SRIO:
3360 Chip has SRIO or not
3361
3362- CONFIG_SRIO1:
3363 Board has SRIO 1 port available
3364
3365- CONFIG_SRIO2:
3366 Board has SRIO 2 port available
3367
3368- CONFIG_SYS_SRIOn_MEM_VIRT:
3369 Virtual Address of SRIO port 'n' memory region
3370
3371- CONFIG_SYS_SRIOn_MEM_PHYS:
3372 Physical Address of SRIO port 'n' memory region
3373
3374- CONFIG_SYS_SRIOn_MEM_SIZE:
3375 Size of SRIO port 'n' memory region
3376
Alex Watermaneced4622011-05-19 15:08:36 -04003377- CONFIG_SYS_NDFC_16
3378 Defined to tell the NDFC that the NAND chip is using a
3379 16 bit bus.
3380
3381- CONFIG_SYS_NDFC_EBC0_CFG
3382 Sets the EBC0_CFG register for the NDFC. If not defined
3383 a default value will be used.
3384
Ben Warrenbb99ad62006-09-07 16:50:54 -04003385- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003386 Get DDR timing information from an I2C EEPROM. Common
3387 with pluggable memory modules such as SODIMMs
3388
Ben Warrenbb99ad62006-09-07 16:50:54 -04003389 SPD_EEPROM_ADDRESS
3390 I2C address of the SPD EEPROM
3391
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003392- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01003393 If SPD EEPROM is on an I2C bus other than the first
3394 one, specify here. Note that the value must resolve
3395 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04003396
York Sun1b3e3c42011-06-07 09:42:16 +08003397- CONFIG_SYS_DDR_RAW_TIMING
3398 Get DDR timing information from other than SPD. Common with
3399 soldered DDR chips onboard without SPD. DDR raw timing
3400 parameters are extracted from datasheet and hard-coded into
3401 header files or board specific files.
3402
York Sun6f5e1dc2011-09-16 13:21:35 -07003403- CONFIG_FSL_DDR_INTERACTIVE
3404 Enable interactive DDR debugging. See doc/README.fsl-ddr.
3405
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003406- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01003407 Only for 83xx systems. If specified, then DDR should
3408 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06003409
wdenkc26e4542004-04-18 10:13:26 +00003410- CONFIG_ETHER_ON_FEC[12]
3411 Define to enable FEC[12] on a 8xx series processor.
3412
3413- CONFIG_FEC[12]_PHY
3414 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00003415 to the given FEC; i. e.
3416 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00003417 means that the PHY with address 4 is connected to FEC1
3418
3419 When set to -1, means to probe for first available.
3420
3421- CONFIG_FEC[12]_PHY_NORXERR
3422 The PHY does not have a RXERR line (RMII only).
3423 (so program the FEC to ignore it).
3424
3425- CONFIG_RMII
3426 Enable RMII mode for all FECs.
3427 Note that this is a global option, we can't
3428 have one FEC in standard MII mode and another in RMII mode.
3429
wdenk5cf91d62004-04-23 20:32:05 +00003430- CONFIG_CRC32_VERIFY
3431 Add a verify option to the crc32 command.
3432 The syntax is:
3433
3434 => crc32 -v <address> <count> <crc32>
3435
3436 Where address/count indicate a memory area
3437 and crc32 is the correct crc32 which the
3438 area should have.
3439
wdenk56523f12004-07-11 17:40:54 +00003440- CONFIG_LOOPW
3441 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003442 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00003443
stroese7b466642004-12-16 18:46:55 +00003444- CONFIG_MX_CYCLIC
3445 Add the "mdc" and "mwc" memory commands. These are cyclic
3446 "md/mw" commands.
3447 Examples:
3448
wdenkefe2a4d2004-12-16 21:44:03 +00003449 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00003450 This command will print 4 bytes (10,11,12,13) each 500 ms.
3451
wdenkefe2a4d2004-12-16 21:44:03 +00003452 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00003453 This command will write 12345678 to address 100 all 10 ms.
3454
wdenkefe2a4d2004-12-16 21:44:03 +00003455 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05003456 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00003457
wdenk8aa1a2d2005-04-04 12:44:11 +00003458- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00003459 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003460 low level initializations (like setting up the memory
3461 controller) are omitted and/or U-Boot does not
3462 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00003463
Wolfgang Denk844f07d2010-11-27 23:30:56 +01003464 Normally this variable MUST NOT be defined. The only
3465 exception is when U-Boot is loaded (to RAM) by some
3466 other boot loader or by a debugger which performs
3467 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00003468
Aneesh V401bb302011-07-13 05:11:07 +00003469- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02003470 Modifies the behaviour of start.S when compiling a loader
3471 that is executed before the actual U-Boot. E.g. when
3472 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00003473
Matthias Weisserd8834a12011-03-10 21:36:32 +00003474- CONFIG_USE_ARCH_MEMCPY
3475 CONFIG_USE_ARCH_MEMSET
3476 If these options are used a optimized version of memcpy/memset will
3477 be used if available. These functions may be faster under some
3478 conditions but may increase the binary size.
3479
Timur Tabif2717b42011-11-22 09:21:25 -06003480Freescale QE/FMAN Firmware Support:
3481-----------------------------------
3482
3483The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3484loading of "firmware", which is encoded in the QE firmware binary format.
3485This firmware often needs to be loaded during U-Boot booting, so macros
3486are used to identify the storage device (NOR flash, SPI, etc) and the address
3487within that device.
3488
3489- CONFIG_SYS_QE_FMAN_FW_ADDR
3490 The address in the storage device where the firmware is located. The
3491 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3492 is also specified.
3493
3494- CONFIG_SYS_QE_FMAN_FW_LENGTH
3495 The maximum possible size of the firmware. The firmware binary format
3496 has a field that specifies the actual size of the firmware, but it
3497 might not be possible to read any part of the firmware unless some
3498 local storage is allocated to hold the entire firmware first.
3499
3500- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3501 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3502 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
3503 virtual address in NOR flash.
3504
3505- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3506 Specifies that QE/FMAN firmware is located in NAND flash.
3507 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3508
3509- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3510 Specifies that QE/FMAN firmware is located on the primary SD/MMC
3511 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3512
3513- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3514 Specifies that QE/FMAN firmware is located on the primary SPI
3515 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3516
Liu Gang292dc6c2012-03-08 00:33:18 +00003517- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3518 Specifies that QE/FMAN firmware is located in the remote (master)
3519 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3520 can be mapped from slave TLB->slave LAW->slave SRIO outbound window
3521 ->master inbound window->master LAW->the ucode address in master's
3522 NOR flash.
Timur Tabif2717b42011-11-22 09:21:25 -06003523
wdenkc6097192002-11-03 00:24:07 +00003524Building the Software:
3525======================
3526
Wolfgang Denk218ca722008-03-26 10:40:12 +01003527Building U-Boot has been tested in several native build environments
3528and in many different cross environments. Of course we cannot support
3529all possibly existing versions of cross development tools in all
3530(potentially obsolete) versions. In case of tool chain problems we
3531recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3532which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003533
Wolfgang Denk218ca722008-03-26 10:40:12 +01003534If you are not using a native environment, it is assumed that you
3535have GNU cross compiling tools available in your path. In this case,
3536you must set the environment variable CROSS_COMPILE in your shell.
3537Note that no changes to the Makefile or any other source files are
3538necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00003539
Wolfgang Denk218ca722008-03-26 10:40:12 +01003540 $ CROSS_COMPILE=ppc_4xx-
3541 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00003542
Peter Tyser2f8d3962009-03-13 18:54:51 -05003543Note: If you wish to generate Windows versions of the utilities in
3544 the tools directory you can use the MinGW toolchain
3545 (http://www.mingw.org). Set your HOST tools to the MinGW
3546 toolchain and execute 'make tools'. For example:
3547
3548 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
3549
3550 Binaries such as tools/mkimage.exe will be created which can
3551 be executed on computers running Windows.
3552
Wolfgang Denk218ca722008-03-26 10:40:12 +01003553U-Boot is intended to be simple to build. After installing the
3554sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00003555is done by typing:
3556
3557 make NAME_config
3558
Wolfgang Denk218ca722008-03-26 10:40:12 +01003559where "NAME_config" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00003560rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00003561
wdenk2729af92004-05-03 20:45:30 +00003562Note: for some board special configuration names may exist; check if
3563 additional information is available from the board vendor; for
3564 instance, the TQM823L systems are available without (standard)
3565 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003566 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00003567
wdenk2729af92004-05-03 20:45:30 +00003568 make TQM823L_config
3569 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00003570
wdenk2729af92004-05-03 20:45:30 +00003571 make TQM823L_LCD_config
3572 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00003573
wdenk2729af92004-05-03 20:45:30 +00003574 etc.
wdenkc6097192002-11-03 00:24:07 +00003575
wdenkc6097192002-11-03 00:24:07 +00003576
wdenk2729af92004-05-03 20:45:30 +00003577Finally, type "make all", and you should get some working U-Boot
3578images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00003579
wdenk2729af92004-05-03 20:45:30 +00003580- "u-boot.bin" is a raw binary image
3581- "u-boot" is an image in ELF binary format
3582- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00003583
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003584By default the build is performed locally and the objects are saved
3585in the source directory. One of the two methods can be used to change
3586this behavior and build U-Boot to some external directory:
3587
35881. Add O= to the make command line invocations:
3589
3590 make O=/tmp/build distclean
3591 make O=/tmp/build NAME_config
3592 make O=/tmp/build all
3593
35942. Set environment variable BUILD_DIR to point to the desired location:
3595
3596 export BUILD_DIR=/tmp/build
3597 make distclean
3598 make NAME_config
3599 make all
3600
3601Note that the command line "O=" setting overrides the BUILD_DIR environment
3602variable.
3603
wdenkc6097192002-11-03 00:24:07 +00003604
wdenk2729af92004-05-03 20:45:30 +00003605Please be aware that the Makefiles assume you are using GNU make, so
3606for instance on NetBSD you might need to use "gmake" instead of
3607native "make".
wdenkc6097192002-11-03 00:24:07 +00003608
wdenkc6097192002-11-03 00:24:07 +00003609
wdenk2729af92004-05-03 20:45:30 +00003610If the system board that you have is not listed, then you will need
3611to port U-Boot to your hardware platform. To do this, follow these
3612steps:
wdenkc6097192002-11-03 00:24:07 +00003613
wdenk2729af92004-05-03 20:45:30 +000036141. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00003615 "boards.cfg" file, using the existing entries as examples.
3616 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000036172. Create a new directory to hold your board specific code. Add any
3618 files you need. In your board directory, you will need at least
3619 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
36203. Create a new configuration file "include/configs/<board>.h" for
3621 your board
36223. If you're porting U-Boot to a new CPU, then also create a new
3623 directory to hold your CPU specific code. Add any files you need.
36244. Run "make <board>_config" with your new name.
36255. Type "make", and you should get a working "u-boot.srec" file
3626 to be installed on your target system.
36276. Debug and solve any problems that might arise.
3628 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00003629
wdenkc6097192002-11-03 00:24:07 +00003630
wdenk2729af92004-05-03 20:45:30 +00003631Testing of U-Boot Modifications, Ports to New Hardware, etc.:
3632==============================================================
wdenkc6097192002-11-03 00:24:07 +00003633
Wolfgang Denk218ca722008-03-26 10:40:12 +01003634If you have modified U-Boot sources (for instance added a new board
3635or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00003636provide feedback to the other developers. The feedback normally takes
3637the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01003638official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00003639
Wolfgang Denk218ca722008-03-26 10:40:12 +01003640But before you submit such a patch, please verify that your modifi-
3641cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00003642the supported boards compile WITHOUT ANY compiler warnings. To do so,
3643just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01003644for ALL supported system. Be warned, this will take a while. You can
3645select which (cross) compiler to use by passing a `CROSS_COMPILE'
3646environment variable to the script, i. e. to use the ELDK cross tools
3647you can type
wdenkc6097192002-11-03 00:24:07 +00003648
wdenk2729af92004-05-03 20:45:30 +00003649 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003650
wdenk2729af92004-05-03 20:45:30 +00003651or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00003652
wdenk2729af92004-05-03 20:45:30 +00003653 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00003654
Wolfgang Denk218ca722008-03-26 10:40:12 +01003655When using the MAKEALL script, the default behaviour is to build
3656U-Boot in the source directory. This location can be changed by
3657setting the BUILD_DIR environment variable. Also, for each target
3658built, the MAKEALL script saves two log files (<target>.ERR and
3659<target>.MAKEALL) in the <source dir>/LOG directory. This default
3660location can be changed by setting the MAKEALL_LOGDIR environment
3661variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003662
3663 export BUILD_DIR=/tmp/build
3664 export MAKEALL_LOGDIR=/tmp/log
3665 CROSS_COMPILE=ppc_8xx- MAKEALL
3666
Wolfgang Denk218ca722008-03-26 10:40:12 +01003667With the above settings build objects are saved in the /tmp/build,
3668log files are saved in the /tmp/log and the source tree remains clean
3669during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02003670
3671
wdenk2729af92004-05-03 20:45:30 +00003672See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00003673
wdenkc6097192002-11-03 00:24:07 +00003674
wdenk2729af92004-05-03 20:45:30 +00003675Monitor Commands - Overview:
3676============================
wdenkc6097192002-11-03 00:24:07 +00003677
wdenk2729af92004-05-03 20:45:30 +00003678go - start application at address 'addr'
3679run - run commands in an environment variable
3680bootm - boot application image from memory
3681bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00003682bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00003683tftpboot- boot image via network using TFTP protocol
3684 and env variables "ipaddr" and "serverip"
3685 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00003686tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00003687rarpboot- boot image via network using RARP/TFTP protocol
3688diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
3689loads - load S-Record file over serial line
3690loadb - load binary file over serial line (kermit mode)
3691md - memory display
3692mm - memory modify (auto-incrementing)
3693nm - memory modify (constant address)
3694mw - memory write (fill)
3695cp - memory copy
3696cmp - memory compare
3697crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05003698i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00003699sspi - SPI utility commands
3700base - print or set address offset
3701printenv- print environment variables
3702setenv - set environment variables
3703saveenv - save environment variables to persistent storage
3704protect - enable or disable FLASH write protection
3705erase - erase FLASH memory
3706flinfo - print FLASH memory information
3707bdinfo - print Board Info structure
3708iminfo - print header information for application image
3709coninfo - print console devices and informations
3710ide - IDE sub-system
3711loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00003712loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00003713mtest - simple RAM test
3714icache - enable or disable instruction cache
3715dcache - enable or disable data cache
3716reset - Perform RESET of the CPU
3717echo - echo args to console
3718version - print monitor version
3719help - print online help
3720? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00003721
wdenkc6097192002-11-03 00:24:07 +00003722
wdenk2729af92004-05-03 20:45:30 +00003723Monitor Commands - Detailed Description:
3724========================================
wdenkc6097192002-11-03 00:24:07 +00003725
wdenk2729af92004-05-03 20:45:30 +00003726TODO.
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk2729af92004-05-03 20:45:30 +00003728For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00003729
3730
wdenk2729af92004-05-03 20:45:30 +00003731Environment Variables:
3732======================
wdenkc6097192002-11-03 00:24:07 +00003733
wdenk2729af92004-05-03 20:45:30 +00003734U-Boot supports user configuration using Environment Variables which
3735can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003736
wdenk2729af92004-05-03 20:45:30 +00003737Environment Variables are set using "setenv", printed using
3738"printenv", and saved to Flash using "saveenv". Using "setenv"
3739without a value can be used to delete a variable from the
3740environment. As long as you don't save the environment you are
3741working with an in-memory copy. In case the Flash area containing the
3742environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003743
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003744Some configuration options can be set using Environment Variables.
3745
3746List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00003747
wdenk2729af92004-05-03 20:45:30 +00003748 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003749
wdenk2729af92004-05-03 20:45:30 +00003750 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003751
wdenk2729af92004-05-03 20:45:30 +00003752 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003753
wdenk2729af92004-05-03 20:45:30 +00003754 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003755
wdenk2729af92004-05-03 20:45:30 +00003756 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003757
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003758 bootm_low - Memory range available for image processing in the bootm
3759 command can be restricted. This variable is given as
3760 a hexadecimal number and defines lowest address allowed
3761 for use by the bootm command. See also "bootm_size"
3762 environment variable. Address defined by "bootm_low" is
3763 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00003764 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3765 bootm_mapsize.
3766
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003767 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00003768 This variable is given as a hexadecimal number and it
3769 defines the size of the memory region starting at base
3770 address bootm_low that is accessible by the Linux kernel
3771 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
3772 as the default value if it is defined, and bootm_size is
3773 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003774
3775 bootm_size - Memory range available for image processing in the bootm
3776 command can be restricted. This variable is given as
3777 a hexadecimal number and defines the size of the region
3778 allowed for use by the bootm command. See also "bootm_low"
3779 environment variable.
3780
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003781 updatefile - Location of the software update file on a TFTP server, used
3782 by the automatic software update feature. Please refer to
3783 documentation in doc/README.update for more details.
3784
wdenk2729af92004-05-03 20:45:30 +00003785 autoload - if set to "no" (any string beginning with 'n'),
3786 "bootp" will just load perform a lookup of the
3787 configuration from the BOOTP server, but not try to
3788 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003789
wdenk2729af92004-05-03 20:45:30 +00003790 autostart - if set to "yes", an image loaded using the "bootp",
3791 "rarpboot", "tftpboot" or "diskboot" commands will
3792 be automatically started (by internally calling
3793 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003794
wdenk2729af92004-05-03 20:45:30 +00003795 If set to "no", a standalone image passed to the
3796 "bootm" command will be copied to the load address
3797 (and eventually uncompressed), but NOT be started.
3798 This can be used to load and uncompress arbitrary
3799 data.
wdenkc6097192002-11-03 00:24:07 +00003800
David A. Longa28afca2011-07-09 16:40:19 -04003801 fdt_high - if set this restricts the maximum address that the
3802 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00003803 For example, if you have a system with 1 GB memory
3804 at physical address 0x10000000, while Linux kernel
3805 only recognizes the first 704 MB as low memory, you
3806 may need to set fdt_high as 0x3C000000 to have the
3807 device tree blob be copied to the maximum address
3808 of the 704 MB low memory, so that Linux kernel can
3809 access it during the boot procedure.
3810
David A. Longa28afca2011-07-09 16:40:19 -04003811 If this is set to the special value 0xFFFFFFFF then
3812 the fdt will not be copied at all on boot. For this
3813 to work it must reside in writable memory, have
3814 sufficient padding on the end of it for u-boot to
3815 add the information it needs into it, and the memory
3816 must be accessible by the kernel.
3817
Simon Glasseea63e02011-10-24 19:15:34 +00003818 fdtcontroladdr- if set this is the address of the control flattened
3819 device tree used by U-Boot when CONFIG_OF_CONTROL is
3820 defined.
3821
wdenk17ea1172004-06-06 21:51:03 +00003822 i2cfast - (PPC405GP|PPC405EP only)
3823 if set to 'y' configures Linux I2C driver for fast
3824 mode (400kHZ). This environment variable is used in
3825 initialization code. So, for changes to be effective
3826 it must be saved and board must be reset.
3827
wdenk2729af92004-05-03 20:45:30 +00003828 initrd_high - restrict positioning of initrd images:
3829 If this variable is not set, initrd images will be
3830 copied to the highest possible address in RAM; this
3831 is usually what you want since it allows for
3832 maximum initrd size. If for some reason you want to
3833 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003834 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003835 variable to a value of "no" or "off" or "0".
3836 Alternatively, you can set it to a maximum upper
3837 address to use (U-Boot will still check that it
3838 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003839
wdenk2729af92004-05-03 20:45:30 +00003840 For instance, when you have a system with 16 MB
3841 RAM, and want to reserve 4 MB from use by Linux,
3842 you can do this by adding "mem=12M" to the value of
3843 the "bootargs" variable. However, now you must make
3844 sure that the initrd image is placed in the first
3845 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003846
wdenk2729af92004-05-03 20:45:30 +00003847 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003848
wdenk2729af92004-05-03 20:45:30 +00003849 If you set initrd_high to 0xFFFFFFFF, this is an
3850 indication to U-Boot that all addresses are legal
3851 for the Linux kernel, including addresses in flash
3852 memory. In this case U-Boot will NOT COPY the
3853 ramdisk at all. This may be useful to reduce the
3854 boot time on your system, but requires that this
3855 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003856
wdenk2729af92004-05-03 20:45:30 +00003857 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003858
wdenk2729af92004-05-03 20:45:30 +00003859 loadaddr - Default load address for commands like "bootp",
3860 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003861
wdenk2729af92004-05-03 20:45:30 +00003862 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003865
wdenk2729af92004-05-03 20:45:30 +00003866 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003867
wdenk2729af92004-05-03 20:45:30 +00003868 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003869
wdenk2729af92004-05-03 20:45:30 +00003870 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003871
Mike Frysingere2a53452011-10-02 10:01:27 +00003872 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003873
Mike Frysingere2a53452011-10-02 10:01:27 +00003874 ethact - controls which interface is currently active.
3875 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00003876
Heiko Schocher48690d82010-07-20 17:45:02 +02003877 => setenv ethact FEC
3878 => ping 192.168.0.1 # traffic sent on FEC
3879 => setenv ethact SCC
3880 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00003881
Matthias Fuchse1692572008-01-17 07:45:05 +01003882 ethrotate - When set to "no" U-Boot does not go through all
3883 available network interfaces.
3884 It just stays at the currently selected interface.
3885
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003886 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00003887 either succeed or fail without retrying.
3888 When set to "once" the network operation will
3889 fail when all the available network interfaces
3890 are tried once without success.
3891 Useful on scripts which control the retry operation
3892 themselves.
wdenkc6097192002-11-03 00:24:07 +00003893
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003894 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003895
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003896 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003897 UDP source port.
3898
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003899 tftpdstport - If this is set, the value is used for TFTP's UDP
3900 destination port instead of the Well Know Port 69.
3901
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01003902 tftpblocksize - Block size to use for TFTP transfers; if not set,
3903 we use the TFTP server's default block size
3904
3905 tftptimeout - Retransmission timeout for TFTP packets (in milli-
3906 seconds, minimum value is 1000 = 1 second). Defines
3907 when a packet is considered to be lost so it has to
3908 be retransmitted. The default is 5000 = 5 seconds.
3909 Lowering this value may make downloads succeed
3910 faster in networks with high packet loss rates or
3911 with unreliable TFTP servers.
3912
3913 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003914 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003915 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003916
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003917The following image location variables contain the location of images
3918used in booting. The "Image" column gives the role of the image and is
3919not an environment variable name. The other columns are environment
3920variable names. "File Name" gives the name of the file on a TFTP
3921server, "RAM Address" gives the location in RAM the image will be
3922loaded to, and "Flash Location" gives the image's address in NOR
3923flash or offset in NAND flash.
3924
3925*Note* - these variables don't have to be defined for all boards, some
3926boards currenlty use other variables for these purposes, and some
3927boards use these variables for other purposes.
3928
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003929Image File Name RAM Address Flash Location
3930----- --------- ----------- --------------
3931u-boot u-boot u-boot_addr_r u-boot_addr
3932Linux kernel bootfile kernel_addr_r kernel_addr
3933device tree blob fdtfile fdt_addr_r fdt_addr
3934ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00003935
wdenk2729af92004-05-03 20:45:30 +00003936The following environment variables may be used and automatically
3937updated by the network boot commands ("bootp" and "rarpboot"),
3938depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003939
wdenk2729af92004-05-03 20:45:30 +00003940 bootfile - see above
3941 dnsip - IP address of your Domain Name Server
3942 dnsip2 - IP address of your secondary Domain Name Server
3943 gatewayip - IP address of the Gateway (Router) to use
3944 hostname - Target hostname
3945 ipaddr - see above
3946 netmask - Subnet Mask
3947 rootpath - Pathname of the root filesystem on the NFS server
3948 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003949
wdenka3d991b2004-04-15 21:48:45 +00003950
wdenk2729af92004-05-03 20:45:30 +00003951There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003952
wdenk2729af92004-05-03 20:45:30 +00003953 serial# - contains hardware identification information such
3954 as type string and/or serial number
3955 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003956
wdenk2729af92004-05-03 20:45:30 +00003957These variables can be set only once (usually during manufacturing of
3958the board). U-Boot refuses to delete or overwrite these variables
3959once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003960
3961
wdenk2729af92004-05-03 20:45:30 +00003962Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003963
wdenk2729af92004-05-03 20:45:30 +00003964 ver - Contains the U-Boot version string as printed
3965 with the "version" command. This variable is
3966 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003967
wdenkc6097192002-11-03 00:24:07 +00003968
wdenk2729af92004-05-03 20:45:30 +00003969Please note that changes to some configuration parameters may take
3970only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003971
stroesec1551ea2003-04-04 15:53:41 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973Command Line Parsing:
3974=====================
stroesec1551ea2003-04-04 15:53:41 +00003975
wdenk2729af92004-05-03 20:45:30 +00003976There are two different command line parsers available with U-Boot:
3977the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003978
wdenk2729af92004-05-03 20:45:30 +00003979Old, simple command line parser:
3980--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003981
wdenk2729af92004-05-03 20:45:30 +00003982- supports environment variables (through setenv / saveenv commands)
3983- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003984- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003985- special characters ('$', ';') can be escaped by prefixing with '\',
3986 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003987 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003988- You can also escape text by enclosing in single apostrophes, for example:
3989 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003990
wdenk2729af92004-05-03 20:45:30 +00003991Hush shell:
3992-----------
wdenkf07771c2003-05-28 08:06:31 +00003993
wdenk2729af92004-05-03 20:45:30 +00003994- similar to Bourne shell, with control structures like
3995 if...then...else...fi, for...do...done; while...do...done,
3996 until...do...done, ...
3997- supports environment ("global") variables (through setenv / saveenv
3998 commands) and local shell variables (through standard shell syntax
3999 "name=value"); only environment variables can be used with "run"
4000 command
wdenkf07771c2003-05-28 08:06:31 +00004001
wdenk2729af92004-05-03 20:45:30 +00004002General rules:
4003--------------
wdenkf07771c2003-05-28 08:06:31 +00004004
wdenk2729af92004-05-03 20:45:30 +00004005(1) If a command line (or an environment variable executed by a "run"
4006 command) contains several commands separated by semicolon, and
4007 one of these commands fails, then the remaining commands will be
4008 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00004009
wdenk2729af92004-05-03 20:45:30 +00004010(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004011 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00004012 command will cause "run" to terminate, i. e. the remaining
4013 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00004014
wdenk2729af92004-05-03 20:45:30 +00004015Note for Redundant Ethernet Interfaces:
4016=======================================
wdenkf07771c2003-05-28 08:06:31 +00004017
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004018Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00004019such configurations and is capable of automatic selection of a
4020"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00004021
wdenk2729af92004-05-03 20:45:30 +00004022Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4023MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4024"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00004025
wdenk2729af92004-05-03 20:45:30 +00004026If the network interface stores some valid MAC address (for instance
4027in SROM), this is used as default address if there is NO correspon-
4028ding setting in the environment; if the corresponding environment
4029variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00004030
wdenk2729af92004-05-03 20:45:30 +00004031o If the SROM has a valid MAC address, and there is no address in the
4032 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004033
wdenk2729af92004-05-03 20:45:30 +00004034o If there is no valid address in the SROM, and a definition in the
4035 environment exists, then the value from the environment variable is
4036 used.
wdenkc6097192002-11-03 00:24:07 +00004037
wdenk2729af92004-05-03 20:45:30 +00004038o If both the SROM and the environment contain a MAC address, and
4039 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004040
wdenk2729af92004-05-03 20:45:30 +00004041o If both the SROM and the environment contain a MAC address, and the
4042 addresses differ, the value from the environment is used and a
4043 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004044
wdenk2729af92004-05-03 20:45:30 +00004045o If neither SROM nor the environment contain a MAC address, an error
4046 is raised.
wdenkc6097192002-11-03 00:24:07 +00004047
Ben Warrenecee9322010-04-26 11:11:46 -07004048If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004049will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07004050may be skipped by setting the appropriate 'ethmacskip' environment variable.
4051The naming convention is as follows:
4052"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004053
wdenk2729af92004-05-03 20:45:30 +00004054Image Formats:
4055==============
wdenkc6097192002-11-03 00:24:07 +00004056
Marian Balakowicz3310c542008-03-12 12:13:13 +01004057U-Boot is capable of booting (and performing other auxiliary operations on)
4058images in two formats:
4059
4060New uImage format (FIT)
4061-----------------------
4062
4063Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4064to Flattened Device Tree). It allows the use of images with multiple
4065components (several kernels, ramdisks, etc.), with contents protected by
4066SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4067
4068
4069Old uImage format
4070-----------------
4071
4072Old image format is based on binary files which can be basically anything,
4073preceded by a special header; see the definitions in include/image.h for
4074details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004075
wdenk2729af92004-05-03 20:45:30 +00004076* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4077 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05004078 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4079 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4080 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02004081* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00004082 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4083 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00004084* Compression Type (uncompressed, gzip, bzip2)
4085* Load Address
4086* Entry Point
4087* Image Name
4088* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00004089
wdenk2729af92004-05-03 20:45:30 +00004090The header is marked by a special Magic Number, and both the header
4091and the data portions of the image are secured against corruption by
4092CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00004093
wdenkc6097192002-11-03 00:24:07 +00004094
wdenk2729af92004-05-03 20:45:30 +00004095Linux Support:
4096==============
wdenkc6097192002-11-03 00:24:07 +00004097
wdenk2729af92004-05-03 20:45:30 +00004098Although U-Boot should support any OS or standalone application
4099easily, the main focus has always been on Linux during the design of
4100U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004101
wdenk2729af92004-05-03 20:45:30 +00004102U-Boot includes many features that so far have been part of some
4103special "boot loader" code within the Linux kernel. Also, any
4104"initrd" images to be used are no longer part of one big Linux image;
4105instead, kernel and "initrd" are separate images. This implementation
4106serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00004107
wdenk2729af92004-05-03 20:45:30 +00004108- the same features can be used for other OS or standalone
4109 applications (for instance: using compressed images to reduce the
4110 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00004111
wdenk2729af92004-05-03 20:45:30 +00004112- it becomes much easier to port new Linux kernel versions because
4113 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00004114
wdenk2729af92004-05-03 20:45:30 +00004115- the same Linux kernel image can now be used with different "initrd"
4116 images; of course this also means that different kernel images can
4117 be run with the same "initrd". This makes testing easier (you don't
4118 have to build a new "zImage.initrd" Linux image when you just
4119 change a file in your "initrd"). Also, a field-upgrade of the
4120 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00004121
wdenkc6097192002-11-03 00:24:07 +00004122
wdenk2729af92004-05-03 20:45:30 +00004123Linux HOWTO:
4124============
wdenkc6097192002-11-03 00:24:07 +00004125
wdenk2729af92004-05-03 20:45:30 +00004126Porting Linux to U-Boot based systems:
4127---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004128
wdenk2729af92004-05-03 20:45:30 +00004129U-Boot cannot save you from doing all the necessary modifications to
4130configure the Linux device drivers for use with your target hardware
4131(no, we don't intend to provide a full virtual machine interface to
4132Linux :-).
wdenkc6097192002-11-03 00:24:07 +00004133
Stefan Roesea47a12b2010-04-15 16:07:28 +02004134But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00004135
wdenk2729af92004-05-03 20:45:30 +00004136Just make sure your machine specific header file (for instance
4137include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02004138Information structure as we define in include/asm-<arch>/u-boot.h,
4139and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004140as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00004141
wdenkc6097192002-11-03 00:24:07 +00004142
wdenk2729af92004-05-03 20:45:30 +00004143Configuring the Linux kernel:
4144-----------------------------
wdenkc6097192002-11-03 00:24:07 +00004145
wdenk2729af92004-05-03 20:45:30 +00004146No specific requirements for U-Boot. Make sure you have some root
4147device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00004148
wdenkc6097192002-11-03 00:24:07 +00004149
wdenk2729af92004-05-03 20:45:30 +00004150Building a Linux Image:
4151-----------------------
wdenkc6097192002-11-03 00:24:07 +00004152
wdenk2729af92004-05-03 20:45:30 +00004153With U-Boot, "normal" build targets like "zImage" or "bzImage" are
4154not used. If you use recent kernel source, a new build target
4155"uImage" will exist which automatically builds an image usable by
4156U-Boot. Most older kernels also have support for a "pImage" target,
4157which was introduced for our predecessor project PPCBoot and uses a
4158100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00004159
wdenk2729af92004-05-03 20:45:30 +00004160Example:
wdenkc6097192002-11-03 00:24:07 +00004161
wdenk2729af92004-05-03 20:45:30 +00004162 make TQM850L_config
4163 make oldconfig
4164 make dep
4165 make uImage
wdenkc6097192002-11-03 00:24:07 +00004166
wdenk2729af92004-05-03 20:45:30 +00004167The "uImage" build target uses a special tool (in 'tools/mkimage') to
4168encapsulate a compressed Linux kernel image with header information,
4169CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00004170
wdenk2729af92004-05-03 20:45:30 +00004171* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00004172
wdenk2729af92004-05-03 20:45:30 +00004173* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00004174
wdenk2729af92004-05-03 20:45:30 +00004175 ${CROSS_COMPILE}-objcopy -O binary \
4176 -R .note -R .comment \
4177 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00004178
wdenk2729af92004-05-03 20:45:30 +00004179* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00004180
wdenk2729af92004-05-03 20:45:30 +00004181 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00004182
wdenk2729af92004-05-03 20:45:30 +00004183* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00004184
wdenk2729af92004-05-03 20:45:30 +00004185 mkimage -A ppc -O linux -T kernel -C gzip \
4186 -a 0 -e 0 -n "Linux Kernel Image" \
4187 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00004188
wdenk24ee89b2002-11-03 17:56:27 +00004189
wdenk2729af92004-05-03 20:45:30 +00004190The "mkimage" tool can also be used to create ramdisk images for use
4191with U-Boot, either separated from the Linux kernel image, or
4192combined into one file. "mkimage" encapsulates the images with a 64
4193byte header containing information about target architecture,
4194operating system, image type, compression method, entry points, time
4195stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00004196
wdenk2729af92004-05-03 20:45:30 +00004197"mkimage" can be called in two ways: to verify existing images and
4198print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00004199
wdenk2729af92004-05-03 20:45:30 +00004200In the first form (with "-l" option) mkimage lists the information
4201contained in the header of an existing U-Boot image; this includes
4202checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00004203
wdenk2729af92004-05-03 20:45:30 +00004204 tools/mkimage -l image
4205 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00004206
wdenk2729af92004-05-03 20:45:30 +00004207The second form (with "-d" option) is used to build a U-Boot image
4208from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00004209
wdenk2729af92004-05-03 20:45:30 +00004210 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4211 -n name -d data_file image
4212 -A ==> set architecture to 'arch'
4213 -O ==> set operating system to 'os'
4214 -T ==> set image type to 'type'
4215 -C ==> set compression type 'comp'
4216 -a ==> set load address to 'addr' (hex)
4217 -e ==> set entry point to 'ep' (hex)
4218 -n ==> set image name to 'name'
4219 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00004220
wdenk69459792004-05-29 16:53:29 +00004221Right now, all Linux kernels for PowerPC systems use the same load
4222address (0x00000000), but the entry point address depends on the
4223kernel version:
wdenkc6097192002-11-03 00:24:07 +00004224
wdenk2729af92004-05-03 20:45:30 +00004225- 2.2.x kernels have the entry point at 0x0000000C,
4226- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00004227
wdenk2729af92004-05-03 20:45:30 +00004228So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00004229
wdenk2729af92004-05-03 20:45:30 +00004230 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4231 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004232 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00004233 > examples/uImage.TQM850L
4234 Image Name: 2.4.4 kernel for TQM850L
4235 Created: Wed Jul 19 02:34:59 2000
4236 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4237 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4238 Load Address: 0x00000000
4239 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004240
wdenk2729af92004-05-03 20:45:30 +00004241To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00004242
wdenk2729af92004-05-03 20:45:30 +00004243 -> tools/mkimage -l examples/uImage.TQM850L
4244 Image Name: 2.4.4 kernel for TQM850L
4245 Created: Wed Jul 19 02:34:59 2000
4246 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4247 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
4248 Load Address: 0x00000000
4249 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004250
wdenk2729af92004-05-03 20:45:30 +00004251NOTE: for embedded systems where boot time is critical you can trade
4252speed for memory and install an UNCOMPRESSED image instead: this
4253needs more space in Flash, but boots much faster since it does not
4254need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00004255
Stefan Roesea47a12b2010-04-15 16:07:28 +02004256 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00004257 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
4258 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02004259 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00004260 > examples/uImage.TQM850L-uncompressed
4261 Image Name: 2.4.4 kernel for TQM850L
4262 Created: Wed Jul 19 02:34:59 2000
4263 Image Type: PowerPC Linux Kernel Image (uncompressed)
4264 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
4265 Load Address: 0x00000000
4266 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004267
wdenkc6097192002-11-03 00:24:07 +00004268
wdenk2729af92004-05-03 20:45:30 +00004269Similar you can build U-Boot images from a 'ramdisk.image.gz' file
4270when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00004271
wdenk2729af92004-05-03 20:45:30 +00004272 -> tools/mkimage -n 'Simple Ramdisk Image' \
4273 > -A ppc -O linux -T ramdisk -C gzip \
4274 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4275 Image Name: Simple Ramdisk Image
4276 Created: Wed Jan 12 14:01:50 2000
4277 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4278 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
4279 Load Address: 0x00000000
4280 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00004281
wdenkdb01a2e2004-04-15 23:14:49 +00004282
wdenk2729af92004-05-03 20:45:30 +00004283Installing a Linux Image:
4284-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00004285
wdenk2729af92004-05-03 20:45:30 +00004286To downloading a U-Boot image over the serial (console) interface,
4287you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00004288
wdenk2729af92004-05-03 20:45:30 +00004289 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00004290
wdenk2729af92004-05-03 20:45:30 +00004291The 'objcopy' does not understand the information in the U-Boot
4292image header, so the resulting S-Record file will be relative to
4293address 0x00000000. To load it to a given address, you need to
4294specify the target address as 'offset' parameter with the 'loads'
4295command.
wdenkc6097192002-11-03 00:24:07 +00004296
wdenk2729af92004-05-03 20:45:30 +00004297Example: install the image to address 0x40100000 (which on the
4298TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00004299
wdenk2729af92004-05-03 20:45:30 +00004300 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00004301
wdenk2729af92004-05-03 20:45:30 +00004302 .......... done
4303 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00004304
wdenk2729af92004-05-03 20:45:30 +00004305 => loads 40100000
4306 ## Ready for S-Record download ...
4307 ~>examples/image.srec
4308 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4309 ...
4310 15989 15990 15991 15992
4311 [file transfer complete]
4312 [connected]
4313 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00004314
4315
wdenk2729af92004-05-03 20:45:30 +00004316You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01004317this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00004318corruption happened:
wdenkc6097192002-11-03 00:24:07 +00004319
wdenk2729af92004-05-03 20:45:30 +00004320 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00004321
wdenk2729af92004-05-03 20:45:30 +00004322 ## Checking Image at 40100000 ...
4323 Image Name: 2.2.13 for initrd on TQM850L
4324 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4325 Data Size: 335725 Bytes = 327 kB = 0 MB
4326 Load Address: 00000000
4327 Entry Point: 0000000c
4328 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004329
4330
wdenk2729af92004-05-03 20:45:30 +00004331Boot Linux:
4332-----------
wdenkc6097192002-11-03 00:24:07 +00004333
wdenk2729af92004-05-03 20:45:30 +00004334The "bootm" command is used to boot an application that is stored in
4335memory (RAM or Flash). In case of a Linux kernel image, the contents
4336of the "bootargs" environment variable is passed to the kernel as
4337parameters. You can check and modify this variable using the
4338"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00004339
4340
wdenk2729af92004-05-03 20:45:30 +00004341 => printenv bootargs
4342 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00004343
wdenk2729af92004-05-03 20:45:30 +00004344 => 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 +00004345
wdenk2729af92004-05-03 20:45:30 +00004346 => printenv bootargs
4347 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 +00004348
wdenk2729af92004-05-03 20:45:30 +00004349 => bootm 40020000
4350 ## Booting Linux kernel at 40020000 ...
4351 Image Name: 2.2.13 for NFS on TQM850L
4352 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4353 Data Size: 381681 Bytes = 372 kB = 0 MB
4354 Load Address: 00000000
4355 Entry Point: 0000000c
4356 Verifying Checksum ... OK
4357 Uncompressing Kernel Image ... OK
4358 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
4359 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4360 time_init: decrementer frequency = 187500000/60
4361 Calibrating delay loop... 49.77 BogoMIPS
4362 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4363 ...
wdenkc6097192002-11-03 00:24:07 +00004364
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004365If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00004366the memory addresses of both the kernel and the initrd image (PPBCOOT
4367format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00004368
wdenk2729af92004-05-03 20:45:30 +00004369 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00004370
wdenk2729af92004-05-03 20:45:30 +00004371 ## Checking Image at 40100000 ...
4372 Image Name: 2.2.13 for initrd on TQM850L
4373 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4374 Data Size: 335725 Bytes = 327 kB = 0 MB
4375 Load Address: 00000000
4376 Entry Point: 0000000c
4377 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004378
wdenk2729af92004-05-03 20:45:30 +00004379 ## Checking Image at 40200000 ...
4380 Image Name: Simple Ramdisk Image
4381 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4382 Data Size: 566530 Bytes = 553 kB = 0 MB
4383 Load Address: 00000000
4384 Entry Point: 00000000
4385 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00004386
wdenk2729af92004-05-03 20:45:30 +00004387 => bootm 40100000 40200000
4388 ## Booting Linux kernel at 40100000 ...
4389 Image Name: 2.2.13 for initrd on TQM850L
4390 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4391 Data Size: 335725 Bytes = 327 kB = 0 MB
4392 Load Address: 00000000
4393 Entry Point: 0000000c
4394 Verifying Checksum ... OK
4395 Uncompressing Kernel Image ... OK
4396 ## Loading RAMDisk Image at 40200000 ...
4397 Image Name: Simple Ramdisk Image
4398 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
4399 Data Size: 566530 Bytes = 553 kB = 0 MB
4400 Load Address: 00000000
4401 Entry Point: 00000000
4402 Verifying Checksum ... OK
4403 Loading Ramdisk ... OK
4404 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
4405 Boot arguments: root=/dev/ram
4406 time_init: decrementer frequency = 187500000/60
4407 Calibrating delay loop... 49.77 BogoMIPS
4408 ...
4409 RAMDISK: Compressed image found at block 0
4410 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00004411
wdenk2729af92004-05-03 20:45:30 +00004412 bash#
wdenkc6097192002-11-03 00:24:07 +00004413
Matthew McClintock02677682006-06-28 10:41:37 -05004414Boot Linux and pass a flat device tree:
4415-----------
4416
4417First, U-Boot must be compiled with the appropriate defines. See the section
4418titled "Linux Kernel Interface" above for a more in depth explanation. The
4419following is an example of how to start a kernel and pass an updated
4420flat device tree:
4421
4422=> print oftaddr
4423oftaddr=0x300000
4424=> print oft
4425oft=oftrees/mpc8540ads.dtb
4426=> tftp $oftaddr $oft
4427Speed: 1000, full duplex
4428Using TSEC0 device
4429TFTP from server 192.168.1.1; our IP address is 192.168.1.101
4430Filename 'oftrees/mpc8540ads.dtb'.
4431Load address: 0x300000
4432Loading: #
4433done
4434Bytes transferred = 4106 (100a hex)
4435=> tftp $loadaddr $bootfile
4436Speed: 1000, full duplex
4437Using TSEC0 device
4438TFTP from server 192.168.1.1; our IP address is 192.168.1.2
4439Filename 'uImage'.
4440Load address: 0x200000
4441Loading:############
4442done
4443Bytes transferred = 1029407 (fb51f hex)
4444=> print loadaddr
4445loadaddr=200000
4446=> print oftaddr
4447oftaddr=0x300000
4448=> bootm $loadaddr - $oftaddr
4449## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01004450 Image Name: Linux-2.6.17-dirty
4451 Image Type: PowerPC Linux Kernel Image (gzip compressed)
4452 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05004453 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01004454 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05004455 Verifying Checksum ... OK
4456 Uncompressing Kernel Image ... OK
4457Booting using flat device tree at 0x300000
4458Using MPC85xx ADS machine description
4459Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
4460[snip]
4461
4462
wdenk2729af92004-05-03 20:45:30 +00004463More About U-Boot Image Types:
4464------------------------------
wdenk6069ff22003-02-28 00:49:47 +00004465
wdenk2729af92004-05-03 20:45:30 +00004466U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00004467
wdenk2729af92004-05-03 20:45:30 +00004468 "Standalone Programs" are directly runnable in the environment
4469 provided by U-Boot; it is expected that (if they behave
4470 well) you can continue to work in U-Boot after return from
4471 the Standalone Program.
4472 "OS Kernel Images" are usually images of some Embedded OS which
4473 will take over control completely. Usually these programs
4474 will install their own set of exception handlers, device
4475 drivers, set up the MMU, etc. - this means, that you cannot
4476 expect to re-enter U-Boot except by resetting the CPU.
4477 "RAMDisk Images" are more or less just data blocks, and their
4478 parameters (address, size) are passed to an OS kernel that is
4479 being started.
4480 "Multi-File Images" contain several images, typically an OS
4481 (Linux) kernel image and one or more data images like
4482 RAMDisks. This construct is useful for instance when you want
4483 to boot over the network using BOOTP etc., where the boot
4484 server provides just a single image file, but you want to get
4485 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00004486
wdenk2729af92004-05-03 20:45:30 +00004487 "Multi-File Images" start with a list of image sizes, each
4488 image size (in bytes) specified by an "uint32_t" in network
4489 byte order. This list is terminated by an "(uint32_t)0".
4490 Immediately after the terminating 0 follow the images, one by
4491 one, all aligned on "uint32_t" boundaries (size rounded up to
4492 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00004493
wdenk2729af92004-05-03 20:45:30 +00004494 "Firmware Images" are binary images containing firmware (like
4495 U-Boot or FPGA images) which usually will be programmed to
4496 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00004497
wdenk2729af92004-05-03 20:45:30 +00004498 "Script files" are command sequences that will be executed by
4499 U-Boot's command interpreter; this feature is especially
4500 useful when you configure U-Boot to use a real shell (hush)
4501 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00004502
Marek Vasut44f074c2012-03-14 21:52:45 +00004503Booting the Linux zImage:
4504-------------------------
4505
4506On some platforms, it's possible to boot Linux zImage. This is done
4507using the "bootz" command. The syntax of "bootz" command is the same
4508as the syntax of "bootm" command.
4509
Marek Vasut017e1f32012-03-18 11:47:58 +00004510Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4511kernel with raw initrd images. The syntax is slightly different, the
4512address of the initrd must be augmented by it's size, in the following
4513format: "<initrd addres>:<initrd size>".
4514
wdenkc6097192002-11-03 00:24:07 +00004515
wdenk2729af92004-05-03 20:45:30 +00004516Standalone HOWTO:
4517=================
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk2729af92004-05-03 20:45:30 +00004519One of the features of U-Boot is that you can dynamically load and
4520run "standalone" applications, which can use some resources of
4521U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00004522
wdenk2729af92004-05-03 20:45:30 +00004523Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00004524
wdenk2729af92004-05-03 20:45:30 +00004525"Hello World" Demo:
4526-------------------
wdenkc6097192002-11-03 00:24:07 +00004527
wdenk2729af92004-05-03 20:45:30 +00004528'examples/hello_world.c' contains a small "Hello World" Demo
4529application; it is automatically compiled when you build U-Boot.
4530It's configured to run at address 0x00040004, so you can play with it
4531like that:
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk2729af92004-05-03 20:45:30 +00004533 => loads
4534 ## Ready for S-Record download ...
4535 ~>examples/hello_world.srec
4536 1 2 3 4 5 6 7 8 9 10 11 ...
4537 [file transfer complete]
4538 [connected]
4539 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004540
wdenk2729af92004-05-03 20:45:30 +00004541 => go 40004 Hello World! This is a test.
4542 ## Starting application at 0x00040004 ...
4543 Hello World
4544 argc = 7
4545 argv[0] = "40004"
4546 argv[1] = "Hello"
4547 argv[2] = "World!"
4548 argv[3] = "This"
4549 argv[4] = "is"
4550 argv[5] = "a"
4551 argv[6] = "test."
4552 argv[7] = "<NULL>"
4553 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk2729af92004-05-03 20:45:30 +00004555 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004556
wdenk2729af92004-05-03 20:45:30 +00004557Another example, which demonstrates how to register a CPM interrupt
4558handler with the U-Boot code, can be found in 'examples/timer.c'.
4559Here, a CPM timer is set up to generate an interrupt every second.
4560The interrupt service routine is trivial, just printing a '.'
4561character, but this is just a demo program. The application can be
4562controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00004563
wdenk2729af92004-05-03 20:45:30 +00004564 ? - print current values og the CPM Timer registers
4565 b - enable interrupts and start timer
4566 e - stop timer and disable interrupts
4567 q - quit application
wdenkc6097192002-11-03 00:24:07 +00004568
wdenk2729af92004-05-03 20:45:30 +00004569 => loads
4570 ## Ready for S-Record download ...
4571 ~>examples/timer.srec
4572 1 2 3 4 5 6 7 8 9 10 11 ...
4573 [file transfer complete]
4574 [connected]
4575 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00004576
wdenk2729af92004-05-03 20:45:30 +00004577 => go 40004
4578 ## Starting application at 0x00040004 ...
4579 TIMERS=0xfff00980
4580 Using timer 1
4581 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk2729af92004-05-03 20:45:30 +00004583Hit 'b':
4584 [q, b, e, ?] Set interval 1000000 us
4585 Enabling timer
4586Hit '?':
4587 [q, b, e, ?] ........
4588 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4589Hit '?':
4590 [q, b, e, ?] .
4591 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4592Hit '?':
4593 [q, b, e, ?] .
4594 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4595Hit '?':
4596 [q, b, e, ?] .
4597 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4598Hit 'e':
4599 [q, b, e, ?] ...Stopping timer
4600Hit 'q':
4601 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00004602
4603
wdenk2729af92004-05-03 20:45:30 +00004604Minicom warning:
4605================
wdenk85ec0bc2003-03-31 16:34:49 +00004606
wdenk2729af92004-05-03 20:45:30 +00004607Over time, many people have reported problems when trying to use the
4608"minicom" terminal emulation program for serial download. I (wd)
4609consider minicom to be broken, and recommend not to use it. Under
4610Unix, I recommend to use C-Kermit for general purpose use (and
4611especially for kermit binary protocol download ("loadb" command), and
4612use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00004613
wdenk2729af92004-05-03 20:45:30 +00004614Nevertheless, if you absolutely want to use it try adding this
4615configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00004616
wdenk2729af92004-05-03 20:45:30 +00004617 Name Program Name U/D FullScr IO-Red. Multi
4618 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
4619 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00004620
4621
wdenk2729af92004-05-03 20:45:30 +00004622NetBSD Notes:
4623=============
wdenkc6097192002-11-03 00:24:07 +00004624
wdenk2729af92004-05-03 20:45:30 +00004625Starting at version 0.9.2, U-Boot supports NetBSD both as host
4626(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00004627
wdenk2729af92004-05-03 20:45:30 +00004628Building requires a cross environment; it is known to work on
4629NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4630need gmake since the Makefiles are not compatible with BSD make).
4631Note that the cross-powerpc package does not install include files;
4632attempting to build U-Boot will fail because <machine/ansi.h> is
4633missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk2729af92004-05-03 20:45:30 +00004635 # cd /usr/pkg/cross/powerpc-netbsd/include
4636 # mkdir powerpc
4637 # ln -s powerpc machine
4638 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4639 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00004640
wdenk2729af92004-05-03 20:45:30 +00004641Native builds *don't* work due to incompatibilities between native
4642and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00004643
wdenk2729af92004-05-03 20:45:30 +00004644Booting assumes that (the first part of) the image booted is a
4645stage-2 loader which in turn loads and then invokes the kernel
4646proper. Loader sources will eventually appear in the NetBSD source
4647tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00004648meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00004649
4650
wdenk2729af92004-05-03 20:45:30 +00004651Implementation Internals:
4652=========================
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk2729af92004-05-03 20:45:30 +00004654The following is not intended to be a complete description of every
4655implementation detail. However, it should help to understand the
4656inner workings of U-Boot and make it easier to port it to custom
4657hardware.
wdenkc6097192002-11-03 00:24:07 +00004658
4659
wdenk2729af92004-05-03 20:45:30 +00004660Initial Stack, Global Data:
4661---------------------------
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk2729af92004-05-03 20:45:30 +00004663The implementation of U-Boot is complicated by the fact that U-Boot
4664starts running out of ROM (flash memory), usually without access to
4665system RAM (because the memory controller is not initialized yet).
4666This means that we don't have writable Data or BSS segments, and BSS
4667is not initialized as zero. To be able to get a C environment working
4668at all, we have to allocate at least a minimal stack. Implementation
4669options for this are defined and restricted by the CPU used: Some CPU
4670models provide on-chip memory (like the IMMR area on MPC8xx and
4671MPC826x processors), on others (parts of) the data cache can be
4672locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00004673
Wolfgang Denk218ca722008-03-26 10:40:12 +01004674 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01004675 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00004676
wdenk2729af92004-05-03 20:45:30 +00004677 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
4678 From: "Chris Hallinan" <clh@net1plus.com>
4679 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
4680 ...
wdenk43d96162003-03-06 00:02:04 +00004681
wdenk2729af92004-05-03 20:45:30 +00004682 Correct me if I'm wrong, folks, but the way I understand it
4683 is this: Using DCACHE as initial RAM for Stack, etc, does not
4684 require any physical RAM backing up the cache. The cleverness
4685 is that the cache is being used as a temporary supply of
4686 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004687 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00004688 can see how this works by studying the cache architecture and
4689 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00004690
wdenk2729af92004-05-03 20:45:30 +00004691 OCM is On Chip Memory, which I believe the 405GP has 4K. It
4692 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004693 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00004694 option should work for you. Using CS 4 should be fine if your
4695 board designers haven't used it for something that would
4696 cause you grief during the initial boot! It is frequently not
4697 used.
wdenk43d96162003-03-06 00:02:04 +00004698
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004699 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00004700 with your processor/board/system design. The default value
4701 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02004702 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00004703 than your SDRAM module. If you have a 64MB SDRAM module, set
4704 it above 400_0000. Just make sure your board has no resources
4705 that are supposed to respond to that address! That code in
4706 start.S has been around a while and should work as is when
4707 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00004708
wdenk2729af92004-05-03 20:45:30 +00004709 -Chris Hallinan
4710 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00004711
wdenk2729af92004-05-03 20:45:30 +00004712It is essential to remember this, since it has some impact on the C
4713code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00004714
wdenk2729af92004-05-03 20:45:30 +00004715* Initialized global data (data segment) is read-only. Do not attempt
4716 to write it.
wdenkc6097192002-11-03 00:24:07 +00004717
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004718* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00004719 as zero data - BSS segment) at all - this is undefined, initiali-
4720 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00004721
wdenk2729af92004-05-03 20:45:30 +00004722* Stack space is very limited. Avoid big data buffers or things like
4723 that.
wdenkc6097192002-11-03 00:24:07 +00004724
wdenk2729af92004-05-03 20:45:30 +00004725Having only the stack as writable memory limits means we cannot use
4726normal global data to share information beween the code. But it
4727turned out that the implementation of U-Boot can be greatly
4728simplified by making a global data structure (gd_t) available to all
4729functions. We could pass a pointer to this data as argument to _all_
4730functions, but this would bloat the code. Instead we use a feature of
4731the GCC compiler (Global Register Variables) to share the data: we
4732place a pointer (gd) to the global data into a register which we
4733reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00004734
wdenk2729af92004-05-03 20:45:30 +00004735When choosing a register for such a purpose we are restricted by the
4736relevant (E)ABI specifications for the current architecture, and by
4737GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00004738
wdenk2729af92004-05-03 20:45:30 +00004739For PowerPC, the following registers have specific use:
4740 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01004741 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00004742 R3-R4: parameter passing and return values
4743 R5-R10: parameter passing
4744 R13: small data area pointer
4745 R30: GOT pointer
4746 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00004747
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01004748 (U-Boot also uses R12 as internal GOT pointer. r12
4749 is a volatile register so r12 needs to be reset when
4750 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00004751
Wolfgang Denke7670f62008-02-14 22:43:22 +01004752 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004753
wdenk2729af92004-05-03 20:45:30 +00004754 Note: on PPC, we could use a static initializer (since the
4755 address of the global data structure is known at compile time),
4756 but it turned out that reserving a register results in somewhat
4757 smaller code - although the code savings are not that big (on
4758 average for all boards 752 bytes for the whole U-Boot image,
4759 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00004760
Robin Getzc4db3352009-08-17 15:23:02 +00004761On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004762 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
4763
Robin Getzc4db3352009-08-17 15:23:02 +00004764 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05004765
wdenk2729af92004-05-03 20:45:30 +00004766On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00004767
wdenk2729af92004-05-03 20:45:30 +00004768 R0: function argument word/integer result
4769 R1-R3: function argument word
4770 R9: GOT pointer
4771 R10: stack limit (used only if stack checking if enabled)
4772 R11: argument (frame) pointer
4773 R12: temporary workspace
4774 R13: stack pointer
4775 R14: link register
4776 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00004777
wdenk2729af92004-05-03 20:45:30 +00004778 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00004779
Thomas Chou0df01fd2010-05-21 11:08:03 +08004780On Nios II, the ABI is documented here:
4781 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
4782
4783 ==> U-Boot will use gp to hold a pointer to the global data
4784
4785 Note: on Nios II, we give "-G0" option to gcc and don't use gp
4786 to access small data sections, so gp is free.
4787
Macpaul Linafc1ce82011-10-19 20:41:11 +00004788On NDS32, the following registers are used:
4789
4790 R0-R1: argument/return
4791 R2-R5: argument
4792 R15: temporary register for assembler
4793 R16: trampoline register
4794 R28: frame pointer (FP)
4795 R29: global pointer (GP)
4796 R30: link register (LP)
4797 R31: stack pointer (SP)
4798 PC: program counter (PC)
4799
4800 ==> U-Boot will use R10 to hold a pointer to the global data
4801
Wolfgang Denkd87080b2006-03-31 18:32:53 +02004802NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4803or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00004804
wdenk2729af92004-05-03 20:45:30 +00004805Memory Management:
4806------------------
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk2729af92004-05-03 20:45:30 +00004808U-Boot runs in system state and uses physical addresses, i.e. the
4809MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00004810
wdenk2729af92004-05-03 20:45:30 +00004811The available memory is mapped to fixed addresses using the memory
4812controller. In this process, a contiguous block is formed for each
4813memory type (Flash, SDRAM, SRAM), even when it consists of several
4814physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00004815
wdenk2729af92004-05-03 20:45:30 +00004816U-Boot is installed in the first 128 kB of the first Flash bank (on
4817TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4818booting and sizing and initializing DRAM, the code relocates itself
4819to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004820memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00004821configuration setting]. Below that, a structure with global Board
4822Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00004823
wdenk2729af92004-05-03 20:45:30 +00004824Additionally, some exception handler code is copied to the low 8 kB
4825of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00004826
wdenk2729af92004-05-03 20:45:30 +00004827So a typical memory configuration with 16 MB of DRAM could look like
4828this:
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk2729af92004-05-03 20:45:30 +00004830 0x0000 0000 Exception Vector code
4831 :
4832 0x0000 1FFF
4833 0x0000 2000 Free for Application Use
4834 :
4835 :
wdenkc6097192002-11-03 00:24:07 +00004836
wdenk2729af92004-05-03 20:45:30 +00004837 :
4838 :
4839 0x00FB FF20 Monitor Stack (Growing downward)
4840 0x00FB FFAC Board Info Data and permanent copy of global data
4841 0x00FC 0000 Malloc Arena
4842 :
4843 0x00FD FFFF
4844 0x00FE 0000 RAM Copy of Monitor Code
4845 ... eventually: LCD or video framebuffer
4846 ... eventually: pRAM (Protected RAM - unchanged by reset)
4847 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004848
4849
wdenk2729af92004-05-03 20:45:30 +00004850System Initialization:
4851----------------------
wdenkc6097192002-11-03 00:24:07 +00004852
wdenk2729af92004-05-03 20:45:30 +00004853In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004854(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004855configuration for CS0# this is a mirror of the onboard Flash memory.
4856To be able to re-map memory U-Boot then jumps to its link address.
4857To be able to implement the initialization code in C, a (small!)
4858initial stack is set up in the internal Dual Ported RAM (in case CPUs
4859which provide such a feature like MPC8xx or MPC8260), or in a locked
4860part of the data cache. After that, U-Boot initializes the CPU core,
4861the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004862
wdenk2729af92004-05-03 20:45:30 +00004863Next, all (potentially) available memory banks are mapped using a
4864preliminary mapping. For example, we put them on 512 MB boundaries
4865(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4866on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4867programmed for SDRAM access. Using the temporary configuration, a
4868simple memory test is run that determines the size of the SDRAM
4869banks.
wdenkc6097192002-11-03 00:24:07 +00004870
wdenk2729af92004-05-03 20:45:30 +00004871When there is more than one SDRAM bank, and the banks are of
4872different size, the largest is mapped first. For equal size, the first
4873bank (CS2#) is mapped first. The first mapping is always for address
48740x00000000, with any additional banks following immediately to create
4875contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004876
wdenk2729af92004-05-03 20:45:30 +00004877Then, the monitor installs itself at the upper end of the SDRAM area
4878and allocates memory for use by malloc() and for the global Board
4879Info data; also, the exception vector code is copied to the low RAM
4880pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk2729af92004-05-03 20:45:30 +00004882Only after this relocation will you have a "normal" C environment;
4883until that you are restricted in several ways, mostly because you are
4884running from ROM, and because the code will have to be relocated to a
4885new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004886
4887
wdenk2729af92004-05-03 20:45:30 +00004888U-Boot Porting Guide:
4889----------------------
wdenkc6097192002-11-03 00:24:07 +00004890
wdenk2729af92004-05-03 20:45:30 +00004891[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4892list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004893
4894
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004895int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004896{
4897 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004898
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004899 signal(SIGALRM, no_more_time);
4900 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004901
wdenk2729af92004-05-03 20:45:30 +00004902 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004903 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004904 return 0;
4905 }
4906
wdenk2729af92004-05-03 20:45:30 +00004907 Download latest U-Boot source;
4908
Wolfgang Denk06682362008-12-30 22:56:11 +01004909 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004910
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004911 if (clueless)
4912 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004913
wdenk2729af92004-05-03 20:45:30 +00004914 while (learning) {
4915 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004916 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4917 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004918 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004919 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004920 }
wdenkc6097192002-11-03 00:24:07 +00004921
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004922 if (available_money > toLocalCurrency ($2500))
4923 Buy a BDI3000;
4924 else
wdenk2729af92004-05-03 20:45:30 +00004925 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004926
4927 if (a similar board exists) { /* hopefully... */
4928 cp -a board/<similar> board/<myboard>
4929 cp include/configs/<similar>.h include/configs/<myboard>.h
4930 } else {
4931 Create your own board support subdirectory;
4932 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004933 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004934 Edit new board/<myboard> files
4935 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004936
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004937 while (!accepted) {
4938 while (!running) {
4939 do {
4940 Add / modify source code;
4941 } until (compiles);
4942 Debug;
4943 if (clueless)
4944 email("Hi, I am having problems...");
4945 }
4946 Send patch file to the U-Boot email list;
4947 if (reasonable critiques)
4948 Incorporate improvements from email list code review;
4949 else
4950 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004951 }
wdenkc6097192002-11-03 00:24:07 +00004952
wdenk2729af92004-05-03 20:45:30 +00004953 return 0;
4954}
4955
4956void no_more_time (int sig)
4957{
4958 hire_a_guru();
4959}
wdenkc6097192002-11-03 00:24:07 +00004960
4961
wdenk2729af92004-05-03 20:45:30 +00004962Coding Standards:
4963-----------------
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk2729af92004-05-03 20:45:30 +00004965All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004966coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004967"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00004968
Detlev Zundel2c051652006-09-01 15:39:02 +02004969Source files originating from a different project (for example the
4970MTD subsystem) are generally exempt from these guidelines and are not
4971reformated to ease subsequent migration to newer versions of those
4972sources.
4973
4974Please note that U-Boot is implemented in C (and to some small parts in
4975Assembler); no C++ is used, so please do not use C++ style comments (//)
4976in your code.
wdenk2729af92004-05-03 20:45:30 +00004977
4978Please also stick to the following formatting rules:
4979- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004980- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00004981- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00004982- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00004983- do not add trailing empty lines to source files
4984
4985Submissions which do not conform to the standards may be returned
4986with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004987
4988
wdenk2729af92004-05-03 20:45:30 +00004989Submitting Patches:
4990-------------------
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk2729af92004-05-03 20:45:30 +00004992Since the number of patches for U-Boot is growing, we need to
4993establish some rules. Submissions which do not conform to these rules
4994may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004995
Magnus Lilja0d28f342008-08-06 19:32:33 +02004996Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004997
Wolfgang Denk06682362008-12-30 22:56:11 +01004998Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4999see http://lists.denx.de/mailman/listinfo/u-boot
5000
wdenk2729af92004-05-03 20:45:30 +00005001When you send a patch, please include the following information with
5002it:
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk2729af92004-05-03 20:45:30 +00005004* For bug fixes: a description of the bug and how your patch fixes
5005 this bug. Please try to include a way of demonstrating that the
5006 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk2729af92004-05-03 20:45:30 +00005008* For new features: a description of the feature and your
5009 implementation.
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk2729af92004-05-03 20:45:30 +00005011* A CHANGELOG entry as plaintext (separate from the patch)
5012
5013* For major contributions, your entry to the CREDITS file
5014
5015* When you add support for a new board, don't forget to add this
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005016 board to the MAINTAINERS file, too.
wdenk2729af92004-05-03 20:45:30 +00005017
5018* If your patch adds new configuration options, don't forget to
5019 document these in the README file.
5020
Wolfgang Denk218ca722008-03-26 10:40:12 +01005021* The patch itself. If you are using git (which is *strongly*
5022 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00005023 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01005024 the U-Boot mailing list, you will avoid most of the common problems
5025 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00005026
Wolfgang Denk218ca722008-03-26 10:40:12 +01005027 If you cannot use git, use "diff -purN OLD NEW". If your version of
5028 diff does not support these options, then get the latest version of
5029 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00005030
Wolfgang Denk218ca722008-03-26 10:40:12 +01005031 The current directory when running this command shall be the parent
5032 directory of the U-Boot source tree (i. e. please make sure that
5033 your patch includes sufficient directory information for the
5034 affected files).
5035
5036 We prefer patches as plain text. MIME attachments are discouraged,
5037 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00005038
5039* If one logical set of modifications affects or creates several
5040 files, all these changes shall be submitted in a SINGLE patch file.
5041
5042* Changesets that contain different, unrelated modifications shall be
5043 submitted as SEPARATE patches, one patch per changeset.
5044
5045
5046Notes:
5047
5048* Before sending the patch, run the MAKEALL script on your patched
5049 source tree and make sure that no errors or warnings are reported
5050 for any of the boards.
5051
5052* Keep your modifications to the necessary minimum: A patch
5053 containing several unrelated changes or arbitrary reformats will be
5054 returned with a request to re-formatting / split it.
5055
5056* If you modify existing code, make sure that your new code does not
5057 add to the memory footprint of the code ;-) Small is beautiful!
5058 When adding new features, these should compile conditionally only
5059 (using #ifdef), and the resulting code with the new feature
5060 disabled must not need more memory than the old code without your
5061 modification.
wdenk90dc6702005-05-03 14:12:25 +00005062
Wolfgang Denk06682362008-12-30 22:56:11 +01005063* Remember that there is a size limit of 100 kB per message on the
5064 u-boot mailing list. Bigger patches will be moderated. If they are
5065 reasonable and not too big, they will be acknowledged. But patches
5066 bigger than the size limit should be avoided.