blob: 1158e24de776b4f1ad01c987c6200855a1d77424 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002# (C) Copyright 2000 - 2009
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
129U-Boot uses a 3 level version number containing a version, a
130sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
131sub-version "34", and patchlevel "4".
132
133The patchlevel is used to indicate certain stages of development
134between released versions, i. e. officially released versions of
135U-Boot will always have a patchlevel of "0".
136
137
wdenkc6097192002-11-03 00:24:07 +0000138Directory Hierarchy:
139====================
140
Robert P. J. Dayad532262009-11-17 01:59:29 -0500141- api Machine/arch independent API for external apps
wdenk7152b1d2003-09-05 23:19:14 +0000142- board Board dependent files
143- common Misc architecture independent functions
wdenkc6097192002-11-03 00:24:07 +0000144- cpu CPU specific files
wdenk983fda82004-10-28 00:09:35 +0000145 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000146 - arm720t Files specific to ARM 720 CPUs
147 - arm920t Files specific to ARM 920 CPUs
wdenka85f9f22005-04-06 13:52:31 +0000148 - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk983fda82004-10-28 00:09:35 +0000149 - imx Files specific to Freescale MC9328 i.MX CPUs
wdenk1d9f4102004-10-09 22:21:29 +0000150 - s3c24x0 Files specific to Samsung S3C24X0 CPUs
wdenk11dadd52004-02-27 00:07:27 +0000151 - arm925t Files specific to ARM 925 CPUs
152 - arm926ejs Files specific to ARM 926 CPUs
wdenk8ed96042005-01-09 23:16:25 +0000153 - arm1136 Files specific to ARM 1136 CPUs
Wolfgang Denk72a087e2006-10-24 14:27:35 +0200154 - at32ap Files specific to Atmel AVR32 AP CPUs
Mike Frysingeradbfeeb2008-08-07 17:50:26 -0400155 - blackfin Files specific to Analog Devices Blackfin CPUs
wdenk11dadd52004-02-27 00:07:27 +0000156 - i386 Files specific to i386 CPUs
157 - ixp Files specific to Intel XScale IXP CPUs
Daniel Hellstromb3309902008-03-28 10:00:33 +0100158 - leon2 Files specific to Gaisler LEON2 SPARC CPU
Daniel Hellstrom1e9a1642008-03-26 22:51:29 +0100159 - leon3 Files specific to Gaisler LEON3 SPARC CPU
wdenk983fda82004-10-28 00:09:35 +0000160 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
TsiChungLiew1552af72008-01-14 17:43:33 -0600161 - mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
TsiChung Liew8e585f02007-06-18 13:50:13 -0500162 - mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
TsiChungLiew8ae158c2007-08-16 15:05:11 -0500163 - mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
TsiChungLiew57a12722008-01-15 14:15:46 -0600164 - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
wdenk11dadd52004-02-27 00:07:27 +0000165 - mips Files specific to MIPS CPUs
wdenk983fda82004-10-28 00:09:35 +0000166 - mpc5xx Files specific to Freescale MPC5xx CPUs
167 - mpc5xxx Files specific to Freescale MPC5xxx CPUs
168 - mpc8xx Files specific to Freescale MPC8xx CPUs
169 - mpc8220 Files specific to Freescale MPC8220 CPUs
170 - mpc824x Files specific to Freescale MPC824x CPUs
171 - mpc8260 Files specific to Freescale MPC8260 CPUs
172 - mpc85xx Files specific to Freescale MPC85xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000173 - nios Files specific to Altera NIOS CPUs
wdenk5c952cf2004-10-10 21:27:30 +0000174 - nios2 Files specific to Altera Nios-II CPUs
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200175 - ppc4xx Files specific to AMCC PowerPC 4xx CPUs
wdenk11dadd52004-02-27 00:07:27 +0000176 - pxa Files specific to Intel XScale PXA CPUs
177 - s3c44b0 Files specific to Samsung S3C44B0 CPUs
178 - sa1100 Files specific to Intel StrongARM SA1100 CPUs
wdenkc6097192002-11-03 00:24:07 +0000179- disk Code for disk drive partition handling
180- doc Documentation (don't expect too much)
wdenk7152b1d2003-09-05 23:19:14 +0000181- drivers Commonly used device drivers
wdenkc6097192002-11-03 00:24:07 +0000182- examples Example code for standalone applications, etc.
Robert P. J. Dayad532262009-11-17 01:59:29 -0500183- fs Filesystem code (cramfs, ext2, jffs2, etc.)
wdenkc6097192002-11-03 00:24:07 +0000184- include Header Files
wdenk11dadd52004-02-27 00:07:27 +0000185- lib_arm Files generic to ARM architecture
Wolfgang Denk7b64fef2006-10-24 14:21:16 +0200186- lib_avr32 Files generic to AVR32 architecture
Mike Frysingeradbfeeb2008-08-07 17:50:26 -0400187- lib_blackfin Files generic to Blackfin architecture
wdenk11dadd52004-02-27 00:07:27 +0000188- lib_generic Files generic to all architectures
189- lib_i386 Files generic to i386 architecture
190- lib_m68k Files generic to m68k architecture
Robert P. J. Dayad532262009-11-17 01:59:29 -0500191- lib_microblaze Files generic to microblaze architecture
wdenk11dadd52004-02-27 00:07:27 +0000192- lib_mips Files generic to MIPS architecture
193- lib_nios Files generic to NIOS architecture
Robert P. J. Dayad532262009-11-17 01:59:29 -0500194- lib_nios2 Files generic to NIOS2 architecture
wdenk11dadd52004-02-27 00:07:27 +0000195- lib_ppc Files generic to PowerPC architecture
Robert P. J. Dayad532262009-11-17 01:59:29 -0500196- lib_sh Files generic to SH architecture
Daniel Hellstromc2f02da2008-03-28 09:47:00 +0100197- lib_sparc Files generic to SPARC architecture
Wolfgang Denk218ca722008-03-26 10:40:12 +0100198- libfdt Library files to support flattened device trees
wdenkc6097192002-11-03 00:24:07 +0000199- net Networking code
wdenkc6097192002-11-03 00:24:07 +0000200- post Power On Self Test
wdenkc6097192002-11-03 00:24:07 +0000201- rtc Real Time Clock drivers
202- tools Tools to build S-Record or U-Boot images, etc.
203
wdenkc6097192002-11-03 00:24:07 +0000204Software Configuration:
205=======================
206
207Configuration is usually done using C preprocessor defines; the
208rationale behind that is to avoid dead code whenever possible.
209
210There are two classes of configuration variables:
211
212* Configuration _OPTIONS_:
213 These are selectable by the user and have names beginning with
214 "CONFIG_".
215
216* Configuration _SETTINGS_:
217 These depend on the hardware etc. and should not be meddled with if
218 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200219 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000220
221Later we will add a configuration tool - probably similar to or even
222identical to what's used for the Linux kernel. Right now, we have to
223do the configuration by hand, which means creating some symbolic
224links and editing some configuration files. We use the TQM8xxL boards
225as an example here.
226
227
228Selection of Processor Architecture and Board Type:
229---------------------------------------------------
230
231For all supported boards there are ready-to-use default
232configurations available; just type "make <board_name>_config".
233
234Example: For a TQM823L module type:
235
236 cd u-boot
237 make TQM823L_config
238
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200239For the Cogent platform, you need to specify the CPU type as well;
wdenkc6097192002-11-03 00:24:07 +0000240e.g. "make cogent_mpc8xx_config". And also configure the cogent
241directory according to the instructions in cogent/README.
242
243
244Configuration Options:
245----------------------
246
247Configuration depends on the combination of board and CPU type; all
248such information is kept in a configuration file
249"include/configs/<board_name>.h".
250
251Example: For a TQM823L module, all configuration settings are in
252"include/configs/TQM823L.h".
253
254
wdenk7f6c2cb2002-11-10 22:06:23 +0000255Many of the options are named exactly as the corresponding Linux
256kernel configuration options. The intention is to make it easier to
257build a config tool - later.
258
259
wdenkc6097192002-11-03 00:24:07 +0000260The following options need to be configured:
261
Kim Phillips26281142007-08-10 13:28:25 -0500262- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000263
Kim Phillips26281142007-08-10 13:28:25 -0500264- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200265
266- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100267 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000268
269- CPU Module Type: (if CONFIG_COGENT is defined)
270 Define exactly one of
271 CONFIG_CMA286_60_OLD
272--- FIXME --- not tested yet:
273 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
274 CONFIG_CMA287_23, CONFIG_CMA287_50
275
276- Motherboard Type: (if CONFIG_COGENT is defined)
277 Define exactly one of
278 CONFIG_CMA101, CONFIG_CMA102
279
280- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
281 Define one or more of
282 CONFIG_CMA302
283
284- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
285 Define one or more of
286 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200287 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000288 a "rotator" |\-/|\-/
289
wdenk2535d602003-07-17 23:16:40 +0000290- Board flavour: (if CONFIG_MPC8260ADS is defined)
291 CONFIG_ADSTYPE
292 Possible values are:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200293 CONFIG_SYS_8260ADS - original MPC8260ADS
294 CONFIG_SYS_8266ADS - MPC8266ADS
295 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR
296 CONFIG_SYS_8272ADS - MPC8272ADS
wdenk2535d602003-07-17 23:16:40 +0000297
wdenkc6097192002-11-03 00:24:07 +0000298- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000299 Define exactly one of
300 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000301
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200302- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000303 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
304 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000305 e.g. if there is no 32KHz
306 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000307 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
308 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000309
wdenk66ca92a2004-09-28 17:59:53 +0000310- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200311 CONFIG_SYS_8xx_CPUCLK_MIN
312 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000313 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000314 See doc/README.MPC866
315
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200316 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000317
wdenkba56f622004-02-06 23:19:44 +0000318 Define this to measure the actual CPU clock instead
319 of relying on the correctness of the configured
320 values. Mostly useful for board bringup to make sure
321 the PLL is locked at the intended frequency. Note
322 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200323 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000324
Heiko Schocher506f3912009-03-12 07:37:15 +0100325 CONFIG_SYS_DELAYED_ICACHE
326
327 Define this option if you want to enable the
328 ICache only when Code runs from RAM.
329
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100330- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200331 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100332
333 Defines the Monahans run mode to oscillator
334 ratio. Valid values are 8, 16, 24, 31. The core
335 frequency is this value multiplied by 13 MHz.
336
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200337 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200338
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100339 Defines the Monahans turbo mode to oscillator
340 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200341 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100342 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200343
wdenk5da627a2003-10-09 20:09:04 +0000344- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000345 CONFIG_CLOCKS_IN_MHZ
346
347 U-Boot stores all clock information in Hz
348 internally. For binary compatibility with older Linux
349 kernels (which expect the clocks passed in the
350 bd_info data to be in MHz) the environment variable
351 "clocks_in_mhz" can be defined so that U-Boot
352 converts clock data to MHZ before passing it to the
353 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000354 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100355 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000356 default environment.
357
wdenk5da627a2003-10-09 20:09:04 +0000358 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
359
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200360 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000361 expect it to be in bytes, others in MB.
362 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
363
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400364 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200365
366 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400367 passed using flattened device trees (based on open firmware
368 concepts).
369
370 CONFIG_OF_LIBFDT
371 * New libfdt-based support
372 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500373 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400374
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200375 OF_CPU - The proper name of the cpus node (only required for
376 MPC512X and MPC5xxx based boards).
377 OF_SOC - The proper name of the soc node (only required for
378 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200379 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600380 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200381
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200382 boards with QUICC Engines require OF_QE to set UCC MAC
383 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500384
Kumar Gala4e253132006-01-11 13:54:17 -0600385 CONFIG_OF_BOARD_SETUP
386
387 Board code has addition modification that it wants to make
388 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000389
Matthew McClintock02677682006-06-28 10:41:37 -0500390 CONFIG_OF_BOOT_CPU
391
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200392 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500393 param header, the default value is zero if undefined.
394
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200395 CONFIG_OF_IDE_FIXUP
396
397 U-Boot can detect if an IDE device is present or not.
398 If not, and this new config option is activated, U-Boot
399 removes the ATA node from the DTS before booting Linux,
400 so the Linux IDE driver does not probe the device and
401 crash. This is needed for buggy hardware (uc101) where
402 no pull down resistor is connected to the signal IDE5V_DD7.
403
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100404- vxWorks boot parameters:
405
406 bootvx constructs a valid bootline using the following
407 environments variables: bootfile, ipaddr, serverip, hostname.
408 It loads the vxWorks image pointed bootfile.
409
410 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
411 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
412 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
413 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
414
415 CONFIG_SYS_VXWORKS_ADD_PARAMS
416
417 Add it at the end of the bootline. E.g "u=username pw=secret"
418
419 Note: If a "bootargs" environment is defined, it will overwride
420 the defaults discussed just above.
421
wdenk6705d812004-08-02 23:22:59 +0000422- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200423 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000424
425 Define this if you want support for Amba PrimeCell PL010 UARTs.
426
Andreas Engel48d01922008-09-08 14:30:53 +0200427 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000428
429 Define this if you want support for Amba PrimeCell PL011 UARTs.
430
431 CONFIG_PL011_CLOCK
432
433 If you have Amba PrimeCell PL011 UARTs, set this variable to
434 the clock speed of the UARTs.
435
436 CONFIG_PL01x_PORTS
437
438 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
439 define this to a list of base addresses for each (supported)
440 port. See e.g. include/configs/versatile.h
441
442
wdenkc6097192002-11-03 00:24:07 +0000443- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000444 Depending on board, define exactly one serial port
445 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
446 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
447 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000448
449 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
450 port routines must be defined elsewhere
451 (i.e. serial_init(), serial_getc(), ...)
452
453 CONFIG_CFB_CONSOLE
454 Enables console device for a color framebuffer. Needs following
455 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
456 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
457 (default big endian)
458 VIDEO_HW_RECTFILL graphic chip supports
459 rectangle fill
460 (cf. smiLynxEM)
461 VIDEO_HW_BITBLT graphic chip supports
462 bit-blit (cf. smiLynxEM)
463 VIDEO_VISIBLE_COLS visible pixel columns
464 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000465 VIDEO_VISIBLE_ROWS visible pixel rows
466 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000467 VIDEO_DATA_FORMAT graphic data format
468 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000469 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000470 VIDEO_KBD_INIT_FCT keyboard int fct
471 (i.e. i8042_kbd_init())
472 VIDEO_TSTC_FCT test char fct
473 (i.e. i8042_tstc)
474 VIDEO_GETC_FCT get char fct
475 (i.e. i8042_getc)
476 CONFIG_CONSOLE_CURSOR cursor drawing on/off
477 (requires blink timer
478 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200479 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000480 CONFIG_CONSOLE_TIME display time/date info in
481 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500482 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000483 CONFIG_VIDEO_LOGO display Linux logo in
484 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000485 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
486 linux_logo.h for logo.
487 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000488 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200489 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000490 the logo
491
wdenk43d96162003-03-06 00:02:04 +0000492 When CONFIG_CFB_CONSOLE is defined, video console is
493 default i/o. Serial console can be forced with
494 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000495
wdenkd4ca31c2004-01-02 14:00:00 +0000496 When CONFIG_SILENT_CONSOLE is defined, all console
497 messages (by U-Boot and Linux!) can be silenced with
498 the "silent" environment variable. See
499 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000500
wdenkc6097192002-11-03 00:24:07 +0000501- Console Baudrate:
502 CONFIG_BAUDRATE - in bps
503 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200504 CONFIG_SYS_BAUDRATE_TABLE, see below.
505 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000506
Heiko Schocherc92fac92009-01-30 12:55:38 +0100507- Console Rx buffer length
508 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
509 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100510 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100511 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
512 must be defined, to setup the maximum idle timeout for
513 the SMC.
514
wdenkc6097192002-11-03 00:24:07 +0000515- Interrupt driven serial port input:
516 CONFIG_SERIAL_SOFTWARE_FIFO
517
518 PPC405GP only.
519 Use an interrupt handler for receiving data on the
520 serial port. It also enables using hardware handshake
521 (RTS/CTS) and UART's built-in FIFO. Set the number of
522 bytes the interrupt driven input buffer should have.
523
wdenk109c0e32004-03-23 21:43:07 +0000524 Leave undefined to disable this feature, including
525 disable the buffer and hardware handshake.
wdenkc6097192002-11-03 00:24:07 +0000526
stroese1d49b1f2003-05-23 11:39:05 +0000527- Console UART Number:
528 CONFIG_UART1_CONSOLE
529
Wolfgang Denk0c8721a2005-09-23 11:05:55 +0200530 AMCC PPC4xx only.
stroese1d49b1f2003-05-23 11:39:05 +0000531 If defined internal UART1 (and not UART0) is used
532 as default U-Boot console.
533
wdenkc6097192002-11-03 00:24:07 +0000534- Boot Delay: CONFIG_BOOTDELAY - in seconds
535 Delay before automatically booting the default image;
536 set to -1 to disable autoboot.
537
538 See doc/README.autoboot for these options that
539 work with CONFIG_BOOTDELAY. None are required.
540 CONFIG_BOOT_RETRY_TIME
541 CONFIG_BOOT_RETRY_MIN
542 CONFIG_AUTOBOOT_KEYED
543 CONFIG_AUTOBOOT_PROMPT
544 CONFIG_AUTOBOOT_DELAY_STR
545 CONFIG_AUTOBOOT_STOP_STR
546 CONFIG_AUTOBOOT_DELAY_STR2
547 CONFIG_AUTOBOOT_STOP_STR2
548 CONFIG_ZERO_BOOTDELAY_CHECK
549 CONFIG_RESET_TO_RETRY
550
551- Autoboot Command:
552 CONFIG_BOOTCOMMAND
553 Only needed when CONFIG_BOOTDELAY is enabled;
554 define a command string that is automatically executed
555 when no character is read on the console interface
556 within "Boot Delay" after reset.
557
558 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000559 This can be used to pass arguments to the bootm
560 command. The value of CONFIG_BOOTARGS goes into the
561 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000562
563 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000564 The value of these goes into the environment as
565 "ramboot" and "nfsboot" respectively, and can be used
566 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200567 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000568
569- Pre-Boot Commands:
570 CONFIG_PREBOOT
571
572 When this option is #defined, the existence of the
573 environment variable "preboot" will be checked
574 immediately before starting the CONFIG_BOOTDELAY
575 countdown and/or running the auto-boot command resp.
576 entering interactive mode.
577
578 This feature is especially useful when "preboot" is
579 automatically generated or modified. For an example
580 see the LWMON board specific code: here "preboot" is
581 modified when the user holds down a certain
582 combination of keys on the (special) keyboard when
583 booting the systems
584
585- Serial Download Echo Mode:
586 CONFIG_LOADS_ECHO
587 If defined to 1, all characters received during a
588 serial download (using the "loads" command) are
589 echoed back. This might be needed by some terminal
590 emulations (like "cu"), but may as well just take
591 time on others. This setting #define's the initial
592 value of the "loads_echo" environment variable.
593
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500594- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000595 CONFIG_KGDB_BAUDRATE
596 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200597 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000598
599- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500600 Monitor commands can be included or excluded
601 from the build by using the #include files
602 "config_cmd_all.h" and #undef'ing unwanted
603 commands, or using "config_cmd_default.h"
604 and augmenting with additional #define's
605 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000606
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500607 The default command configuration includes all commands
608 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000609
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500610 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500611 CONFIG_CMD_BDI bdinfo
612 CONFIG_CMD_BEDBUG * Include BedBug Debugger
613 CONFIG_CMD_BMP * BMP support
614 CONFIG_CMD_BSP * Board specific commands
615 CONFIG_CMD_BOOTD bootd
616 CONFIG_CMD_CACHE * icache, dcache
617 CONFIG_CMD_CONSOLE coninfo
618 CONFIG_CMD_DATE * support for RTC, date/time...
619 CONFIG_CMD_DHCP * DHCP support
620 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600621 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
622 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
623 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
624 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500625 CONFIG_CMD_DTT * Digital Therm and Thermostat
626 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500627 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500628 CONFIG_CMD_EEPROM * EEPROM read/write support
629 CONFIG_CMD_ELF * bootelf, bootvx
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500630 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500631 CONFIG_CMD_FDC * Floppy Disk Support
632 CONFIG_CMD_FAT * FAT partition support
633 CONFIG_CMD_FDOS * Dos diskette Support
634 CONFIG_CMD_FLASH flinfo, erase, protect
635 CONFIG_CMD_FPGA FPGA device initialization support
636 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
637 CONFIG_CMD_I2C * I2C serial bus support
638 CONFIG_CMD_IDE * IDE harddisk support
639 CONFIG_CMD_IMI iminfo
640 CONFIG_CMD_IMLS List all found images
641 CONFIG_CMD_IMMAP * IMMR dump support
642 CONFIG_CMD_IRQ * irqinfo
643 CONFIG_CMD_ITEST Integer/string test of 2 values
644 CONFIG_CMD_JFFS2 * JFFS2 Support
645 CONFIG_CMD_KGDB * kgdb
646 CONFIG_CMD_LOADB loadb
647 CONFIG_CMD_LOADS loads
Robin Getz02c9aa12009-07-27 00:07:59 -0400648 CONFIG_CMD_MD5SUM print md5 message digest
649 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500650 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
651 loop, loopw, mtest
652 CONFIG_CMD_MISC Misc functions like sleep etc
653 CONFIG_CMD_MMC * MMC memory mapped support
654 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +0100655 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500656 CONFIG_CMD_NAND * NAND support
657 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Peter Tysere92739d2008-12-17 16:36:21 -0600658 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
659 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500660 CONFIG_CMD_PCI * pciinfo
661 CONFIG_CMD_PCMCIA * PCMCIA support
662 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
663 host
664 CONFIG_CMD_PORTIO * Port I/O
665 CONFIG_CMD_REGINFO * Register dump
666 CONFIG_CMD_RUN run command in env variable
667 CONFIG_CMD_SAVES * save S record dump
668 CONFIG_CMD_SCSI * SCSI Support
669 CONFIG_CMD_SDRAM * print SDRAM configuration information
670 (requires CONFIG_CMD_I2C)
671 CONFIG_CMD_SETGETDCR Support for DCR Register access
672 (4xx only)
Robin Getz02c9aa12009-07-27 00:07:59 -0400673 CONFIG_CMD_SHA1 print sha1 memory digest
674 (requires CONFIG_CMD_MEMORY)
Wolfgang Denk74de7ae2009-04-01 23:34:12 +0200675 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500676 CONFIG_CMD_SPI * SPI serial bus support
677 CONFIG_CMD_USB * USB support
678 CONFIG_CMD_VFD * VFD support (TRAB)
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500679 CONFIG_CMD_CDP * Cisco Discover Protocol support
680 CONFIG_CMD_FSL * Microblaze FSL support
wdenkc6097192002-11-03 00:24:07 +0000681
wdenkc6097192002-11-03 00:24:07 +0000682
683 EXAMPLE: If you want all functions except of network
684 support you can write:
685
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500686 #include "config_cmd_all.h"
687 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000688
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400689 Other Commands:
690 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000691
692 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500693 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +0000694 what you (and your U-Boot users) are doing. Data
695 cache cannot be enabled on systems like the 8xx or
696 8260 (where accesses to the IMMR region must be
697 uncached), and it cannot be disabled on all other
698 systems where we (mis-) use the data cache to hold an
699 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000700
701
702 XXX - this list needs to get updated!
703
704- Watchdog:
705 CONFIG_WATCHDOG
706 If this variable is defined, it enables watchdog
wdenk7152b1d2003-09-05 23:19:14 +0000707 support. There must be support in the platform specific
wdenkc6097192002-11-03 00:24:07 +0000708 code for a watchdog. For the 8xx and 8260 CPUs, the
709 SIU Watchdog feature is enabled in the SYPCR
710 register.
711
stroesec1551ea2003-04-04 15:53:41 +0000712- U-Boot Version:
713 CONFIG_VERSION_VARIABLE
714 If this variable is defined, an environment variable
715 named "ver" is created by U-Boot showing the U-Boot
716 version as printed by the "version" command.
717 This variable is readonly.
718
wdenkc6097192002-11-03 00:24:07 +0000719- Real-Time Clock:
720
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500721 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000722 has to be selected, too. Define exactly one of the
723 following options:
724
725 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
726 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Guennadi Liakhovetski7ce63702008-04-15 14:15:30 +0200727 CONFIG_RTC_MC13783 - use MC13783 RTC
wdenkc6097192002-11-03 00:24:07 +0000728 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000729 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000730 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000731 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
wdenk3bac3512003-03-12 10:41:04 +0000732 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100733 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000734 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200735 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
wdenkc6097192002-11-03 00:24:07 +0000736
wdenkb37c7e52003-06-30 16:24:52 +0000737 Note that if the RTC uses I2C, then the I2C interface
738 must also be configured. See I2C Support, below.
739
Peter Tysere92739d2008-12-17 16:36:21 -0600740- GPIO Support:
741 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
742 CONFIG_PCA953X_INFO - enable pca953x info command
743
744 Note that if the GPIO device uses I2C, then the I2C interface
745 must also be configured. See I2C Support, below.
746
wdenkc6097192002-11-03 00:24:07 +0000747- Timestamp Support:
748
wdenk43d96162003-03-06 00:02:04 +0000749 When CONFIG_TIMESTAMP is selected, the timestamp
750 (date and time) of an image is printed by image
751 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500752 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000753
754- Partition Support:
755 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
richardretanubun07f3d782008-09-26 11:13:22 -0400756 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenkc6097192002-11-03 00:24:07 +0000757
Wolfgang Denk218ca722008-03-26 10:40:12 +0100758 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
759 CONFIG_CMD_SCSI) you must configure support for at
760 least one partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000761
762- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000763 CONFIG_IDE_RESET_ROUTINE - this is defined in several
764 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000765
wdenk4d13cba2004-03-14 14:09:05 +0000766 CONFIG_IDE_RESET - is this is defined, IDE Reset will
767 be performed by calling the function
768 ide_set_reset(int reset)
769 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000770
771- ATAPI Support:
772 CONFIG_ATAPI
773
774 Set this to enable ATAPI support.
775
wdenkc40b2952004-03-13 23:29:43 +0000776- LBA48 Support
777 CONFIG_LBA48
778
779 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100780 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000781 Whithout these , LBA48 support uses 32bit variables and will 'only'
782 support disks up to 2.1TB.
783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200784 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000785 When enabled, makes the IDE subsystem use 64bit sector addresses.
786 Default is 32bit.
787
wdenkc6097192002-11-03 00:24:07 +0000788- SCSI Support:
789 At the moment only there is only support for the
790 SYM53C8XX SCSI controller; define
791 CONFIG_SCSI_SYM53C8XX to enable it.
792
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200793 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
794 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
795 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000796 maximum numbers of LUNs, SCSI ID's and target
797 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200798 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +0000799
800- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000801 CONFIG_E1000
802 Support for Intel 8254x gigabit chips.
stroese53cf9432003-06-05 15:39:44 +0000803
Andre Schwarzac3315c2008-03-06 16:45:44 +0100804 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200805 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +0100806
wdenkc6097192002-11-03 00:24:07 +0000807 CONFIG_EEPRO100
808 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200809 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000810 write routine for first time initialisation.
811
812 CONFIG_TULIP
813 Support for Digital 2114x chips.
814 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
815 modem chip initialisation (KS8761/QS6611).
816
817 CONFIG_NATSEMI
818 Support for National dp83815 chips.
819
820 CONFIG_NS8382X
821 Support for National dp8382[01] gigabit chips.
822
wdenk45219c42003-05-12 21:50:16 +0000823- NETWORK Support (other):
824
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100825 CONFIG_DRIVER_AT91EMAC
826 Support for AT91RM9200 EMAC.
827
828 CONFIG_RMII
829 Define this to use reduced MII inteface
830
831 CONFIG_DRIVER_AT91EMAC_QUIET
832 If this defined, the driver is quiet.
833 The driver doen't show link status messages.
834
wdenk45219c42003-05-12 21:50:16 +0000835 CONFIG_DRIVER_LAN91C96
836 Support for SMSC's LAN91C96 chips.
837
838 CONFIG_LAN91C96_BASE
839 Define this to hold the physical address
840 of the LAN91C96's I/O space
841
842 CONFIG_LAN91C96_USE_32_BIT
843 Define this to enable 32 bit addressing
844
wdenkf39748a2004-06-09 13:37:52 +0000845 CONFIG_DRIVER_SMC91111
846 Support for SMSC's LAN91C111 chip
847
848 CONFIG_SMC91111_BASE
849 Define this to hold the physical address
850 of the device (I/O space)
851
852 CONFIG_SMC_USE_32_BIT
853 Define this if data bus is 32 bits
854
855 CONFIG_SMC_USE_IOFUNCS
856 Define this to use i/o functions instead of macros
857 (some hardware wont work with macros)
858
Mike Rapoportc2fff332009-11-11 10:03:03 +0200859 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +0200860 Support for SMSC's LAN911x and LAN921x chips
861
Mike Rapoportc2fff332009-11-11 10:03:03 +0200862 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +0200863 Define this to hold the physical address
864 of the device (I/O space)
865
Mike Rapoportc2fff332009-11-11 10:03:03 +0200866 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200867 Define this if data bus is 32 bits
868
Mike Rapoportc2fff332009-11-11 10:03:03 +0200869 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +0200870 Define this if data bus is 16 bits. If your processor
871 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +0200872 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +0200873
wdenkc6097192002-11-03 00:24:07 +0000874- USB Support:
875 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +0000876 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +0000877 CONFIG_USB_UHCI to enable it.
878 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +0000879 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +0000880 storage devices.
881 Note:
882 Supported are USB Keyboards and USB Floppy drives
883 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +0000884 MPC5200 USB requires additional defines:
885 CONFIG_USB_CLOCK
886 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500887 CONFIG_PSC3_USB
888 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +0000889 CONFIG_USB_CONFIG
890 for differential drivers: 0x00001000
891 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -0500892 for differential drivers on PSC3: 0x00000100
893 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200894 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +0200895 May be defined to allow interrupt polling
896 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +0000897
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200898- USB Device:
899 Define the below if you wish to use the USB console.
900 Once firmware is rebuilt from a serial console issue the
901 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200902 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200903 it has found a new device. The environment variable usbtty
904 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +0200905 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200906 Common Device Class Abstract Control Model serial device.
907 If you select usbtty = gserial you should be able to enumerate
908 a Linux host by
909 # modprobe usbserial vendor=0xVendorID product=0xProductID
910 else if using cdc_acm, simply setting the environment
911 variable usbtty to be cdc_acm should suffice. The following
912 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200913
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200914 CONFIG_USB_DEVICE
915 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +0000916
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200917 CONFIG_USB_TTY
918 Define this to have a tty type of device available to
919 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +0200920
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200921 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200922 Define this if you want stdin, stdout &/or stderr to
923 be set to usbtty.
924
925 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200926 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200927 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200928 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +0200929
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200930 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200931 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200932 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200933
Wolfgang Denk386eda02006-06-14 18:14:56 +0200934 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200935 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +0200936 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200937 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
938 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
939 should pretend to be a Linux device to it's target host.
940
941 CONFIG_USBD_MANUFACTURER
942 Define this string as the name of your company for
943 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +0200944
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200945 CONFIG_USBD_PRODUCT_NAME
946 Define this string as the name of your product
947 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
948
949 CONFIG_USBD_VENDORID
950 Define this as your assigned Vendor ID from the USB
951 Implementors Forum. This *must* be a genuine Vendor ID
952 to avoid polluting the USB namespace.
953 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +0200954
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +0200955 CONFIG_USBD_PRODUCTID
956 Define this as the unique Product ID
957 for your device
958 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +0000959
960
961- MMC Support:
962 The MMC controller on the Intel PXA is supported. To
963 enable this define CONFIG_MMC. The MMC can be
964 accessed from the boot prompt by mapping the device
965 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500966 enabled with CONFIG_CMD_MMC. The MMC driver also works with
967 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +0000968
wdenk6705d812004-08-02 23:22:59 +0000969- Journaling Flash filesystem support:
970 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
971 CONFIG_JFFS2_NAND_DEV
972 Define these for a default partition on a NAND device
973
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200974 CONFIG_SYS_JFFS2_FIRST_SECTOR,
975 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +0000976 Define these for a default partition on a NOR device
977
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200978 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +0000979 Define this to create an own partition. You have to provide a
980 function struct part_info* jffs2_part_info(int part_num)
981
982 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200983 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +0000984 to disable the command chpart. This is the default when you
985 have not defined a custom partition
986
wdenkc6097192002-11-03 00:24:07 +0000987- Keyboard Support:
988 CONFIG_ISA_KEYBOARD
989
990 Define this to enable standard (PC-Style) keyboard
991 support
992
993 CONFIG_I8042_KBD
994 Standard PC keyboard driver with US (is default) and
995 GERMAN key layout (switch via environment 'keymap=de') support.
996 Export function i8042_kbd_init, i8042_tstc and i8042_getc
997 for cfb_console. Supports cursor blinking.
998
999- Video support:
1000 CONFIG_VIDEO
1001
1002 Define this to enable video support (for output to
1003 video).
1004
1005 CONFIG_VIDEO_CT69000
1006
1007 Enable Chips & Technologies 69000 Video chip
1008
1009 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001010 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001011 video output is selected via environment 'videoout'
1012 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1013 assumed.
wdenkc6097192002-11-03 00:24:07 +00001014
wdenkb79a11c2004-03-25 15:14:43 +00001015 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001016 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001017 are possible:
1018 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001019 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001020
1021 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1022 -------------+---------------------------------------------
1023 8 bits | 0x301* 0x303 0x305 0x161 0x307
1024 15 bits | 0x310 0x313 0x316 0x162 0x319
1025 16 bits | 0x311 0x314 0x317 0x163 0x31A
1026 24 bits | 0x312 0x315 0x318 ? 0x31B
1027 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001028 (i.e. setenv videomode 317; saveenv; reset;)
1029
wdenkb79a11c2004-03-25 15:14:43 +00001030 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001031 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001032
1033
stroesec1551ea2003-04-04 15:53:41 +00001034 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001035 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001036 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1037 or CONFIG_VIDEO_SED13806_16BPP
1038
wdenk682011f2003-06-03 23:54:09 +00001039- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001040 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001041
wdenk8bde7f72003-06-27 21:31:46 +00001042 Define this to enable a custom keyboard support.
1043 This simply calls drv_keyboard_init() which must be
1044 defined in your board-specific files.
1045 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001046
wdenkc6097192002-11-03 00:24:07 +00001047- LCD Support: CONFIG_LCD
1048
1049 Define this to enable LCD support (for output to LCD
1050 display); also select one of the supported displays
1051 by defining one of these:
1052
Stelian Pop39cf4802008-05-09 21:57:18 +02001053 CONFIG_ATMEL_LCD:
1054
1055 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1056
wdenkfd3103b2003-11-25 16:55:19 +00001057 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001058
wdenkfd3103b2003-11-25 16:55:19 +00001059 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001060
wdenkfd3103b2003-11-25 16:55:19 +00001061 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001062
wdenkfd3103b2003-11-25 16:55:19 +00001063 NEC NL6448BC20-08. 6.5", 640x480.
1064 Active, color, single scan.
1065
1066 CONFIG_NEC_NL6448BC33_54
1067
1068 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001069 Active, color, single scan.
1070
1071 CONFIG_SHARP_16x9
1072
1073 Sharp 320x240. Active, color, single scan.
1074 It isn't 16x9, and I am not sure what it is.
1075
1076 CONFIG_SHARP_LQ64D341
1077
1078 Sharp LQ64D341 display, 640x480.
1079 Active, color, single scan.
1080
1081 CONFIG_HLD1045
1082
1083 HLD1045 display, 640x480.
1084 Active, color, single scan.
1085
1086 CONFIG_OPTREX_BW
1087
1088 Optrex CBL50840-2 NF-FW 99 22 M5
1089 or
1090 Hitachi LMG6912RPFC-00T
1091 or
1092 Hitachi SP14Q002
1093
1094 320x240. Black & white.
1095
1096 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001097 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001098
wdenk7152b1d2003-09-05 23:19:14 +00001099- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001100
wdenk8bde7f72003-06-27 21:31:46 +00001101 If this option is set, the environment is checked for
1102 a variable "splashimage". If found, the usual display
1103 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001104 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001105 specified in "splashimage" is loaded instead. The
1106 console is redirected to the "nulldev", too. This
1107 allows for a "silent" boot where a splash screen is
1108 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001109
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001110 CONFIG_SPLASH_SCREEN_ALIGN
1111
1112 If this option is set the splash image can be freely positioned
1113 on the screen. Environment variable "splashpos" specifies the
1114 position as "x,y". If a positive number is given it is used as
1115 number of pixel from left/top. If a negative number is given it
1116 is used as number of pixel from right/bottom. You can also
1117 specify 'm' for centering the image.
1118
1119 Example:
1120 setenv splashpos m,m
1121 => image at center of screen
1122
1123 setenv splashpos 30,20
1124 => image at x = 30 and y = 20
1125
1126 setenv splashpos -10,m
1127 => vertically centered image
1128 at x = dspWidth - bmpWidth - 9
1129
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001130- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1131
1132 If this option is set, additionally to standard BMP
1133 images, gzipped BMP images can be displayed via the
1134 splashscreen support or the bmp command.
1135
wdenkc29fdfc2003-08-29 20:57:53 +00001136- Compression support:
1137 CONFIG_BZIP2
1138
1139 If this option is set, support for bzip2 compressed
1140 images is included. If not, only uncompressed and gzip
1141 compressed images are supported.
1142
wdenk42d1f032003-10-15 23:53:47 +00001143 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001144 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001145 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001146
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001147 CONFIG_LZMA
1148
1149 If this option is set, support for lzma compressed
1150 images is included.
1151
1152 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1153 requires an amount of dynamic memory that is given by the
1154 formula:
1155
1156 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1157
1158 Where lc and lp stand for, respectively, Literal context bits
1159 and Literal pos bits.
1160
1161 This value is upper-bounded by 14MB in the worst case. Anyway,
1162 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1163 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1164 a very small buffer.
1165
1166 Use the lzmainfo tool to determinate the lc and lp values and
1167 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001168 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001169
wdenk17ea1172004-06-06 21:51:03 +00001170- MII/PHY support:
1171 CONFIG_PHY_ADDR
1172
1173 The address of PHY on MII bus.
1174
1175 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1176
1177 The clock frequency of the MII bus
1178
1179 CONFIG_PHY_GIGE
1180
1181 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001182 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001183
1184 CONFIG_PHY_RESET_DELAY
1185
1186 Some PHY like Intel LXT971A need extra delay after
1187 reset before any MII register access is possible.
1188 For such PHY, set this option to the usec delay
1189 required. (minimum 300usec for LXT971A)
1190
1191 CONFIG_PHY_CMD_DELAY (ppc4xx)
1192
1193 Some PHY like Intel LXT971A need extra delay after
1194 command issued before MII status register can be read
1195
wdenkc6097192002-11-03 00:24:07 +00001196- Ethernet address:
1197 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001198 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001199 CONFIG_ETH2ADDR
1200 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001201 CONFIG_ETH4ADDR
1202 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001203
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001204 Define a default value for Ethernet address to use
1205 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001206 is not determined automatically.
1207
1208- IP address:
1209 CONFIG_IPADDR
1210
1211 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001212 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001213 determined through e.g. bootp.
1214
1215- Server IP address:
1216 CONFIG_SERVERIP
1217
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001218 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001219 server to contact when using the "tftboot" command.
1220
Robin Getz97cfe862009-07-21 12:15:28 -04001221 CONFIG_KEEP_SERVERADDR
1222
1223 Keeps the server's MAC address, in the env 'serveraddr'
1224 for passing to bootargs (like Linux's netconsole option)
1225
David Updegraff53a5c422007-06-11 10:41:07 -05001226- Multicast TFTP Mode:
1227 CONFIG_MCAST_TFTP
1228
1229 Defines whether you want to support multicast TFTP as per
1230 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001231 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001232 driver in use must provide a function: mcast() to join/leave a
1233 multicast group.
1234
1235 CONFIG_BOOTP_RANDOM_DELAY
wdenkc6097192002-11-03 00:24:07 +00001236- BOOTP Recovery Mode:
1237 CONFIG_BOOTP_RANDOM_DELAY
1238
1239 If you have many targets in a network that try to
1240 boot using BOOTP, you may want to avoid that all
1241 systems send out BOOTP requests at precisely the same
1242 moment (which would happen for instance at recovery
1243 from a power failure, when all systems will try to
1244 boot, thus flooding the BOOTP server. Defining
1245 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1246 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001247 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001248
1249 1st BOOTP request: delay 0 ... 1 sec
1250 2nd BOOTP request: delay 0 ... 2 sec
1251 3rd BOOTP request: delay 0 ... 4 sec
1252 4th and following
1253 BOOTP requests: delay 0 ... 8 sec
1254
stroesefe389a82003-08-28 14:17:32 +00001255- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001256 You can fine tune the DHCP functionality by defining
1257 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001258
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001259 CONFIG_BOOTP_SUBNETMASK
1260 CONFIG_BOOTP_GATEWAY
1261 CONFIG_BOOTP_HOSTNAME
1262 CONFIG_BOOTP_NISDOMAIN
1263 CONFIG_BOOTP_BOOTPATH
1264 CONFIG_BOOTP_BOOTFILESIZE
1265 CONFIG_BOOTP_DNS
1266 CONFIG_BOOTP_DNS2
1267 CONFIG_BOOTP_SEND_HOSTNAME
1268 CONFIG_BOOTP_NTPSERVER
1269 CONFIG_BOOTP_TIMEOFFSET
1270 CONFIG_BOOTP_VENDOREX
stroesefe389a82003-08-28 14:17:32 +00001271
Wilson Callan5d110f02007-07-28 10:56:13 -04001272 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1273 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001274
1275 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1276 serverip from a DHCP server, it is possible that more
1277 than one DNS serverip is offered to the client.
1278 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1279 serverip will be stored in the additional environment
1280 variable "dnsip2". The first DNS serverip is always
1281 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001282 is defined.
stroesefe389a82003-08-28 14:17:32 +00001283
1284 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1285 to do a dynamic update of a DNS server. To do this, they
1286 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001287 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001288 of the "hostname" environment variable is passed as
1289 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001290
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001291 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1292
1293 A 32bit value in microseconds for a delay between
1294 receiving a "DHCP Offer" and sending the "DHCP Request".
1295 This fixes a problem with certain DHCP servers that don't
1296 respond 100% of the time to a "DHCP request". E.g. On an
1297 AT91RM9200 processor running at 180MHz, this delay needed
1298 to be *at least* 15,000 usec before a Windows Server 2003
1299 DHCP server would reply 100% of the time. I recommend at
1300 least 50,000 usec to be safe. The alternative is to hope
1301 that one of the retries will be successful but note that
1302 the DHCP timeout and retry process takes a longer than
1303 this delay.
1304
wdenka3d991b2004-04-15 21:48:45 +00001305 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001306 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001307
1308 The device id used in CDP trigger frames.
1309
1310 CONFIG_CDP_DEVICE_ID_PREFIX
1311
1312 A two character string which is prefixed to the MAC address
1313 of the device.
1314
1315 CONFIG_CDP_PORT_ID
1316
1317 A printf format string which contains the ascii name of
1318 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001319 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001320
1321 CONFIG_CDP_CAPABILITIES
1322
1323 A 32bit integer which indicates the device capabilities;
1324 0x00000010 for a normal host which does not forwards.
1325
1326 CONFIG_CDP_VERSION
1327
1328 An ascii string containing the version of the software.
1329
1330 CONFIG_CDP_PLATFORM
1331
1332 An ascii string containing the name of the platform.
1333
1334 CONFIG_CDP_TRIGGER
1335
1336 A 32bit integer sent on the trigger.
1337
1338 CONFIG_CDP_POWER_CONSUMPTION
1339
1340 A 16bit integer containing the power consumption of the
1341 device in .1 of milliwatts.
1342
1343 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1344
1345 A byte containing the id of the VLAN.
1346
wdenkc6097192002-11-03 00:24:07 +00001347- Status LED: CONFIG_STATUS_LED
1348
1349 Several configurations allow to display the current
1350 status using a LED. For instance, the LED will blink
1351 fast while running U-Boot code, stop blinking as
1352 soon as a reply to a BOOTP request was received, and
1353 start blinking slow once the Linux kernel is running
1354 (supported by a status LED driver in the Linux
1355 kernel). Defining CONFIG_STATUS_LED enables this
1356 feature in U-Boot.
1357
1358- CAN Support: CONFIG_CAN_DRIVER
1359
1360 Defining CONFIG_CAN_DRIVER enables CAN driver support
1361 on those systems that support this (optional)
1362 feature, like the TQM8xxL modules.
1363
1364- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1365
wdenkb37c7e52003-06-30 16:24:52 +00001366 These enable I2C serial bus commands. Defining either of
wdenk945af8d2003-07-16 21:53:01 +00001367 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001368 include the appropriate I2C driver for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00001369
wdenk945af8d2003-07-16 21:53:01 +00001370 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001371 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00001372 CONFIG_COMMANDS) and communicate with i2c based realtime
1373 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00001374 command line interface.
wdenkc6097192002-11-03 00:24:07 +00001375
Ben Warrenbb99ad62006-09-07 16:50:54 -04001376 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00001377
wdenk945af8d2003-07-16 21:53:01 +00001378 CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenkb37c7e52003-06-30 16:24:52 +00001379 bit-banging) driver instead of CPM or similar hardware
1380 support for I2C.
wdenkc6097192002-11-03 00:24:07 +00001381
wdenk945af8d2003-07-16 21:53:01 +00001382 There are several other quantities that must also be
wdenkb37c7e52003-06-30 16:24:52 +00001383 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenkc6097192002-11-03 00:24:07 +00001384
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001385 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00001386 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001387 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001388 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00001389
wdenkb37c7e52003-06-30 16:24:52 +00001390 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001391 sets the CPU up as a master node and so its address should
wdenkb37c7e52003-06-30 16:24:52 +00001392 therefore be cleared to 0 (See, eg, MPC823e User's Manual
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001393 p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00001394
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05001395 CONFIG_SYS_I2C_INIT_MPC5XXX
1396
1397 When a board is reset during an i2c bus transfer
1398 chips might think that the current transfer is still
1399 in progress. Reset the slave devices by sending start
1400 commands until the slave device responds.
1401
wdenk945af8d2003-07-16 21:53:01 +00001402 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00001403
1404 If you use the software i2c interface (CONFIG_SOFT_I2C)
1405 then the following macros need to be defined (examples are
1406 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001407
1408 I2C_INIT
1409
wdenkb37c7e52003-06-30 16:24:52 +00001410 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001411 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001412
wdenkba56f622004-02-06 23:19:44 +00001413 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001414
wdenkc6097192002-11-03 00:24:07 +00001415 I2C_PORT
1416
wdenk43d96162003-03-06 00:02:04 +00001417 (Only for MPC8260 CPU). The I/O port to use (the code
1418 assumes both bits are on the same port). Valid values
1419 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00001420
1421 I2C_ACTIVE
1422
1423 The code necessary to make the I2C data line active
1424 (driven). If the data line is open collector, this
1425 define can be null.
1426
wdenkb37c7e52003-06-30 16:24:52 +00001427 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1428
wdenkc6097192002-11-03 00:24:07 +00001429 I2C_TRISTATE
1430
1431 The code necessary to make the I2C data line tri-stated
1432 (inactive). If the data line is open collector, this
1433 define can be null.
1434
wdenkb37c7e52003-06-30 16:24:52 +00001435 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1436
wdenkc6097192002-11-03 00:24:07 +00001437 I2C_READ
1438
1439 Code that returns TRUE if the I2C data line is high,
1440 FALSE if it is low.
1441
wdenkb37c7e52003-06-30 16:24:52 +00001442 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1443
wdenkc6097192002-11-03 00:24:07 +00001444 I2C_SDA(bit)
1445
1446 If <bit> is TRUE, sets the I2C data line high. If it
1447 is FALSE, it clears it (low).
1448
wdenkb37c7e52003-06-30 16:24:52 +00001449 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001450 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001451 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001452
wdenkc6097192002-11-03 00:24:07 +00001453 I2C_SCL(bit)
1454
1455 If <bit> is TRUE, sets the I2C clock line high. If it
1456 is FALSE, it clears it (low).
1457
wdenkb37c7e52003-06-30 16:24:52 +00001458 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001459 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001460 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001461
wdenkc6097192002-11-03 00:24:07 +00001462 I2C_DELAY
1463
1464 This delay is invoked four times per clock cycle so this
1465 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001466 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001467 like:
1468
wdenkb37c7e52003-06-30 16:24:52 +00001469 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001470
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001471 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001472
wdenk8bde7f72003-06-27 21:31:46 +00001473 When a board is reset during an i2c bus transfer
1474 chips might think that the current transfer is still
1475 in progress. On some boards it is possible to access
1476 the i2c SCLK line directly, either by using the
1477 processor pin as a GPIO or by having a second pin
1478 connected to the bus. If this option is defined a
1479 custom i2c_init_board() routine in boards/xxx/board.c
1480 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001481
wdenk17ea1172004-06-06 21:51:03 +00001482 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
1483
1484 This option enables configuration of bi_iic_fast[] flags
1485 in u-boot bd_info structure based on u-boot environment
1486 variable "i2cfast". (see also i2cfast)
1487
Ben Warrenbb99ad62006-09-07 16:50:54 -04001488 CONFIG_I2C_MULTI_BUS
1489
1490 This option allows the use of multiple I2C buses, each of which
1491 must have a controller. At any point in time, only one bus is
1492 active. To switch to a different bus, use the 'i2c dev' command.
1493 Note that bus numbering is zero-based.
1494
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001495 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001496
1497 This option specifies a list of I2C devices that will be skipped
Peter Tyser0f89c542009-04-18 22:34:03 -05001498 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
1499 is set, specify a list of bus-device pairs. Otherwise, specify
1500 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001501
1502 e.g.
1503 #undef CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001504 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001505
1506 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1507
1508 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001509 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001510
1511 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1512
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001513 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001514
1515 If defined, then this indicates the I2C bus number for DDR SPD.
1516 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001518 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001519
1520 If defined, then this indicates the I2C bus number for the RTC.
1521 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1522
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001523 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001524
1525 If defined, then this indicates the I2C bus number for the DTT.
1526 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
1527
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001528 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07001529
1530 If defined, specifies the I2C address of the DTT device.
1531 If not defined, then U-Boot uses predefined value for
1532 specified DTT device.
1533
Timur Tabibe5e6182006-11-03 19:15:00 -06001534 CONFIG_FSL_I2C
1535
1536 Define this option if you want to use Freescale's I2C driver in
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001537 drivers/i2c/fsl_i2c.c.
Timur Tabibe5e6182006-11-03 19:15:00 -06001538
Heiko Schocher67b23a32008-10-15 09:39:47 +02001539 CONFIG_I2C_MUX
1540
1541 Define this option if you have I2C devices reached over 1 .. n
1542 I2C Muxes like the pca9544a. This option addes a new I2C
1543 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
1544 new I2C Bus to the existing I2C Busses. If you select the
1545 new Bus with "i2c dev", u-bbot sends first the commandos for
1546 the muxes to activate this new "bus".
1547
1548 CONFIG_I2C_MULTI_BUS must be also defined, to use this
1549 feature!
1550
1551 Example:
1552 Adding a new I2C Bus reached over 2 pca9544a muxes
1553 The First mux with address 70 and channel 6
1554 The Second mux with address 71 and channel 4
1555
1556 => i2c bus pca9544a:70:6:pca9544a:71:4
1557
1558 Use the "i2c bus" command without parameter, to get a list
1559 of I2C Busses with muxes:
1560
1561 => i2c bus
1562 Busses reached over muxes:
1563 Bus ID: 2
1564 reached over Mux(es):
1565 pca9544a@70 ch: 4
1566 Bus ID: 3
1567 reached over Mux(es):
1568 pca9544a@70 ch: 6
1569 pca9544a@71 ch: 4
1570 =>
1571
1572 If you now switch to the new I2C Bus 3 with "i2c dev 3"
1573 u-boot sends First the Commando to the mux@70 to enable
1574 channel 6, and then the Commando to the mux@71 to enable
1575 the channel 4.
1576
1577 After that, you can use the "normal" i2c commands as
1578 usual, to communicate with your I2C devices behind
1579 the 2 muxes.
1580
1581 This option is actually implemented for the bitbanging
1582 algorithm in common/soft_i2c.c and for the Hardware I2C
1583 Bus on the MPC8260. But it should be not so difficult
1584 to add this option to other architectures.
1585
Andrew Dyer2ac69852008-12-29 17:36:01 -06001586 CONFIG_SOFT_I2C_READ_REPEATED_START
1587
1588 defining this will force the i2c_read() function in
1589 the soft_i2c driver to perform an I2C repeated start
1590 between writing the address pointer and reading the
1591 data. If this define is omitted the default behaviour
1592 of doing a stop-start sequence will be used. Most I2C
1593 devices can use either method, but some require one or
1594 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001595
wdenkc6097192002-11-03 00:24:07 +00001596- SPI Support: CONFIG_SPI
1597
1598 Enables SPI driver (so far only tested with
1599 SPI EEPROM, also an instance works with Crystal A/D and
1600 D/As on the SACSng board)
1601
1602 CONFIG_SPI_X
1603
1604 Enables extended (16-bit) SPI EEPROM addressing.
1605 (symmetrical to CONFIG_I2C_X)
1606
1607 CONFIG_SOFT_SPI
1608
wdenk43d96162003-03-06 00:02:04 +00001609 Enables a software (bit-bang) SPI driver rather than
1610 using hardware support. This is a general purpose
1611 driver that only requires three general I/O port pins
1612 (two outputs, one input) to function. If this is
1613 defined, the board configuration must define several
1614 SPI configuration items (port pins to use, etc). For
1615 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001616
Ben Warren04a9e112008-01-16 22:37:35 -05001617 CONFIG_HARD_SPI
1618
1619 Enables a hardware SPI driver for general-purpose reads
1620 and writes. As with CONFIG_SOFT_SPI, the board configuration
1621 must define a list of chip-select function pointers.
1622 Currently supported on some MPC8xxx processors. For an
1623 example, see include/configs/mpc8349emds.h.
1624
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02001625 CONFIG_MXC_SPI
1626
1627 Enables the driver for the SPI controllers on i.MX and MXC
1628 SoCs. Currently only i.MX31 is supported.
1629
Matthias Fuchs01335022007-12-27 17:12:34 +01001630- FPGA Support: CONFIG_FPGA
1631
1632 Enables FPGA subsystem.
1633
1634 CONFIG_FPGA_<vendor>
1635
1636 Enables support for specific chip vendors.
1637 (ALTERA, XILINX)
1638
1639 CONFIG_FPGA_<family>
1640
1641 Enables support for FPGA family.
1642 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1643
1644 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001645
wdenk43d96162003-03-06 00:02:04 +00001646 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001647
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001648 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001649
wdenk8bde7f72003-06-27 21:31:46 +00001650 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001651
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001652 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00001653
wdenk43d96162003-03-06 00:02:04 +00001654 Enable checks on FPGA configuration interface busy
1655 status by the configuration function. This option
1656 will require a board or device specific function to
1657 be written.
wdenkc6097192002-11-03 00:24:07 +00001658
1659 CONFIG_FPGA_DELAY
1660
1661 If defined, a function that provides delays in the FPGA
1662 configuration driver.
1663
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001664 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00001665 Allow Control-C to interrupt FPGA configuration
1666
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001667 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00001668
wdenk43d96162003-03-06 00:02:04 +00001669 Check for configuration errors during FPGA bitfile
1670 loading. For example, abort during Virtex II
1671 configuration if the INIT_B line goes low (which
1672 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00001673
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001674 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00001675
wdenk43d96162003-03-06 00:02:04 +00001676 Maximum time to wait for the INIT_B line to deassert
1677 after PROB_B has been deasserted during a Virtex II
1678 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001679 ms.
wdenkc6097192002-11-03 00:24:07 +00001680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001681 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00001682
wdenk43d96162003-03-06 00:02:04 +00001683 Maximum time to wait for BUSY to deassert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001684 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00001685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001686 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00001687
wdenk43d96162003-03-06 00:02:04 +00001688 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001689 200 ms.
wdenkc6097192002-11-03 00:24:07 +00001690
1691- Configuration Management:
1692 CONFIG_IDENT_STRING
1693
wdenk43d96162003-03-06 00:02:04 +00001694 If defined, this string will be added to the U-Boot
1695 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00001696
1697- Vendor Parameter Protection:
1698
wdenk43d96162003-03-06 00:02:04 +00001699 U-Boot considers the values of the environment
1700 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00001701 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00001702 are set once by the board vendor / manufacturer, and
1703 protects these variables from casual modification by
1704 the user. Once set, these variables are read-only,
1705 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001706 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00001707
1708 If CONFIG_ENV_OVERWRITE is #defined in your config
1709 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00001710 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00001711 these parameters.
1712
1713 Alternatively, if you #define _both_ CONFIG_ETHADDR
1714 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001715 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00001716 which can be changed exactly ONCE by the user. [The
1717 serial# is unaffected by this, i. e. it remains
1718 read-only.]
1719
1720- Protected RAM:
1721 CONFIG_PRAM
1722
1723 Define this variable to enable the reservation of
1724 "protected RAM", i. e. RAM which is not overwritten
1725 by U-Boot. Define CONFIG_PRAM to hold the number of
1726 kB you want to reserve for pRAM. You can overwrite
1727 this default value by defining an environment
1728 variable "pram" to the number of kB you want to
1729 reserve. Note that the board info structure will
1730 still show the full amount of RAM. If pRAM is
1731 reserved, a new environment variable "mem" will
1732 automatically be defined to hold the amount of
1733 remaining RAM in a form that can be passed as boot
1734 argument to Linux, for instance like that:
1735
Wolfgang Denkfe126d82005-11-20 21:40:11 +01001736 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00001737 saveenv
1738
1739 This way you can tell Linux not to use this memory,
1740 either, which results in a memory region that will
1741 not be affected by reboots.
1742
1743 *WARNING* If your board configuration uses automatic
1744 detection of the RAM size, you must make sure that
1745 this memory test is non-destructive. So far, the
1746 following board configurations are known to be
1747 "pRAM-clean":
1748
1749 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1750 HERMES, IP860, RPXlite, LWMON, LANTEC,
1751 PCU_E, FLAGADM, TQM8260
1752
1753- Error Recovery:
1754 CONFIG_PANIC_HANG
1755
1756 Define this variable to stop the system in case of a
1757 fatal error, so that you have to reset it manually.
1758 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001759 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00001760 automatically as fast as possible, but it may be
1761 useful during development since you can try to debug
1762 the conditions that lead to the situation.
1763
1764 CONFIG_NET_RETRY_COUNT
1765
wdenk43d96162003-03-06 00:02:04 +00001766 This variable defines the number of retries for
1767 network operations like ARP, RARP, TFTP, or BOOTP
1768 before giving up the operation. If not defined, a
1769 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00001770
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02001771 CONFIG_ARP_TIMEOUT
1772
1773 Timeout waiting for an ARP reply in milliseconds.
1774
wdenkc6097192002-11-03 00:24:07 +00001775- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001776 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00001777
1778 Enable auto completion of commands using TAB.
1779
Wolfgang Denka9398e02006-11-27 15:32:42 +01001780 Note that this feature has NOT been implemented yet
1781 for the "hush" shell.
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02001782
1783
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001784 CONFIG_SYS_HUSH_PARSER
wdenkc6097192002-11-03 00:24:07 +00001785
1786 Define this variable to enable the "hush" shell (from
1787 Busybox) as command line interpreter, thus enabling
1788 powerful command line syntax like
1789 if...then...else...fi conditionals or `&&' and '||'
1790 constructs ("shell scripts").
1791
1792 If undefined, you get the old, much simpler behaviour
1793 with a somewhat smaller memory footprint.
1794
1795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001796 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00001797
1798 This defines the secondary prompt string, which is
1799 printed when the command interpreter needs more input
1800 to complete a command. Usually "> ".
1801
1802 Note:
1803
wdenk8bde7f72003-06-27 21:31:46 +00001804 In the current implementation, the local variables
1805 space and global environment variables space are
1806 separated. Local variables are those you define by
1807 simply typing `name=value'. To access a local
1808 variable later on, you have write `$name' or
1809 `${name}'; to execute the contents of a variable
1810 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00001811
wdenk43d96162003-03-06 00:02:04 +00001812 Global environment variables are those you use
1813 setenv/printenv to work with. To run a command stored
1814 in such a variable, you need to use the run command,
1815 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00001816
1817 To store commands and special characters in a
1818 variable, please use double quotation marks
1819 surrounding the whole text of the variable, instead
1820 of the backslashes before semicolons and special
1821 symbols.
1822
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001823- Commandline Editing and History:
1824 CONFIG_CMDLINE_EDITING
1825
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001826 Enable editing and History functions for interactive
Wolfgang Denkb9365a22006-07-21 11:56:05 +02001827 commandline input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02001828
wdenka8c7c702003-12-06 19:49:23 +00001829- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00001830 CONFIG_EXTRA_ENV_SETTINGS
1831
wdenk43d96162003-03-06 00:02:04 +00001832 Define this to contain any number of null terminated
1833 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00001834 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00001835
wdenk43d96162003-03-06 00:02:04 +00001836 For example, place something like this in your
1837 board's config file:
wdenkc6097192002-11-03 00:24:07 +00001838
1839 #define CONFIG_EXTRA_ENV_SETTINGS \
1840 "myvar1=value1\0" \
1841 "myvar2=value2\0"
1842
wdenk43d96162003-03-06 00:02:04 +00001843 Warning: This method is based on knowledge about the
1844 internal format how the environment is stored by the
1845 U-Boot code. This is NOT an official, exported
1846 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00001847 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00001848 You better know what you are doing here.
1849
wdenk43d96162003-03-06 00:02:04 +00001850 Note: overly (ab)use of the default environment is
1851 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001852 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00001853 boot command first.
wdenkc6097192002-11-03 00:24:07 +00001854
wdenka8c7c702003-12-06 19:49:23 +00001855- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00001856 CONFIG_HAS_DATAFLASH
1857
wdenk8bde7f72003-06-27 21:31:46 +00001858 Defining this option enables DataFlash features and
1859 allows to read/write in Dataflash via the standard
1860 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00001861
wdenk3f85ce22004-02-23 16:11:30 +00001862- SystemACE Support:
1863 CONFIG_SYSTEMACE
1864
1865 Adding this option adds support for Xilinx SystemACE
1866 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001867 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001868 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00001869
1870 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001871 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00001872
1873 When SystemACE support is added, the "ace" device type
1874 becomes available to the fat commands, i.e. fatls.
1875
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001876- TFTP Fixed UDP Port:
1877 CONFIG_TFTP_PORT
1878
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001879 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001880 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001881 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001882 number generator is used.
1883
Wolfgang Denk28cb9372005-09-24 23:25:46 +02001884 Also, the environment variable tftpdstp is used to supply
1885 the TFTP UDP destination port value. If tftpdstp isn't
1886 defined, the normal port 69 is used.
1887
1888 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02001889 blindly start the TFTP transfer using the pre-configured
1890 target IP address and UDP port. This has the effect of
1891 "punching through" the (Windows XP) firewall, allowing
1892 the remainder of the TFTP transfer to proceed normally.
1893 A better solution is to properly configure the firewall,
1894 but sometimes that is not allowed.
1895
wdenka8c7c702003-12-06 19:49:23 +00001896- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00001897 CONFIG_SHOW_BOOT_PROGRESS
1898
wdenk43d96162003-03-06 00:02:04 +00001899 Defining this option allows to add some board-
1900 specific code (calling a user-provided function
1901 "show_boot_progress(int)") that enables you to show
1902 the system's boot progress on some display (for
1903 example, some LED's) on your board. At the moment,
1904 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00001905
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001906Legacy uImage format:
1907
wdenkc6097192002-11-03 00:24:07 +00001908 Arg Where When
1909 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00001910 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00001911 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00001912 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001913 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00001914 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00001915 4 common/cmd_bootm.c Image data has correct checksum
1916 -4 common/cmd_bootm.c Image is for unsupported architecture
1917 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001918 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00001919 6 common/cmd_bootm.c Image Type check OK
1920 -6 common/cmd_bootm.c gunzip uncompression error
1921 -7 common/cmd_bootm.c Unimplemented compression type
1922 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001923 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00001924 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001925
1926 9 common/image.c Start initial ramdisk verification
1927 -10 common/image.c Ramdisk header has bad magic number
1928 -11 common/image.c Ramdisk header has bad checksum
1929 10 common/image.c Ramdisk header is OK
1930 -12 common/image.c Ramdisk data has bad checksum
1931 11 common/image.c Ramdisk data has correct checksum
1932 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001933 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01001934 13 common/image.c Start multifile image verification
1935 14 common/image.c No initial ramdisk, no multifile, continue.
1936
1937 15 lib_<arch>/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00001938
wdenk11dadd52004-02-27 00:07:27 +00001939 -30 lib_ppc/board.c Fatal error, hang the system
1940 -31 post/post.c POST test failed, detected by post_output_backlog()
1941 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00001942
Heiko Schocher566a4942007-06-22 19:11:54 +02001943 34 common/cmd_doc.c before loading a Image from a DOC device
1944 -35 common/cmd_doc.c Bad usage of "doc" command
1945 35 common/cmd_doc.c correct usage of "doc" command
1946 -36 common/cmd_doc.c No boot device
1947 36 common/cmd_doc.c correct boot device
1948 -37 common/cmd_doc.c Unknown Chip ID on boot device
1949 37 common/cmd_doc.c correct chip ID found, device available
1950 -38 common/cmd_doc.c Read Error on boot device
1951 38 common/cmd_doc.c reading Image header from DOC device OK
1952 -39 common/cmd_doc.c Image header has bad magic number
1953 39 common/cmd_doc.c Image header has correct magic number
1954 -40 common/cmd_doc.c Error reading Image from DOC device
1955 40 common/cmd_doc.c Image header has correct magic number
1956 41 common/cmd_ide.c before loading a Image from a IDE device
1957 -42 common/cmd_ide.c Bad usage of "ide" command
1958 42 common/cmd_ide.c correct usage of "ide" command
1959 -43 common/cmd_ide.c No boot device
1960 43 common/cmd_ide.c boot device found
1961 -44 common/cmd_ide.c Device not available
1962 44 common/cmd_ide.c Device available
1963 -45 common/cmd_ide.c wrong partition selected
1964 45 common/cmd_ide.c partition selected
1965 -46 common/cmd_ide.c Unknown partition table
1966 46 common/cmd_ide.c valid partition table found
1967 -47 common/cmd_ide.c Invalid partition type
1968 47 common/cmd_ide.c correct partition type
1969 -48 common/cmd_ide.c Error reading Image Header on boot device
1970 48 common/cmd_ide.c reading Image Header from IDE device OK
1971 -49 common/cmd_ide.c Image header has bad magic number
1972 49 common/cmd_ide.c Image header has correct magic number
1973 -50 common/cmd_ide.c Image header has bad checksum
1974 50 common/cmd_ide.c Image header has correct checksum
1975 -51 common/cmd_ide.c Error reading Image from IDE device
1976 51 common/cmd_ide.c reading Image from IDE device OK
1977 52 common/cmd_nand.c before loading a Image from a NAND device
1978 -53 common/cmd_nand.c Bad usage of "nand" command
1979 53 common/cmd_nand.c correct usage of "nand" command
1980 -54 common/cmd_nand.c No boot device
1981 54 common/cmd_nand.c boot device found
1982 -55 common/cmd_nand.c Unknown Chip ID on boot device
1983 55 common/cmd_nand.c correct chip ID found, device available
1984 -56 common/cmd_nand.c Error reading Image Header on boot device
1985 56 common/cmd_nand.c reading Image Header from NAND device OK
1986 -57 common/cmd_nand.c Image header has bad magic number
1987 57 common/cmd_nand.c Image header has correct magic number
1988 -58 common/cmd_nand.c Error reading Image from NAND device
1989 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00001990
Heiko Schocher566a4942007-06-22 19:11:54 +02001991 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00001992
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001993 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02001994 -64 net/eth.c no Ethernet found.
1995 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00001996
Heiko Schocher566a4942007-06-22 19:11:54 +02001997 -80 common/cmd_net.c usage wrong
1998 80 common/cmd_net.c before calling NetLoop()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001999 -81 common/cmd_net.c some error in NetLoop() occurred
Heiko Schocher566a4942007-06-22 19:11:54 +02002000 81 common/cmd_net.c NetLoop() back without error
2001 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2002 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002003 83 common/cmd_net.c running "source" command
2004 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002005 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002006
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002007FIT uImage format:
2008
2009 Arg Where When
2010 100 common/cmd_bootm.c Kernel FIT Image has correct format
2011 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2012 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2013 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2014 102 common/cmd_bootm.c Kernel unit name specified
2015 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002016 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002017 104 common/cmd_bootm.c Got kernel subimage node offset
2018 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2019 105 common/cmd_bootm.c Kernel subimage hash verification OK
2020 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2021 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002022 -106 common/cmd_bootm.c Kernel subimage has wrong type
2023 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002024 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2025 108 common/cmd_bootm.c Got kernel subimage data/size
2026 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2027 -109 common/cmd_bootm.c Can't get kernel subimage type
2028 -110 common/cmd_bootm.c Can't get kernel subimage comp
2029 -111 common/cmd_bootm.c Can't get kernel subimage os
2030 -112 common/cmd_bootm.c Can't get kernel subimage load address
2031 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2032
2033 120 common/image.c Start initial ramdisk verification
2034 -120 common/image.c Ramdisk FIT image has incorrect format
2035 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002036 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002037 -122 common/image.c Can't get configuration for ramdisk subimage
2038 123 common/image.c Ramdisk unit name specified
2039 -124 common/image.c Can't get ramdisk subimage node offset
2040 125 common/image.c Got ramdisk subimage node offset
2041 -125 common/image.c Ramdisk subimage hash verification failed
2042 126 common/image.c Ramdisk subimage hash verification OK
2043 -126 common/image.c Ramdisk subimage for unsupported architecture
2044 127 common/image.c Architecture check OK
2045 -127 common/image.c Can't get ramdisk subimage data/size
2046 128 common/image.c Got ramdisk subimage data/size
2047 129 common/image.c Can't get ramdisk load address
2048 -129 common/image.c Got ramdisk load address
2049
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002050 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002051 131 common/cmd_doc.c FIT image format OK
2052
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002053 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002054 141 common/cmd_ide.c FIT image format OK
2055
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002056 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002057 151 common/cmd_nand.c FIT image format OK
2058
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002059- Automatic software updates via TFTP server
2060 CONFIG_UPDATE_TFTP
2061 CONFIG_UPDATE_TFTP_CNT_MAX
2062 CONFIG_UPDATE_TFTP_MSEC_MAX
2063
2064 These options enable and control the auto-update feature;
2065 for a more detailed description refer to doc/README.update.
2066
2067- MTD Support (mtdparts command, UBI support)
2068 CONFIG_MTD_DEVICE
2069
2070 Adds the MTD device infrastructure from the Linux kernel.
2071 Needed for mtdparts command support.
2072
2073 CONFIG_MTD_PARTITIONS
2074
2075 Adds the MTD partitioning infrastructure from the Linux
2076 kernel. Needed for UBI support.
2077
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002078
wdenkc6097192002-11-03 00:24:07 +00002079Modem Support:
2080--------------
2081
wdenk85ec0bc2003-03-31 16:34:49 +00002082[so far only for SMDK2400 and TRAB boards]
wdenkc6097192002-11-03 00:24:07 +00002083
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002084- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00002085 CONFIG_MODEM_SUPPORT
2086
2087- RTS/CTS Flow control enable:
2088 CONFIG_HWFLOW
2089
2090- Modem debug support:
2091 CONFIG_MODEM_SUPPORT_DEBUG
2092
wdenk43d96162003-03-06 00:02:04 +00002093 Enables debugging stuff (char screen[1024], dbg())
2094 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00002095
wdenka8c7c702003-12-06 19:49:23 +00002096- Interrupt support (PPC):
2097
wdenkd4ca31c2004-01-02 14:00:00 +00002098 There are common interrupt_init() and timer_interrupt()
2099 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002100 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00002101 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002102 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00002103 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002104 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00002105 specific handling. If board has watchdog / status_led
2106 / other_activity_monitor it works automatically from
2107 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00002108
wdenkc6097192002-11-03 00:24:07 +00002109- General:
2110
wdenk43d96162003-03-06 00:02:04 +00002111 In the target system modem support is enabled when a
2112 specific key (key combination) is pressed during
2113 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002114 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00002115 board_init(). Currently key_pressed() is a dummy
2116 function, returning 1 and thus enabling modem
2117 initialization.
wdenkc6097192002-11-03 00:24:07 +00002118
wdenk43d96162003-03-06 00:02:04 +00002119 If there are no modem init strings in the
2120 environment, U-Boot proceed to autoboot; the
2121 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002122 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00002123
2124 See also: doc/README.Modem
2125
2126
wdenkc6097192002-11-03 00:24:07 +00002127Configuration Settings:
2128-----------------------
2129
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002130- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00002131 undefine this when you're short of memory.
2132
Peter Tyser2fb26042009-01-27 18:03:12 -06002133- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2134 width of the commands listed in the 'help' command output.
2135
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002136- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00002137 prompt for user input.
2138
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002139- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00002140
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002141- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00002142
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002143- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00002144
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002145- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00002146 the application (usually a Linux kernel) when it is
2147 booted
2148
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002149- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00002150 List of legal baudrate settings for this board.
2151
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002152- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00002153 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00002154
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002155- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00002156 If the board specific function
2157 extern int overwrite_console (void);
2158 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00002159 serial port, else the settings in the environment are used.
2160
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002161- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00002162 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00002163
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002164- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00002165 Enable overwrite of previous console environment settings.
2166
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002167- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00002168 Begin and End addresses of the area used by the
2169 simple memory test.
2170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002171- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00002172 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00002173
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002174- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00002175 Scratch address used by the alternate memory test
2176 You only need to set this if address zero isn't writeable
2177
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002178- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
2179 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01002180 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002181 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01002182 fixing up gd->ram_size the Linux kernel should gets passed
2183 the now "corrected" memory size and won't touch it either.
2184 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01002185 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01002186 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01002187 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01002188
2189 This option can be used as a workaround for the 440EPx/GRx
2190 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
2191 be touched.
2192
2193 WARNING: Please make sure that this value is a multiple of
2194 the Linux page size (normally 4k). If this is not the case,
2195 then the end address of the Linux memory will be located at a
2196 non page size aligned address and this could cause major
2197 problems.
2198
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002199- CONFIG_SYS_TFTP_LOADADDR:
wdenkc6097192002-11-03 00:24:07 +00002200 Default load address for network file downloads
2201
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002202- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00002203 Enable temporary baudrate change while serial download
2204
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002205- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00002206 Physical start address of SDRAM. _Must_ be 0 here.
2207
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002208- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00002209 Physical start address of Motherboard I/O (if using a
2210 Cogent motherboard)
2211
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002212- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00002213 Physical start address of Flash memory.
2214
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002215- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00002216 Physical start address of boot monitor code (set by
2217 make config files to be same as the text base address
2218 (TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002219 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00002220
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002221- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00002222 Size of memory reserved for monitor code, used to
2223 determine _at_compile_time_ (!) if the environment is
2224 embedded within the U-Boot image, or in a separate
2225 flash sector.
wdenkc6097192002-11-03 00:24:07 +00002226
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002227- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00002228 Size of DRAM reserved for malloc() use.
2229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002230- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01002231 Normally compressed uImages are limited to an
2232 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002233 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01002234 to adjust this setting to your needs.
2235
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002236- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00002237 Maximum size of memory mapped by the startup code of
2238 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02002239 the Linux kernel (bd_info, boot arguments, FDT blob if
2240 used) must be put below this limit, unless "bootm_low"
2241 enviroment variable is defined and non-zero. In such case
2242 all data for the Linux kernel must be between "bootm_low"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002243 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
wdenkc6097192002-11-03 00:24:07 +00002244
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002245- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00002246 Max number of Flash memory banks
2247
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002248- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00002249 Max number of sectors on a Flash chip
2250
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002251- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002252 Timeout for Flash erase operations (in ms)
2253
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002254- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00002255 Timeout for Flash write operations (in ms)
2256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002257- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002258 Timeout for Flash set sector lock bit operation (in ms)
2259
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002260- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00002261 Timeout for Flash clear lock bits operation (in ms)
2262
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002263- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00002264 If defined, hardware flash sectors protection is used
2265 instead of U-Boot software protection.
2266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002267- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00002268
2269 Enable TFTP transfers directly to flash memory;
2270 without this option such a download has to be
2271 performed in two steps: (1) download to RAM, and (2)
2272 copy from RAM to flash.
2273
2274 The two-step approach is usually more reliable, since
2275 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002276 the flash, but in some situations (when system RAM is
2277 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00002278 downloaded image) this option may be very useful.
2279
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002280- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00002281 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00002282 common flash structure for storing flash geometry.
2283
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02002284- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00002285 This option also enables the building of the cfi_flash driver
2286 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00002287
Piotr Ziecik91809ed2008-11-17 15:57:58 +01002288- CONFIG_FLASH_CFI_MTD
2289 This option enables the building of the cfi_mtd driver
2290 in the drivers directory. The driver exports CFI flash
2291 to the MTD layer.
2292
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002293- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02002294 Use buffered writes to flash.
2295
2296- CONFIG_FLASH_SPANSION_S29WS_N
2297 s29ws-n MirrorBit flash has non-standard addresses for buffered
2298 write commands.
2299
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002300- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01002301 If this option is defined, the common CFI flash doesn't
2302 print it's warning upon not recognized FLASH banks. This
2303 is useful, if some of the configured banks are only
2304 optionally available.
2305
Jerry Van Baren9a042e92008-03-08 13:48:01 -05002306- CONFIG_FLASH_SHOW_PROGRESS
2307 If defined (must be an integer), print out countdown
2308 digits and dots. Recommended value: 45 (9..1) for 80
2309 column displays, 15 (3..1) for 40 column displays.
2310
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002311- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002312 Defines the number of Ethernet receive buffers. On some
2313 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00002314 to 8 or even higher (EEPRO100 or 405 EMAC), since all
2315 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002316 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00002317 Defaults to 4 if not defined.
2318
wdenkc6097192002-11-03 00:24:07 +00002319The following definitions that deal with the placement and management
2320of environment data (variable area); in general, we support the
2321following configurations:
2322
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002323- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00002324
2325 Define this if the environment is in flash memory.
2326
2327 a) The environment occupies one whole flash sector, which is
2328 "embedded" in the text segment with the U-Boot code. This
2329 happens usually with "bottom boot sector" or "top boot
2330 sector" type flash chips, which have several smaller
2331 sectors at the start or the end. For instance, such a
2332 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2333 such a case you would place the environment in one of the
2334 4 kB sectors - with U-Boot code before and after it. With
2335 "top boot sector" type flash chips, you would put the
2336 environment in one of the last sectors, leaving a gap
2337 between U-Boot and the environment.
2338
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002339 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002340
2341 Offset of environment data (variable area) to the
2342 beginning of flash memory; for instance, with bottom boot
2343 type flash chips the second sector can be used: the offset
2344 for this sector is given here.
2345
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002346 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00002347
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002348 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002349
2350 This is just another way to specify the start address of
2351 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002352 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00002353
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002354 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002355
2356 Size of the sector containing the environment.
2357
2358
2359 b) Sometimes flash chips have few, equal sized, BIG sectors.
2360 In such a case you don't want to spend a whole sector for
2361 the environment.
2362
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002363 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002364
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02002365 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002366 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00002367 of this flash sector for the environment. This saves
2368 memory for the RAM copy of the environment.
2369
2370 It may also save flash memory if you decide to use this
2371 when your environment is "embedded" within U-Boot code,
2372 since then the remainder of the flash sector could be used
2373 for U-Boot code. It should be pointed out that this is
2374 STRONGLY DISCOURAGED from a robustness point of view:
2375 updating the environment in flash makes it always
2376 necessary to erase the WHOLE sector. If something goes
2377 wrong before the contents has been restored from a copy in
2378 RAM, your target system will be dead.
2379
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002380 - CONFIG_ENV_ADDR_REDUND
2381 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00002382
wdenk43d96162003-03-06 00:02:04 +00002383 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002384 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00002385 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00002386 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00002387
2388BE CAREFUL! Any changes to the flash layout, and some changes to the
2389source code will make it necessary to adapt <board>/u-boot.lds*
2390accordingly!
2391
2392
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02002393- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00002394
2395 Define this if you have some non-volatile memory device
2396 (NVRAM, battery buffered SRAM) which you want to use for the
2397 environment.
2398
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002399 - CONFIG_ENV_ADDR:
2400 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002401
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002402 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00002403 want to use for environment. It is assumed that this memory
2404 can just be read and written to, without any special
2405 provision.
2406
2407BE CAREFUL! The first access to the environment happens quite early
2408in U-Boot initalization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002409console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00002410U-Boot will hang.
2411
2412Please note that even with NVRAM we still use a copy of the
2413environment in RAM: we could work on NVRAM directly, but we want to
2414keep settings there always unmodified except somebody uses "saveenv"
2415to save the current settings.
2416
2417
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02002418- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00002419
2420 Use this if you have an EEPROM or similar serial access
2421 device and a driver for it.
2422
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002423 - CONFIG_ENV_OFFSET:
2424 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002425
2426 These two #defines specify the offset and size of the
2427 environment area within the total memory of your EEPROM.
2428
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002429 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002430 If defined, specified the chip address of the EEPROM device.
2431 The default address is zero.
2432
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002433 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00002434 If defined, the number of bits used to address bytes in a
2435 single page in the EEPROM device. A 64 byte page, for example
2436 would require six bits.
2437
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002438 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00002439 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00002440 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00002441
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002442 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00002443 The length in bytes of the EEPROM memory array address. Note
2444 that this is NOT the chip address length!
2445
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002446 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00002447 EEPROM chips that implement "address overflow" are ones
2448 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
2449 address and the extra bits end up in the "chip address" bit
2450 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
2451 byte chips.
2452
2453 Note that we consider the length of the address field to
2454 still be one byte because the extra address bits are hidden
2455 in the chip address.
2456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002457 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002458 The size in bytes of the EEPROM device.
2459
Heiko Schocher548738b2010-01-07 08:55:40 +01002460 - CONFIG_ENV_EEPROM_IS_ON_I2C
2461 define this, if you have I2C and SPI activated, and your
2462 EEPROM, which holds the environment, is on the I2C bus.
2463
2464 - CONFIG_I2C_ENV_EEPROM_BUS
2465 if you have an Environment on an EEPROM reached over
2466 I2C muxes, you can define here, how to reach this
2467 EEPROM. For example:
2468
2469 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0"
2470
2471 EEPROM which holds the environment, is reached over
2472 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00002473
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02002474- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00002475
wdenkd4ca31c2004-01-02 14:00:00 +00002476 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00002477 want to use for the environment.
2478
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002479 - CONFIG_ENV_OFFSET:
2480 - CONFIG_ENV_ADDR:
2481 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00002482
2483 These three #defines specify the offset and size of the
2484 environment area within the total memory of your DataFlash placed
2485 at the specified address.
2486
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02002487- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00002488
2489 Define this if you have a NAND device which you want to use
2490 for the environment.
2491
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002492 - CONFIG_ENV_OFFSET:
2493 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00002494
2495 These two #defines specify the offset and size of the environment
2496 area within the first NAND device.
wdenk5779d8d2003-12-06 23:55:10 +00002497
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002498 - CONFIG_ENV_OFFSET_REDUND
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002499
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002500 This setting describes a second storage area of CONFIG_ENV_SIZE
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002501 size used to hold a redundant copy of the environment data,
2502 so that there is a valid backup copy in case there is a
2503 power failure during a "saveenv" operation.
2504
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02002505 Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
2506 to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
Markus Klotzbuechere443c942006-03-20 18:02:44 +01002507 the NAND devices block size.
2508
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02002509- CONFIG_NAND_ENV_DST
2510
2511 Defines address in RAM to which the nand_spl code should copy the
2512 environment. If redundant environment is used, it will be copied to
2513 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002515- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00002516
2517 Defines offset to the initial SPI buffer area in DPRAM. The
2518 area is used at an early stage (ROM part) if the environment
2519 is configured to reside in the SPI EEPROM: We need a 520 byte
2520 scratch DPRAM area. It is used between the two initialization
2521 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2522 to be a good choice since it makes it far enough from the
2523 start of the data area as well as from the stack pointer.
2524
Bruce Adlere881cb52007-11-02 13:15:42 -07002525Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00002526has been relocated to RAM and a RAM copy of the environment has been
2527created; also, when using EEPROM you will have to use getenv_r()
2528until then to read environment variables.
2529
wdenk85ec0bc2003-03-31 16:34:49 +00002530The environment is protected by a CRC32 checksum. Before the monitor
2531is relocated into RAM, as a result of a bad CRC you will be working
2532with the compiled-in default environment - *silently*!!! [This is
2533necessary, because the first environment variable we need is the
2534"baudrate" setting for the console - if we have a bad CRC, we don't
2535have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00002536
2537Note: once the monitor has been relocated, then it will complain if
2538the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00002539use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00002540
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002541- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00002542 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00002543
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002544 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00002545 also needs to be defined.
2546
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002547- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00002548 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00002549
Ron Madridf5675aa2009-02-18 14:30:44 -08002550- CONFIG_NS16550_MIN_FUNCTIONS:
2551 Define this if you desire to only have use of the NS16550_init
2552 and NS16550_putc functions for the serial driver located at
2553 drivers/serial/ns16550.c. This option is useful for saving
2554 space for already greatly restricted images, including but not
2555 limited to NAND_SPL configurations.
2556
wdenkc6097192002-11-03 00:24:07 +00002557Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00002558---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00002559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002560- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00002561 Cache Line Size of the CPU.
2562
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002563- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00002564 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00002565
wdenk42d1f032003-10-15 23:53:47 +00002566 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
2567 and RPXsuper) to be able to adjust the position of
2568 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00002569
wdenk7f6c2cb2002-11-10 22:06:23 +00002570- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002571 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00002572
2573 the default drive number (default value 0)
2574
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002575 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00002576
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002577 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00002578 (default value 1)
2579
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002580 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00002581
wdenk43d96162003-03-06 00:02:04 +00002582 defines the offset of register from address. It
2583 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002584 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00002585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002586 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
2587 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00002588 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00002589
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002590 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00002591 fdc_hw_init() is called at the beginning of the FDC
2592 setup. fdc_hw_init() must be provided by the board
2593 source code. It is used to make hardware dependant
2594 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00002595
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002596- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00002597 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00002598 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00002599
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002600- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00002601
wdenk7152b1d2003-09-05 23:19:14 +00002602 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00002603 initial data and stack; please note that this must be
2604 writable memory that is working WITHOUT special
2605 initialization, i. e. you CANNOT use normal RAM which
2606 will become available only after programming the
2607 memory controller and running certain initialization
2608 sequences.
2609
2610 U-Boot uses the following memory types:
2611 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2612 - MPC824X: data cache
2613 - PPC4xx: data cache
2614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002615- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00002616
2617 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002618 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
2619 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00002620 data is located at the end of the available space
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002621 (sometimes written as (CONFIG_SYS_INIT_RAM_END -
2622 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
2623 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
2624 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00002625
2626 Note:
2627 On the MPC824X (or other systems that use the data
2628 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002629 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00002630 point to an otherwise UNUSED address space between
2631 the top of RAM and the start of the PCI space.
2632
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002633- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00002634
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002635- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00002636
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002637- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00002638
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002639- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00002640
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002641- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00002642
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002643- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00002644
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002645- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00002646 SDRAM timing
2647
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002648- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00002649 periodic timer for refresh
2650
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002651- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00002652
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002653- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
2654 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
2655 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
2656 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002657 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2658
2659- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002660 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
2661 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00002662 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2663
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002664- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
2665 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00002666 Machine Mode Register and Memory Periodic Timer
2667 Prescaler definitions (SDRAM timing)
2668
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002669- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002670 enable I2C microcode relocation patch (MPC8xx);
2671 define relocation offset in DPRAM [DSP2]
2672
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002673- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01002674 enable SMC microcode relocation patch (MPC8xx);
2675 define relocation offset in DPRAM [SMC1]
2676
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002677- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00002678 enable SPI microcode relocation patch (MPC8xx);
2679 define relocation offset in DPRAM [SCC4]
2680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002681- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00002682 Use OSCM clock mode on MBX8xx board. Be careful,
2683 wrong setting might damage your board. Read
2684 doc/README.MBX before setting this variable!
2685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002686- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00002687 Offset of the bootmode word in DPRAM used by post
2688 (Power On Self Tests). This definition overrides
2689 #define'd default value in commproc.h resp.
2690 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00002691
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002692- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
2693 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
2694 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
2695 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
2696 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
2697 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
2698 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
2699 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
wdenk5d232d02003-05-22 22:52:13 +00002700 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
2701
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01002702- CONFIG_PCI_DISABLE_PCIE:
2703 Disable PCI-Express on systems where it is supported but not
2704 required.
2705
Ben Warrenbb99ad62006-09-07 16:50:54 -04002706- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002707 Get DDR timing information from an I2C EEPROM. Common
2708 with pluggable memory modules such as SODIMMs
2709
Ben Warrenbb99ad62006-09-07 16:50:54 -04002710 SPD_EEPROM_ADDRESS
2711 I2C address of the SPD EEPROM
2712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002713- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01002714 If SPD EEPROM is on an I2C bus other than the first
2715 one, specify here. Note that the value must resolve
2716 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002717
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002718- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01002719 Only for 83xx systems. If specified, then DDR should
2720 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06002721
wdenkc26e4542004-04-18 10:13:26 +00002722- CONFIG_ETHER_ON_FEC[12]
2723 Define to enable FEC[12] on a 8xx series processor.
2724
2725- CONFIG_FEC[12]_PHY
2726 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00002727 to the given FEC; i. e.
2728 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00002729 means that the PHY with address 4 is connected to FEC1
2730
2731 When set to -1, means to probe for first available.
2732
2733- CONFIG_FEC[12]_PHY_NORXERR
2734 The PHY does not have a RXERR line (RMII only).
2735 (so program the FEC to ignore it).
2736
2737- CONFIG_RMII
2738 Enable RMII mode for all FECs.
2739 Note that this is a global option, we can't
2740 have one FEC in standard MII mode and another in RMII mode.
2741
wdenk5cf91d62004-04-23 20:32:05 +00002742- CONFIG_CRC32_VERIFY
2743 Add a verify option to the crc32 command.
2744 The syntax is:
2745
2746 => crc32 -v <address> <count> <crc32>
2747
2748 Where address/count indicate a memory area
2749 and crc32 is the correct crc32 which the
2750 area should have.
2751
wdenk56523f12004-07-11 17:40:54 +00002752- CONFIG_LOOPW
2753 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002754 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00002755
stroese7b466642004-12-16 18:46:55 +00002756- CONFIG_MX_CYCLIC
2757 Add the "mdc" and "mwc" memory commands. These are cyclic
2758 "md/mw" commands.
2759 Examples:
2760
wdenkefe2a4d2004-12-16 21:44:03 +00002761 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00002762 This command will print 4 bytes (10,11,12,13) each 500 ms.
2763
wdenkefe2a4d2004-12-16 21:44:03 +00002764 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00002765 This command will write 12345678 to address 100 all 10 ms.
2766
wdenkefe2a4d2004-12-16 21:44:03 +00002767 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002768 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00002769
wdenk8aa1a2d2005-04-04 12:44:11 +00002770- CONFIG_SKIP_LOWLEVEL_INIT
2771- CONFIG_SKIP_RELOCATE_UBOOT
2772
wdenk3c2b3d42005-04-05 23:32:21 +00002773 [ARM only] If these variables are defined, then
2774 certain low level initializations (like setting up
2775 the memory controller) are omitted and/or U-Boot does
2776 not relocate itself into RAM.
2777 Normally these variables MUST NOT be defined. The
2778 only exception is when U-Boot is loaded (to RAM) by
2779 some other boot loader or by a debugger which
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002780 performs these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00002781
Magnus Liljadf812382009-06-13 20:50:00 +02002782- CONFIG_PRELOADER
2783
2784 Modifies the behaviour of start.S when compiling a loader
2785 that is executed before the actual U-Boot. E.g. when
2786 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00002787
wdenkc6097192002-11-03 00:24:07 +00002788Building the Software:
2789======================
2790
Wolfgang Denk218ca722008-03-26 10:40:12 +01002791Building U-Boot has been tested in several native build environments
2792and in many different cross environments. Of course we cannot support
2793all possibly existing versions of cross development tools in all
2794(potentially obsolete) versions. In case of tool chain problems we
2795recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2796which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00002797
Wolfgang Denk218ca722008-03-26 10:40:12 +01002798If you are not using a native environment, it is assumed that you
2799have GNU cross compiling tools available in your path. In this case,
2800you must set the environment variable CROSS_COMPILE in your shell.
2801Note that no changes to the Makefile or any other source files are
2802necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00002803
Wolfgang Denk218ca722008-03-26 10:40:12 +01002804 $ CROSS_COMPILE=ppc_4xx-
2805 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00002806
Peter Tyser2f8d3962009-03-13 18:54:51 -05002807Note: If you wish to generate Windows versions of the utilities in
2808 the tools directory you can use the MinGW toolchain
2809 (http://www.mingw.org). Set your HOST tools to the MinGW
2810 toolchain and execute 'make tools'. For example:
2811
2812 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
2813
2814 Binaries such as tools/mkimage.exe will be created which can
2815 be executed on computers running Windows.
2816
Wolfgang Denk218ca722008-03-26 10:40:12 +01002817U-Boot is intended to be simple to build. After installing the
2818sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00002819is done by typing:
2820
2821 make NAME_config
2822
Wolfgang Denk218ca722008-03-26 10:40:12 +01002823where "NAME_config" is the name of one of the existing configu-
2824rations; see the main Makefile for supported names.
wdenk54387ac2003-10-08 22:45:44 +00002825
wdenk2729af92004-05-03 20:45:30 +00002826Note: for some board special configuration names may exist; check if
2827 additional information is available from the board vendor; for
2828 instance, the TQM823L systems are available without (standard)
2829 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002830 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00002831
wdenk2729af92004-05-03 20:45:30 +00002832 make TQM823L_config
2833 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00002834
wdenk2729af92004-05-03 20:45:30 +00002835 make TQM823L_LCD_config
2836 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00002837
wdenk2729af92004-05-03 20:45:30 +00002838 etc.
wdenkc6097192002-11-03 00:24:07 +00002839
wdenkc6097192002-11-03 00:24:07 +00002840
wdenk2729af92004-05-03 20:45:30 +00002841Finally, type "make all", and you should get some working U-Boot
2842images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00002843
wdenk2729af92004-05-03 20:45:30 +00002844- "u-boot.bin" is a raw binary image
2845- "u-boot" is an image in ELF binary format
2846- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00002847
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002848By default the build is performed locally and the objects are saved
2849in the source directory. One of the two methods can be used to change
2850this behavior and build U-Boot to some external directory:
2851
28521. Add O= to the make command line invocations:
2853
2854 make O=/tmp/build distclean
2855 make O=/tmp/build NAME_config
2856 make O=/tmp/build all
2857
28582. Set environment variable BUILD_DIR to point to the desired location:
2859
2860 export BUILD_DIR=/tmp/build
2861 make distclean
2862 make NAME_config
2863 make all
2864
2865Note that the command line "O=" setting overrides the BUILD_DIR environment
2866variable.
2867
wdenkc6097192002-11-03 00:24:07 +00002868
wdenk2729af92004-05-03 20:45:30 +00002869Please be aware that the Makefiles assume you are using GNU make, so
2870for instance on NetBSD you might need to use "gmake" instead of
2871native "make".
wdenkc6097192002-11-03 00:24:07 +00002872
wdenkc6097192002-11-03 00:24:07 +00002873
wdenk2729af92004-05-03 20:45:30 +00002874If the system board that you have is not listed, then you will need
2875to port U-Boot to your hardware platform. To do this, follow these
2876steps:
wdenkc6097192002-11-03 00:24:07 +00002877
wdenk2729af92004-05-03 20:45:30 +000028781. Add a new configuration option for your board to the toplevel
2879 "Makefile" and to the "MAKEALL" script, using the existing
2880 entries as examples. Note that here and at many other places
2881 boards and other names are listed in alphabetical sort order. Please
2882 keep this order.
28832. Create a new directory to hold your board specific code. Add any
2884 files you need. In your board directory, you will need at least
2885 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
28863. Create a new configuration file "include/configs/<board>.h" for
2887 your board
28883. If you're porting U-Boot to a new CPU, then also create a new
2889 directory to hold your CPU specific code. Add any files you need.
28904. Run "make <board>_config" with your new name.
28915. Type "make", and you should get a working "u-boot.srec" file
2892 to be installed on your target system.
28936. Debug and solve any problems that might arise.
2894 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00002895
wdenkc6097192002-11-03 00:24:07 +00002896
wdenk2729af92004-05-03 20:45:30 +00002897Testing of U-Boot Modifications, Ports to New Hardware, etc.:
2898==============================================================
wdenkc6097192002-11-03 00:24:07 +00002899
Wolfgang Denk218ca722008-03-26 10:40:12 +01002900If you have modified U-Boot sources (for instance added a new board
2901or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00002902provide feedback to the other developers. The feedback normally takes
2903the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01002904official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00002905
Wolfgang Denk218ca722008-03-26 10:40:12 +01002906But before you submit such a patch, please verify that your modifi-
2907cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00002908the supported boards compile WITHOUT ANY compiler warnings. To do so,
2909just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01002910for ALL supported system. Be warned, this will take a while. You can
2911select which (cross) compiler to use by passing a `CROSS_COMPILE'
2912environment variable to the script, i. e. to use the ELDK cross tools
2913you can type
wdenkc6097192002-11-03 00:24:07 +00002914
wdenk2729af92004-05-03 20:45:30 +00002915 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002916
wdenk2729af92004-05-03 20:45:30 +00002917or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00002918
wdenk2729af92004-05-03 20:45:30 +00002919 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00002920
Wolfgang Denk218ca722008-03-26 10:40:12 +01002921When using the MAKEALL script, the default behaviour is to build
2922U-Boot in the source directory. This location can be changed by
2923setting the BUILD_DIR environment variable. Also, for each target
2924built, the MAKEALL script saves two log files (<target>.ERR and
2925<target>.MAKEALL) in the <source dir>/LOG directory. This default
2926location can be changed by setting the MAKEALL_LOGDIR environment
2927variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002928
2929 export BUILD_DIR=/tmp/build
2930 export MAKEALL_LOGDIR=/tmp/log
2931 CROSS_COMPILE=ppc_8xx- MAKEALL
2932
Wolfgang Denk218ca722008-03-26 10:40:12 +01002933With the above settings build objects are saved in the /tmp/build,
2934log files are saved in the /tmp/log and the source tree remains clean
2935during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02002936
2937
wdenk2729af92004-05-03 20:45:30 +00002938See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00002939
wdenkc6097192002-11-03 00:24:07 +00002940
wdenk2729af92004-05-03 20:45:30 +00002941Monitor Commands - Overview:
2942============================
wdenkc6097192002-11-03 00:24:07 +00002943
wdenk2729af92004-05-03 20:45:30 +00002944go - start application at address 'addr'
2945run - run commands in an environment variable
2946bootm - boot application image from memory
2947bootp - boot image via network using BootP/TFTP protocol
2948tftpboot- boot image via network using TFTP protocol
2949 and env variables "ipaddr" and "serverip"
2950 (and eventually "gatewayip")
2951rarpboot- boot image via network using RARP/TFTP protocol
2952diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
2953loads - load S-Record file over serial line
2954loadb - load binary file over serial line (kermit mode)
2955md - memory display
2956mm - memory modify (auto-incrementing)
2957nm - memory modify (constant address)
2958mw - memory write (fill)
2959cp - memory copy
2960cmp - memory compare
2961crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05002962i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00002963sspi - SPI utility commands
2964base - print or set address offset
2965printenv- print environment variables
2966setenv - set environment variables
2967saveenv - save environment variables to persistent storage
2968protect - enable or disable FLASH write protection
2969erase - erase FLASH memory
2970flinfo - print FLASH memory information
2971bdinfo - print Board Info structure
2972iminfo - print header information for application image
2973coninfo - print console devices and informations
2974ide - IDE sub-system
2975loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00002976loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00002977mtest - simple RAM test
2978icache - enable or disable instruction cache
2979dcache - enable or disable data cache
2980reset - Perform RESET of the CPU
2981echo - echo args to console
2982version - print monitor version
2983help - print online help
2984? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00002985
wdenkc6097192002-11-03 00:24:07 +00002986
wdenk2729af92004-05-03 20:45:30 +00002987Monitor Commands - Detailed Description:
2988========================================
wdenkc6097192002-11-03 00:24:07 +00002989
wdenk2729af92004-05-03 20:45:30 +00002990TODO.
wdenkc6097192002-11-03 00:24:07 +00002991
wdenk2729af92004-05-03 20:45:30 +00002992For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00002993
2994
wdenk2729af92004-05-03 20:45:30 +00002995Environment Variables:
2996======================
wdenkc6097192002-11-03 00:24:07 +00002997
wdenk2729af92004-05-03 20:45:30 +00002998U-Boot supports user configuration using Environment Variables which
2999can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00003000
wdenk2729af92004-05-03 20:45:30 +00003001Environment Variables are set using "setenv", printed using
3002"printenv", and saved to Flash using "saveenv". Using "setenv"
3003without a value can be used to delete a variable from the
3004environment. As long as you don't save the environment you are
3005working with an in-memory copy. In case the Flash area containing the
3006environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00003007
wdenk2729af92004-05-03 20:45:30 +00003008Some configuration options can be set using Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003009
wdenk2729af92004-05-03 20:45:30 +00003010 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00003011
wdenk2729af92004-05-03 20:45:30 +00003012 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00003013
wdenk2729af92004-05-03 20:45:30 +00003014 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00003015
wdenk2729af92004-05-03 20:45:30 +00003016 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00003017
wdenk2729af92004-05-03 20:45:30 +00003018 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00003019
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003020 bootm_low - Memory range available for image processing in the bootm
3021 command can be restricted. This variable is given as
3022 a hexadecimal number and defines lowest address allowed
3023 for use by the bootm command. See also "bootm_size"
3024 environment variable. Address defined by "bootm_low" is
3025 also the base of the initial memory mapping for the Linux
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003026 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003027
3028 bootm_size - Memory range available for image processing in the bootm
3029 command can be restricted. This variable is given as
3030 a hexadecimal number and defines the size of the region
3031 allowed for use by the bootm command. See also "bootm_low"
3032 environment variable.
3033
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02003034 updatefile - Location of the software update file on a TFTP server, used
3035 by the automatic software update feature. Please refer to
3036 documentation in doc/README.update for more details.
3037
wdenk2729af92004-05-03 20:45:30 +00003038 autoload - if set to "no" (any string beginning with 'n'),
3039 "bootp" will just load perform a lookup of the
3040 configuration from the BOOTP server, but not try to
3041 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00003042
wdenk2729af92004-05-03 20:45:30 +00003043 autostart - if set to "yes", an image loaded using the "bootp",
3044 "rarpboot", "tftpboot" or "diskboot" commands will
3045 be automatically started (by internally calling
3046 "bootm")
wdenkc6097192002-11-03 00:24:07 +00003047
wdenk2729af92004-05-03 20:45:30 +00003048 If set to "no", a standalone image passed to the
3049 "bootm" command will be copied to the load address
3050 (and eventually uncompressed), but NOT be started.
3051 This can be used to load and uncompress arbitrary
3052 data.
wdenkc6097192002-11-03 00:24:07 +00003053
wdenk17ea1172004-06-06 21:51:03 +00003054 i2cfast - (PPC405GP|PPC405EP only)
3055 if set to 'y' configures Linux I2C driver for fast
3056 mode (400kHZ). This environment variable is used in
3057 initialization code. So, for changes to be effective
3058 it must be saved and board must be reset.
3059
wdenk2729af92004-05-03 20:45:30 +00003060 initrd_high - restrict positioning of initrd images:
3061 If this variable is not set, initrd images will be
3062 copied to the highest possible address in RAM; this
3063 is usually what you want since it allows for
3064 maximum initrd size. If for some reason you want to
3065 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003066 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00003067 variable to a value of "no" or "off" or "0".
3068 Alternatively, you can set it to a maximum upper
3069 address to use (U-Boot will still check that it
3070 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00003071
wdenk2729af92004-05-03 20:45:30 +00003072 For instance, when you have a system with 16 MB
3073 RAM, and want to reserve 4 MB from use by Linux,
3074 you can do this by adding "mem=12M" to the value of
3075 the "bootargs" variable. However, now you must make
3076 sure that the initrd image is placed in the first
3077 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00003078
wdenk2729af92004-05-03 20:45:30 +00003079 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00003080
wdenk2729af92004-05-03 20:45:30 +00003081 If you set initrd_high to 0xFFFFFFFF, this is an
3082 indication to U-Boot that all addresses are legal
3083 for the Linux kernel, including addresses in flash
3084 memory. In this case U-Boot will NOT COPY the
3085 ramdisk at all. This may be useful to reduce the
3086 boot time on your system, but requires that this
3087 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00003088
wdenk2729af92004-05-03 20:45:30 +00003089 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00003090
wdenk2729af92004-05-03 20:45:30 +00003091 loadaddr - Default load address for commands like "bootp",
3092 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00003093
wdenk2729af92004-05-03 20:45:30 +00003094 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00003095
wdenk2729af92004-05-03 20:45:30 +00003096 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00003097
wdenk2729af92004-05-03 20:45:30 +00003098 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00003099
wdenk2729af92004-05-03 20:45:30 +00003100 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00003101
wdenk2729af92004-05-03 20:45:30 +00003102 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00003103
wdenk2729af92004-05-03 20:45:30 +00003104 ethprime - When CONFIG_NET_MULTI is enabled controls which
3105 interface is used first.
wdenkc6097192002-11-03 00:24:07 +00003106
wdenk2729af92004-05-03 20:45:30 +00003107 ethact - When CONFIG_NET_MULTI is enabled controls which
3108 interface is currently active. For example you
3109 can do the following
wdenkc6097192002-11-03 00:24:07 +00003110
wdenk2729af92004-05-03 20:45:30 +00003111 => setenv ethact FEC ETHERNET
3112 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3113 => setenv ethact SCC ETHERNET
3114 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
wdenkc6097192002-11-03 00:24:07 +00003115
Matthias Fuchse1692572008-01-17 07:45:05 +01003116 ethrotate - When set to "no" U-Boot does not go through all
3117 available network interfaces.
3118 It just stays at the currently selected interface.
3119
wdenk2729af92004-05-03 20:45:30 +00003120 netretry - When set to "no" each network operation will
3121 either succeed or fail without retrying.
3122 When set to "once" the network operation will
3123 fail when all the available network interfaces
3124 are tried once without success.
3125 Useful on scripts which control the retry operation
3126 themselves.
wdenkc6097192002-11-03 00:24:07 +00003127
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01003128 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01003129
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003130 tftpsrcport - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003131 UDP source port.
3132
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003133 tftpdstport - If this is set, the value is used for TFTP's UDP
3134 destination port instead of the Well Know Port 69.
3135
wdenk2729af92004-05-03 20:45:30 +00003136 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003137 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00003138 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00003139
wdenk2729af92004-05-03 20:45:30 +00003140The following environment variables may be used and automatically
3141updated by the network boot commands ("bootp" and "rarpboot"),
3142depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00003143
wdenk2729af92004-05-03 20:45:30 +00003144 bootfile - see above
3145 dnsip - IP address of your Domain Name Server
3146 dnsip2 - IP address of your secondary Domain Name Server
3147 gatewayip - IP address of the Gateway (Router) to use
3148 hostname - Target hostname
3149 ipaddr - see above
3150 netmask - Subnet Mask
3151 rootpath - Pathname of the root filesystem on the NFS server
3152 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00003153
wdenka3d991b2004-04-15 21:48:45 +00003154
wdenk2729af92004-05-03 20:45:30 +00003155There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003156
wdenk2729af92004-05-03 20:45:30 +00003157 serial# - contains hardware identification information such
3158 as type string and/or serial number
3159 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00003160
wdenk2729af92004-05-03 20:45:30 +00003161These variables can be set only once (usually during manufacturing of
3162the board). U-Boot refuses to delete or overwrite these variables
3163once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00003164
3165
wdenk2729af92004-05-03 20:45:30 +00003166Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00003167
wdenk2729af92004-05-03 20:45:30 +00003168 ver - Contains the U-Boot version string as printed
3169 with the "version" command. This variable is
3170 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00003171
wdenkc6097192002-11-03 00:24:07 +00003172
wdenk2729af92004-05-03 20:45:30 +00003173Please note that changes to some configuration parameters may take
3174only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00003175
stroesec1551ea2003-04-04 15:53:41 +00003176
wdenk2729af92004-05-03 20:45:30 +00003177Command Line Parsing:
3178=====================
stroesec1551ea2003-04-04 15:53:41 +00003179
wdenk2729af92004-05-03 20:45:30 +00003180There are two different command line parsers available with U-Boot:
3181the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00003182
wdenk2729af92004-05-03 20:45:30 +00003183Old, simple command line parser:
3184--------------------------------
wdenkc6097192002-11-03 00:24:07 +00003185
wdenk2729af92004-05-03 20:45:30 +00003186- supports environment variables (through setenv / saveenv commands)
3187- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003188- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00003189- special characters ('$', ';') can be escaped by prefixing with '\',
3190 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01003191 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00003192- You can also escape text by enclosing in single apostrophes, for example:
3193 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00003194
wdenk2729af92004-05-03 20:45:30 +00003195Hush shell:
3196-----------
wdenkf07771c2003-05-28 08:06:31 +00003197
wdenk2729af92004-05-03 20:45:30 +00003198- similar to Bourne shell, with control structures like
3199 if...then...else...fi, for...do...done; while...do...done,
3200 until...do...done, ...
3201- supports environment ("global") variables (through setenv / saveenv
3202 commands) and local shell variables (through standard shell syntax
3203 "name=value"); only environment variables can be used with "run"
3204 command
wdenkf07771c2003-05-28 08:06:31 +00003205
wdenk2729af92004-05-03 20:45:30 +00003206General rules:
3207--------------
wdenkf07771c2003-05-28 08:06:31 +00003208
wdenk2729af92004-05-03 20:45:30 +00003209(1) If a command line (or an environment variable executed by a "run"
3210 command) contains several commands separated by semicolon, and
3211 one of these commands fails, then the remaining commands will be
3212 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00003213
wdenk2729af92004-05-03 20:45:30 +00003214(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003215 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00003216 command will cause "run" to terminate, i. e. the remaining
3217 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00003218
wdenk2729af92004-05-03 20:45:30 +00003219Note for Redundant Ethernet Interfaces:
3220=======================================
wdenkf07771c2003-05-28 08:06:31 +00003221
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003222Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00003223such configurations and is capable of automatic selection of a
3224"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00003225
wdenk2729af92004-05-03 20:45:30 +00003226Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
3227MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3228"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00003229
wdenk2729af92004-05-03 20:45:30 +00003230If the network interface stores some valid MAC address (for instance
3231in SROM), this is used as default address if there is NO correspon-
3232ding setting in the environment; if the corresponding environment
3233variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00003234
wdenk2729af92004-05-03 20:45:30 +00003235o If the SROM has a valid MAC address, and there is no address in the
3236 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00003237
wdenk2729af92004-05-03 20:45:30 +00003238o If there is no valid address in the SROM, and a definition in the
3239 environment exists, then the value from the environment variable is
3240 used.
wdenkc6097192002-11-03 00:24:07 +00003241
wdenk2729af92004-05-03 20:45:30 +00003242o If both the SROM and the environment contain a MAC address, and
3243 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00003244
wdenk2729af92004-05-03 20:45:30 +00003245o If both the SROM and the environment contain a MAC address, and the
3246 addresses differ, the value from the environment is used and a
3247 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00003248
wdenk2729af92004-05-03 20:45:30 +00003249o If neither SROM nor the environment contain a MAC address, an error
3250 is raised.
wdenkc6097192002-11-03 00:24:07 +00003251
wdenkc6097192002-11-03 00:24:07 +00003252
wdenk2729af92004-05-03 20:45:30 +00003253Image Formats:
3254==============
wdenkc6097192002-11-03 00:24:07 +00003255
Marian Balakowicz3310c542008-03-12 12:13:13 +01003256U-Boot is capable of booting (and performing other auxiliary operations on)
3257images in two formats:
3258
3259New uImage format (FIT)
3260-----------------------
3261
3262Flexible and powerful format based on Flattened Image Tree -- FIT (similar
3263to Flattened Device Tree). It allows the use of images with multiple
3264components (several kernels, ramdisks, etc.), with contents protected by
3265SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
3266
3267
3268Old uImage format
3269-----------------
3270
3271Old image format is based on binary files which can be basically anything,
3272preceded by a special header; see the definitions in include/image.h for
3273details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00003274
wdenk2729af92004-05-03 20:45:30 +00003275* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3276 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05003277 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3278 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3279 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003280* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
wdenk2729af92004-05-03 20:45:30 +00003281 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02003282 Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00003283* Compression Type (uncompressed, gzip, bzip2)
3284* Load Address
3285* Entry Point
3286* Image Name
3287* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00003288
wdenk2729af92004-05-03 20:45:30 +00003289The header is marked by a special Magic Number, and both the header
3290and the data portions of the image are secured against corruption by
3291CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00003292
wdenkc6097192002-11-03 00:24:07 +00003293
wdenk2729af92004-05-03 20:45:30 +00003294Linux Support:
3295==============
wdenkc6097192002-11-03 00:24:07 +00003296
wdenk2729af92004-05-03 20:45:30 +00003297Although U-Boot should support any OS or standalone application
3298easily, the main focus has always been on Linux during the design of
3299U-Boot.
wdenkc6097192002-11-03 00:24:07 +00003300
wdenk2729af92004-05-03 20:45:30 +00003301U-Boot includes many features that so far have been part of some
3302special "boot loader" code within the Linux kernel. Also, any
3303"initrd" images to be used are no longer part of one big Linux image;
3304instead, kernel and "initrd" are separate images. This implementation
3305serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00003306
wdenk2729af92004-05-03 20:45:30 +00003307- the same features can be used for other OS or standalone
3308 applications (for instance: using compressed images to reduce the
3309 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00003310
wdenk2729af92004-05-03 20:45:30 +00003311- it becomes much easier to port new Linux kernel versions because
3312 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00003313
wdenk2729af92004-05-03 20:45:30 +00003314- the same Linux kernel image can now be used with different "initrd"
3315 images; of course this also means that different kernel images can
3316 be run with the same "initrd". This makes testing easier (you don't
3317 have to build a new "zImage.initrd" Linux image when you just
3318 change a file in your "initrd"). Also, a field-upgrade of the
3319 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00003320
wdenkc6097192002-11-03 00:24:07 +00003321
wdenk2729af92004-05-03 20:45:30 +00003322Linux HOWTO:
3323============
wdenkc6097192002-11-03 00:24:07 +00003324
wdenk2729af92004-05-03 20:45:30 +00003325Porting Linux to U-Boot based systems:
3326---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003327
wdenk2729af92004-05-03 20:45:30 +00003328U-Boot cannot save you from doing all the necessary modifications to
3329configure the Linux device drivers for use with your target hardware
3330(no, we don't intend to provide a full virtual machine interface to
3331Linux :-).
wdenkc6097192002-11-03 00:24:07 +00003332
wdenk2729af92004-05-03 20:45:30 +00003333But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00003334
wdenk2729af92004-05-03 20:45:30 +00003335Just make sure your machine specific header file (for instance
3336include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02003337Information structure as we define in include/asm-<arch>/u-boot.h,
3338and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003339as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00003340
wdenkc6097192002-11-03 00:24:07 +00003341
wdenk2729af92004-05-03 20:45:30 +00003342Configuring the Linux kernel:
3343-----------------------------
wdenkc6097192002-11-03 00:24:07 +00003344
wdenk2729af92004-05-03 20:45:30 +00003345No specific requirements for U-Boot. Make sure you have some root
3346device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00003347
wdenkc6097192002-11-03 00:24:07 +00003348
wdenk2729af92004-05-03 20:45:30 +00003349Building a Linux Image:
3350-----------------------
wdenkc6097192002-11-03 00:24:07 +00003351
wdenk2729af92004-05-03 20:45:30 +00003352With U-Boot, "normal" build targets like "zImage" or "bzImage" are
3353not used. If you use recent kernel source, a new build target
3354"uImage" will exist which automatically builds an image usable by
3355U-Boot. Most older kernels also have support for a "pImage" target,
3356which was introduced for our predecessor project PPCBoot and uses a
3357100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00003358
wdenk2729af92004-05-03 20:45:30 +00003359Example:
wdenkc6097192002-11-03 00:24:07 +00003360
wdenk2729af92004-05-03 20:45:30 +00003361 make TQM850L_config
3362 make oldconfig
3363 make dep
3364 make uImage
wdenkc6097192002-11-03 00:24:07 +00003365
wdenk2729af92004-05-03 20:45:30 +00003366The "uImage" build target uses a special tool (in 'tools/mkimage') to
3367encapsulate a compressed Linux kernel image with header information,
3368CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00003369
wdenk2729af92004-05-03 20:45:30 +00003370* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00003371
wdenk2729af92004-05-03 20:45:30 +00003372* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00003373
wdenk2729af92004-05-03 20:45:30 +00003374 ${CROSS_COMPILE}-objcopy -O binary \
3375 -R .note -R .comment \
3376 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00003377
wdenk2729af92004-05-03 20:45:30 +00003378* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00003379
wdenk2729af92004-05-03 20:45:30 +00003380 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00003381
wdenk2729af92004-05-03 20:45:30 +00003382* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00003383
wdenk2729af92004-05-03 20:45:30 +00003384 mkimage -A ppc -O linux -T kernel -C gzip \
3385 -a 0 -e 0 -n "Linux Kernel Image" \
3386 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00003387
wdenk24ee89b2002-11-03 17:56:27 +00003388
wdenk2729af92004-05-03 20:45:30 +00003389The "mkimage" tool can also be used to create ramdisk images for use
3390with U-Boot, either separated from the Linux kernel image, or
3391combined into one file. "mkimage" encapsulates the images with a 64
3392byte header containing information about target architecture,
3393operating system, image type, compression method, entry points, time
3394stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00003395
wdenk2729af92004-05-03 20:45:30 +00003396"mkimage" can be called in two ways: to verify existing images and
3397print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00003398
wdenk2729af92004-05-03 20:45:30 +00003399In the first form (with "-l" option) mkimage lists the information
3400contained in the header of an existing U-Boot image; this includes
3401checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00003402
wdenk2729af92004-05-03 20:45:30 +00003403 tools/mkimage -l image
3404 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00003405
wdenk2729af92004-05-03 20:45:30 +00003406The second form (with "-d" option) is used to build a U-Boot image
3407from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00003408
wdenk2729af92004-05-03 20:45:30 +00003409 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3410 -n name -d data_file image
3411 -A ==> set architecture to 'arch'
3412 -O ==> set operating system to 'os'
3413 -T ==> set image type to 'type'
3414 -C ==> set compression type 'comp'
3415 -a ==> set load address to 'addr' (hex)
3416 -e ==> set entry point to 'ep' (hex)
3417 -n ==> set image name to 'name'
3418 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00003419
wdenk69459792004-05-29 16:53:29 +00003420Right now, all Linux kernels for PowerPC systems use the same load
3421address (0x00000000), but the entry point address depends on the
3422kernel version:
wdenkc6097192002-11-03 00:24:07 +00003423
wdenk2729af92004-05-03 20:45:30 +00003424- 2.2.x kernels have the entry point at 0x0000000C,
3425- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00003426
wdenk2729af92004-05-03 20:45:30 +00003427So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00003428
wdenk2729af92004-05-03 20:45:30 +00003429 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3430 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3431 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
3432 > examples/uImage.TQM850L
3433 Image Name: 2.4.4 kernel for TQM850L
3434 Created: Wed Jul 19 02:34:59 2000
3435 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3436 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3437 Load Address: 0x00000000
3438 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003439
wdenk2729af92004-05-03 20:45:30 +00003440To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00003441
wdenk2729af92004-05-03 20:45:30 +00003442 -> tools/mkimage -l examples/uImage.TQM850L
3443 Image Name: 2.4.4 kernel for TQM850L
3444 Created: Wed Jul 19 02:34:59 2000
3445 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3446 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
3447 Load Address: 0x00000000
3448 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003449
wdenk2729af92004-05-03 20:45:30 +00003450NOTE: for embedded systems where boot time is critical you can trade
3451speed for memory and install an UNCOMPRESSED image instead: this
3452needs more space in Flash, but boots much faster since it does not
3453need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00003454
wdenk2729af92004-05-03 20:45:30 +00003455 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
3456 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
3457 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3458 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
3459 > examples/uImage.TQM850L-uncompressed
3460 Image Name: 2.4.4 kernel for TQM850L
3461 Created: Wed Jul 19 02:34:59 2000
3462 Image Type: PowerPC Linux Kernel Image (uncompressed)
3463 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
3464 Load Address: 0x00000000
3465 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003466
wdenkc6097192002-11-03 00:24:07 +00003467
wdenk2729af92004-05-03 20:45:30 +00003468Similar you can build U-Boot images from a 'ramdisk.image.gz' file
3469when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00003470
wdenk2729af92004-05-03 20:45:30 +00003471 -> tools/mkimage -n 'Simple Ramdisk Image' \
3472 > -A ppc -O linux -T ramdisk -C gzip \
3473 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3474 Image Name: Simple Ramdisk Image
3475 Created: Wed Jan 12 14:01:50 2000
3476 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3477 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
3478 Load Address: 0x00000000
3479 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00003480
wdenkdb01a2e2004-04-15 23:14:49 +00003481
wdenk2729af92004-05-03 20:45:30 +00003482Installing a Linux Image:
3483-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00003484
wdenk2729af92004-05-03 20:45:30 +00003485To downloading a U-Boot image over the serial (console) interface,
3486you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00003487
wdenk2729af92004-05-03 20:45:30 +00003488 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00003489
wdenk2729af92004-05-03 20:45:30 +00003490The 'objcopy' does not understand the information in the U-Boot
3491image header, so the resulting S-Record file will be relative to
3492address 0x00000000. To load it to a given address, you need to
3493specify the target address as 'offset' parameter with the 'loads'
3494command.
wdenkc6097192002-11-03 00:24:07 +00003495
wdenk2729af92004-05-03 20:45:30 +00003496Example: install the image to address 0x40100000 (which on the
3497TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00003498
wdenk2729af92004-05-03 20:45:30 +00003499 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00003500
wdenk2729af92004-05-03 20:45:30 +00003501 .......... done
3502 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00003503
wdenk2729af92004-05-03 20:45:30 +00003504 => loads 40100000
3505 ## Ready for S-Record download ...
3506 ~>examples/image.srec
3507 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3508 ...
3509 15989 15990 15991 15992
3510 [file transfer complete]
3511 [connected]
3512 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00003513
3514
wdenk2729af92004-05-03 20:45:30 +00003515You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01003516this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00003517corruption happened:
wdenkc6097192002-11-03 00:24:07 +00003518
wdenk2729af92004-05-03 20:45:30 +00003519 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00003520
wdenk2729af92004-05-03 20:45:30 +00003521 ## Checking Image at 40100000 ...
3522 Image Name: 2.2.13 for initrd on TQM850L
3523 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3524 Data Size: 335725 Bytes = 327 kB = 0 MB
3525 Load Address: 00000000
3526 Entry Point: 0000000c
3527 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003528
3529
wdenk2729af92004-05-03 20:45:30 +00003530Boot Linux:
3531-----------
wdenkc6097192002-11-03 00:24:07 +00003532
wdenk2729af92004-05-03 20:45:30 +00003533The "bootm" command is used to boot an application that is stored in
3534memory (RAM or Flash). In case of a Linux kernel image, the contents
3535of the "bootargs" environment variable is passed to the kernel as
3536parameters. You can check and modify this variable using the
3537"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00003538
3539
wdenk2729af92004-05-03 20:45:30 +00003540 => printenv bootargs
3541 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00003542
wdenk2729af92004-05-03 20:45:30 +00003543 => 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 +00003544
wdenk2729af92004-05-03 20:45:30 +00003545 => printenv bootargs
3546 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 +00003547
wdenk2729af92004-05-03 20:45:30 +00003548 => bootm 40020000
3549 ## Booting Linux kernel at 40020000 ...
3550 Image Name: 2.2.13 for NFS on TQM850L
3551 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3552 Data Size: 381681 Bytes = 372 kB = 0 MB
3553 Load Address: 00000000
3554 Entry Point: 0000000c
3555 Verifying Checksum ... OK
3556 Uncompressing Kernel Image ... OK
3557 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
3558 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3559 time_init: decrementer frequency = 187500000/60
3560 Calibrating delay loop... 49.77 BogoMIPS
3561 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3562 ...
wdenkc6097192002-11-03 00:24:07 +00003563
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003564If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00003565the memory addresses of both the kernel and the initrd image (PPBCOOT
3566format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00003567
wdenk2729af92004-05-03 20:45:30 +00003568 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00003569
wdenk2729af92004-05-03 20:45:30 +00003570 ## Checking Image at 40100000 ...
3571 Image Name: 2.2.13 for initrd on TQM850L
3572 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3573 Data Size: 335725 Bytes = 327 kB = 0 MB
3574 Load Address: 00000000
3575 Entry Point: 0000000c
3576 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003577
wdenk2729af92004-05-03 20:45:30 +00003578 ## Checking Image at 40200000 ...
3579 Image Name: Simple Ramdisk Image
3580 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3581 Data Size: 566530 Bytes = 553 kB = 0 MB
3582 Load Address: 00000000
3583 Entry Point: 00000000
3584 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00003585
wdenk2729af92004-05-03 20:45:30 +00003586 => bootm 40100000 40200000
3587 ## Booting Linux kernel at 40100000 ...
3588 Image Name: 2.2.13 for initrd on TQM850L
3589 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3590 Data Size: 335725 Bytes = 327 kB = 0 MB
3591 Load Address: 00000000
3592 Entry Point: 0000000c
3593 Verifying Checksum ... OK
3594 Uncompressing Kernel Image ... OK
3595 ## Loading RAMDisk Image at 40200000 ...
3596 Image Name: Simple Ramdisk Image
3597 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
3598 Data Size: 566530 Bytes = 553 kB = 0 MB
3599 Load Address: 00000000
3600 Entry Point: 00000000
3601 Verifying Checksum ... OK
3602 Loading Ramdisk ... OK
3603 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
3604 Boot arguments: root=/dev/ram
3605 time_init: decrementer frequency = 187500000/60
3606 Calibrating delay loop... 49.77 BogoMIPS
3607 ...
3608 RAMDISK: Compressed image found at block 0
3609 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00003610
wdenk2729af92004-05-03 20:45:30 +00003611 bash#
wdenkc6097192002-11-03 00:24:07 +00003612
Matthew McClintock02677682006-06-28 10:41:37 -05003613Boot Linux and pass a flat device tree:
3614-----------
3615
3616First, U-Boot must be compiled with the appropriate defines. See the section
3617titled "Linux Kernel Interface" above for a more in depth explanation. The
3618following is an example of how to start a kernel and pass an updated
3619flat device tree:
3620
3621=> print oftaddr
3622oftaddr=0x300000
3623=> print oft
3624oft=oftrees/mpc8540ads.dtb
3625=> tftp $oftaddr $oft
3626Speed: 1000, full duplex
3627Using TSEC0 device
3628TFTP from server 192.168.1.1; our IP address is 192.168.1.101
3629Filename 'oftrees/mpc8540ads.dtb'.
3630Load address: 0x300000
3631Loading: #
3632done
3633Bytes transferred = 4106 (100a hex)
3634=> tftp $loadaddr $bootfile
3635Speed: 1000, full duplex
3636Using TSEC0 device
3637TFTP from server 192.168.1.1; our IP address is 192.168.1.2
3638Filename 'uImage'.
3639Load address: 0x200000
3640Loading:############
3641done
3642Bytes transferred = 1029407 (fb51f hex)
3643=> print loadaddr
3644loadaddr=200000
3645=> print oftaddr
3646oftaddr=0x300000
3647=> bootm $loadaddr - $oftaddr
3648## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01003649 Image Name: Linux-2.6.17-dirty
3650 Image Type: PowerPC Linux Kernel Image (gzip compressed)
3651 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05003652 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01003653 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05003654 Verifying Checksum ... OK
3655 Uncompressing Kernel Image ... OK
3656Booting using flat device tree at 0x300000
3657Using MPC85xx ADS machine description
3658Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
3659[snip]
3660
3661
wdenk2729af92004-05-03 20:45:30 +00003662More About U-Boot Image Types:
3663------------------------------
wdenk6069ff22003-02-28 00:49:47 +00003664
wdenk2729af92004-05-03 20:45:30 +00003665U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00003666
wdenk2729af92004-05-03 20:45:30 +00003667 "Standalone Programs" are directly runnable in the environment
3668 provided by U-Boot; it is expected that (if they behave
3669 well) you can continue to work in U-Boot after return from
3670 the Standalone Program.
3671 "OS Kernel Images" are usually images of some Embedded OS which
3672 will take over control completely. Usually these programs
3673 will install their own set of exception handlers, device
3674 drivers, set up the MMU, etc. - this means, that you cannot
3675 expect to re-enter U-Boot except by resetting the CPU.
3676 "RAMDisk Images" are more or less just data blocks, and their
3677 parameters (address, size) are passed to an OS kernel that is
3678 being started.
3679 "Multi-File Images" contain several images, typically an OS
3680 (Linux) kernel image and one or more data images like
3681 RAMDisks. This construct is useful for instance when you want
3682 to boot over the network using BOOTP etc., where the boot
3683 server provides just a single image file, but you want to get
3684 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00003685
wdenk2729af92004-05-03 20:45:30 +00003686 "Multi-File Images" start with a list of image sizes, each
3687 image size (in bytes) specified by an "uint32_t" in network
3688 byte order. This list is terminated by an "(uint32_t)0".
3689 Immediately after the terminating 0 follow the images, one by
3690 one, all aligned on "uint32_t" boundaries (size rounded up to
3691 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00003692
wdenk2729af92004-05-03 20:45:30 +00003693 "Firmware Images" are binary images containing firmware (like
3694 U-Boot or FPGA images) which usually will be programmed to
3695 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00003696
wdenk2729af92004-05-03 20:45:30 +00003697 "Script files" are command sequences that will be executed by
3698 U-Boot's command interpreter; this feature is especially
3699 useful when you configure U-Boot to use a real shell (hush)
3700 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00003701
wdenkc6097192002-11-03 00:24:07 +00003702
wdenk2729af92004-05-03 20:45:30 +00003703Standalone HOWTO:
3704=================
wdenkc6097192002-11-03 00:24:07 +00003705
wdenk2729af92004-05-03 20:45:30 +00003706One of the features of U-Boot is that you can dynamically load and
3707run "standalone" applications, which can use some resources of
3708U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00003709
wdenk2729af92004-05-03 20:45:30 +00003710Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00003711
wdenk2729af92004-05-03 20:45:30 +00003712"Hello World" Demo:
3713-------------------
wdenkc6097192002-11-03 00:24:07 +00003714
wdenk2729af92004-05-03 20:45:30 +00003715'examples/hello_world.c' contains a small "Hello World" Demo
3716application; it is automatically compiled when you build U-Boot.
3717It's configured to run at address 0x00040004, so you can play with it
3718like that:
wdenkc6097192002-11-03 00:24:07 +00003719
wdenk2729af92004-05-03 20:45:30 +00003720 => loads
3721 ## Ready for S-Record download ...
3722 ~>examples/hello_world.srec
3723 1 2 3 4 5 6 7 8 9 10 11 ...
3724 [file transfer complete]
3725 [connected]
3726 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003727
wdenk2729af92004-05-03 20:45:30 +00003728 => go 40004 Hello World! This is a test.
3729 ## Starting application at 0x00040004 ...
3730 Hello World
3731 argc = 7
3732 argv[0] = "40004"
3733 argv[1] = "Hello"
3734 argv[2] = "World!"
3735 argv[3] = "This"
3736 argv[4] = "is"
3737 argv[5] = "a"
3738 argv[6] = "test."
3739 argv[7] = "<NULL>"
3740 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00003741
wdenk2729af92004-05-03 20:45:30 +00003742 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003743
wdenk2729af92004-05-03 20:45:30 +00003744Another example, which demonstrates how to register a CPM interrupt
3745handler with the U-Boot code, can be found in 'examples/timer.c'.
3746Here, a CPM timer is set up to generate an interrupt every second.
3747The interrupt service routine is trivial, just printing a '.'
3748character, but this is just a demo program. The application can be
3749controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00003750
wdenk2729af92004-05-03 20:45:30 +00003751 ? - print current values og the CPM Timer registers
3752 b - enable interrupts and start timer
3753 e - stop timer and disable interrupts
3754 q - quit application
wdenkc6097192002-11-03 00:24:07 +00003755
wdenk2729af92004-05-03 20:45:30 +00003756 => loads
3757 ## Ready for S-Record download ...
3758 ~>examples/timer.srec
3759 1 2 3 4 5 6 7 8 9 10 11 ...
3760 [file transfer complete]
3761 [connected]
3762 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00003763
wdenk2729af92004-05-03 20:45:30 +00003764 => go 40004
3765 ## Starting application at 0x00040004 ...
3766 TIMERS=0xfff00980
3767 Using timer 1
3768 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00003769
wdenk2729af92004-05-03 20:45:30 +00003770Hit 'b':
3771 [q, b, e, ?] Set interval 1000000 us
3772 Enabling timer
3773Hit '?':
3774 [q, b, e, ?] ........
3775 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3776Hit '?':
3777 [q, b, e, ?] .
3778 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3779Hit '?':
3780 [q, b, e, ?] .
3781 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3782Hit '?':
3783 [q, b, e, ?] .
3784 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3785Hit 'e':
3786 [q, b, e, ?] ...Stopping timer
3787Hit 'q':
3788 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00003789
3790
wdenk2729af92004-05-03 20:45:30 +00003791Minicom warning:
3792================
wdenk85ec0bc2003-03-31 16:34:49 +00003793
wdenk2729af92004-05-03 20:45:30 +00003794Over time, many people have reported problems when trying to use the
3795"minicom" terminal emulation program for serial download. I (wd)
3796consider minicom to be broken, and recommend not to use it. Under
3797Unix, I recommend to use C-Kermit for general purpose use (and
3798especially for kermit binary protocol download ("loadb" command), and
3799use "cu" for S-Record download ("loads" command).
wdenk85ec0bc2003-03-31 16:34:49 +00003800
wdenk2729af92004-05-03 20:45:30 +00003801Nevertheless, if you absolutely want to use it try adding this
3802configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00003803
wdenk2729af92004-05-03 20:45:30 +00003804 Name Program Name U/D FullScr IO-Red. Multi
3805 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
3806 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00003807
3808
wdenk2729af92004-05-03 20:45:30 +00003809NetBSD Notes:
3810=============
wdenkc6097192002-11-03 00:24:07 +00003811
wdenk2729af92004-05-03 20:45:30 +00003812Starting at version 0.9.2, U-Boot supports NetBSD both as host
3813(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00003814
wdenk2729af92004-05-03 20:45:30 +00003815Building requires a cross environment; it is known to work on
3816NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3817need gmake since the Makefiles are not compatible with BSD make).
3818Note that the cross-powerpc package does not install include files;
3819attempting to build U-Boot will fail because <machine/ansi.h> is
3820missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00003821
wdenk2729af92004-05-03 20:45:30 +00003822 # cd /usr/pkg/cross/powerpc-netbsd/include
3823 # mkdir powerpc
3824 # ln -s powerpc machine
3825 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3826 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00003827
wdenk2729af92004-05-03 20:45:30 +00003828Native builds *don't* work due to incompatibilities between native
3829and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00003830
wdenk2729af92004-05-03 20:45:30 +00003831Booting assumes that (the first part of) the image booted is a
3832stage-2 loader which in turn loads and then invokes the kernel
3833proper. Loader sources will eventually appear in the NetBSD source
3834tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00003835meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00003836
3837
wdenk2729af92004-05-03 20:45:30 +00003838Implementation Internals:
3839=========================
wdenkc6097192002-11-03 00:24:07 +00003840
wdenk2729af92004-05-03 20:45:30 +00003841The following is not intended to be a complete description of every
3842implementation detail. However, it should help to understand the
3843inner workings of U-Boot and make it easier to port it to custom
3844hardware.
wdenkc6097192002-11-03 00:24:07 +00003845
3846
wdenk2729af92004-05-03 20:45:30 +00003847Initial Stack, Global Data:
3848---------------------------
wdenkc6097192002-11-03 00:24:07 +00003849
wdenk2729af92004-05-03 20:45:30 +00003850The implementation of U-Boot is complicated by the fact that U-Boot
3851starts running out of ROM (flash memory), usually without access to
3852system RAM (because the memory controller is not initialized yet).
3853This means that we don't have writable Data or BSS segments, and BSS
3854is not initialized as zero. To be able to get a C environment working
3855at all, we have to allocate at least a minimal stack. Implementation
3856options for this are defined and restricted by the CPU used: Some CPU
3857models provide on-chip memory (like the IMMR area on MPC8xx and
3858MPC826x processors), on others (parts of) the data cache can be
3859locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00003860
Wolfgang Denk218ca722008-03-26 10:40:12 +01003861 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01003862 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00003863
wdenk2729af92004-05-03 20:45:30 +00003864 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
3865 From: "Chris Hallinan" <clh@net1plus.com>
3866 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
3867 ...
wdenk43d96162003-03-06 00:02:04 +00003868
wdenk2729af92004-05-03 20:45:30 +00003869 Correct me if I'm wrong, folks, but the way I understand it
3870 is this: Using DCACHE as initial RAM for Stack, etc, does not
3871 require any physical RAM backing up the cache. The cleverness
3872 is that the cache is being used as a temporary supply of
3873 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003874 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00003875 can see how this works by studying the cache architecture and
3876 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00003877
wdenk2729af92004-05-03 20:45:30 +00003878 OCM is On Chip Memory, which I believe the 405GP has 4K. It
3879 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003880 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00003881 option should work for you. Using CS 4 should be fine if your
3882 board designers haven't used it for something that would
3883 cause you grief during the initial boot! It is frequently not
3884 used.
wdenk43d96162003-03-06 00:02:04 +00003885
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003886 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00003887 with your processor/board/system design. The default value
3888 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02003889 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00003890 than your SDRAM module. If you have a 64MB SDRAM module, set
3891 it above 400_0000. Just make sure your board has no resources
3892 that are supposed to respond to that address! That code in
3893 start.S has been around a while and should work as is when
3894 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00003895
wdenk2729af92004-05-03 20:45:30 +00003896 -Chris Hallinan
3897 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00003898
wdenk2729af92004-05-03 20:45:30 +00003899It is essential to remember this, since it has some impact on the C
3900code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00003901
wdenk2729af92004-05-03 20:45:30 +00003902* Initialized global data (data segment) is read-only. Do not attempt
3903 to write it.
wdenkc6097192002-11-03 00:24:07 +00003904
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003905* Do not use any uninitialized global data (or implicitely initialized
wdenk2729af92004-05-03 20:45:30 +00003906 as zero data - BSS segment) at all - this is undefined, initiali-
3907 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00003908
wdenk2729af92004-05-03 20:45:30 +00003909* Stack space is very limited. Avoid big data buffers or things like
3910 that.
wdenkc6097192002-11-03 00:24:07 +00003911
wdenk2729af92004-05-03 20:45:30 +00003912Having only the stack as writable memory limits means we cannot use
3913normal global data to share information beween the code. But it
3914turned out that the implementation of U-Boot can be greatly
3915simplified by making a global data structure (gd_t) available to all
3916functions. We could pass a pointer to this data as argument to _all_
3917functions, but this would bloat the code. Instead we use a feature of
3918the GCC compiler (Global Register Variables) to share the data: we
3919place a pointer (gd) to the global data into a register which we
3920reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00003921
wdenk2729af92004-05-03 20:45:30 +00003922When choosing a register for such a purpose we are restricted by the
3923relevant (E)ABI specifications for the current architecture, and by
3924GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00003925
wdenk2729af92004-05-03 20:45:30 +00003926For PowerPC, the following registers have specific use:
3927 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01003928 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00003929 R3-R4: parameter passing and return values
3930 R5-R10: parameter passing
3931 R13: small data area pointer
3932 R30: GOT pointer
3933 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00003934
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01003935 (U-Boot also uses R12 as internal GOT pointer. r12
3936 is a volatile register so r12 needs to be reset when
3937 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00003938
Wolfgang Denke7670f62008-02-14 22:43:22 +01003939 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003940
wdenk2729af92004-05-03 20:45:30 +00003941 Note: on PPC, we could use a static initializer (since the
3942 address of the global data structure is known at compile time),
3943 but it turned out that reserving a register results in somewhat
3944 smaller code - although the code savings are not that big (on
3945 average for all boards 752 bytes for the whole U-Boot image,
3946 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00003947
Robin Getzc4db3352009-08-17 15:23:02 +00003948On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05003949 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
3950
Robin Getzc4db3352009-08-17 15:23:02 +00003951 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05003952
wdenk2729af92004-05-03 20:45:30 +00003953On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00003954
wdenk2729af92004-05-03 20:45:30 +00003955 R0: function argument word/integer result
3956 R1-R3: function argument word
3957 R9: GOT pointer
3958 R10: stack limit (used only if stack checking if enabled)
3959 R11: argument (frame) pointer
3960 R12: temporary workspace
3961 R13: stack pointer
3962 R14: link register
3963 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00003964
wdenk2729af92004-05-03 20:45:30 +00003965 ==> U-Boot will use R8 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00003966
Wolfgang Denkd87080b2006-03-31 18:32:53 +02003967NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3968or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00003969
wdenk2729af92004-05-03 20:45:30 +00003970Memory Management:
3971------------------
wdenkc6097192002-11-03 00:24:07 +00003972
wdenk2729af92004-05-03 20:45:30 +00003973U-Boot runs in system state and uses physical addresses, i.e. the
3974MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00003975
wdenk2729af92004-05-03 20:45:30 +00003976The available memory is mapped to fixed addresses using the memory
3977controller. In this process, a contiguous block is formed for each
3978memory type (Flash, SDRAM, SRAM), even when it consists of several
3979physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00003980
wdenk2729af92004-05-03 20:45:30 +00003981U-Boot is installed in the first 128 kB of the first Flash bank (on
3982TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3983booting and sizing and initializing DRAM, the code relocates itself
3984to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003985memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00003986configuration setting]. Below that, a structure with global Board
3987Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00003988
wdenk2729af92004-05-03 20:45:30 +00003989Additionally, some exception handler code is copied to the low 8 kB
3990of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00003991
wdenk2729af92004-05-03 20:45:30 +00003992So a typical memory configuration with 16 MB of DRAM could look like
3993this:
wdenkc6097192002-11-03 00:24:07 +00003994
wdenk2729af92004-05-03 20:45:30 +00003995 0x0000 0000 Exception Vector code
3996 :
3997 0x0000 1FFF
3998 0x0000 2000 Free for Application Use
3999 :
4000 :
wdenkc6097192002-11-03 00:24:07 +00004001
wdenk2729af92004-05-03 20:45:30 +00004002 :
4003 :
4004 0x00FB FF20 Monitor Stack (Growing downward)
4005 0x00FB FFAC Board Info Data and permanent copy of global data
4006 0x00FC 0000 Malloc Arena
4007 :
4008 0x00FD FFFF
4009 0x00FE 0000 RAM Copy of Monitor Code
4010 ... eventually: LCD or video framebuffer
4011 ... eventually: pRAM (Protected RAM - unchanged by reset)
4012 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00004013
4014
wdenk2729af92004-05-03 20:45:30 +00004015System Initialization:
4016----------------------
wdenkc6097192002-11-03 00:24:07 +00004017
wdenk2729af92004-05-03 20:45:30 +00004018In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004019(on most PowerPC systems at address 0x00000100). Because of the reset
wdenk2729af92004-05-03 20:45:30 +00004020configuration for CS0# this is a mirror of the onboard Flash memory.
4021To be able to re-map memory U-Boot then jumps to its link address.
4022To be able to implement the initialization code in C, a (small!)
4023initial stack is set up in the internal Dual Ported RAM (in case CPUs
4024which provide such a feature like MPC8xx or MPC8260), or in a locked
4025part of the data cache. After that, U-Boot initializes the CPU core,
4026the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00004027
wdenk2729af92004-05-03 20:45:30 +00004028Next, all (potentially) available memory banks are mapped using a
4029preliminary mapping. For example, we put them on 512 MB boundaries
4030(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4031on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4032programmed for SDRAM access. Using the temporary configuration, a
4033simple memory test is run that determines the size of the SDRAM
4034banks.
wdenkc6097192002-11-03 00:24:07 +00004035
wdenk2729af92004-05-03 20:45:30 +00004036When there is more than one SDRAM bank, and the banks are of
4037different size, the largest is mapped first. For equal size, the first
4038bank (CS2#) is mapped first. The first mapping is always for address
40390x00000000, with any additional banks following immediately to create
4040contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00004041
wdenk2729af92004-05-03 20:45:30 +00004042Then, the monitor installs itself at the upper end of the SDRAM area
4043and allocates memory for use by malloc() and for the global Board
4044Info data; also, the exception vector code is copied to the low RAM
4045pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00004046
wdenk2729af92004-05-03 20:45:30 +00004047Only after this relocation will you have a "normal" C environment;
4048until that you are restricted in several ways, mostly because you are
4049running from ROM, and because the code will have to be relocated to a
4050new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00004051
4052
wdenk2729af92004-05-03 20:45:30 +00004053U-Boot Porting Guide:
4054----------------------
wdenkc6097192002-11-03 00:24:07 +00004055
wdenk2729af92004-05-03 20:45:30 +00004056[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
4057list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00004058
4059
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004060int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00004061{
4062 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00004063
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004064 signal(SIGALRM, no_more_time);
4065 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00004066
wdenk2729af92004-05-03 20:45:30 +00004067 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004068 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00004069 return 0;
4070 }
4071
wdenk2729af92004-05-03 20:45:30 +00004072 Download latest U-Boot source;
4073
Wolfgang Denk06682362008-12-30 22:56:11 +01004074 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00004075
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004076 if (clueless)
4077 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00004078
wdenk2729af92004-05-03 20:45:30 +00004079 while (learning) {
4080 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004081 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
4082 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00004083 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004084 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00004085 }
wdenkc6097192002-11-03 00:24:07 +00004086
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004087 if (available_money > toLocalCurrency ($2500))
4088 Buy a BDI3000;
4089 else
wdenk2729af92004-05-03 20:45:30 +00004090 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004091
4092 if (a similar board exists) { /* hopefully... */
4093 cp -a board/<similar> board/<myboard>
4094 cp include/configs/<similar>.h include/configs/<myboard>.h
4095 } else {
4096 Create your own board support subdirectory;
4097 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00004098 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004099 Edit new board/<myboard> files
4100 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00004101
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04004102 while (!accepted) {
4103 while (!running) {
4104 do {
4105 Add / modify source code;
4106 } until (compiles);
4107 Debug;
4108 if (clueless)
4109 email("Hi, I am having problems...");
4110 }
4111 Send patch file to the U-Boot email list;
4112 if (reasonable critiques)
4113 Incorporate improvements from email list code review;
4114 else
4115 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00004116 }
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk2729af92004-05-03 20:45:30 +00004118 return 0;
4119}
4120
4121void no_more_time (int sig)
4122{
4123 hire_a_guru();
4124}
wdenkc6097192002-11-03 00:24:07 +00004125
4126
wdenk2729af92004-05-03 20:45:30 +00004127Coding Standards:
4128-----------------
wdenkc6097192002-11-03 00:24:07 +00004129
wdenk2729af92004-05-03 20:45:30 +00004130All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02004131coding style; see the file "Documentation/CodingStyle" and the script
4132"scripts/Lindent" in your Linux kernel source directory. In sources
4133originating from U-Boot a style corresponding to "Lindent -pcs" (adding
4134spaces before parameters to function calls) is actually used.
wdenk2729af92004-05-03 20:45:30 +00004135
Detlev Zundel2c051652006-09-01 15:39:02 +02004136Source files originating from a different project (for example the
4137MTD subsystem) are generally exempt from these guidelines and are not
4138reformated to ease subsequent migration to newer versions of those
4139sources.
4140
4141Please note that U-Boot is implemented in C (and to some small parts in
4142Assembler); no C++ is used, so please do not use C++ style comments (//)
4143in your code.
wdenk2729af92004-05-03 20:45:30 +00004144
4145Please also stick to the following formatting rules:
4146- remove any trailing white space
4147- use TAB characters for indentation, not spaces
4148- make sure NOT to use DOS '\r\n' line feeds
4149- do not add more than 2 empty lines to source files
4150- do not add trailing empty lines to source files
4151
4152Submissions which do not conform to the standards may be returned
4153with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00004154
4155
wdenk2729af92004-05-03 20:45:30 +00004156Submitting Patches:
4157-------------------
wdenkc6097192002-11-03 00:24:07 +00004158
wdenk2729af92004-05-03 20:45:30 +00004159Since the number of patches for U-Boot is growing, we need to
4160establish some rules. Submissions which do not conform to these rules
4161may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00004162
Magnus Lilja0d28f342008-08-06 19:32:33 +02004163Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01004164
Wolfgang Denk06682362008-12-30 22:56:11 +01004165Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
4166see http://lists.denx.de/mailman/listinfo/u-boot
4167
wdenk2729af92004-05-03 20:45:30 +00004168When you send a patch, please include the following information with
4169it:
wdenkc6097192002-11-03 00:24:07 +00004170
wdenk2729af92004-05-03 20:45:30 +00004171* For bug fixes: a description of the bug and how your patch fixes
4172 this bug. Please try to include a way of demonstrating that the
4173 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00004174
wdenk2729af92004-05-03 20:45:30 +00004175* For new features: a description of the feature and your
4176 implementation.
wdenkc6097192002-11-03 00:24:07 +00004177
wdenk2729af92004-05-03 20:45:30 +00004178* A CHANGELOG entry as plaintext (separate from the patch)
4179
4180* For major contributions, your entry to the CREDITS file
4181
4182* When you add support for a new board, don't forget to add this
4183 board to the MAKEALL script, too.
4184
4185* If your patch adds new configuration options, don't forget to
4186 document these in the README file.
4187
Wolfgang Denk218ca722008-03-26 10:40:12 +01004188* The patch itself. If you are using git (which is *strongly*
4189 recommended) you can easily generate the patch using the
4190 "git-format-patch". If you then use "git-send-email" to send it to
4191 the U-Boot mailing list, you will avoid most of the common problems
4192 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00004193
Wolfgang Denk218ca722008-03-26 10:40:12 +01004194 If you cannot use git, use "diff -purN OLD NEW". If your version of
4195 diff does not support these options, then get the latest version of
4196 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00004197
Wolfgang Denk218ca722008-03-26 10:40:12 +01004198 The current directory when running this command shall be the parent
4199 directory of the U-Boot source tree (i. e. please make sure that
4200 your patch includes sufficient directory information for the
4201 affected files).
4202
4203 We prefer patches as plain text. MIME attachments are discouraged,
4204 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00004205
4206* If one logical set of modifications affects or creates several
4207 files, all these changes shall be submitted in a SINGLE patch file.
4208
4209* Changesets that contain different, unrelated modifications shall be
4210 submitted as SEPARATE patches, one patch per changeset.
4211
4212
4213Notes:
4214
4215* Before sending the patch, run the MAKEALL script on your patched
4216 source tree and make sure that no errors or warnings are reported
4217 for any of the boards.
4218
4219* Keep your modifications to the necessary minimum: A patch
4220 containing several unrelated changes or arbitrary reformats will be
4221 returned with a request to re-formatting / split it.
4222
4223* If you modify existing code, make sure that your new code does not
4224 add to the memory footprint of the code ;-) Small is beautiful!
4225 When adding new features, these should compile conditionally only
4226 (using #ifdef), and the resulting code with the new feature
4227 disabled must not need more memory than the old code without your
4228 modification.
wdenk90dc6702005-05-03 14:12:25 +00004229
Wolfgang Denk06682362008-12-30 22:56:11 +01004230* Remember that there is a size limit of 100 kB per message on the
4231 u-boot mailing list. Bigger patches will be moderated. If they are
4232 reasonable and not too big, they will be acknowledged. But patches
4233 bigger than the size limit should be avoided.